|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + * or more contributor license agreements. See the NOTICE file |
| 4 | + * distributed with this work for additional information |
| 5 | + * regarding copyright ownership. The ASF licenses this file |
| 6 | + * to you under the Apache License, Version 2.0 (the |
| 7 | + * "License"); you may not use this file except in compliance |
| 8 | + * with the License. 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, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | + |
| 20 | +/*************************************************************************** |
| 21 | + * Copyright (C) 2017-2025 ZmartZone Holding BV |
| 22 | + * All rights reserved. |
| 23 | + * |
| 24 | + * DISCLAIMER OF WARRANTIES: |
| 25 | + * |
| 26 | + * THE SOFTWARE PROVIDED HEREUNDER IS PROVIDED ON AN "AS IS" BASIS, WITHOUT |
| 27 | + * ANY WARRANTIES OR REPRESENTATIONS EXPRESS, IMPLIED OR STATUTORY; INCLUDING, |
| 28 | + * WITHOUT LIMITATION, WARRANTIES OF QUALITY, PERFORMANCE, NONINFRINGEMENT, |
| 29 | + * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. NOR ARE THERE ANY |
| 30 | + * WARRANTIES CREATED BY A COURSE OR DEALING, COURSE OF PERFORMANCE OR TRADE |
| 31 | + * USAGE. FURTHERMORE, THERE ARE NO WARRANTIES THAT THE SOFTWARE WILL MEET |
| 32 | + * YOUR NEEDS OR BE FREE FROM ERRORS, OR THAT THE OPERATION OF THE SOFTWARE |
| 33 | + * WILL BE UNINTERRUPTED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR |
| 34 | + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| 35 | + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES HOWEVER CAUSED AND ON ANY THEORY OF |
| 36 | + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| 37 | + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 38 | + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 39 | + * |
| 40 | + * @Author: Hans Zandbelt - [email protected] |
| 41 | + */ |
| 42 | + |
| 43 | +#include "util/util.h" |
| 44 | + |
| 45 | +/* |
| 46 | + * create a symmetric key from a client_secret |
| 47 | + */ |
| 48 | +apr_byte_t oidc_util_key_symmetric_create(request_rec *r, const char *client_secret, unsigned int r_key_len, |
| 49 | + const char *hash_algo, apr_byte_t set_kid, oidc_jwk_t **jwk) { |
| 50 | + oidc_jose_error_t err = {{'\0'}, 0, {'\0'}, {'\0'}}; |
| 51 | + unsigned char *key = NULL; |
| 52 | + unsigned int key_len; |
| 53 | + |
| 54 | + if ((client_secret != NULL) && (_oidc_strlen(client_secret) > 0)) { |
| 55 | + |
| 56 | + if (hash_algo == NULL) { |
| 57 | + key = (unsigned char *)client_secret; |
| 58 | + key_len = _oidc_strlen(client_secret); |
| 59 | + } else { |
| 60 | + /* hash the client_secret first, this is OpenID Connect specific */ |
| 61 | + oidc_jose_hash_bytes(r->pool, hash_algo, (const unsigned char *)client_secret, |
| 62 | + _oidc_strlen(client_secret), &key, &key_len, &err); |
| 63 | + } |
| 64 | + |
| 65 | + if ((key != NULL) && (key_len > 0)) { |
| 66 | + if ((r_key_len != 0) && (key_len >= r_key_len)) |
| 67 | + key_len = r_key_len; |
| 68 | + oidc_debug(r, "key_len=%d", key_len); |
| 69 | + *jwk = oidc_jwk_create_symmetric_key(r->pool, NULL, key, key_len, set_kid, &err); |
| 70 | + } |
| 71 | + |
| 72 | + if (*jwk == NULL) { |
| 73 | + oidc_error(r, "could not create JWK from the provided secret: %s", oidc_jose_e2s(r->pool, err)); |
| 74 | + return FALSE; |
| 75 | + } |
| 76 | + } |
| 77 | + |
| 78 | + return TRUE; |
| 79 | +} |
| 80 | + |
| 81 | +/* |
| 82 | + * merge provided keys and client secret in to a single hashtable |
| 83 | + */ |
| 84 | +apr_hash_t *oidc_util_key_symmetric_merge(apr_pool_t *pool, const apr_array_header_t *keys, oidc_jwk_t *jwk) { |
| 85 | + apr_hash_t *result = apr_hash_make(pool); |
| 86 | + const oidc_jwk_t *elem = NULL; |
| 87 | + int i = 0; |
| 88 | + if (keys != NULL) { |
| 89 | + for (i = 0; i < keys->nelts; i++) { |
| 90 | + elem = APR_ARRAY_IDX(keys, i, oidc_jwk_t *); |
| 91 | + apr_hash_set(result, elem->kid, APR_HASH_KEY_STRING, elem); |
| 92 | + } |
| 93 | + } |
| 94 | + if (jwk != NULL) { |
| 95 | + apr_hash_set(result, jwk->kid, APR_HASH_KEY_STRING, jwk); |
| 96 | + } |
| 97 | + return result; |
| 98 | +} |
| 99 | + |
| 100 | +/* |
| 101 | + * merge the provided array of keys (k2) into a hash table of keys (k1) |
| 102 | + */ |
| 103 | +apr_hash_t *oidc_util_key_sets_merge(apr_pool_t *pool, apr_hash_t *k1, const apr_array_header_t *k2) { |
| 104 | + apr_hash_t *rv = k1 ? apr_hash_copy(pool, k1) : apr_hash_make(pool); |
| 105 | + const oidc_jwk_t *jwk = NULL; |
| 106 | + int i = 0; |
| 107 | + if (k2 != NULL) { |
| 108 | + for (i = 0; i < k2->nelts; i++) { |
| 109 | + jwk = APR_ARRAY_IDX(k2, i, oidc_jwk_t *); |
| 110 | + apr_hash_set(rv, jwk->kid, APR_HASH_KEY_STRING, jwk); |
| 111 | + } |
| 112 | + } |
| 113 | + return rv; |
| 114 | +} |
| 115 | + |
| 116 | +/* |
| 117 | + * merge two hash tables with key sets |
| 118 | + */ |
| 119 | +apr_hash_t *oidc_util_key_sets_hash_merge(apr_pool_t *pool, apr_hash_t *k1, apr_hash_t *k2) { |
| 120 | + if (k1 == NULL) { |
| 121 | + if (k2 == NULL) |
| 122 | + return apr_hash_make(pool); |
| 123 | + return k2; |
| 124 | + } |
| 125 | + if (k2 == NULL) |
| 126 | + return k1; |
| 127 | + return apr_hash_overlay(pool, k1, k2); |
| 128 | +} |
| 129 | + |
| 130 | +/* |
| 131 | + * return the first JWK that matches a provided key type and use from an array of JWKs |
| 132 | + */ |
| 133 | +oidc_jwk_t *oidc_util_key_list_first(const apr_array_header_t *key_list, int kty, const char *use) { |
| 134 | + oidc_jwk_t *rv = NULL; |
| 135 | + int i = 0; |
| 136 | + oidc_jwk_t *jwk = NULL; |
| 137 | + for (i = 0; (key_list) && (i < key_list->nelts); i++) { |
| 138 | + jwk = APR_ARRAY_IDX(key_list, i, oidc_jwk_t *); |
| 139 | + if ((kty != -1) && (jwk->kty != kty)) |
| 140 | + continue; |
| 141 | + if (((use == NULL) || (jwk->use == NULL) || (_oidc_strncmp(jwk->use, use, _oidc_strlen(use)) == 0))) { |
| 142 | + rv = jwk; |
| 143 | + break; |
| 144 | + } |
| 145 | + } |
| 146 | + return rv; |
| 147 | +} |
| 148 | + |
0 commit comments