m2mb_httpd.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/*-----------------------------------------------------------------------------------------------*/

#ifndef  M2MB_HTTPD_API_H
#define  M2MB_HTTPD_API_H

/*-----------------------------------------------------------------------------------------------*/


/*-----------------------------------------------------------------------------------------------*/
/* Global declarations ==========================================================================*/

#define M2MB_HTTPD_PATH_MAX              31 
#define M2MB_HTTPD_SRVR_NAME_MAX        512 
#define HTTP_OK             200
#define HTTP_CREATED        201
#define HTTP_ACCEPTED       202
#define HTTP_NO_CONTENT     204
#define HTTP_RESET_CONTENT  205

/* http redirect codes: 3xx */
#define HTTP_REDIRECT_MULTI    300
#define HTTP_REDIRECT_PERM     301
#define HTTP_REDIRECT_TEMP     302
#define HTTP_REDIRECT_OTHER    303
#define HTTP_REDIRECT_NOMOD    304
#define HTTP_REDIRECT_PROXY    305

/* Client errors: 4xx */
#define HTTP_ERROR_BADREQ   400
#define HTTP_ERROR_AUTHFAIL 401
#define HTTP_ERROR_PAYMENT  402
#define HTTP_ERROR_FORBID   403
#define HTTP_ERROR_NOFILE   404
#define HTTP_ERROR_METHOD   405
#define HTTP_ERROR_UNACCEPT 406
#define HTTP_ERROR_PROXYAUT 407
#define HTTP_ERROR_REQTMO   408
#define HTTP_ERROR_CONFLICT 409
#define HTTP_ERROR_RESGONE  410
#define HTTP_ERROR_LENGTH   411
#define HTTP_ERROR_PREFAIL  412
#define HTTP_ERROR_TOOBIG   413
#define HTTP_ERROR_URIBIG   414
#define HTTP_ERROR_BADMEDIA 415

/* Server errors: 5xx */
#define HTTP_ERROR_SERVER      500
#define HTTP_ERROR_NOTIMPLEMENTED   501
#define HTTP_ERROR_BADGATEWAY  502
#define HTTP_ERROR_OVERLOAD    503
#define HTTP_ERROR_GATEAWYTMO  504
#define HTTP_ERROR_HTTPVER     505

/* Global typedefs ==============================================================================*/

typedef enum
{
        FP_ERR    = 0x110,  
        FP_OK     = 0x120,  
        FP_FILE   = 0x140,  
        FP_DONE   = 0x200,  
}M2MB_HTTPD_CGI_RETURN_E;

typedef enum
{
        M2MB_HTTPD_MODE_HTTP            = 1,     
        M2MB_HTTPD_MODE_HTTPS           = 2,     
        M2MB_HTTPD_MODE_HTTP_AND_HTTPS  = 3      
} M2MB_HTTPD_MODE_E;

typedef enum
{
        M2MB_HTTPD_METHOD_INVALID   = 1,        
        M2MB_HTTPD_METHOD_GET       = 2,        
        M2MB_HTTPD_METHOD_HEAD      = 3,        
    M2MB_HTTPD_METHOD_POST      = 4,        
    M2MB_HTTPD_METHOD_PUT       = 5,        
    M2MB_HTTPD_METHOD_DELETE    = 6,        
    M2MB_HTTPD_METHOD_TRACE     = 7,        
    M2MB_HTTPD_METHOD_POSTMULTI = 8         
} M2MB_HTTPD_METHOD_E;

typedef enum M2MB_URI_AUTH_FLAG
{
    M2MB_URI_FLAG_NOAUTH    = 0x00,  
        M2MB_URI_FLAG_AUTHBASIC = 0x02,  
        M2MB_URI_FLAG_AUTHMD5   = 0x04   
}M2MB_URI_AUTH_FLAG_T;

