providers/implementations/keymgmt/ecx_kmgmt.c

   1 /*
   2  * Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #include <assert.h>
  11 #include <openssl/core_numbers.h>
  12 #include <openssl/core_names.h>
  13 #include <openssl/params.h>
  14 #include "openssl/param_build.h"
  15 #include "crypto/ecx.h"
  16 #include "prov/implementations.h"
  17 #include "prov/providercommon.h"
  18
  19 static OSSL_OP_keymgmt_new_fn x25519_new_key;
  20 static OSSL_OP_keymgmt_new_fn x448_new_key;
  21 static OSSL_OP_keymgmt_new_fn ed25519_new_key;
  22 static OSSL_OP_keymgmt_new_fn ed448_new_key;
  23 static OSSL_OP_keymgmt_get_params_fn x25519_get_params;
  24 static OSSL_OP_keymgmt_get_params_fn x448_get_params;
  25 static OSSL_OP_keymgmt_get_params_fn ed25519_get_params;
  26 static OSSL_OP_keymgmt_get_params_fn ed448_get_params;
  27 static OSSL_OP_keymgmt_gettable_params_fn ecx_gettable_params;
  28 static OSSL_OP_keymgmt_has_fn ecx_has;
  29 static OSSL_OP_keymgmt_import_fn ecx_import;
  30 static OSSL_OP_keymgmt_import_types_fn ecx_imexport_types;
  31 static OSSL_OP_keymgmt_export_fn ecx_export;
  32 static OSSL_OP_keymgmt_export_types_fn ecx_imexport_types;
  33
  34 #define ECX_POSSIBLE_SELECTIONS (OSSL_KEYMGMT_SELECT_KEYPAIR)
  35
  36 static void *x25519_new_key(void *provctx)
  37 {
  38     return ecx_key_new(ECX_KEY_TYPE_X25519, 0);
  39 }
  40
  41 static void *x448_new_key(void *provctx)
  42 {
  43     return ecx_key_new(ECX_KEY_TYPE_X448, 0);
  44 }
  45
  46 static void *ed25519_new_key(void *provctx)
  47 {
  48     return ecx_key_new(ECX_KEY_TYPE_ED25519, 0);
  49 }
  50
  51 static void *ed448_new_key(void *provctx)
  52 {
  53     return ecx_key_new(ECX_KEY_TYPE_ED448, 0);
  54 }
  55
  56 static int ecx_has(void *keydata, int selection)
  57 {
  58     ECX_KEY *key = keydata;
  59     int ok = 0;
  60
  61     if (key != NULL) {
  62         if ((selection & ECX_POSSIBLE_SELECTIONS) != 0)
  63             ok = 1;
  64
  65         if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) != 0)
  66             ok = ok && key->haspubkey;
  67
  68         if ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0)
  69             ok = ok && key->privkey != NULL;
  70     }
  71     return ok;
  72 }
  73
  74 static int ecx_import(void *keydata, int selection, const OSSL_PARAM params[])
  75 {
  76     ECX_KEY *key = keydata;
  77     int ok = 1;
  78     int include_private = 0;
  79
  80     if (key == NULL)
  81         return 0;
  82
  83     if ((selection & OSSL_KEYMGMT_SELECT_PUBLIC_KEY) == 0)
  84         return 0;
  85
  86     include_private = ((selection & OSSL_KEYMGMT_SELECT_PRIVATE_KEY) != 0);
  87     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
  88         ok = ok && ecx_key_fromdata(key, params, include_private);
  89
  90     return ok;
  91 }
  92
  93 static int key_to_params(ECX_KEY *key, OSSL_PARAM_BLD *tmpl)
  94 {
  95     if (key == NULL)
  96         return 0;
  97
  98     if (!OSSL_PARAM_BLD_push_octet_string(tmpl, OSSL_PKEY_PARAM_PUB_KEY,
  99                                           key->pubkey, key->keylen))
 100         return 0;
 101
 102     if (key->privkey != NULL
 103         && !OSSL_PARAM_BLD_push_octet_string(tmpl, OSSL_PKEY_PARAM_PRIV_KEY,
 104                                              key->privkey, key->keylen))
 105         return 0;
 106
 107     return 1;
 108 }
 109
 110 static int ecx_export(void *keydata, int selection, OSSL_CALLBACK *param_cb,
 111                       void *cbarg)
 112 {
 113     ECX_KEY *key = keydata;
 114     OSSL_PARAM_BLD tmpl;
 115     OSSL_PARAM *params = NULL;
 116     int ret;
 117
 118     if (key == NULL)
 119         return 0;
 120
 121     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0
 122             && !key_to_params(key, &tmpl))
 123         return 0;
 124
 125     OSSL_PARAM_BLD_init(&tmpl);
 126     params = OSSL_PARAM_BLD_to_param(&tmpl);
 127     if (params == NULL) {
 128         OSSL_PARAM_BLD_free(params);
 129         return 0;
 130     }
 131
 132     ret = param_cb(params, cbarg);
 133     OSSL_PARAM_BLD_free(params);
 134     return ret;
 135 }
 136
 137 static const OSSL_PARAM ecx_key_types[] = {
 138     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PUB_KEY, NULL, 0),
 139     OSSL_PARAM_octet_string(OSSL_PKEY_PARAM_PRIV_KEY, NULL, 0),
 140     OSSL_PARAM_END
 141 };
 142 static const OSSL_PARAM *ecx_imexport_types(int selection)
 143 {
 144     if ((selection & OSSL_KEYMGMT_SELECT_KEYPAIR) != 0)
 145         return ecx_key_types;
 146     return NULL;
 147 }
 148
 149 static int ecx_get_params(OSSL_PARAM params[], int bits, int secbits,
 150                           int size)
 151 {
 152     OSSL_PARAM *p;
 153
 154     if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_BITS)) != NULL
 155         && !OSSL_PARAM_set_int(p, bits))
 156         return 0;
 157     if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_SECURITY_BITS)) != NULL
 158         && !OSSL_PARAM_set_int(p, secbits))
 159         return 0;
 160     if ((p = OSSL_PARAM_locate(params, OSSL_PKEY_PARAM_MAX_SIZE)) != NULL
 161         && !OSSL_PARAM_set_int(p, size))
 162         return 0;
 163     return 1;
 164 }
 165
 166 static int x25519_get_params(void *key, OSSL_PARAM params[])
 167 {
 168     return ecx_get_params(params, X25519_BITS, X25519_SECURITY_BITS, X25519_KEYLEN);
 169 }
 170
 171 static int x448_get_params(void *key, OSSL_PARAM params[])
 172 {
 173     return ecx_get_params(params, X448_BITS, X448_SECURITY_BITS, X448_KEYLEN);
 174 }
 175
 176 static int ed25519_get_params(void *key, OSSL_PARAM params[])
 177 {
 178     return ecx_get_params(params, ED25519_BITS, ED25519_SECURITY_BITS, ED25519_KEYLEN);
 179 }
 180
 181 static int ed448_get_params(void *key, OSSL_PARAM params[])
 182 {
 183     return ecx_get_params(params, ED448_BITS, ED448_SECURITY_BITS, ED448_KEYLEN);
 184 }
 185
 186 static const OSSL_PARAM ecx_params[] = {
 187     OSSL_PARAM_int(OSSL_PKEY_PARAM_BITS, NULL),
 188     OSSL_PARAM_int(OSSL_PKEY_PARAM_SECURITY_BITS, NULL),
 189     OSSL_PARAM_int(OSSL_PKEY_PARAM_MAX_SIZE, NULL),
 190     OSSL_PARAM_END
 191 };
 192
 193 static const OSSL_PARAM *ecx_gettable_params(void)
 194 {
 195     return ecx_params;
 196 }
 197
 198 #define MAKE_KEYMGMT_FUNCTIONS(alg) \
 199     const OSSL_DISPATCH alg##_keymgmt_functions[] = { \
 200         { OSSL_FUNC_KEYMGMT_NEW, (void (*)(void))alg##_new_key }, \
 201         { OSSL_FUNC_KEYMGMT_FREE, (void (*)(void))ecx_key_free }, \
 202         { OSSL_FUNC_KEYMGMT_GET_PARAMS, (void (*) (void))alg##_get_params }, \
 203         { OSSL_FUNC_KEYMGMT_GETTABLE_PARAMS, (void (*) (void))ecx_gettable_params }, \
 204         { OSSL_FUNC_KEYMGMT_HAS, (void (*)(void))ecx_has }, \
 205         { OSSL_FUNC_KEYMGMT_IMPORT, (void (*)(void))ecx_import }, \
 206         { OSSL_FUNC_KEYMGMT_IMPORT_TYPES, (void (*)(void))ecx_imexport_types }, \
 207         { OSSL_FUNC_KEYMGMT_EXPORT, (void (*)(void))ecx_export }, \
 208         { OSSL_FUNC_KEYMGMT_EXPORT_TYPES, (void (*)(void))ecx_imexport_types }, \
 209         { 0, NULL } \
 210     };
 211
 212 MAKE_KEYMGMT_FUNCTIONS(x25519)
 213 MAKE_KEYMGMT_FUNCTIONS(x448)
 214 MAKE_KEYMGMT_FUNCTIONS(ed25519)
 215 MAKE_KEYMGMT_FUNCTIONS(ed448)