mcl_core_common.h

Go to the documentation of this file.

#ifndef MCL_CORE_COMMON_H_
#define MCL_CORE_COMMON_H_

#include "mcl_core/mcl_config_setup.h"

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

#ifdef  __cplusplus
extern "C"
{
#endif

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;
typedef mcl_int32_t mcl_error_t;

#define MCL_FUNCTION_LEAVE_LABEL mcl_function_leave_label

#define MCL_FALSE ((mcl_bool_t) 0)

#define MCL_TRUE ((mcl_bool_t) 1)

// Maximum value mcl_size_t can have.
// The expression below is portable and safe.
#define MCL_SIZE_MAX ((mcl_size_t) - 1)

// MCL_NULL Definition. Refer to C-FAQ Q5.2 - Q5.17 (http://c-faq.com/null/safermacs.html).
#define MCL_NULL ((void *) 0)

#define MCL_NULL_CHAR '\0'
#define MCL_NULL_CHAR_SIZE 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, 
    MCL_PROXY_END                  
} E_MCL_PROXY;

typedef enum E_MCL_SECURITY_PROFILE
{
    MCL_SECURITY_SHARED_SECRET,  
    MCL_SECURITY_RSA_3072,       
    MCL_SECURITY_PROFILE_END     
} E_MCL_SECURITY_PROFILE;

typedef enum E_MCL_CORE_RETURN_CODE
{
    // General return codes.
    MCL_OK = 0,                             
    MCL_FAIL,                               
    MCL_TRIGGERED_WITH_NULL,                
    MCL_OUT_OF_MEMORY,                      
    MCL_INVALID_PARAMETER,                  
    MCL_INVALID_LOG_LEVEL,                  
    MCL_NO_SERVER_TIME,                     
    MCL_NO_ACCESS_TOKEN_EXISTS,             
    MCL_NO_ACCESS_TOKEN_PROVIDED,           
    MCL_NO_FILE_SUPPORT,                    
    MCL_OPERATION_NOT_SUPPORTED,            

    // HTTPS return 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 return codes.
    MCL_NOT_ONBOARDED,                      
    MCL_ALREADY_ONBOARDED,                  
    MCL_EXCHANGE_STREAMING_IS_ACTIVE,       
    MCL_CREDENTIALS_UP_TO_DATE,             
    MCL_CANNOT_ENTER_CRITICAL_SECTION,      

    // Operational return codes.
    MCL_BAD_CONTENT_ENCODING,               
    MCL_JSON_NON_EXISTING_CHILD,            
    MCL_JSON_NAME_DUPLICATION,              
    MCL_JSON_TYPE_MISMATCH,                 
    MCL_SHA256_CALCULATION_FAIL,            
    MCL_CREDENTIALS_NOT_SAVED,              
    MCL_CREDENTIALS_NOT_LOADED,             

    // Internal return codes.
    MCL_LIST_IS_EMPTY,                      
    MCL_LIMIT_EXCEEDED,                     
    MCL_CORE_RETURN_CODE_END                
} E_MCL_CORE_RETURN_CODE;

// Deprecated error code. Kept for backward compatibility.
#define MCL_NON_EXISTING_JSON_CHILD MCL_JSON_NON_EXISTING_CHILD

extern MCL_CORE_EXPORT const char *mcl_core_return_code_strings[MCL_CORE_RETURN_CODE_END];

// This function converts the given return code to its string value for core module.
#define MCL_CORE_CODE_TO_STRING(code) (code < MCL_CORE_RETURN_CODE_END ? mcl_core_return_code_strings[code] : NULL)

typedef mcl_error_t (*mcl_credentials_load_shared_secret_callback_t)(char **client_id, char **client_secret, char **registration_access_token, char **registration_uri);

typedef mcl_error_t (*mcl_credentials_save_shared_secret_callback_t)(const char *client_id, const char *client_secret, const char *registration_access_token,
    const char *registration_uri);

typedef mcl_error_t (*mcl_credentials_load_rsa_callback_t)(char **client_id, char **public_key, char **private_key, char **registration_access_token, char **registration_uri);

typedef mcl_error_t (*mcl_credentials_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_credentials_load_callback_t
{
    mcl_credentials_load_shared_secret_callback_t shared_secret; 
    mcl_credentials_load_rsa_callback_t rsa;                     
} mcl_credentials_load_callback_t;

typedef union mcl_credentials_save_callback_t
{
    mcl_credentials_save_shared_secret_callback_t shared_secret; 
    mcl_credentials_save_rsa_callback_t rsa;                     
} mcl_credentials_save_callback_t;

typedef mcl_error_t (*mcl_critical_section_enter_callback_t)(void);

typedef void (*mcl_critical_section_leave_callback_t)(void);

#ifdef  __cplusplus
}
#endif

#endif //MCL_CORE_COMMON_H_