mcl_common.h

Go to the documentation of this file.

/*!**********************************************************************
 *
 * @copyright Copyright (C) 2016 Siemens Aktiengesellschaft.\n
 *            All rights reserved.
 *
 *************************************************************************
 *
 * @file     mcl_common.h
 * @date     Jul 18, 2016
 * @brief    Common module interface header file.
 *
 * This module contains common type definitions used in various MCL modules.
 *
 ************************************************************************/

#ifndef MCL_COMMON_H_
#define MCL_COMMON_H_

#include "mcl/mcl_config_setup.h"

#include <stddef.h>
#include <stdint.h>
#include <time.h>

#ifdef  __cplusplus
extern "C"
{
#endif

    #define MCL_LOG_UTIL_LEVEL_VERBOSE  1
    #define MCL_LOG_UTIL_LEVEL_DEBUG    2
    #define MCL_LOG_UTIL_LEVEL_INFO     3
    #define MCL_LOG_UTIL_LEVEL_WARN     4
    #define MCL_LOG_UTIL_LEVEL_ERROR    5
    #define MCL_LOG_UTIL_LEVEL_FATAL    6
    #define MCL_LOG_UTIL_LEVEL_NONE     0xFF

    typedef size_t mcl_size_t;
    typedef int8_t mcl_int8_t;
    typedef int16_t mcl_int16_t;
    typedef int32_t mcl_int32_t;
    typedef int64_t mcl_int64_t;
    typedef uint8_t mcl_uint8_t;
    typedef uint16_t mcl_uint16_t;
    typedef uint32_t mcl_uint32_t;
    typedef uint64_t mcl_uint64_t;
    typedef mcl_uint8_t mcl_bool_t;
    typedef time_t mcl_time_t;

    #define MCL_FALSE ((mcl_bool_t)0)
    #define MCL_TRUE ((mcl_bool_t)1)

    #define MCL_MAXIMUM_HTTP_PAYLOAD_SIZE (10485760)

    typedef enum E_MCL_PROXY
    {
        MCL_PROXY_UNKNOWN = -1,       
        MCL_PROXY_HTTP = 0,           
        MCL_PROXY_HTTP_1_0 = 1,       
        MCL_PROXY_SOCKS4 = 4,         
        MCL_PROXY_SOCKS5 = 5,         
        MCL_PROXY_SOCKS4A = 6,        
        MCL_PROXY_SOCKS5_HOSTNAME = 7 
    } E_MCL_PROXY;

    typedef enum E_MCL_SECURITY_PROFILE
    {
        MCL_SECURITY_SHARED_SECRET, 
        MCL_SECURITY_RSA_3072       
    } E_MCL_SECURITY_PROFILE;

    typedef enum E_MCL_CONFIGURATION_TYPE
    {
        MCL_CONFIGURATION_MINDSPHERE_HOSTNAME = 0, 
        MCL_CONFIGURATION_MINDSPHERE_PORT,         
        MCL_CONFIGURATION_MINDSPHERE_CERTIFICATE,  
        MCL_CONFIGURATION_PROXY_HOSTNAME,          
        MCL_CONFIGURATION_PROXY_PORT,              
        MCL_CONFIGURATION_PROXY_TYPE,              
        MCL_CONFIGURATION_PROXY_USER_NAME,         
        MCL_CONFIGURATION_PASSWORD,                
        MCL_CONFIGURATION_DOMAIN,                  
        MCL_CONFIGURATION_SECURITY_PROFILE         
    } E_MCL_CONFIGURATION_TYPE;

    typedef enum E_MCL_SOURCE_TYPE
    {
        MCL_SOURCE_TYPE_ASSET,       
        MCL_SOURCE_TYPE_APPLICATION, 
        MCL_SOURCE_TYPE_AGENT        
    } E_MCL_SOURCE_TYPE;

    typedef enum E_MCL_EVENT_SEVERITY
    {
        MCL_EVENT_SEVERITY_ERROR = 0,    
        MCL_EVENT_SEVERITY_WARNING,      
        MCL_EVENT_SEVERITY_INFORMATION,  
        MCL_EVENT_SEVERITY_END
    } E_MCL_EVENT_SEVERITY;

    typedef enum E_MCL_EVENT_OPTION
    {
        MCL_EVENT_OPTION_CORRELATION_ID,    
        MCL_EVENT_OPTION_DESCRIPTION,       
        MCL_EVENT_OPTION_DETAILS            
    } E_MCL_EVENT_OPTION;

    typedef enum E_MCL_ERROR_CODE
    {
        // General error codes.
        MCL_OK = 0,                                  
        MCL_FAIL,                                    
        MCL_TRIGGERED_WITH_NULL,                     
        MCL_OUT_OF_MEMORY,                           
        MCL_INVALID_PARAMETER,                       
        MCL_NO_FILE_SUPPORT,                         
        MCL_NO_STORAGE_MEDIUM,                       
        MCL_INVALID_LOG_LEVEL,                       
        MCL_OPERATION_IS_NOT_SUPPORTED,              
        MCL_FILE_CANNOT_BE_OPENED,                   
        MCL_JSON_NAME_DUPLICATION,                   
        MCL_INDEX_OUT_OF_RANGE,                      
        MCL_ITEM_ALREADY_EXISTS,                     
        MCL_INVALID_EVENT_SEVERITY_LEVEL,            
        MCL_NO_SERVER_TIME,                          
        MCL_NO_ACCESS_TOKEN_EXISTS,                  

        // Error codes for configuration parameters.
        MCL_INVALID_HOST_NAME,                       
        MCL_INVALID_CERTIFICATE,                     
        MCL_INVALID_PROXY_HOST_NAME,                 
        MCL_INVALID_PROXY_USER_NAME,                 
        MCL_INVALID_PROXY_PASSWORD,                  
        MCL_INVALID_PROXY_DOMAIN,                    
        MCL_INVALID_SECURITY_PROFILE,                
        MCL_INVALID_USER_AGENT,                      
        MCL_INVALID_TENANT,                          
        MCL_INVALID_MAX_HTTP_PAYLOAD_SIZE,           
        MCL_NO_ACCESS_TOKEN_PROVIDED,                
        MCL_PATH_NOT_ACCESSIBLE,                     

        // HTTPS error codes.
        MCL_COULD_NOT_RESOLVE_PROXY,                 
        MCL_COULD_NOT_RESOLVE_HOST,                  
        MCL_COULD_NOT_CONNECT,                       
        MCL_SSL_HANDSHAKE_FAIL,                      
        MCL_NETWORK_SEND_FAIL,                       
        MCL_NETWORK_RECEIVE_FAIL,                    
        MCL_SERVER_CERTIFICATE_NOT_VERIFIED,         
        MCL_IMPROPER_CERTIFICATE,                    
        MCL_REQUEST_TIMEOUT,                         
        MCL_SERVER_FAIL,                             
        MCL_CREATED,                                 
        MCL_PARTIAL_CONTENT,                         
        MCL_BAD_REQUEST,                             
        MCL_UNAUTHORIZED,                            
        MCL_FORBIDDEN,                               
        MCL_NOT_FOUND,                               
        MCL_CONFLICT,                                
        MCL_PRECONDITION_FAIL,                       
        MCL_REQUEST_PAYLOAD_TOO_LARGE,               
        MCL_TOO_MANY_REQUESTS,                       
        MCL_UNEXPECTED_RESULT_CODE,                  

        // Status error codes.
        MCL_NOT_INITIALIZED,                          
        MCL_NOT_ONBOARDED,                            
        MCL_ALREADY_ONBOARDED,                        
        MCL_STORE_IS_EMPTY,                           
        MCL_EXCHANGE_STREAMING_IS_ACTIVE,             
        MCL_SECURITY_UP_TO_DATE,                      
        MCL_CANNOT_ENTER_CRITICAL_SECTION,            

        // Operational error codes.
        MCL_INITIALIZATION_FAIL,                      
        MCL_STORE_ITEM_EXCEEDS_MAX_HTTP_REQUEST_SIZE, 
        MCL_UNDEFINED_ENDPOINT,                       
        MCL_BAD_CONTENT_ENCODING,                     
        MCL_NON_EXISTING_JSON_CHILD,                  
        MCL_SHA256_CALCULATION_FAIL,                  
        MCL_SERVER_PROOF_FAIL,                        
        MCL_REGISTRATION_INFO_IS_NOT_SAVED,           
        MCL_REGISTRATION_INFO_IS_NOT_LOADED,          
        MCL_BUFFER_OVERFLOW_ERROR,                    

        // Internal error codes.
        MCL_HTTP_REQUEST_NO_MORE_SPACE,               
        MCL_LIMIT_EXCEEDED,                           
        MCL_ARRAY_IS_EMPTY,                           
        MCL_PARTIALLY_WRITTEN,                        
        MCL_HTTP_REQUEST_FINALIZE_FAILED,             
        MCL_ERROR_CODE_END                            
        //Do NOT add new error codes after MCL_ERROR_CODE_END!!!
    } E_MCL_ERROR_CODE;

    typedef E_MCL_ERROR_CODE (*mcl_load_shared_secret_callback_t)(char **client_id, char **client_secret, char **registration_access_token, char **registration_uri);

    typedef E_MCL_ERROR_CODE (*mcl_save_shared_secret_callback_t)(const char *client_id, const char *client_secret, const char *registration_access_token,
        const char *registration_uri);

    typedef E_MCL_ERROR_CODE (*mcl_load_rsa_callback_t)(char **client_id, char **public_key, char **private_key, char **registration_access_token, char **registration_uri);

    typedef E_MCL_ERROR_CODE (*mcl_save_rsa_callback_t)(const char *client_id, const char *public_key, const char *private_key, const char *registration_access_token,
        const char *registration_uri);

    typedef union mcl_load_registration_information_callback_t
    {
        mcl_load_shared_secret_callback_t shared_secret; 
        mcl_load_rsa_callback_t rsa;                     
    } mcl_load_registration_information_callback_t;

    typedef union mcl_save_registration_information_callback_t
    {
        mcl_save_shared_secret_callback_t shared_secret; 
        mcl_save_rsa_callback_t rsa;                     
    } mcl_save_registration_information_callback_t;

    typedef E_MCL_ERROR_CODE (*mcl_enter_critical_section_callback_t)(void);

    typedef void (*mcl_leave_critical_section_callback_t)(void);

#ifdef  __cplusplus
}
#endif

#endif //MCL_COMMON_H_