X-Git-Url: https://gerrit.automotivelinux.org/gerrit/gitweb?a=blobdiff_plain;f=src%2Fafb-session.c;h=fe5aa4afbb244445a27b50457ef09f6b3693ca1d;hb=29ae81fa15c6080fd27929f4cc78e1289cb920e9;hp=dfa383b141d4094c9ed345deff8020f8c21ba2a6;hpb=400331c1921a1e8388551b4221b8cb835c06cf21;p=src%2Fapp-framework-binder.git diff --git a/src/afb-session.c b/src/afb-session.c index dfa383b1..fe5aa4af 100644 --- a/src/afb-session.c +++ b/src/afb-session.c @@ -1,5 +1,5 @@ /* - * Copyright (C) 2015, 2016, 2017 "IoT.bzh" + * Copyright (C) 2015-2019 "IoT.bzh" * Author "Fulup Ar Foll" * Author: José Bollo * @@ -22,17 +22,17 @@ #include #include #include +#include #include -#include #include -#include - #include "afb-session.h" #include "afb-hook.h" +#include "afb-token.h" #include "verbose.h" +#include "pearson.h" +#include "uuid.h" -#define SIZEUUID 37 #define HEADCOUNT 16 #define COOKIECOUNT 8 #define COOKIEMASK (COOKIECOUNT - 1) @@ -40,78 +40,65 @@ #define _MAXEXP_ ((time_t)(~(time_t)0)) #define _MAXEXP2_ ((time_t)((((unsigned long long)_MAXEXP_) >> 1))) #define MAX_EXPIRATION (_MAXEXP_ >= 0 ? _MAXEXP_ : _MAXEXP2_) -#define NOW (time(NULL)) +#define NOW (time_now()) -/* structure for a cookie added to sessions */ +/** + * structure for a cookie added to sessions + */ struct cookie { - struct cookie *next; /* link to next cookie */ - const void *key; /* pointer key */ - void *value; /* value */ - void (*freecb)(void*); /* function to call when session is closed */ + struct cookie *next; /**< link to next cookie */ + const void *key; /**< pointer key */ + void *value; /**< value */ + void (*freecb)(void*); /**< function to call when session is closed */ }; -/* +/** * structure for session */ struct afb_session { - struct afb_session *next; /* link to the next */ - unsigned refcount; /* external reference count of the session */ - int timeout; /* timeout of the session */ - time_t expiration; /* expiration time of the token */ - pthread_mutex_t mutex; /* mutex of the session */ - struct cookie *cookies[COOKIECOUNT]; /* cookies of the session */ - uint8_t closed: 1; /* is the session closed ? */ - uint8_t autoclose: 1; /* close the session when unreferenced */ - uint8_t notinset: 1; /* session removed from the set of sessions */ - char uuid[SIZEUUID]; /* long term authentication of remote client */ - char token[SIZEUUID]; /* short term authentication of remote client */ + struct afb_session *next; /**< link to the next */ + unsigned refcount; /**< count of reference to the session */ + int timeout; /**< timeout of the session */ + time_t expiration; /**< expiration time of the token */ + pthread_mutex_t mutex; /**< mutex of the session */ + struct cookie *cookies[COOKIECOUNT]; /**< cookies of the session */ + char *lang; /**< current language setting for the session */ + uint8_t closed: 1; /**< is the session closed ? */ + uint8_t autoclose: 1; /**< close the session when unreferenced */ + uint8_t notinset: 1; /**< session removed from the set of sessions */ + uuid_stringz_t uuid; /**< long term authentication of remote client */ + struct afb_token *token;/**< short term authentication of remote client */ }; -/* Session UUID are store in a simple array [for 10 sessions this should be enough] */ +/** + * structure for managing sessions + */ static struct { - int count; /* current number of sessions */ - int max; /* maximum count of sessions */ - int timeout; /* common initial timeout */ - struct afb_session *heads[HEADCOUNT]; /* sessions */ - char initok[SIZEUUID]; /* common initial token */ - pthread_mutex_t mutex; /* declare a mutex to protect hash table */ + int count; /**< current number of sessions */ + int max; /**< maximum count of sessions */ + int timeout; /**< common initial timeout */ + struct afb_session *heads[HEADCOUNT]; /**< sessions */ + struct afb_token *initok;/**< common initial token */ + pthread_mutex_t mutex; /**< declare a mutex to protect hash table */ } sessions = { .count = 0, .max = 10, .timeout = 3600, .heads = { 0 }, - .initok = { 0 }, + .initok = 0, .mutex = PTHREAD_MUTEX_INITIALIZER }; -/* generate a new fresh 'uuid' */ -static void new_uuid(char uuid[SIZEUUID]) -{ - uuid_t newuuid; - uuid_generate(newuuid); - uuid_unparse_lower(newuuid, uuid); -} - -/* - * Returns a tiny hash value for the 'text'. - * - * Tiny hash function inspired from pearson +/** + * Get the actual raw time */ -static uint8_t pearson4(const char *text) +static inline time_t time_now() { - static uint8_t T[16] = { - 4, 1, 6, 0, 9, 14, 11, 5, - 2, 3, 12, 15, 10, 7, 8, 13 - }; - uint8_t r, c; - - for (r = 0; (c = (uint8_t)*text) ; text++) { - r = T[r ^ (15 & c)]; - r = T[r ^ (c >> 4)]; - } - return r; // % HEADCOUNT; + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC_RAW, &ts); + return ts.tv_sec; } /* lock the set of sessions for exclusive access */ @@ -146,7 +133,7 @@ static struct afb_session *sessionset_search(const char *uuid, uint8_t hashidx) static int sessionset_add(struct afb_session *session, uint8_t hashidx) { /* check availability */ - if (sessions.count >= sessions.max) { + if (sessions.max && sessions.count >= sessions.max) { errno = EBUSY; return -1; } @@ -159,12 +146,12 @@ static int sessionset_add(struct afb_session *session, uint8_t hashidx) } /* make a new uuid not used in the set of sessions */ -static uint8_t sessionset_make_uuid (char uuid[SIZEUUID]) +static uint8_t sessionset_make_uuid (uuid_stringz_t uuid) { uint8_t hashidx; do { - new_uuid(uuid); + uuid_new_stringz(uuid); hashidx = pearson4(uuid); } while(sessionset_search(uuid, hashidx)); return hashidx; @@ -193,8 +180,10 @@ static void session_close(struct afb_session *session) /* close it now */ session->closed = 1; +#if WITH_AFB_HOOK /* emit the hook */ afb_hook_session_close(session); +#endif /* release cookies */ for (idx = 0 ; idx < COOKIECOUNT ; idx++) { @@ -211,29 +200,24 @@ static void session_close(struct afb_session *session) /* destroy the 'session' */ static void session_destroy (struct afb_session *session) { +#if WITH_AFB_HOOK afb_hook_session_destroy(session); +#endif pthread_mutex_destroy(&session->mutex); + afb_token_unref(session->token); + free(session->lang); free(session); } /* update expiration of 'session' according to 'now' */ static void session_update_expiration(struct afb_session *session, time_t now) { - int timeout; time_t expiration; /* compute expiration */ - timeout = session->timeout; - if (timeout == AFB_SESSION_TIMEOUT_INFINITE) + expiration = now + afb_session_timeout(session); + if (expiration < 0) expiration = MAX_EXPIRATION; - else { - if (timeout == AFB_SESSION_TIMEOUT_DEFAULT) - expiration = now + sessions.timeout; - else - expiration = now + timeout; - if (expiration < 0) - expiration = MAX_EXPIRATION; - } /* record the expiration */ session->expiration = expiration; @@ -267,17 +251,20 @@ static struct afb_session *session_add(const char *uuid, int timeout, time_t now pthread_mutex_init(&session->mutex, NULL); session->refcount = 1; strcpy(session->uuid, uuid); - strcpy(session->token, sessions.initok); + session->token = afb_token_addref(sessions.initok); session->timeout = timeout; session_update_expiration(session, now); /* add */ if (sessionset_add(session, hashidx)) { + afb_token_unref(session->token); free(session); return NULL; } +#if WITH_AFB_HOOK afb_hook_session_create(session); +#endif return session; } @@ -321,10 +308,13 @@ static time_t sessionset_cleanup (int force) * @param max_session_count maximum allowed session count in the same time * @param timeout the initial default timeout of sessions * @param initok the initial default token of sessions - * + * */ int afb_session_init (int max_session_count, int timeout, const char *initok) { + int rc; + uuid_stringz_t uuid; + /* check parameters */ if (initok && strlen(initok) >= sizeof sessions.initok) { ERROR("initial token '%s' too long (max length %d)", @@ -338,14 +328,42 @@ int afb_session_init (int max_session_count, int timeout, const char *initok) sessionset_cleanup(1); sessions.max = max_session_count; sessions.timeout = timeout; - if (initok == NULL) - new_uuid(sessions.initok); - else - strcpy(sessions.initok, initok); + if (initok == NULL) { + uuid_new_stringz(uuid); + initok = uuid; + } + sessions.initok = 0; + if (*initok) { + rc = afb_token_get(&sessions.initok, initok); + if (rc < 0) + return rc; + } sessionset_unlock(); return 0; } +/** + * Iterate the sessions and call 'callback' with + * the 'closure' for each session. + */ +void afb_session_foreach(void (*callback)(void *closure, struct afb_session *session), void *closure) +{ + struct afb_session *session; + int idx; + + /* Loop on Sessions Table and remove anything that is older than timeout */ + sessionset_lock(); + for (idx = 0 ; idx < HEADCOUNT; idx++) { + session = sessions.heads[idx]; + while (session) { + if (!session->closed) + callback(closure, session); + session = session->next; + } + } + sessionset_unlock(); +} + /** * Cleanup the sessionset of its closed or expired sessions */ @@ -361,7 +379,7 @@ void afb_session_purge() */ const char *afb_session_initial_token() { - return sessions.initok; + return sessions.initok ? afb_token_string(sessions.initok) : ""; } /* Searchs the session of 'uuid' */ @@ -386,10 +404,34 @@ struct afb_session *afb_session_create (int timeout) return afb_session_get(NULL, timeout, NULL); } +/** + * Returns the timeout of 'session' in seconds + */ +int afb_session_timeout(struct afb_session *session) +{ + int timeout; + + /* compute timeout */ + timeout = session->timeout; + if (timeout == AFB_SESSION_TIMEOUT_DEFAULT) + timeout = sessions.timeout; + if (timeout < 0) + timeout = INT_MAX; + return timeout; +} + +/** + * Returns the second remaining before expiration of 'session' + */ +int afb_session_what_remains(struct afb_session *session) +{ + return (int)(session->expiration - NOW); +} + /* This function will return exiting session or newly created session */ struct afb_session *afb_session_get (const char *uuid, int timeout, int *created) { - char _uuid_[SIZEUUID]; + uuid_stringz_t _uuid_; uint8_t hashidx; struct afb_session *session; time_t now; @@ -428,8 +470,10 @@ end: struct afb_session *afb_session_addref(struct afb_session *session) { if (session != NULL) { - afb_hook_session_unref(session); +#if WITH_AFB_HOOK afb_hook_session_addref(session); +#endif + session_lock(session); session->refcount++; session_unlock(session); } @@ -442,8 +486,10 @@ void afb_session_unref(struct afb_session *session) if (session == NULL) return; - session_lock(session); +#if WITH_AFB_HOOK afb_hook_session_unref(session); +#endif + session_lock(session); if (!--session->refcount) { if (session->autoclose) session_close(session); @@ -467,7 +513,7 @@ void afb_session_close (struct afb_session *session) * Set the 'autoclose' flag of the 'session' * * A session whose autoclose flag is true will close as - * soon as it is no more referenced. + * soon as it is no more referenced. * * @param session the session to set * @param autoclose the value to set @@ -491,10 +537,10 @@ int afb_session_check_token (struct afb_session *session, const char *token) { int r; - session_unlock(session); + session_lock(session); r = !session->closed && session->expiration >= NOW - && !(session->token[0] && strcmp (token, session->token)); + && !(session->token && strcmp(token, afb_session_token(session))); session_unlock(session); return r; } @@ -502,10 +548,23 @@ int afb_session_check_token (struct afb_session *session, const char *token) /* generate a new token and update client context */ void afb_session_new_token (struct afb_session *session) { - session_unlock(session); - new_uuid(session->token); - session_update_expiration(session, NOW); - afb_hook_session_renew(session); + int rc; + uuid_stringz_t uuid; + struct afb_token *previous, *next; + session_lock(session); + uuid_new_stringz(uuid); + rc = afb_token_get(&next, uuid); + if (rc < 0) + ERROR("can't renew token"); + else { + previous = session->token; + session->token = next; + session_update_expiration(session, NOW); +#if WITH_AFB_HOOK + afb_hook_session_renew(session); +#endif + afb_token_unref(previous); + } session_unlock(session); } @@ -518,7 +577,7 @@ const char *afb_session_uuid (struct afb_session *session) /* Returns the token of 'session' */ const char *afb_session_token (struct afb_session *session) { - return session->token; + return afb_token_string(session->token); } /** @@ -543,7 +602,7 @@ static int cookeyidx(const void *key) * @param makecb the creation function or NULL * @param freecb the release function or NULL * @param closure an argument for makecb or the value if makecb==NULL - * @param replace a boolean enforcing replecement of the previous value + * @param replace a boolean enforcing replacement of the previous value * * @return the value of the cookie * @@ -648,11 +707,44 @@ void *afb_session_get_cookie(struct afb_session *session, const void *key) * @param value the value to store at key * @param freecb a function to use when the cookie value is to remove (or null) * - * @return the data staored for the key or NULL if the key isn't found - * + * @return 0 in case of success or -1 in case of error */ int afb_session_set_cookie(struct afb_session *session, const void *key, void *value, void (*freecb)(void*)) { return -(value != afb_session_cookie(session, key, NULL, freecb, value, 1)); } +/** + * Set the language attached to the session + * + * @param session the session to set + * @param lang the language specifiction to set to session + * + * @return 0 in case of success or -1 in case of error + */ +int afb_session_set_language(struct afb_session *session, const char *lang) +{ + char *oldl, *newl; + + newl = strdup(lang); + if (newl == NULL) + return -1; + + oldl = session->lang; + session->lang = newl; + free(oldl); + return 0; +} + +/** + * Get the language attached to the session + * + * @param session the session to query + * @param lang a default language specifiction + * + * @return the langauage specification to use for session + */ +const char *afb_session_get_language(struct afb_session *session, const char *lang) +{ + return session->lang ?: lang; +}