src/reclaim/oidc_helper.c

   1 /*
   2       This file is part of GNUnet
   3       Copyright (C) 2010-2015 GNUnet e.V.
   4
   5       GNUnet is free software: you can redistribute it and/or modify it
   6       under the terms of the GNU Affero General Public License as published
   7       by the Free Software Foundation, either version 3 of the License,
   8       or (at your option) any later version.
   9
  10       GNUnet is distributed in the hope that it will be useful, but
  11       WITHOUT ANY WARRANTY; without even the implied warranty of
  12       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13       Affero General Public License for more details.
  14
  15       You should have received a copy of the GNU Affero General Public License
  16       along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17
  18      SPDX-License-Identifier: AGPL3.0-or-later
  19  */
  20
  21 /**
  22  * @file reclaim/oidc_helper.c
  23  * @brief helper library for OIDC related functions
  24  * @author Martin Schanzenbach
  25  */
  26 #include "platform.h"
  27 #include <inttypes.h>
  28 #include <jansson.h>
  29
  30 #include "gnunet_util_lib.h"
  31
  32 #include "gnunet_reclaim_attribute_lib.h"
  33 #include "gnunet_reclaim_service.h"
  34 #include "gnunet_signatures.h"
  35 #include "oidc_helper.h"
  36 static char *
  37 create_jwt_header (void)
  38 {
  39   json_t *root;
  40   char *json_str;
  41
  42   root = json_object ();
  43   json_object_set_new (root, JWT_ALG, json_string (JWT_ALG_VALUE));
  44   json_object_set_new (root, JWT_TYP, json_string (JWT_TYP_VALUE));
  45
  46   json_str = json_dumps (root, JSON_INDENT (0) | JSON_COMPACT);
  47   json_decref (root);
  48   return json_str;
  49 }
  50
  51 static void
  52 replace_char (char *str, char find, char replace)
  53 {
  54   char *current_pos = strchr (str, find);
  55   while (current_pos)
  56   {
  57     *current_pos = replace;
  58     current_pos = strchr (current_pos, find);
  59   }
  60 }
  61
  62 // RFC4648
  63 static void
  64 fix_base64 (char *str)
  65 {
  66   // Replace + with -
  67   replace_char (str, '+', '-');
  68
  69   // Replace / with _
  70   replace_char (str, '/', '_');
  71 }
  72
  73 /**
  74  * Create a JWT from attributes
  75  *
  76  * @param aud_key the public of the audience
  77  * @param sub_key the public key of the subject
  78  * @param attrs the attribute list
  79  * @param expiration_time the validity of the token
  80  * @param secret_key the key used to sign the JWT
  81  * @return a new base64-encoded JWT string.
  82  */
  83 char *
  84 OIDC_id_token_new (const struct GNUNET_CRYPTO_EcdsaPublicKey *aud_key,
  85                    const struct GNUNET_CRYPTO_EcdsaPublicKey *sub_key,
  86                    const struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *attrs,
  87                    const struct GNUNET_TIME_Relative *expiration_time,
  88                    const char *nonce,
  89                    const char *secret_key)
  90 {
  91   struct GNUNET_RECLAIM_ATTRIBUTE_ClaimListEntry *le;
  92   struct GNUNET_HashCode signature;
  93   struct GNUNET_TIME_Absolute exp_time;
  94   struct GNUNET_TIME_Absolute time_now;
  95   char *audience;
  96   char *subject;
  97   char *header;
  98   char *body_str;
  99   char *result;
 100   char *header_base64;
 101   char *body_base64;
 102   char *signature_target;
 103   char *signature_base64;
 104   char *attr_val_str;
 105   json_t *body;
 106
 107   // iat REQUIRED time now
 108   time_now = GNUNET_TIME_absolute_get ();
 109   // exp REQUIRED time expired from config
 110   exp_time = GNUNET_TIME_absolute_add (time_now, *expiration_time);
 111   // auth_time only if max_age
 112   // nonce only if nonce
 113   // OPTIONAL acr,amr,azp
 114   subject = GNUNET_STRINGS_data_to_string_alloc (
 115     sub_key,
 116     sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey));
 117   audience = GNUNET_STRINGS_data_to_string_alloc (
 118     aud_key,
 119     sizeof (struct GNUNET_CRYPTO_EcdsaPublicKey));
 120   header = create_jwt_header ();
 121   body = json_object ();
 122
 123   // iss REQUIRED case sensitive server uri with https
 124   // The issuer is the local reclaim instance (e.g.
 125   // https://reclaim.id/api/openid)
 126   json_object_set_new (body, "iss", json_string (SERVER_ADDRESS));
 127   // sub REQUIRED public key identity, not exceed 255 ASCII  length
 128   json_object_set_new (body, "sub", json_string (subject));
 129   // aud REQUIRED public key client_id must be there
 130   json_object_set_new (body, "aud", json_string (audience));
 131   // iat
 132   json_object_set_new (body,
 133                        "iat",
 134                        json_integer (time_now.abs_value_us / (1000 * 1000)));
 135   // exp
 136   json_object_set_new (body,
 137                        "exp",
 138                        json_integer (exp_time.abs_value_us / (1000 * 1000)));
 139   // nbf
 140   json_object_set_new (body,
 141                        "nbf",
 142                        json_integer (time_now.abs_value_us / (1000 * 1000)));
 143   // nonce
 144   if (NULL != nonce)
 145     json_object_set_new (body, "nonce", json_string (nonce));
 146
 147   for (le = attrs->list_head; NULL != le; le = le->next)
 148   {
 149     attr_val_str =
 150       GNUNET_RECLAIM_ATTRIBUTE_value_to_string (le->claim->type,
 151                                                 le->claim->data,
 152                                                 le->claim->data_size);
 153     json_object_set_new (body, le->claim->name, json_string (attr_val_str));
 154     GNUNET_free (attr_val_str);
 155   }
 156   body_str = json_dumps (body, JSON_INDENT (0) | JSON_COMPACT);
 157   json_decref (body);
 158
 159   GNUNET_STRINGS_base64_encode (header, strlen (header), &header_base64);
 160   fix_base64 (header_base64);
 161
 162   GNUNET_STRINGS_base64_encode (body_str, strlen (body_str), &body_base64);
 163   fix_base64 (body_base64);
 164
 165   GNUNET_free (subject);
 166   GNUNET_free (audience);
 167
 168   /**
 169    * Creating the JWT signature. This might not be
 170    * standards compliant, check.
 171    */
 172   GNUNET_asprintf (&signature_target, "%s.%s", header_base64, body_base64);
 173   GNUNET_CRYPTO_hmac_raw (secret_key,
 174                           strlen (secret_key),
 175                           signature_target,
 176                           strlen (signature_target),
 177                           &signature);
 178   GNUNET_STRINGS_base64_encode ((const char *) &signature,
 179                                 sizeof (struct GNUNET_HashCode),
 180                                 &signature_base64);
 181   fix_base64 (signature_base64);
 182
 183   GNUNET_asprintf (&result,
 184                    "%s.%s.%s",
 185                    header_base64,
 186                    body_base64,
 187                    signature_base64);
 188
 189   GNUNET_free (signature_target);
 190   GNUNET_free (header);
 191   GNUNET_free (body_str);
 192   GNUNET_free (signature_base64);
 193   GNUNET_free (body_base64);
 194   GNUNET_free (header_base64);
 195   return result;
 196 }
 197
 198 /* Converts a hex character to its integer value */
 199 static char
 200 from_hex (char ch)
 201 {
 202   return isdigit (ch) ? ch - '0' : tolower (ch) - 'a' + 10;
 203 }
 204
 205 /* Converts an integer value to its hex character*/
 206 static char
 207 to_hex (char code)
 208 {
 209   static char hex[] = "0123456789abcdef";
 210   return hex[code & 15];
 211 }
 212
 213 /* Returns a url-encoded version of str */
 214 /* IMPORTANT: be sure to free() the returned string after use */
 215 static char *
 216 url_encode (const char *str)
 217 {
 218   char *pstr = (char *) str;
 219   char *buf = GNUNET_malloc (strlen (str) * 3 + 1);
 220   char *pbuf = buf;
 221   while (*pstr)
 222   {
 223     if (isalnum (*pstr) || *pstr == '-' || *pstr == '_' || *pstr == '.' ||
 224         *pstr == '~')
 225       *pbuf++ = *pstr;
 226     else if (*pstr == ' ')
 227       *pbuf++ = '+';
 228     else
 229     {
 230       *pbuf++ = '%';
 231       *pbuf++ = to_hex (*pstr >> 4);
 232       *pbuf++ = to_hex (*pstr & 15);
 233     }
 234     pstr++;
 235   }
 236   *pbuf = '\0';
 237   return buf;
 238 }
 239
 240
 241 /* Returns a url-decoded version of str */
 242 /* IMPORTANT: be sure to free() the returned string after use */
 243 static char *
 244 url_decode (const char *str)
 245 {
 246   char *pstr = (char *) str;
 247   char *buf = GNUNET_malloc (strlen (str) + 1);
 248   char *pbuf = buf;
 249   while (*pstr)
 250   {
 251     if (*pstr == '%')
 252     {
 253       if (pstr[1] && pstr[2])
 254       {
 255         *pbuf++ = from_hex (pstr[1]) << 4 | from_hex (pstr[2]);
 256         pstr += 2;
 257       }
 258     }
 259     else if (*pstr == '+')
 260     {
 261       *pbuf++ = ' ';
 262     }
 263     else
 264     {
 265       *pbuf++ = *pstr;
 266     }
 267     pstr++;
 268   }
 269   *pbuf = '\0';
 270   return buf;
 271 }
 272
 273
 274 /**
 275  * Returns base64 encoded string urlencoded
 276  *
 277  * @param string the string to encode
 278  * @return base64 encoded string
 279  */
 280 static char *
 281 base64_encode (const char *data, size_t data_size)
 282 {
 283   char *enc;
 284   char *enc_urlencode;
 285
 286   GNUNET_STRINGS_base64_encode (data, data_size, &enc);
 287   enc_urlencode = url_encode (enc);
 288   GNUNET_free (enc);
 289   return enc_urlencode;
 290 }
 291
 292
 293 /**
 294  * Builds an OIDC authorization code including
 295  * a reclaim ticket and nonce
 296  *
 297  * @param issuer the issuer of the ticket, used to sign the ticket and nonce
 298  * @param ticket the ticket to include in the code
 299  * @param attrs list of attributes whicha re shared
 300  * @param nonce the nonce to include in the code
 301  * @return a new authorization code (caller must free)
 302  */
 303 char *
 304 OIDC_build_authz_code (const struct GNUNET_CRYPTO_EcdsaPrivateKey *issuer,
 305                        const struct GNUNET_RECLAIM_Ticket *ticket,
 306                        struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *attrs,
 307                        const char *nonce_str)
 308 {
 309   char *code_payload;
 310   char *attrs_ser;
 311   char *code_str;
 312   char *buf_ptr;
 313   size_t signature_payload_len;
 314   size_t attr_list_len;
 315   size_t code_payload_len;
 316   unsigned int nonce;
 317   unsigned int nonce_tmp;
 318   struct GNUNET_CRYPTO_EcdsaSignature signature;
 319   struct GNUNET_CRYPTO_EccSignaturePurpose *purpose;
 320
 321   attrs_ser = NULL;
 322   signature_payload_len =
 323     sizeof (struct GNUNET_RECLAIM_Ticket) + sizeof (unsigned int);
 324   if (NULL != attrs)
 325   {
 326     attr_list_len = GNUNET_RECLAIM_ATTRIBUTE_list_serialize_get_size (attrs);
 327     signature_payload_len += attr_list_len;
 328     attrs_ser = GNUNET_malloc (attr_list_len);
 329     GNUNET_RECLAIM_ATTRIBUTE_list_serialize (attrs, attrs_ser);
 330   }
 331   code_payload_len = sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
 332                      signature_payload_len + sizeof (signature);
 333   code_payload = GNUNET_malloc (code_payload_len);
 334   purpose = (struct GNUNET_CRYPTO_EccSignaturePurpose *) code_payload;
 335   purpose->size = htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
 336                          signature_payload_len);
 337   purpose->purpose = htonl (GNUNET_SIGNATURE_PURPOSE_RECLAIM_CODE_SIGN);
 338   // First, copy ticket
 339   buf_ptr = (char *) &purpose[1];
 340   memcpy (buf_ptr, ticket, sizeof (struct GNUNET_RECLAIM_Ticket));
 341   buf_ptr += sizeof (struct GNUNET_RECLAIM_Ticket);
 342   // Then copy nonce
 343   nonce = 0;
 344   if (NULL != nonce_str)
 345   {
 346     if ((1 != SSCANF (nonce_str, "%u", &nonce)) || (nonce > UINT16_MAX))
 347     {
 348       GNUNET_break (0);
 349       GNUNET_free (code_payload);
 350       GNUNET_free_non_null (attrs_ser);
 351       return NULL;
 352     }
 353   }
 354   nonce_tmp = htons (nonce);
 355   memcpy (buf_ptr, &nonce_tmp, sizeof (unsigned int));
 356   buf_ptr += sizeof (unsigned int);
 357   // Finally, attributes
 358   if (NULL != attrs_ser)
 359   {
 360     memcpy (buf_ptr, attrs_ser, attr_list_len);
 361     buf_ptr += attr_list_len;
 362   }
 363   if (GNUNET_SYSERR == GNUNET_CRYPTO_ecdsa_sign (issuer, purpose, &signature))
 364   {
 365     GNUNET_break (0);
 366     GNUNET_free (code_payload);
 367     GNUNET_free_non_null (attrs_ser);
 368     return NULL;
 369   }
 370   memcpy (buf_ptr, &signature, sizeof (signature));
 371   code_str = base64_encode ((const char *) &code_payload, code_payload_len);
 372   GNUNET_free (code_payload);
 373   GNUNET_free_non_null (attrs_ser);
 374   return code_str;
 375 }
 376
 377
 378 /**
 379  * Parse reclaim ticket and nonce from
 380  * authorization code.
 381  * This also verifies the signature in the code.
 382  *
 383  * @param audience the expected audience of the code
 384  * @param code the string representation of the code
 385  * @param ticket where to store the ticket
 386  * @param attrs the attributes in the code
 387  * @param nonce where to store the nonce
 388  * @return GNUNET_OK if successful, else GNUNET_SYSERR
 389  */
 390 int
 391 OIDC_parse_authz_code (const struct GNUNET_CRYPTO_EcdsaPublicKey *audience,
 392                        const char *code,
 393                        struct GNUNET_RECLAIM_Ticket *ticket,
 394                        struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList **attrs,
 395                        char **nonce_str)
 396 {
 397   char *code_payload;
 398   char *attrs_ser;
 399   char *ptr;
 400   struct GNUNET_CRYPTO_EccSignaturePurpose *purpose;
 401   struct GNUNET_CRYPTO_EcdsaSignature *signature;
 402   size_t code_payload_len;
 403   size_t attrs_ser_len;
 404   size_t signature_offset;
 405   unsigned int nonce;
 406
 407   code_payload = NULL;
 408   code_payload_len =
 409     GNUNET_STRINGS_base64_decode (code, strlen (code), (void **) &code_payload);
 410   purpose = (struct GNUNET_CRYPTO_EccSignaturePurpose *) code_payload;
 411   attrs_ser_len = code_payload_len;
 412   attrs_ser_len -= sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose);
 413   *ticket = *((struct GNUNET_RECLAIM_Ticket *) &purpose[1]);
 414   attrs_ser_len -= sizeof (struct GNUNET_RECLAIM_Ticket);
 415   nonce = ntohs (((unsigned int *) &ticket[1]));
 416   attrs_ser_len -= sizeof (unsigned int);
 417   ptr = code_payload;
 418   signature_offset =
 419     code_payload_len - sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
 420   signature = (struct GNUNET_CRYPTO_EcdsaSignature *) &ptr[signature_offset];
 421   attrs_ser_len -= sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
 422   attrs_ser = ((char *) &ticket[1]) + sizeof (unsigned int);
 423   *attrs = GNUNET_RECLAIM_ATTRIBUTE_list_deserialize (attrs_ser, attrs_ser_len);
 424   if (0 != GNUNET_memcmp (audience, &ticket->audience))
 425   {
 426     GNUNET_RECLAIM_ATTRIBUTE_list_destroy (*attrs);
 427     GNUNET_free (code_payload);
 428     GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
 429                 "Audience in ticket does not match client!\n");
 430     return GNUNET_SYSERR;
 431   }
 432   if (GNUNET_OK !=
 433       GNUNET_CRYPTO_ecdsa_verify (GNUNET_SIGNATURE_PURPOSE_RECLAIM_CODE_SIGN,
 434                                   purpose,
 435                                   signature,
 436                                   &ticket->identity))
 437   {
 438     GNUNET_RECLAIM_ATTRIBUTE_list_destroy (*attrs);
 439     GNUNET_free (code_payload);
 440     GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Signature of AuthZ code invalid!\n");
 441     return GNUNET_SYSERR;
 442   }
 443   *nonce_str = NULL;
 444   if (nonce != 0)
 445     GNUNET_asprintf (nonce_str, "%u", nonce);
 446   return GNUNET_OK;
 447 }
 448
 449
 450 /**
 451  * Build a token response for a token request
 452  * TODO: Maybe we should add the scope here?
 453  *
 454  * @param access_token the access token to include
 455  * @param id_token the id_token to include
 456  * @param expiration_time the expiration time of the token(s)
 457  * @param token_response where to store the response
 458  */
 459 void
 460 OIDC_build_token_response (const char *access_token,
 461                            const char *id_token,
 462                            const struct GNUNET_TIME_Relative *expiration_time,
 463                            char **token_response)
 464 {
 465   json_t *root_json;
 466
 467   root_json = json_object ();
 468
 469   GNUNET_assert (NULL != access_token);
 470   GNUNET_assert (NULL != id_token);
 471   GNUNET_assert (NULL != expiration_time);
 472   json_object_set_new (root_json, "access_token", json_string (access_token));
 473   json_object_set_new (root_json, "token_type", json_string ("Bearer"));
 474   json_object_set_new (
 475     root_json,
 476     "expires_in",
 477     json_integer (expiration_time->rel_value_us / (1000 * 1000)));
 478   json_object_set_new (root_json, "id_token", json_string (id_token));
 479   *token_response = json_dumps (root_json, JSON_INDENT (0) | JSON_COMPACT);
 480   json_decref (root_json);
 481 }
 482
 483 /**
 484  * Generate a new access token
 485  */
 486 char *
 487 OIDC_access_token_new ()
 488 {
 489   char *access_token_number;
 490   char *access_token;
 491   uint64_t random_number;
 492
 493   random_number =
 494     GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_NONCE, UINT64_MAX);
 495   GNUNET_asprintf (&access_token_number, "%" PRIu64, random_number);
 496   GNUNET_STRINGS_base64_encode (access_token_number,
 497                                 strlen (access_token_number),
 498                                 &access_token);
 499   return access_token;
 500 }