typedef enum M2MB_HTTPD_URI_USER_EVENT
{
    M2MB_HTTPD_URI_USER_EVENT_CON_OPENED      = 0x00000001, 
    M2MB_HTTPD_URI_USER_EVENT_CON_CLOSE       = 0x00000002, 
    M2MB_HTTPD_URI_USER_EVENT_HEADERS_RECV    = 0x00000004, 
    M2MB_HTTPD_URI_USER_EVENT_FORM_RECV       = 0x00000008, 
    M2MB_HTTPD_URI_USER_EVENT_BODY_RECV       = 0x00000010, 
    M2MB_HTTPD_URI_USER_EVENT_ALL_RECV        = 0x00000020, 
    M2MB_HTTPD_URI_USER_EVENT_FORM_FILE_RECV  = 0x00000040, 
    M2MB_HTTPD_URI_USER_EVENT_DATA_SENT       = 0x00000080  

} M2MB_HTTPD_URI_USER_EVENT_E;

typedef struct M2MB_HTTPD_CONFIG_S
{
    CHAR interface_Name[8]; 
    M2MB_HTTPD_MODE_E mode;
    UINT16 http_Port;
    UINT16 https_Port;
    CHAR root_Index_Page[ M2MB_HTTPD_PATH_MAX ];
    CHAR root_Path[ M2MB_HTTPD_PATH_MAX ];
    CHAR cert_File[ M2MB_HTTPD_PATH_MAX ];
    UINT8 family;
    CHAR *server_Name;
    VOID (*webfiles_Setup)(void);
    UINT16 rxbufsize;
    UINT16 txbufsize;
        UINT8 username_auth;
        UINT8* username;
        UINT8* password;
} M2MB_HTTPD_CONFIG_T;

typedef struct M2MB_HTTPD_URI_CTX
{
        UINT8 index;    
        VOID *appCtx;   
}M2MB_HTTPD_URICTX_T;

typedef struct M2MB_HTTPD_URI_REQ_INFO{
        UINT8   index;              
        VOID    *hp;                
        VOID    *form;              
        UINT8   *requestLine;       
        UINT32  requestLine_len;    
        UINT32  bodyType;           
        UINT32  bodyLength;         
        INT8    method;             
    UINT32  body_read;          
    UINT32  head_read;          
}M2MB_HTTPD_URI_REQ_INFO_T;

typedef struct M2MB_HTTPD_URI_REQ_CGI_KEY_PAIR {
   CHAR *name;
   CHAR *value;
}M2MB_HTTPD_URI_REQ_CGI_KEY_PAIR_T;

typedef struct M2MB_HTTPD_URI_REQ_CGI_FORM_DATA {
   CHAR  *action;                                   
   INT32  nv_ct;                                    
   M2MB_HTTPD_URI_REQ_CGI_KEY_PAIR_T nameval[1];    
}M2MB_HTTPD_URI_REQ_CGI_FORM_DATA_T;

typedef INT32 (*M2MB_HTTPD_URI_HANDLER_T)( VOID* conn_handle, VOID* usr_ctx, INT32 event );

typedef struct M2MB_URI_CFG_S
{
    UINT8 name[128];
    UINT16 flags;

    M2MB_HTTPD_URI_HANDLER_T h;

    UINT16 method;
        void *appCtx; /* User context */
    UINT16 uri_id;
}M2MB_URI_CFG_T;


typedef enum M2MB_HTTPD_CONF_ID
{
    //SET CONF IDs
    M2MB_HTTPD_CONF_SET_REGISTER_URI             = 0,   
    M2MB_HTTPD_CONF_SET_DEREGISTER_URI           = 1,   
    M2MB_HTTPD_CONF_SET_USER_CHANGE_PASSWORD     = 2,   
    //GET CONF IDs
    M2MB_HTTPD_CONF_GET_IS_STARTED               = 3,   
    M2MB_HTTPD_CONF_GET_MESSAGE_BODY             = 4,   
    M2MB_HTTPD_CONF_GET_MESSAGE_HEAD             = 5,   
    M2MB_HTTPD_CONF_GET_CONTENT_LEN              = 6,   
    M2MB_HTTPD_CONF_GET_BODY_LOCATION            = 7,   
    M2MB_HTTPD_CONF_GET_REQUEST_TYPE             = 8,   
    M2MB_HTTPD_CONF_GET_CGI_FORM                 = 9,   
}M2MB_HTTPD_CONF_ID_E;

typedef struct M2MB_HTTPD_INIT_PARAMS
        {
    M2MB_HTTPD_CONFIG_T *cfg;           
    M2MB_SSL_CTXT_HANDLE ssl_handle;    
}M2MB_HTTPD_INIT_PARAMS_T;

