Liberator Auth API  7.1.32.168819-ecf4276a
rttpd.h
Go to the documentation of this file.
1 #ifndef __RTTPD_H__
2 #define __RTTPD_H__
3 
4 
5 #include <time.h>
6 #include <sys/types.h>
7 #ifndef WIN32
8 #include <netinet/in.h>
9 #endif
10 
11 
12 #define RTTPD_VERSION "7.1.32"
13 
14 #define RTTPD_MAJOR_VERSION 7
15 #define RTTPD_MINOR_VERSION 1
16 #define RTTPD_PATCH_VERSION 32
17 
18 
19 #ifdef WIN32
20 #ifndef AUTH_EXPORT
21 #define AUTH_EXPORT extern __declspec(dllimport)
22 #endif
23 #else
24 #define AUTH_EXPORT
25 #endif
26 
27 
28 
34 #define MAX_OBNAME 4096
35 
36 
38 #define MAX_USERNAME 255
39 
40 typedef struct _string_pair_type string_pair_t;
41 
42 typedef struct _authfuncs authfuncs_t;
43 
44 typedef struct _user user_t;
45 
46 typedef struct _session session_t;
47 
48 typedef struct _object object_t;
49 
50 typedef struct _nodeinfo nodeinfo_t;
51 
52 typedef struct _logininfo logininfo_t;
53 
54 typedef struct _mapinfo mapinfo_t;
55 
56 typedef struct _checkwriteinfo checkwriteinfo_t;
57 
58 
66 typedef void (*eventcallback_t)(void *data, short event, short code);
67 
68 
72 {
73  UNKNOWN_TYPE = 200,
74  USER_TYPE = 202,
76  PAGE_TYPE = 221,
77  RECORD_TYPE = 222,
78  NEWS_TYPE = 223,
79  STORY_TYPE = 224,
80  RECORD_TYPE2 = 225,
81  RECORD_TYPE3 = 226,
82  CHAT_TYPE = 227,
84  PERM_TYPE = 230,
85  INFO_TYPE = 201,
86  GENERIC_TYPE = 231,
87  JSON_TYPE = 232,
88 };
89 
90 typedef enum _object_type object_type_t;
91 
92 
112 char *auth_filename_expand(char *format, char *buf, size_t buflen);
113 
114 
120 {
121  AUTH_EJECT = 3,
122  AUTH_AGAIN = 2,
123  AUTH_DELAYED = 1,
124  AUTH_OK = 0,
125  AUTH_DENY = -1,
126  AUTH_FALSE = -2,
127  AUTH_INVALID_USER = -3,
128  AUTH_INVALID_PASS = -4,
129  AUTH_INVALID_ADDR = -5,
130  AUTH_ACCT_EXPIRED = -6,
131  AUTH_USER_LC_EXCEEDED = -7,
132  AUTH_SITE_LC_EXCEEDED = -8,
133  AUTH_ERROR = -9,
134  AUTH_USER1 = -99,
135  AUTH_USER2 = -98,
136  AUTH_USER3 = -97,
137  AUTH_USER4 = -96,
138  AUTH_USER5 = -95,
139 };
140 
141 
145 {
149 };
150 
151 typedef enum _auth_perm_operation auth_perm_operation_t;
152 
153 typedef struct _auth_map_type auth_map_t;
154 
155 struct _auth_map_type
156 {
157  char* key;
158  char* value;
159 };
160 
161 enum _http_method
162 {
163  M_HTTP_GET = 1,
164  M_HTTP_HEAD = 2,
165  M_HTTP_POST = 3,
166  M_HTTP_PUT = 4,
167  M_HTTP_DELETE = 5,
168 };
169 
170 typedef enum _http_method http_method_t;
171 
172 
178 {
179  int (*auth_new_user)(session_t *session, char *user, char *pass);
180 
194  int (*auth_free_user)(session_t *session);
195 
203  int (*auth_new_object)(object_t *obj, object_t *parent);
204 
215  int (*auth_free_object)(object_t *obj);
216 
226  int (*auth_check_read)(session_t *session, object_t *obj, char *requested_name);
227 
247  int (*auth_check_write)(session_t *session, object_t *obj, char *requested_name);
248 
269  int (*auth_map_object)(session_t *session, char *requested_name, char *name, char *mapped, int *len);
270 
290  int (*auth_request_object)(session_t *session, object_t *obj);
291 
303  int (*auth_discard_object)(session_t *session, object_t *obj);
304 
316  int (*auth_http_request)(char *user, char *pass, http_method_t method, char *path);
317 
332  int (*auth_check_update)(session_t *session, object_t *obj, char *data);
333 
349  int (*auth_check_permission_update)(session_t *session, object_t *obj, char *key, int auth_map_size, auth_map_t *keyvalues);
350  void (*auth_exit)();
351 
354  int (*auth_check_write_extended)(session_t *session, object_t *obj, char *requested_name, int field_count, string_pair_t * fields, char *contrib_id);
355 
379  void (*auth_global_permission_update)(object_t *obj, char *key, int auth_map_size, auth_map_t *keyvalues, auth_perm_operation_t operation);
380 
390 };
391 
392 
401 struct _user
402  {
403  char *username;
404  char *password;
405  int ref;
406  void *auth;
408  };
409 
410 struct _string_pair_type
411 {
412  char* name;
413  char* value;
414 };
415 
416 AUTH_EXPORT int auth_eject_sessions(user_t *user, int num);
417 
418 AUTH_EXPORT int auth_eject_sessions_by_app_id(user_t *user, int num, char *app_id);
419 
420 AUTH_EXPORT int auth_eject_sessions_by_machine_id(user_t *user, int num, char *machine_id);
421 
422 AUTH_EXPORT int auth_eject_all_sessions_by_app_id(const char *app_id);
423 
424 AUTH_EXPORT void auth_invalidate_sessions(user_t *user, int num, int flags);
425 
426 AUTH_EXPORT void auth_invalidate_sessions_by_name(char *name, int num, int flags);
427 
428 AUTH_EXPORT void auth_invalidate_all_sessions(int flags);
429 
430 AUTH_EXPORT void auth_invalidate_object(char *name, int flags);
431 
432 AUTH_EXPORT int signature_check(char *key_id, char *token);
433 
434 AUTH_EXPORT void auth_session_throttle(char *session_id, char *command);
435 
436 AUTH_EXPORT void auth_listener_throttle(char *session_id, char * object_name, char *command);
437 
438 AUTH_EXPORT int auth_get_user_session_count_by_name(char * object_name);
439 
440 AUTH_EXPORT int auth_eject_username_sessions(char *name, int num);
441 
442 AUTH_EXPORT int auth_eject_username_by_app_id(char *name, int num, char *app_id);
443 
444 AUTH_EXPORT int auth_eject_username_by_machine_id(char *name, int num, char *machine_id);
445 
446 AUTH_EXPORT int auth_create_object(char *name, object_type_t type);
447 
448 AUTH_EXPORT void auth_delete_object(char *name);
449 
450 AUTH_EXPORT int auth_verify_signature_username(char *expected_username, char *token);
451 
452 AUTH_EXPORT int auth_get_login_count(char *username);
453 
454 AUTH_EXPORT size_t auth_get_extra_data(char *token, char *buffer, size_t max_len);
455 
456 AUTH_EXPORT char *auth_get_token_parameter(const char *keymaster_token, const char *parameter_to_query);
457 
458 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));
459 
460 AUTH_EXPORT void auth_subscribe(int subscriptionId);
461 
462 AUTH_EXPORT void auth_unsubscribe(int subscriptionId);
463 
464 AUTH_EXPORT void auth_unsubscribe_free_data(int subscriptionId, void *free_context, void (*free_data_cb)(void *, void *));
465 
466 AUTH_EXPORT void auth_set_tobouser(const char *username, const char *tobouser);
467 
468 AUTH_EXPORT char *auth_get_tobouser(const char *username);
469 
470 AUTH_EXPORT void auth_reset_tobouser(const char *username);
471 
472 
474 #define SESSION_ID_LEN_MIN 6
475 
476 
478 #define SESSION_ID_LEN_DEFAULT 22
479 
480 
482 #define SESSION_ID_LEN_MAX 256
483 
484 
486 typedef struct _session_request_retry session_request_retry_t;
487 
488 
501 struct _session
502 {
503  char id[SESSION_ID_LEN_MAX+1];
504  int uid;
506  void *auth;
507  time_t s_connected;
508  time_t s_loggedin;
509  unsigned long s_updates;
510  struct sockaddr_storage addr;
511  char *addrname;
512  char type;
514  char *machine_id;
515  char *cookie;
517 };
518 
519 typedef struct _fieldset fieldset_t;
520 
521 
539 struct _object
540 {
541  char *name;
542  object_type_t type;
543  void *auth;
544 };
545 
546 enum
547 {
548  THREADS_AUTH_LOGIN = 600,
549  THREADS_AUTH_MAPPED = 601,
550  THREADS_AUTH_CHECKWRITE = 602,
551 };
552 
553 
568 {
569  char session_id[SESSION_ID_LEN_MAX+1];
570  short msg;
571 };
572 
573 
580 struct _mapinfo
581 {
582  char session_id[SESSION_ID_LEN_MAX+1];
583  short msg;
584  char name[MAX_OBNAME+1];
585  char mapped[MAX_OBNAME+1];
586 };
587 
588 struct _checkwriteinfo
589 {
590  char session_id[SESSION_ID_LEN_MAX+1];
591  short msg;
592  char name[MAX_OBNAME+1]; /* The name of the object that is being contributed to */
593  char contrib_id[5];
594 };
595 
596 AUTH_EXPORT char *object_get_value(object_t *obj, int32_t fieldnum, char *buf, int len);
597 
598 AUTH_EXPORT char *object_get_value_byname(object_t *obj, char *fieldname, char *buf, int len);
599 
600 AUTH_EXPORT int infoob_add_field(const char *name, int flags);
601 
602 AUTH_EXPORT object_t *infoob_new_object(const char *name);
603 
604 AUTH_EXPORT void infoob_add_str(object_t *obj, int field, const char *value);
605 
606 AUTH_EXPORT void infoob_add_int(object_t *obj, int field, int value);
607 
608 AUTH_EXPORT void infoob_add_data(object_t *obj, const int *fields, const char **values, int count);
609 
610 AUTH_EXPORT void infoob_add_str_generic(object_t *obj, const char *fieldname, const char *value);
611 
612 AUTH_EXPORT void infoob_add_int_generic(object_t *obj, const char *fieldname, int value);
613 
614 AUTH_EXPORT void infoob_add_data_generic(object_t *obj, const char **fieldnames, const char **values, int count);
615 
616 
622 struct _nodeinfo
623  {
624  char *nodename;
625  unsigned short sessions;
626  unsigned short max_sessions;
627  };
628 
629 
630 #endif /* __RTTPD_H__ */
AUTH_EXPORT int auth_eject_username_by_app_id(char *name, int num, char *app_id)
Wrapper for auth_eject_username_by_app_id that takes the user name instead of a _user pointer...
Definition: auth.c:2202
char * authorization
Definition: rttpd.h:516
Describes the callback functions that should be implemented by an auth module.
Definition: rttpd.h:177
AUTH_EXPORT int auth_verify_signature_username(char *expected_username, char *token)
Verify that the supplied token is for the expected username.
Definition: auth.c:6530
Definition: rttpd.h:87
Definition: rttpd.h:74
The user object.
Definition: rttpd.h:401
Definition: rttpd.h:75
Definition: rttpd.h:78
char * addrname
Definition: rttpd.h:511
Definition: rttpd.h:77
char * tobo_username
Definition: rttpd.h:407
AUTH_EXPORT void auth_invalidate_sessions(user_t *user, int num, int flags)
Invalidate all sessions for a user.
Definition: auth.c:2454
struct _session_request_retry session_request_retry_t
Structure used to hold request retry information when things are overloaded.
Definition: rttpd.h:486
AUTH_EXPORT object_t * infoob_new_object(const char *name)
Creates a new system object.
Definition: infoob.c:184
Definition: rttpd.h:85
#define MAX_OBNAME
Definition: rttpd.h:34
void(* eventcallback_t)(void *data, short event, short code)
Definition of the callback function for delayed events.
Definition: rttpd.h:66
_auth_perm_operation
Operations for the __authfuncs::auth_global_permission_update() function.
Definition: rttpd.h:144
Definition: rttpd.h:83
int uid
Definition: rttpd.h:504
_object_type
Definition of RTTP object types.
Definition: rttpd.h:71
AUTH_EXPORT void auth_listener_throttle(char *session_id, char *object_name, char *command)
Throttle an individual subscription on a user&#39;s session.
Definition: auth.c:2626
AUTH_EXPORT int auth_eject_username_sessions(char *name, int num)
Wrapper for auth_eject_sessions that takes the user name instead of a _user pointer.
Definition: auth.c:2102
short msg
Definition: rttpd.h:570
Definition: rttpd.h:148
AUTH_EXPORT void infoob_add_str(object_t *obj, int field, const char *value)
Adds a value to a system object.
Definition: infoob.c:264
AUTH_EXPORT void auth_subscribe(int subscriptionId)
Subscribes to subject.
Definition: auth.c:6689
time_t s_loggedin
Definition: rttpd.h:508
AUTH_EXPORT void auth_unsubscribe_free_data(int subscriptionId, void *free_context, void(*free_data_cb)(void *, void *))
Unsubscribes to subject and frees the user context on the thread handling auth updates.
Definition: auth.c:6757
AUTH_EXPORT char * auth_get_tobouser(const char *username)
Get the TOBO user setting.
Definition: auth.c:6250
char * cookie
Definition: rttpd.h:515
AUTH_EXPORT int signature_check(char *key_id, char *token)
Provides a mechanism for validating a KeyMaster-generated encrypted single-use token.
Definition: auth.c:1542
AUTH_EXPORT int auth_eject_all_sessions_by_app_id(const char *app_id)
Eject all logged in sessions that are using the specified application id.
Definition: auth.c:2355
AUTH_EXPORT char * object_get_value(object_t *obj, int32_t fieldnum, char *buf, int len)
The function returns the value of a specified field in an object.
Definition: object.c:4069
Definition: rttpd.h:147
AUTH_EXPORT void auth_reset_tobouser(const char *username)
Remove the tobouser for the user specified by the session.
Definition: auth.c:6276
AUTH_EXPORT void auth_invalidate_all_sessions(int flags)
Invalidate all sessions for all users in the system.
Definition: auth.c:2549
void * auth
Definition: rttpd.h:406
char * nodename
Definition: rttpd.h:624
char * password
Definition: rttpd.h:404
AUTH_EXPORT void infoob_add_data(object_t *obj, const int *fields, const char **values, int count)
Adds an array of values to a system object.
Definition: infoob.c:311
AUTH_EXPORT void infoob_add_int_generic(object_t *obj, const char *fieldname, int value)
Adds a numerical value to a system object.
Definition: infoob.c:360
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))
Creates a subscription for use with auth_subscribe and auth_unsubscribe.
Definition: auth.c:6668
AUTH_EXPORT void auth_invalidate_sessions_by_name(char *name, int num, int flags)
Invalidate all sessions for a username.
Definition: auth.c:2490
AUTH_EXPORT void infoob_add_data_generic(object_t *obj, const char **fieldnames, const char **values, int count)
Adds an array of values to a system object.
Definition: infoob.c:383
AUTH_EXPORT int infoob_add_field(const char *name, int flags)
Creates a new field for updating system objects.
Definition: infoob.c:160
Definition: rttpd.h:80
char * name
Definition: rttpd.h:541
Definition: rttpd.h:73
unsigned short sessions
Definition: rttpd.h:625
time_t s_connected
Definition: rttpd.h:507
user_t * user
Definition: rttpd.h:505
AUTH_EXPORT int auth_create_object(char *name, object_type_t type)
Create an object within the Liberator.
Definition: auth.c:6384
int ref
Definition: rttpd.h:405
Definition: rttpd.h:86
object_type_t type
Definition: rttpd.h:542
The RTTP Session Object.
Definition: rttpd.h:501
char * application_id
Definition: rttpd.h:513
Definition: rttpd.h:146
unsigned long s_updates
Definition: rttpd.h:509
unsigned short max_sessions
Definition: rttpd.h:626
short msg
Definition: rttpd.h:583
Definition: rttpd.h:76
AUTH_EXPORT int auth_eject_sessions_by_app_id(user_t *user, int num, char *app_id)
Eject sessions with matching application id.
Definition: auth.c:2246
Callback that is called when an object changes initial state.
Definition: rttpd.h:539
AUTH_EXPORT int auth_get_login_count(char *username)
Get the number of current logins for a username.
Definition: auth.c:6556
AUTH_EXPORT void auth_invalidate_object(char *name, int flags)
Invalidate an object.
Definition: auth.c:2522
_auth_result
Return codes for the authentication functions.
Definition: rttpd.h:119
void * auth
Definition: rttpd.h:506
AUTH_EXPORT int auth_get_user_session_count_by_name(char *object_name)
Return the number of active sessions.
Definition: auth.c:6329
AUTH_EXPORT size_t auth_get_extra_data(char *token, char *buffer, size_t max_len)
Gets the extra data from the token. The extra data is expected to be the 4th part of the ~ separated ...
Definition: auth.c:6591
AUTH_EXPORT void auth_delete_object(char *name)
Delete an object within the Liberator.
Definition: auth.c:6412
AUTH_EXPORT void auth_unsubscribe(int subscriptionId)
Unsubscribes to subject.
Definition: auth.c:6732
char * username
Definition: rttpd.h:403
Definition: rttpd.h:82
AUTH_EXPORT void auth_set_tobouser(const char *username, const char *tobouser)
Set the tobo user for the specified user.
Definition: auth.c:6220
char * machine_id
Definition: rttpd.h:514
The map information object.
Definition: rttpd.h:580
AUTH_EXPORT char * auth_get_token_parameter(const char *keymaster_token, const char *parameter_to_query)
Return a value for the given field within a keymaster token.
Definition: auth.c:6186
The RTTP node object.
Definition: rttpd.h:622
AUTH_EXPORT void infoob_add_int(object_t *obj, int field, int value)
Adds a numerical value to a system object.
Definition: infoob.c:287
AUTH_EXPORT int auth_eject_sessions(user_t *user, int num)
Eject sessions.
Definition: auth.c:2145
AUTH_EXPORT int auth_eject_username_by_machine_id(char *name, int num, char *machine_id)
Wrapper for auth_eject_sessions_by_machine_id that takes the user name instead of a _user pointer...
Definition: auth.c:2340
char * auth_filename_expand(char *format, char *buf, size_t buflen)
Expand a filename pattern into a fully qualified filename.
Definition: auth.c:6370
Definition: rttpd.h:79
AUTH_EXPORT void infoob_add_str_generic(object_t *obj, const char *fieldname, const char *value)
Adds a value to a system object.
Definition: infoob.c:338
AUTH_EXPORT int auth_eject_sessions_by_machine_id(user_t *user, int num, char *machine_id)
Eject sessions based on the username by machine id.
Definition: auth.c:2395
Structure passed between invalidation routines.
Definition: rttpd.h:567
char type
Definition: rttpd.h:512
Definition: rttpd.h:81
#define SESSION_ID_LEN_MAX
Definition: rttpd.h:482
void * auth
Definition: rttpd.h:543
AUTH_EXPORT void auth_session_throttle(char *session_id, char *command)
Throttle a users&#39; session.
Definition: auth.c:2578

Generated on Wed Oct 18 2023 17:52:17 for Liberator Auth API