src/afb-session.c

   1 /*
   2  * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  * Author: José Bollo <jose.bollo@iot.bzh>
   5  *
   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
   9  *
  10  *   http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #include <stdio.h>
  21 #include <time.h>
  22 #include <pthread.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <uuid/uuid.h>
  26 #include <assert.h>
  27 #include <errno.h>
  28
  29 #include <json-c/json.h>
  30
  31 #include "afb-session.h"
  32 #include "verbose.h"
  33
  34 #define COOKEYCOUNT  8
  35 #define COOKEYMASK   (COOKEYCOUNT - 1)
  36
  37 #define NOW (time(NULL))
  38
  39 struct cookie
  40 {
  41         struct cookie *next;
  42         const void *key;
  43         void *value;
  44         void (*freecb)(void*);
  45 };
  46
  47 struct afb_session
  48 {
  49         unsigned refcount;
  50         int timeout;
  51         time_t expiration;    // expiration time of the token
  52         time_t access;
  53         pthread_mutex_t mutex;
  54         char uuid[37];        // long term authentication of remote client
  55         char token[37];       // short term authentication of remote client
  56         struct cookie *cookies[COOKEYCOUNT];
  57 };
  58
  59 // Session UUID are store in a simple array [for 10 sessions this should be enough]
  60 static struct {
  61         pthread_mutex_t mutex;          // declare a mutex to protect hash table
  62         struct afb_session **store;          // sessions store
  63         int count;                      // current number of sessions
  64         int max;
  65         int timeout;
  66         char initok[37];
  67 } sessions;
  68
  69 /**
  70  * Get the index of the 'key' in the cookies array.
  71  * @param key the key to scan
  72  * @return the index of the list for key within cookies
  73  */
  74 static int cookeyidx(const void *key)
  75 {
  76         intptr_t x = (intptr_t)key;
  77         unsigned r = (unsigned)((x >> 5) ^ (x >> 15));
  78         return r & COOKEYMASK;
  79 }
  80
  81 /* generate a uuid */
  82 static void new_uuid(char uuid[37])
  83 {
  84         uuid_t newuuid;
  85         uuid_generate(newuuid);
  86         uuid_unparse_lower(newuuid, uuid);
  87 }
  88
  89 static inline void lock(struct afb_session *session)
  90 {
  91         pthread_mutex_lock(&session->mutex);
  92 }
  93
  94 static inline void unlock(struct afb_session *session)
  95 {
  96         pthread_mutex_unlock(&session->mutex);
  97 }
  98
  99 // Free context [XXXX Should be protected again memory abort XXXX]
 100 static void free_data (struct afb_session *session)
 101 {
 102         int idx;
 103         struct cookie *cookie, *next;
 104
 105         // free cookies
 106         for (idx = 0 ; idx < COOKEYCOUNT ; idx++) {
 107                 cookie = session->cookies[idx];
 108                 session->cookies[idx] = NULL;
 109                 while (cookie != NULL) {
 110                         next = cookie->next;
 111                         if (cookie->freecb != NULL)
 112                                 cookie->freecb(cookie->value);
 113                         free(cookie);
 114                         cookie = next;
 115                 }
 116         }
 117 }
 118
 119 // Create a new store in RAM, not that is too small it will be automatically extended
 120 void afb_session_init (int max_session_count, int timeout, const char *initok)
 121 {
 122         // let's create as store as hashtable does not have any
 123         sessions.store = calloc (1 + (unsigned)max_session_count, sizeof *sessions.store);
 124         pthread_mutex_init(&sessions.mutex, NULL);
 125         sessions.max = max_session_count;
 126         sessions.timeout = timeout;
 127         if (initok == NULL)
 128                 /* without token, a secret is made to forbid creation of sessions */
 129                 new_uuid(sessions.initok);
 130         else if (strlen(initok) < sizeof(sessions.store[0]->token))
 131                 strcpy(sessions.initok, initok);
 132         else {
 133                 ERROR("initial token '%s' too long (max length 36)", initok);
 134                 exit(1);
 135         }
 136 }
 137
 138 const char *afb_session_initial_token()
 139 {
 140         return sessions.initok;
 141 }
 142
 143 static struct afb_session *search (const char* uuid)
 144 {
 145         int  idx;
 146         struct afb_session *session;
 147
 148         assert (uuid != NULL);
 149
 150         pthread_mutex_lock(&sessions.mutex);
 151
 152         for (idx=0; idx < sessions.max; idx++) {
 153                 session = sessions.store[idx];
 154                 if (session && (0 == strcmp (uuid, session->uuid)))
 155                         goto found;
 156         }
 157         session = NULL;
 158
 159 found:
 160         pthread_mutex_unlock(&sessions.mutex);
 161         return session;
 162 }
 163
 164 static int destroy (struct afb_session *session)
 165 {
 166         int idx;
 167         int status;
 168
 169         assert (session != NULL);
 170
 171         pthread_mutex_lock(&sessions.mutex);
 172
 173         for (idx=0; idx < sessions.max; idx++) {
 174                 if (sessions.store[idx] == session) {
 175                         sessions.store[idx] = NULL;
 176                         sessions.count--;
 177                         status = 1;
 178                         goto deleted;
 179                 }
 180         }
 181         status = 0;
 182 deleted:
 183         pthread_mutex_unlock(&sessions.mutex);
 184         return status;
 185 }
 186
 187 static int add (struct afb_session *session)
 188 {
 189         int idx;
 190         int status;
 191
 192         assert (session != NULL);
 193
 194         pthread_mutex_lock(&sessions.mutex);
 195
 196         for (idx=0; idx < sessions.max; idx++) {
 197                 if (NULL == sessions.store[idx]) {
 198                         sessions.store[idx] = session;
 199                         sessions.count++;
 200                         status = 1;
 201                         goto added;
 202                 }
 203         }
 204         status = 0;
 205 added:
 206         pthread_mutex_unlock(&sessions.mutex);
 207         return status;
 208 }
 209
 210 // Check if context timeout or not
 211 static int is_expired (struct afb_session *ctx, time_t now)
 212 {
 213         assert (ctx != NULL);
 214         return ctx->expiration < now;
 215 }
 216
 217 // Check if context is active or not
 218 static int is_active (struct afb_session *ctx, time_t now)
 219 {
 220         assert (ctx != NULL);
 221         return ctx->uuid[0] != 0 && ctx->expiration >= now;
 222 }
 223
 224 // Loop on every entry and remove old context sessions.hash
 225 static void cleanup (time_t now)
 226 {
 227         struct afb_session *ctx;
 228         long idx;
 229
 230         // Loop on Sessions Table and remove anything that is older than timeout
 231         for (idx=0; idx < sessions.max; idx++) {
 232                 ctx = sessions.store[idx];
 233                 if (ctx != NULL && is_expired(ctx, now)) {
 234                         afb_session_close (ctx);
 235                 }
 236         }
 237 }
 238
 239 static struct afb_session *make_session (const char *uuid, int timeout, time_t now)
 240 {
 241         struct afb_session *session;
 242
 243         /* allocates a new one */
 244         session = calloc(1, sizeof *session);
 245         if (session == NULL) {
 246                 errno = ENOMEM;
 247                 goto error;
 248         }
 249         pthread_mutex_init(&session->mutex, NULL);
 250
 251         /* generate the uuid */
 252         if (uuid == NULL) {
 253                 new_uuid(session->uuid);
 254         } else {
 255                 if (strlen(uuid) >= sizeof session->uuid) {
 256                         errno = EINVAL;
 257                         goto error2;
 258                 }
 259                 strcpy(session->uuid, uuid);
 260         }
 261
 262         /* init the token */
 263         strcpy(session->token, sessions.initok);
 264         session->timeout = timeout;
 265         if (timeout != 0)
 266                 session->expiration = now + timeout;
 267         else {
 268                 session->expiration = (time_t)(~(time_t)0);
 269                 if (session->expiration < 0)
 270                         session->expiration = (time_t)(((unsigned long long)session->expiration) >> 1);
 271         }
 272         if (!add (session)) {
 273                 errno = ENOMEM;
 274                 goto error2;
 275         }
 276
 277         session->access = now;
 278         session->refcount = 1;
 279         return session;
 280
 281 error2:
 282         free(session);
 283 error:
 284         return NULL;
 285 }
 286
 287 struct afb_session *afb_session_create (const char *uuid, int timeout)
 288 {
 289         time_t now;
 290
 291         /* cleaning */
 292         now = NOW;
 293         cleanup (now);
 294
 295         /* search for an existing one not too old */
 296         if (uuid != NULL && search(uuid) != NULL) {
 297                 errno = EEXIST;
 298                 return NULL;
 299         }
 300
 301         return make_session(uuid, timeout, now);
 302 }
 303
 304 // This function will return exiting session or newly created session
 305 struct afb_session *afb_session_get (const char *uuid, int *created)
 306 {
 307         struct afb_session *session;
 308         time_t now;
 309
 310         /* cleaning */
 311         now = NOW;
 312         cleanup (now);
 313
 314         /* search for an existing one not too old */
 315         if (uuid != NULL) {
 316                 session = search(uuid);
 317                 if (!created)
 318                         return session;
 319                 if (session != NULL) {
 320                         *created = 0;
 321                         session->access = now;
 322                         session->refcount++;
 323                         return session;
 324                 }
 325         }
 326
 327         if (created)
 328                 *created = 1;
 329
 330         return make_session(uuid, sessions.timeout, now);
 331 }
 332
 333 struct afb_session *afb_session_addref(struct afb_session *session)
 334 {
 335         if (session != NULL)
 336                 __atomic_add_fetch(&session->refcount, 1, __ATOMIC_RELAXED);
 337         return session;
 338 }
 339
 340 void afb_session_unref(struct afb_session *session)
 341 {
 342         if (session != NULL) {
 343                 assert(session->refcount != 0);
 344                 if (!__atomic_sub_fetch(&session->refcount, 1, __ATOMIC_RELAXED)) {
 345                         if (session->uuid[0] == 0) {
 346                                 destroy (session);
 347                                 pthread_mutex_destroy(&session->mutex);
 348                                 free(session);
 349                         }
 350                 }
 351         }
 352 }
 353
 354 // Free Client Session Context
 355 void afb_session_close (struct afb_session *session)
 356 {
 357         assert(session != NULL);
 358         if (session->uuid[0] != 0) {
 359                 session->uuid[0] = 0;
 360                 free_data (session);
 361                 if (session->refcount == 0) {
 362                         destroy (session);
 363                         free(session);
 364                 }
 365         }
 366 }
 367
 368 // Sample Generic Ping Debug API
 369 int afb_session_check_token (struct afb_session *session, const char *token)
 370 {
 371         assert(session != NULL);
 372         assert(token != NULL);
 373
 374         // compare current token with previous one
 375         if (!is_active (session, NOW))
 376                 return 0;
 377
 378         if (session->token[0] && strcmp (token, session->token) != 0)
 379                 return 0;
 380
 381         return 1;
 382 }
 383
 384 // generate a new token and update client context
 385 void afb_session_new_token (struct afb_session *session)
 386 {
 387         assert(session != NULL);
 388
 389         // Old token was valid let's regenerate a new one
 390         new_uuid(session->token);
 391
 392         // keep track of time for session timeout and further clean up
 393         if (session->timeout != 0)
 394                 session->expiration = NOW + session->timeout;
 395 }
 396
 397 const char *afb_session_uuid (struct afb_session *session)
 398 {
 399         assert(session != NULL);
 400         return session->uuid;
 401 }
 402
 403 const char *afb_session_token (struct afb_session *session)
 404 {
 405         assert(session != NULL);
 406         return session->token;
 407 }
 408
 409 static struct cookie *cookie_search(struct afb_session *session, const void *key, int *idx)
 410 {
 411         struct cookie *cookie;
 412
 413         cookie = session->cookies[*idx = cookeyidx(key)];
 414         while(cookie != NULL && cookie->key != key)
 415                 cookie = cookie->next;
 416         return cookie;
 417 }
 418
 419 static struct cookie *cookie_add(struct afb_session *session, int idx, const void *key, void *value, void (*freecb)(void*))
 420 {
 421         struct cookie *cookie;
 422
 423         cookie = malloc(sizeof *cookie);
 424         if (!cookie)
 425                 errno = ENOMEM;
 426         else {
 427                 cookie->key = key;
 428                 cookie->value = value;
 429                 cookie->freecb = freecb;
 430                 cookie->next = session->cookies[idx];
 431                 session->cookies[idx] = cookie;
 432         }
 433         return cookie;
 434 }
 435
 436 void *afb_session_cookie(struct afb_session *session, const void *key, void *(*makecb)(void), void (*freecb)(void*))
 437 {
 438         int idx;
 439         void *value;
 440         struct cookie *cookie;
 441
 442         lock(session);
 443         cookie = cookie_search(session, key, &idx);
 444         if (cookie)
 445                 value = cookie->value;
 446         else {
 447                 value = makecb ? makecb() : NULL;
 448                 if (makecb || freecb) {
 449                         cookie = cookie_add(session, idx, key, value, freecb);
 450                         if (!cookie) {
 451                                 if (makecb && freecb)
 452                                         free(value);
 453                                 value = NULL;
 454                         }
 455                 }
 456         }
 457         unlock(session);
 458         return value;
 459 }
 460
 461 void *afb_session_get_cookie(struct afb_session *session, const void *key)
 462 {
 463         int idx;
 464         void *value;
 465         struct cookie *cookie;
 466
 467         lock(session);
 468         cookie = cookie_search(session, key, &idx);
 469         value = cookie ? cookie->value : NULL;
 470         unlock(session);
 471         return value;
 472 }
 473
 474 int afb_session_set_cookie(struct afb_session *session, const void *key, void *value, void (*freecb)(void*))
 475 {
 476         int idx;
 477         struct cookie *cookie;
 478
 479         lock(session);
 480         cookie = cookie_search(session, key, &idx);
 481         if (!cookie)
 482                 cookie = cookie_add(session, idx, key, value, freecb);
 483         else {
 484                 if (cookie->value != value && cookie->freecb)
 485                         cookie->freecb(cookie->value);
 486                 cookie->value = value;
 487                 cookie->freecb = freecb;
 488         }
 489         unlock(session);
 490         return -!cookie;
 491 }
 492