typedef struct M2MB_HTTPD_URI_CONFIG_PARAMS
                {
    CHAR *uri;                      
    UINT8* methods;                 
    M2MB_URI_AUTH_FLAG_T flag;      
    M2MB_HTTPD_URI_HANDLER_T fn_cb; 
    VOID* usr_ctx;                  
}M2MB_HTTPD_URI_CONFIG_PARAMS_T;

typedef struct M2MB_HTTPD_GET_MSG_INFO
                {
    VOID *conn_handle;      
    INT8 *buf;              
    UINT32 *plen;           
}M2MB_HTTPD_GET_MSG_INFO_T;

typedef struct M2MB_HTTPD_GET_CONTENT_LEN
{
    VOID *conn_handle;      
    INT32 content_len;      
}M2MB_HTTPD_GET_CONTENT_LEN_T;

typedef struct M2MB_HTTPD_GET_BODY_LOC
{
    VOID *conn_handle;  
    CHAR *body_loc;     
}M2MB_HTTPD_GET_BODY_LOC_T;

typedef struct M2MB_HTTPD_GET_REQUEST_TYPE
{
    VOID *conn_handle;      
    INT32 request_type;     
}M2MB_HTTPD_GET_REQUEST_TYPE_T;

typedef struct M2MB_HTTPD_GET_REQ_URI_CGI_FORM_DATA
        {
    VOID *conn_handle;                                 
    M2MB_HTTPD_URI_REQ_CGI_FORM_DATA_T* cgi_form_data; 
}M2MB_HTTPD_GET_REQ_URI_CGI_FORM_DATA_T;

typedef struct M2MB_HTTPD_URICTXT_FROM_INDEX
                {
    INT32 index;            
    VOID * uri_ctxt;        
}M2MB_HTTPD_URICTXT_FROM_INDEX_T;

typedef struct M2MB_HTTPD_USER_INFO
                {
    CHAR *username;                 
    CHAR *cur_password;             
    CHAR *new_password;             
}M2MB_HTTPD_USER_INFO_T;

typedef union 
{
    INT32 httpd_status;                                            
    M2MB_HTTPD_URI_CONFIG_PARAMS_T *uri_cfg_params;                 
    CHAR *deConfig_uri;                                             
    M2MB_HTTPD_GET_MSG_INFO_T *get_msg_info;                        
    M2MB_HTTPD_GET_CONTENT_LEN_T *get_content_len;                  
    M2MB_HTTPD_GET_BODY_LOC_T *get_body_loc;                        
    M2MB_HTTPD_GET_REQUEST_TYPE_T *get_request_type;                
    M2MB_HTTPD_GET_REQ_URI_CGI_FORM_DATA_T *get_uri_cgi_form_data;  
    M2MB_HTTPD_URICTXT_FROM_INDEX_T *get_uri_ctxt;                  
    M2MB_HTTPD_USER_INFO_T *user_info;                              
}M2MB_HTTPD_CONF_PARAMS_T;


/* External variables ===========================================================================*/

/* External functions ===========================================================================*/

/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_init( HANDLE *handle, M2MB_HTTPD_INIT_PARAMS_T * init_params );

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_deinit(HANDLE handle); 

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_start(HANDLE handle);

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_stop(HANDLE handle);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_send_headers( VOID *conn_handle,
                                       UINT8 *content_type,
                                       INT32 content_length,
                                       INT32 status_code,
                                       UINT8 *status_text,
                                       UINT8 *user_headers );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/                                             
M2MB_STATUS_T m2mb_httpd_send_data( VOID *conn_handle, const INT8 *data, UINT32 length );


/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_set_cfg( HANDLE handle, M2MB_HTTPD_CONF_ID_E conf_id, M2MB_HTTPD_CONF_PARAMS_T * conf_params);

    
/*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_get_cfg( HANDLE handle, M2MB_HTTPD_CONF_ID_E conf_id, M2MB_HTTPD_CONF_PARAMS_T * conf_params);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_URI_CFG_T * m2mb_httpd_get_uri_cfg_from_index(INT32 index);

/*-----------------------------------------------------------------------------------------------*/

                                                
#endif