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 
/* 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       = 0x00000010, 
    M2MB_HTTPD_URI_USER_EVENT_HEADERS_RECV    = 0x00000100, 
    M2MB_HTTPD_URI_USER_EVENT_FORM_RECV       = 0x00001000, 
    M2MB_HTTPD_URI_USER_EVENT_BODY_RECV       = 0x00010000, 
    M2MB_HTTPD_URI_USER_EVENT_ALL_RECV        = 0x00100000, 
    M2MB_HTTPD_URI_USER_EVENT_FORM_FILE_RECV  = 0x01000000  
} 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 );

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

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

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

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_init( M2MB_HTTPD_CONFIG_T *cfg, M2MB_SSL_CTXT_HANDLE ssl_handle );

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

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

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

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_is_started();

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_httpd_uri_cfg( CHAR *uri, UINT8* methods, M2MB_URI_AUTH_FLAG_T flag, 
        M2MB_HTTPD_URI_HANDLER_T fn_cb, VOID* usr_ctx );

/*-----------------------------------------------------------------------------------------------*/
M2MB_OS_RESULT_E m2mb_httpd_uri_decfg( char *uri );

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

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

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_get_message_body( VOID *conn_handle, INT8 *buf, UINT32 *plen);

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_get_message_head( VOID *conn_handle, UINT8 *buf, UINT32 *plen);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_httpd_get_content_len( VOID *conn_handle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
CHAR* m2mb_httpd_get_body_location( VOID *conn_handle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
INT32 m2mb_httpd_get_request_type( VOID *conn_handle);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_HTTPD_URI_REQ_CGI_FORM_DATA_T* m2mb_httpd_get_cgi_form( VOID *conn_handle );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
VOID * m2mb_httpd_FindURICtx_FromIndex(INT32 index);

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_user_add( const char *username, const char *password );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_user_del( const char *username, const char *password );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_user_validate( char *username, char *password );

/*-----------------------------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_httpd_user_change_password( char *username, char *cur_password, char *new_password );

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

                                                
#endif