rttpd.h

Go to the documentation of this file.

#ifndef __RTTPD_H__
#define __RTTPD_H__


#include <time.h>
#include <sys/types.h>
#ifndef WIN32
#include <netinet/in.h>
#endif


#define RTTPD_VERSION         "7.1.0"

#define RTTPD_MAJOR_VERSION   7
#define RTTPD_MINOR_VERSION   1
#define RTTPD_PATCH_VERSION   0


#ifdef WIN32
#ifndef AUTH_EXPORT
#define AUTH_EXPORT extern __declspec(dllimport)
#endif
#else
#define AUTH_EXPORT
#endif



#define MAX_OBNAME         4096


#define MAX_USERNAME       255

typedef struct _string_pair_type string_pair_t;

typedef struct _authfuncs        authfuncs_t;

typedef struct _user             user_t;

typedef struct _session          session_t;

typedef struct _object           object_t;

typedef struct _nodeinfo         nodeinfo_t;

typedef struct _logininfo        logininfo_t;

typedef struct _mapinfo          mapinfo_t;

typedef struct _checkwriteinfo   checkwriteinfo_t;


typedef void (*eventcallback_t)(void *data, short event, short code);


enum _object_type
{
   UNKNOWN_TYPE            = 200,         
   USER_TYPE               = 202,          
   DIRECTORY_TYPE          = 220,         
   PAGE_TYPE               = 221,         
   RECORD_TYPE             = 222,         
   NEWS_TYPE               = 223,         
   STORY_TYPE              = 224,         
   RECORD_TYPE2            = 225,         
   RECORD_TYPE3            = 226,         
   CHAT_TYPE               = 227,         
   CONTAINER_TYPE          = 228,         
   PERM_TYPE               = 230,
   INFO_TYPE               = 201,         
   GENERIC_TYPE            = 231,         
};

typedef enum _object_type  object_type_t;


char      *auth_filename_expand(char *format, char *buf, size_t buflen);


enum _auth_result
{
   AUTH_AGAIN = 2,
   AUTH_DELAYED = 1,
   AUTH_OK = 0,
   AUTH_DENY = -1,
   AUTH_FALSE = -2,
   AUTH_INVALID_USER = -3,
   AUTH_INVALID_PASS = -4,
   AUTH_INVALID_ADDR = -5,
   AUTH_ACCT_EXPIRED = -6,
   AUTH_USER_LC_EXCEEDED = -7,
   AUTH_SITE_LC_EXCEEDED = -8,
   AUTH_ERROR = -9,
   AUTH_USER1 = -99,
   AUTH_USER2 = -98,
   AUTH_USER3 = -97,
   AUTH_USER4 = -96,
   AUTH_USER5 = -95,
};

typedef enum _auth_perm_operation auth_perm_operation_t;


enum _auth_perm_operation
{
   AUTH_PERM_ADD = 1,      
   AUTH_PERM_DELETE = 2,   
   AUTH_PERM_UPDATE = 3,   
};

typedef struct _auth_map_type  auth_map_t;

struct _auth_map_type
{
  char*    key;
  char*    value;
};

typedef enum _http_method http_method_t;

enum _http_method
{
   M_HTTP_GET = 1,
   M_HTTP_HEAD = 2,
   M_HTTP_POST = 3,
   M_HTTP_PUT = 4,
   M_HTTP_DELETE = 5,
};


struct _authfuncs
{
   int               (*auth_new_user)(session_t *session, char *user, char *pass);

   int               (*auth_free_user)(session_t *session);

   int               (*auth_new_object)(object_t *obj, object_t *parent);

   int               (*auth_free_object)(object_t *obj);

   int               (*auth_check_read)(session_t *session, object_t *obj, char *requested_name);

   int               (*auth_check_write)(session_t *session, object_t *obj, char *requested_name);

   int               (*auth_map_object)(session_t *session, char *requested_name, char *name, char *mapped, int *len);

   int               (*auth_request_object)(session_t *session, object_t *obj);

   int               (*auth_discard_object)(session_t *session, object_t *obj);

   int               (*auth_http_request)(char *user, char *pass, http_method_t method, char *path);

   int               (*auth_check_update)(session_t *session, object_t *obj, char *data);

   int                (*auth_check_permission_update)(session_t *session, object_t *obj, char *key, int auth_map_size, auth_map_t *keyvalues);
   void              (*auth_exit)();

   int               (*auth_check_write_extended)(session_t *session, object_t *obj, char *requested_name, int field_count, string_pair_t * fields, char *contrib_id);

   void             (*auth_global_permission_update)(object_t *obj, char *key, int auth_map_size, auth_map_t *keyvalues, auth_perm_operation_t operation);
};


