aws_iot_defender.h

Go to the documentation of this file.

/*
 * AWS IoT Defender V3.0.0
 * Copyright (C) 2018 Amazon.com, Inc. or its affiliates.  All Rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#ifndef AWS_IOT_DEFENDER_H_
#define AWS_IOT_DEFENDER_H_

/* The config header is always included first. */
#include "iot_config.h"

/* Standard includes. */
#include <stdint.h>
#include <stdlib.h>

/* MQTT include. */
#include "iot_mqtt.h"

#define AWS_IOT_DEFENDER_FORMAT_CBOR    1                                      
#define AWS_IOT_DEFENDER_FORMAT_JSON    2                                      
#define AWS_IOT_DEFENDER_METRICS_ALL                                        0xffffffff 
#define AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED_TOTAL          0x00000001 
#define AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED_REMOTE_ADDR    0x00000004 
#define AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED_CONNECTIONS \
    ( AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED_REMOTE_ADDR ) \


#define AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED                                                                          \
    ( AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED_CONNECTIONS | AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS_ESTABLISHED_TOTAL ) \


#define AWS_IOT_DEFENDER_CALLBACK_INITIALIZER \
    {                                         \
        .pCallbackContext = NULL,             \
        .function = NULL                      \
    } 
#define AWS_IOT_DEFENDER_START_INFO_INITIALIZER          \
    { .pClientIdentifier = NULL,                         \
      .clientIdentifierLength = 0,                       \
      .mqttConnection = IOT_MQTT_CONNECTION_INITIALIZER, \
      .callback = AWS_IOT_DEFENDER_CALLBACK_INITIALIZER  \
    } 
typedef enum
{
    AWS_IOT_DEFENDER_METRICS_TCP_CONNECTIONS, 
} AwsIotDefenderMetricsGroup_t;

typedef enum
{
    AWS_IOT_DEFENDER_SUCCESS = 0,      
    AWS_IOT_DEFENDER_INVALID_INPUT,    
    AWS_IOT_DEFENDER_ALREADY_STARTED,  
    AWS_IOT_DEFENDER_PERIOD_TOO_SHORT, 
    AWS_IOT_DEFENDER_ERROR_NO_MEMORY,  
    AWS_IOT_DEFENDER_INTERNAL_FAILURE  
} AwsIotDefenderError_t;

typedef enum
{
    AWS_IOT_DEFENDER_METRICS_ACCEPTED = 0,  
    AWS_IOT_DEFENDER_METRICS_REJECTED,      
    AWS_IOT_DEFENDER_FAILURE_MQTT,          
    AWS_IOT_DEFENDER_FAILURE_METRICS_REPORT 
} AwsIotDefenderEventType_t;

typedef struct AwsIotDefenderCallbackInfo
{
    const uint8_t * pMetricsReport;      
    size_t metricsReportLength;          
    const uint8_t * pPayload;            
    size_t payloadLength;                
    AwsIotDefenderEventType_t eventType; 
} AwsIotDefenderCallbackInfo_t;

typedef struct AwsIotDefenderCallback
{
    void * pCallbackContext;                                     
    void ( * function )( void *,
                         AwsIotDefenderCallbackInfo_t * const ); 
} AwsIotDefenderCallback_t;

typedef struct AwsIotDefenderStartInfo
{
    const char * pClientIdentifier;     
    uint16_t clientIdentifierLength;    
    IotMqttConnection_t mqttConnection; 
    AwsIotDefenderCallback_t callback;  
} AwsIotDefenderStartInfo_t;

/* @[declare_defender_setmetrics] */
AwsIotDefenderError_t AwsIotDefender_SetMetrics( AwsIotDefenderMetricsGroup_t metricsGroup,
                                                 uint32_t metrics );
/* @[declare_defender_setmetrics] */

/* @[declare_defender_start] */
AwsIotDefenderError_t AwsIotDefender_Start( AwsIotDefenderStartInfo_t * pStartInfo );
/* @[declare_defender_start] */

/* @[declare_defender_stop] */
void AwsIotDefender_Stop( void );
/* @[declare_defender_stop] */

/* @[declare_defender_setperiod] */
AwsIotDefenderError_t AwsIotDefender_SetPeriod( uint32_t periodSeconds );
/* @[declare_defender_setperiod] */

/* @[declare_defender_getperiod] */
uint32_t AwsIotDefender_GetPeriod( void );
/* @[declare_defender_getperiod] */

/* @[declare_defender_strerror] */
const char * AwsIotDefender_strerror( AwsIotDefenderError_t error );
/* @[declare_defender_strerror] */

/* @[declare_defender_EventType] */
const char * AwsIotDefender_EventType( AwsIotDefenderEventType_t eventType );
/* @[declare_defender_EventType] */
#endif /* AWS_IOT_DEFENDER_H_ */