2 This file is part of GNUnet
3 Copyright (C) 2010-2015 GNUnet e.V.
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.
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.
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/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @file reclaim/oidc_helper.c
23 * @brief helper library for OIDC related functions
24 * @author Martin Schanzenbach
30 #include "gnunet_util_lib.h"
32 #include "gnunet_reclaim_attribute_lib.h"
33 #include "gnunet_reclaim_service.h"
34 #include "gnunet_signatures.h"
35 #include "oidc_helper.h"
37 create_jwt_header (void)
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));
46 json_str = json_dumps (root, JSON_INDENT (0) | JSON_COMPACT);
52 replace_char (char *str, char find, char replace)
54 char *current_pos = strchr (str, find);
57 *current_pos = replace;
58 current_pos = strchr (current_pos, find);
64 fix_base64 (char *str)
67 replace_char (str, '+', '-');
70 replace_char (str, '/', '_');
74 * Create a JWT from attributes
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.
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,
89 const char *secret_key)
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;
102 char *signature_target;
103 char *signature_base64;
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
115 GNUNET_STRINGS_data_to_string_alloc (sub_key,
117 GNUNET_CRYPTO_EcdsaPublicKey));
119 GNUNET_STRINGS_data_to_string_alloc (aud_key,
121 GNUNET_CRYPTO_EcdsaPublicKey));
122 header = create_jwt_header ();
123 body = json_object ();
125 // iss REQUIRED case sensitive server uri with https
126 // The issuer is the local reclaim instance (e.g.
127 // https://reclaim.id/api/openid)
128 json_object_set_new (body, "iss", json_string (SERVER_ADDRESS));
129 // sub REQUIRED public key identity, not exceed 255 ASCII length
130 json_object_set_new (body, "sub", json_string (subject));
131 // aud REQUIRED public key client_id must be there
132 json_object_set_new (body, "aud", json_string (audience));
134 json_object_set_new (body,
136 json_integer (time_now.abs_value_us / (1000 * 1000)));
138 json_object_set_new (body,
140 json_integer (exp_time.abs_value_us / (1000 * 1000)));
142 json_object_set_new (body,
144 json_integer (time_now.abs_value_us / (1000 * 1000)));
147 json_object_set_new (body, "nonce", json_string (nonce));
149 for (le = attrs->list_head; NULL != le; le = le->next)
152 GNUNET_RECLAIM_ATTRIBUTE_value_to_string (le->claim->type,
154 le->claim->data_size);
155 json_object_set_new (body, le->claim->name, json_string (attr_val_str));
156 GNUNET_free (attr_val_str);
158 body_str = json_dumps (body, JSON_INDENT (0) | JSON_COMPACT);
161 GNUNET_STRINGS_base64_encode (header, strlen (header), &header_base64);
162 fix_base64 (header_base64);
164 GNUNET_STRINGS_base64_encode (body_str, strlen (body_str), &body_base64);
165 fix_base64 (body_base64);
167 GNUNET_free (subject);
168 GNUNET_free (audience);
171 * Creating the JWT signature. This might not be
172 * standards compliant, check.
174 GNUNET_asprintf (&signature_target, "%s.%s", header_base64, body_base64);
175 GNUNET_CRYPTO_hmac_raw (secret_key,
178 strlen (signature_target),
180 GNUNET_STRINGS_base64_encode ((const char *) &signature,
181 sizeof (struct GNUNET_HashCode),
183 fix_base64 (signature_base64);
185 GNUNET_asprintf (&result,
191 GNUNET_free (signature_target);
192 GNUNET_free (header);
193 GNUNET_free (body_str);
194 GNUNET_free (signature_base64);
195 GNUNET_free (body_base64);
196 GNUNET_free (header_base64);
200 /* Converts a hex character to its integer value */
204 return isdigit (ch) ? ch - '0' : tolower (ch) - 'a' + 10;
207 /* Converts an integer value to its hex character*/
211 static char hex[] = "0123456789abcdef";
212 return hex[code & 15];
215 /* Returns a url-encoded version of str */
216 /* IMPORTANT: be sure to free() the returned string after use */
218 url_encode (const char *str)
220 char *pstr = (char *) str;
221 char *buf = GNUNET_malloc (strlen (str) * 3 + 1);
225 if (isalnum (*pstr) || *pstr == '-' || *pstr == '_' || *pstr == '.' ||
228 else if (*pstr == ' ')
233 *pbuf++ = to_hex (*pstr >> 4);
234 *pbuf++ = to_hex (*pstr & 15);
243 /* Returns a url-decoded version of str */
244 /* IMPORTANT: be sure to free() the returned string after use */
246 url_decode (const char *str)
248 char *pstr = (char *) str;
249 char *buf = GNUNET_malloc (strlen (str) + 1);
255 if (pstr[1] && pstr[2])
257 *pbuf++ = from_hex (pstr[1]) << 4 | from_hex (pstr[2]);
261 else if (*pstr == '+')
277 * Returns base64 encoded string urlencoded
279 * @param string the string to encode
280 * @return base64 encoded string
283 base64_encode (const char *data, size_t data_size)
288 GNUNET_STRINGS_base64_encode (data, data_size, &enc);
289 enc_urlencode = url_encode (enc);
291 return enc_urlencode;
296 * Builds an OIDC authorization code including
297 * a reclaim ticket and nonce
299 * @param issuer the issuer of the ticket, used to sign the ticket and nonce
300 * @param ticket the ticket to include in the code
301 * @param attrs list of attributes whicha re shared
302 * @param nonce the nonce to include in the code
303 * @return a new authorization code (caller must free)
306 OIDC_build_authz_code (const struct GNUNET_CRYPTO_EcdsaPrivateKey *issuer,
307 const struct GNUNET_RECLAIM_Ticket *ticket,
308 struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList *attrs,
309 const char *nonce_str)
315 size_t signature_payload_len;
316 size_t attr_list_len;
317 size_t code_payload_len;
319 unsigned int nonce_tmp;
320 struct GNUNET_CRYPTO_EccSignaturePurpose *purpose;
323 signature_payload_len =
324 sizeof (struct GNUNET_RECLAIM_Ticket) + sizeof (unsigned int);
327 attr_list_len = GNUNET_RECLAIM_ATTRIBUTE_list_serialize_get_size (attrs);
328 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
329 "Length of serialized attributes: %lu\n",
331 signature_payload_len += attr_list_len;
332 attrs_ser = GNUNET_malloc (attr_list_len);
333 GNUNET_RECLAIM_ATTRIBUTE_list_serialize (attrs, attrs_ser);
335 code_payload_len = sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
336 signature_payload_len +
337 sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
338 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
339 "Length of data to encode: %lu\n",
341 code_payload = GNUNET_malloc (code_payload_len);
342 GNUNET_assert (NULL != code_payload);
343 purpose = (struct GNUNET_CRYPTO_EccSignaturePurpose *) code_payload;
344 purpose->size = htonl (sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
345 signature_payload_len);
346 purpose->purpose = htonl (GNUNET_SIGNATURE_PURPOSE_RECLAIM_CODE_SIGN);
347 // First, copy ticket
348 buf_ptr = (char *) &purpose[1];
349 memcpy (buf_ptr, ticket, sizeof (struct GNUNET_RECLAIM_Ticket));
350 buf_ptr += sizeof (struct GNUNET_RECLAIM_Ticket);
353 if (NULL != nonce_str)
355 if ((1 != SSCANF (nonce_str, "%u", &nonce)) || (nonce > UINT32_MAX))
358 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Invalid nonce %s\n", nonce_str);
359 GNUNET_free (code_payload);
360 GNUNET_free_non_null (attrs_ser);
364 nonce_tmp = htons (nonce);
365 memcpy (buf_ptr, &nonce_tmp, sizeof (unsigned int));
366 buf_ptr += sizeof (unsigned int);
367 // Finally, attributes
368 if (NULL != attrs_ser)
370 memcpy (buf_ptr, attrs_ser, attr_list_len);
371 buf_ptr += attr_list_len;
374 GNUNET_CRYPTO_ecdsa_sign (issuer,
376 (struct GNUNET_CRYPTO_EcdsaSignature *)
380 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Unable to sign code\n");
381 GNUNET_free (code_payload);
382 GNUNET_free_non_null (attrs_ser);
385 code_str = base64_encode (code_payload, code_payload_len);
386 GNUNET_free (code_payload);
387 GNUNET_free_non_null (attrs_ser);
393 * Parse reclaim ticket and nonce from
394 * authorization code.
395 * This also verifies the signature in the code.
397 * @param audience the expected audience of the code
398 * @param code the string representation of the code
399 * @param ticket where to store the ticket
400 * @param attrs the attributes in the code
401 * @param nonce where to store the nonce
402 * @return GNUNET_OK if successful, else GNUNET_SYSERR
405 OIDC_parse_authz_code (const struct GNUNET_CRYPTO_EcdsaPublicKey *audience,
407 struct GNUNET_RECLAIM_Ticket *ticket,
408 struct GNUNET_RECLAIM_ATTRIBUTE_ClaimList **attrs,
413 struct GNUNET_CRYPTO_EccSignaturePurpose *purpose;
414 struct GNUNET_CRYPTO_EcdsaSignature *signature;
415 size_t code_payload_len;
416 size_t attrs_ser_len;
417 size_t signature_offset;
420 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Trying to decode `%s'", code);
423 GNUNET_STRINGS_base64_decode (code, strlen (code), (void **) &code_payload);
425 if (code_payload_len < sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose) +
426 sizeof (struct GNUNET_RECLAIM_Ticket) +
427 sizeof (unsigned int) +
428 sizeof (struct GNUNET_CRYPTO_EcdsaSignature))
430 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Authorization code malformed\n");
431 GNUNET_free_non_null (code_payload);
432 return GNUNET_SYSERR;
435 purpose = (struct GNUNET_CRYPTO_EccSignaturePurpose *) code_payload;
436 attrs_ser_len = code_payload_len;
437 attrs_ser_len -= sizeof (struct GNUNET_CRYPTO_EccSignaturePurpose);
438 ptr = (char *) &purpose[1];
439 *ticket = *((struct GNUNET_RECLAIM_Ticket *) ptr);
440 attrs_ser_len -= sizeof (struct GNUNET_RECLAIM_Ticket);
441 ptr += sizeof (struct GNUNET_RECLAIM_Ticket);
442 nonce = ntohs (*((unsigned int *) ptr));
443 attrs_ser_len -= sizeof (unsigned int);
444 ptr += sizeof (unsigned int);
445 attrs_ser_len -= sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
446 *attrs = GNUNET_RECLAIM_ATTRIBUTE_list_deserialize (ptr, attrs_ser_len);
448 code_payload_len - sizeof (struct GNUNET_CRYPTO_EcdsaSignature);
450 (struct GNUNET_CRYPTO_EcdsaSignature *) &code_payload[signature_offset];
451 if (0 != GNUNET_memcmp (audience, &ticket->audience))
453 GNUNET_RECLAIM_ATTRIBUTE_list_destroy (*attrs);
454 GNUNET_free (code_payload);
455 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
456 "Audience in ticket does not match client!\n");
457 return GNUNET_SYSERR;
460 GNUNET_CRYPTO_ecdsa_verify (GNUNET_SIGNATURE_PURPOSE_RECLAIM_CODE_SIGN,
465 GNUNET_RECLAIM_ATTRIBUTE_list_destroy (*attrs);
466 GNUNET_free (code_payload);
467 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Signature of AuthZ code invalid!\n");
468 return GNUNET_SYSERR;
472 GNUNET_asprintf (nonce_str, "%u", nonce);
478 * Build a token response for a token request
479 * TODO: Maybe we should add the scope here?
481 * @param access_token the access token to include
482 * @param id_token the id_token to include
483 * @param expiration_time the expiration time of the token(s)
484 * @param token_response where to store the response
487 OIDC_build_token_response (const char *access_token,
488 const char *id_token,
489 const struct GNUNET_TIME_Relative *expiration_time,
490 char **token_response)
494 root_json = json_object ();
496 GNUNET_assert (NULL != access_token);
497 GNUNET_assert (NULL != id_token);
498 GNUNET_assert (NULL != expiration_time);
499 json_object_set_new (root_json, "access_token", json_string (access_token));
500 json_object_set_new (root_json, "token_type", json_string ("Bearer"));
501 json_object_set_new (root_json,
503 json_integer (expiration_time->rel_value_us /
505 json_object_set_new (root_json, "id_token", json_string (id_token));
506 *token_response = json_dumps (root_json, JSON_INDENT (0) | JSON_COMPACT);
507 json_decref (root_json);
511 * Generate a new access token
514 OIDC_access_token_new ()
516 char *access_token_number;
518 uint64_t random_number;
521 GNUNET_CRYPTO_random_u64 (GNUNET_CRYPTO_QUALITY_NONCE, UINT64_MAX);
522 GNUNET_asprintf (&access_token_number, "%" PRIu64, random_number);
523 GNUNET_STRINGS_base64_encode (access_token_number,
524 strlen (access_token_number),