2 * Copyright (C) 2015-2019 "IoT.bzh"
3 * Author "Fulup Ar Foll"
4 * Author: José Bollo <jose.bollo@iot.bzh>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
29 #include "afb-session.h"
37 #define COOKIEMASK (COOKIECOUNT - 1)
39 #define _MAXEXP_ ((time_t)(~(time_t)0))
40 #define _MAXEXP2_ ((time_t)((((unsigned long long)_MAXEXP_) >> 1)))
41 #define MAX_EXPIRATION (_MAXEXP_ >= 0 ? _MAXEXP_ : _MAXEXP2_)
42 #define NOW (time_now())
45 * structure for a cookie added to sessions
49 struct cookie *next; /**< link to next cookie */
50 const void *key; /**< pointer key */
51 void *value; /**< value */
52 void (*freecb)(void*); /**< function to call when session is closed */
56 * structure for session
60 struct afb_session *next; /**< link to the next */
61 unsigned refcount; /**< count of reference to the session */
62 int timeout; /**< timeout of the session */
63 time_t expiration; /**< expiration time of the token */
64 pthread_mutex_t mutex; /**< mutex of the session */
65 struct cookie *cookies[COOKIECOUNT]; /**< cookies of the session */
66 char *lang; /**< current language setting for the session */
67 uint8_t closed: 1; /**< is the session closed ? */
68 uint8_t autoclose: 1; /**< close the session when unreferenced */
69 uint8_t notinset: 1; /**< session removed from the set of sessions */
70 uuid_stringz_t uuid; /**< long term authentication of remote client */
71 uuid_stringz_t token; /**< short term authentication of remote client */
75 * structure for managing sessions
78 int count; /**< current number of sessions */
79 int max; /**< maximum count of sessions */
80 int timeout; /**< common initial timeout */
81 struct afb_session *heads[HEADCOUNT]; /**< sessions */
82 uuid_stringz_t initok; /**< common initial token */
83 pthread_mutex_t mutex; /**< declare a mutex to protect hash table */
90 .mutex = PTHREAD_MUTEX_INITIALIZER
94 * Get the actual raw time
96 static inline time_t time_now()
99 clock_gettime(CLOCK_MONOTONIC_RAW, &ts);
103 /* lock the set of sessions for exclusive access */
104 static inline void sessionset_lock()
106 pthread_mutex_lock(&sessions.mutex);
109 /* unlock the set of sessions of exclusive access */
110 static inline void sessionset_unlock()
112 pthread_mutex_unlock(&sessions.mutex);
116 * search within the set of sessions the session of 'uuid'.
117 * 'hashidx' is the precomputed hash for 'uuid'
118 * return the session or NULL
120 static struct afb_session *sessionset_search(const char *uuid, uint8_t hashidx)
122 struct afb_session *session;
124 session = sessions.heads[hashidx];
125 while (session && strcmp(uuid, session->uuid))
126 session = session->next;
131 /* add 'session' to the set of sessions */
132 static int sessionset_add(struct afb_session *session, uint8_t hashidx)
134 /* check availability */
135 if (sessions.max && sessions.count >= sessions.max) {
140 /* add the session */
141 session->next = sessions.heads[hashidx];
142 sessions.heads[hashidx] = session;
147 /* make a new uuid not used in the set of sessions */
148 static uint8_t sessionset_make_uuid (uuid_stringz_t uuid)
153 uuid_new_stringz(uuid);
154 hashidx = pearson4(uuid);
155 } while(sessionset_search(uuid, hashidx));
159 /* lock the 'session' for exclusive access */
160 static inline void session_lock(struct afb_session *session)
162 pthread_mutex_lock(&session->mutex);
165 /* unlock the 'session' of exclusive access */
166 static inline void session_unlock(struct afb_session *session)
168 pthread_mutex_unlock(&session->mutex);
171 /* close the 'session' */
172 static void session_close(struct afb_session *session)
175 struct cookie *cookie;
177 /* close only one time */
178 if (!session->closed) {
184 afb_hook_session_close(session);
187 /* release cookies */
188 for (idx = 0 ; idx < COOKIECOUNT ; idx++) {
189 while ((cookie = session->cookies[idx])) {
190 session->cookies[idx] = cookie->next;
191 if (cookie->freecb != NULL)
192 cookie->freecb(cookie->value);
199 /* destroy the 'session' */
200 static void session_destroy (struct afb_session *session)
203 afb_hook_session_destroy(session);
205 pthread_mutex_destroy(&session->mutex);
210 /* update expiration of 'session' according to 'now' */
211 static void session_update_expiration(struct afb_session *session, time_t now)
215 /* compute expiration */
216 expiration = now + afb_session_timeout(session);
218 expiration = MAX_EXPIRATION;
220 /* record the expiration */
221 session->expiration = expiration;
225 * Add a new session with the 'uuid' (of 'hashidx')
226 * and the 'timeout' starting from 'now'.
227 * Add it to the set of sessions
228 * Return the created session
230 static struct afb_session *session_add(const char *uuid, int timeout, time_t now, uint8_t hashidx)
232 struct afb_session *session;
234 /* check arguments */
235 if (!AFB_SESSION_TIMEOUT_IS_VALID(timeout)
236 || (uuid && strlen(uuid) >= sizeof session->uuid)) {
241 /* allocates a new one */
242 session = calloc(1, sizeof *session);
243 if (session == NULL) {
249 pthread_mutex_init(&session->mutex, NULL);
250 session->refcount = 1;
251 strcpy(session->uuid, uuid);
252 strcpy(session->token, sessions.initok);
253 session->timeout = timeout;
254 session_update_expiration(session, now);
257 if (sessionset_add(session, hashidx)) {
263 afb_hook_session_create(session);
269 /* Remove expired sessions and return current time (now) */
270 static time_t sessionset_cleanup (int force)
272 struct afb_session *session, **prv;
276 /* Loop on Sessions Table and remove anything that is older than timeout */
278 for (idx = 0 ; idx < HEADCOUNT; idx++) {
279 prv = &sessions.heads[idx];
280 while ((session = *prv)) {
281 session_lock(session);
282 if (force || session->expiration < now)
283 session_close(session);
284 if (!session->closed)
285 prv = &session->next;
287 *prv = session->next;
289 session->notinset = 1;
290 if ( !session->refcount) {
291 session_destroy(session);
295 session_unlock(session);
302 * Initialize the session manager with a 'max_session_count',
303 * an initial common 'timeout' and an initial common token 'initok'.
305 * @param max_session_count maximum allowed session count in the same time
306 * @param timeout the initial default timeout of sessions
307 * @param initok the initial default token of sessions
310 int afb_session_init (int max_session_count, int timeout, const char *initok)
312 /* check parameters */
313 if (initok && strlen(initok) >= sizeof sessions.initok) {
314 ERROR("initial token '%s' too long (max length %d)",
315 initok, ((int)(sizeof sessions.initok)) - 1);
320 /* init the sessionset (after cleanup) */
322 sessionset_cleanup(1);
323 sessions.max = max_session_count;
324 sessions.timeout = timeout;
326 uuid_new_stringz(sessions.initok);
328 strcpy(sessions.initok, initok);
334 * Iterate the sessions and call 'callback' with
335 * the 'closure' for each session.
337 void afb_session_foreach(void (*callback)(void *closure, struct afb_session *session), void *closure)
339 struct afb_session *session;
342 /* Loop on Sessions Table and remove anything that is older than timeout */
344 for (idx = 0 ; idx < HEADCOUNT; idx++) {
345 session = sessions.heads[idx];
347 if (!session->closed)
348 callback(closure, session);
349 session = session->next;
356 * Cleanup the sessionset of its closed or expired sessions
358 void afb_session_purge()
361 sessionset_cleanup(0);
366 * @return the initial token set at initialization
368 const char *afb_session_initial_token()
370 return sessions.initok;
373 /* Searchs the session of 'uuid' */
374 struct afb_session *afb_session_search (const char *uuid)
376 struct afb_session *session;
379 sessionset_cleanup(0);
380 session = sessionset_search(uuid, pearson4(uuid));
381 session = afb_session_addref(session);
388 * Creates a new session with 'timeout'
390 struct afb_session *afb_session_create (int timeout)
392 return afb_session_get(NULL, timeout, NULL);
396 * Returns the timeout of 'session' in seconds
398 int afb_session_timeout(struct afb_session *session)
402 /* compute timeout */
403 timeout = session->timeout;
404 if (timeout == AFB_SESSION_TIMEOUT_DEFAULT)
405 timeout = sessions.timeout;
412 * Returns the second remaining before expiration of 'session'
414 int afb_session_what_remains(struct afb_session *session)
416 return (int)(session->expiration - NOW);
419 /* This function will return exiting session or newly created session */
420 struct afb_session *afb_session_get (const char *uuid, int timeout, int *created)
422 uuid_stringz_t _uuid_;
424 struct afb_session *session;
430 now = sessionset_cleanup(0);
432 /* search for an existing one not too old */
434 hashidx = sessionset_make_uuid(_uuid_);
437 hashidx = pearson4(uuid);
438 session = sessionset_search(uuid, hashidx);
441 afb_session_addref(session);
446 /* create the session */
447 session = session_add(uuid, timeout, now, hashidx);
457 /* increase the use count on 'session' (can be NULL) */
458 struct afb_session *afb_session_addref(struct afb_session *session)
460 if (session != NULL) {
462 afb_hook_session_addref(session);
464 session_lock(session);
466 session_unlock(session);
471 /* decrease the use count of 'session' (can be NULL) */
472 void afb_session_unref(struct afb_session *session)
478 afb_hook_session_unref(session);
480 session_lock(session);
481 if (!--session->refcount) {
482 if (session->autoclose)
483 session_close(session);
484 if (session->notinset) {
485 session_destroy(session);
489 session_unlock(session);
492 /* close 'session' */
493 void afb_session_close (struct afb_session *session)
495 session_lock(session);
496 session_close(session);
497 session_unlock(session);
501 * Set the 'autoclose' flag of the 'session'
503 * A session whose autoclose flag is true will close as
504 * soon as it is no more referenced.
506 * @param session the session to set
507 * @param autoclose the value to set
509 void afb_session_set_autoclose(struct afb_session *session, int autoclose)
511 session->autoclose = !!autoclose;
514 /* is 'session' closed? */
515 int afb_session_is_closed (struct afb_session *session)
517 return session->closed;
521 * check whether the token of 'session' is 'token'
522 * return 1 if true or 0 otherwise
524 int afb_session_check_token (struct afb_session *session, const char *token)
528 session_lock(session);
530 && session->expiration >= NOW
531 && !(session->token[0] && strcmp (token, session->token));
532 session_unlock(session);
536 /* generate a new token and update client context */
537 void afb_session_new_token (struct afb_session *session)
539 session_lock(session);
540 uuid_new_stringz(session->token);
541 session_update_expiration(session, NOW);
543 afb_hook_session_renew(session);
545 session_unlock(session);
548 /* Returns the uuid of 'session' */
549 const char *afb_session_uuid (struct afb_session *session)
551 return session->uuid;
554 /* Returns the token of 'session' */
555 const char *afb_session_token (struct afb_session *session)
557 return session->token;
561 * Get the index of the 'key' in the cookies array.
562 * @param key the key to scan
563 * @return the index of the list for key within cookies
565 static int cookeyidx(const void *key)
567 intptr_t x = (intptr_t)key;
568 unsigned r = (unsigned)((x >> 5) ^ (x >> 15));
569 return r & COOKIEMASK;
573 * Set, get, replace, remove a cookie of 'key' for the 'session'
575 * The behaviour of this function depends on its parameters:
577 * @param session the session
578 * @param key the key of the cookie
579 * @param makecb the creation function or NULL
580 * @param freecb the release function or NULL
581 * @param closure an argument for makecb or the value if makecb==NULL
582 * @param replace a boolean enforcing replacement of the previous value
584 * @return the value of the cookie
586 * The 'key' is a pointer and compared as pointers.
588 * For getting the current value of the cookie:
590 * afb_session_cookie(session, key, NULL, NULL, NULL, 0)
592 * For storing the value of the cookie
594 * afb_session_cookie(session, key, NULL, NULL, value, 1)
596 void *afb_session_cookie(struct afb_session *session, const void *key, void *(*makecb)(void *closure), void (*freecb)(void *item), void *closure, int replace)
600 struct cookie *cookie, **prv;
602 /* get key hashed index */
603 idx = cookeyidx(key);
605 /* lock session and search for the cookie of 'key' */
606 session_lock(session);
607 prv = &session->cookies[idx];
611 /* 'key' not found, create value using 'closure' and 'makecb' */
612 value = makecb ? makecb(closure) : closure;
613 /* store the the only if it has some meaning */
614 if (replace || makecb || freecb) {
615 cookie = malloc(sizeof *cookie);
618 /* calling freecb if there is no makecb may have issue */
619 if (makecb && freecb)
624 cookie->value = value;
625 cookie->freecb = freecb;
631 } else if (cookie->key == key) {
632 /* cookie of key found */
634 /* not replacing, get the value */
635 value = cookie->value;
637 /* create value using 'closure' and 'makecb' */
638 value = makecb ? makecb(closure) : closure;
640 /* free previous value is needed */
641 if (cookie->value != value && cookie->freecb)
642 cookie->freecb(cookie->value);
644 /* if both value and freecb are NULL drop the cookie */
645 if (!value && !freecb) {
649 /* store the value and its releaser */
650 cookie->value = value;
651 cookie->freecb = freecb;
656 prv = &(cookie->next);
660 /* unlock the session and return the value */
661 session_unlock(session);
666 * Get the cookie of 'key' in the 'session'.
668 * @param session the session to search in
669 * @param key the key of the data to retrieve
671 * @return the data staored for the key or NULL if the key isn't found
673 void *afb_session_get_cookie(struct afb_session *session, const void *key)
675 return afb_session_cookie(session, key, NULL, NULL, NULL, 0);
679 * Set the cookie of 'key' in the 'session' to the 'value' that can be
680 * cleaned using 'freecb' (if not null).
682 * @param session the session to set
683 * @param key the key of the data to store
684 * @param value the value to store at key
685 * @param freecb a function to use when the cookie value is to remove (or null)
687 * @return 0 in case of success or -1 in case of error
689 int afb_session_set_cookie(struct afb_session *session, const void *key, void *value, void (*freecb)(void*))
691 return -(value != afb_session_cookie(session, key, NULL, freecb, value, 1));
695 * Set the language attached to the session
697 * @param session the session to set
698 * @param lang the language specifiction to set to session
700 * @return 0 in case of success or -1 in case of error
702 int afb_session_set_language(struct afb_session *session, const char *lang)
710 oldl = session->lang;
711 session->lang = newl;
717 * Get the language attached to the session
719 * @param session the session to query
720 * @param lang a default language specifiction
722 * @return the langauage specification to use for session
724 const char *afb_session_get_language(struct afb_session *session, const char *lang)
726 return session->lang ?: lang;