struct _user
  {
     char               *username;             
     char               *password;             
     int                 ref;                  
     void               *auth;                 
  };

struct _string_pair_type
{
  char*    name;
  char*    value;
};

AUTH_EXPORT int       auth_eject_sessions(user_t *user, int num);

AUTH_EXPORT int       auth_eject_sessions_by_app_id(user_t *user, int num, char *app_id);

AUTH_EXPORT int       auth_eject_sessions_by_machine_id(user_t *user, int num, char *machine_id);

AUTH_EXPORT void      auth_invalidate_sessions(user_t *user, int num, int flags);

AUTH_EXPORT void      auth_invalidate_sessions_by_name(char *name, int num, int flags);

AUTH_EXPORT void      auth_invalidate_all_sessions(int flags);

AUTH_EXPORT void      auth_invalidate_object(char *name, int flags);

AUTH_EXPORT int       signature_check(char *key_id, char *token);

AUTH_EXPORT void      auth_session_throttle(char *session_id, char *command);

AUTH_EXPORT void      auth_listener_throttle(char *session_id, char * object_name, char *command);

AUTH_EXPORT int       auth_get_user_session_count_by_name(char * object_name);

AUTH_EXPORT int       auth_eject_username_sessions(char *name, int num);

AUTH_EXPORT int       auth_eject_username_by_app_id(char *name, int num, char *app_id);

AUTH_EXPORT int       auth_eject_username_by_machine_id(char *name, int num, char *machine_id);

AUTH_EXPORT int       auth_create_object(char *name, object_type_t type);

AUTH_EXPORT void      auth_delete_object(char *name);

AUTH_EXPORT int       auth_verify_signature_username(char *expected_username, char *token);

AUTH_EXPORT int       auth_get_login_count(char *username);

AUTH_EXPORT size_t    auth_get_extra_data(char *token, char *buffer, size_t max_len);

AUTH_EXPORT char     *auth_get_token_parameter(const char *keymaster_token, const char *parameter_to_query);

AUTH_EXPORT int       auth_new_subscription(char *prefix, char *subject, void *user_context, void (*loaded)(void *, int, char *), void (*failed)(void *, int, char *), void (*status)(void *, int, char *, int));

AUTH_EXPORT void      auth_subscribe(int subscriptionId);

AUTH_EXPORT void      auth_unsubscribe(int subscriptionId);


#define SESSION_ID_LEN_MIN       6


#define SESSION_ID_LEN_DEFAULT   22


#define SESSION_ID_LEN_MAX       256


typedef struct _session_request_retry session_request_retry_t;


struct _session
{
   char                id[SESSION_ID_LEN_MAX+1]; 
   int                 uid;          
   user_t             *user;         
   void               *auth;         
   time_t              s_connected;  
   time_t              s_loggedin;   
   unsigned long       s_updates;    
   struct sockaddr_storage  addr;         
   char               *addrname;     
   char                type;         
   char               *application_id;  
   char               *machine_id;   
   char               *cookie;       
   char               *authorization; 
};

typedef struct _fieldset fieldset_t;


struct _object
{
   char               *name;   
   object_type_t       type;   
   void               *auth;   
};

enum
{
   THREADS_AUTH_LOGIN = 600,
   THREADS_AUTH_MAPPED = 601,
   THREADS_AUTH_CHECKWRITE = 602
};


struct _logininfo
{
   char                session_id[SESSION_ID_LEN_MAX+1];  
   short               msg;  
};


struct _mapinfo
{
   char                session_id[SESSION_ID_LEN_MAX+1];   
   short               msg;   
   char                name[MAX_OBNAME+1];  
   char                mapped[MAX_OBNAME+1]; 
};

struct _checkwriteinfo
{
   char                session_id[SESSION_ID_LEN_MAX+1];   
   short               msg;   
   char                name[MAX_OBNAME+1];   /* The name of the object that is being contributed to */
   char                contrib_id[5];  
};

AUTH_EXPORT char      *object_get_value(object_t *obj, int32_t fieldnum, char *buf, int len);

AUTH_EXPORT char      *object_get_value_byname(object_t *obj, char *fieldname, char *buf, int len);

AUTH_EXPORT int        infoob_add_field(const char *name, int flags);

AUTH_EXPORT object_t  *infoob_new_object(const char *name);

AUTH_EXPORT void       infoob_add_str(object_t *obj, int field, const char *value);

AUTH_EXPORT void       infoob_add_int(object_t *obj, int field, int value);

AUTH_EXPORT void       infoob_add_data(object_t *obj, const int *fields, const char **values, int count);


struct _nodeinfo
  {
     char               *nodename;   
     unsigned short      sessions;   
     unsigned short      max_sessions;  
  };


#endif /* __RTTPD_H__ */