1 /* 2 * Copyright 2020-2024 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 /* Internal EC functions for other submodules: not for application use */ 11 12 #ifndef OSSL_CRYPTO_ECX_H 13 # define OSSL_CRYPTO_ECX_H 14 # pragma once 15 16 # include <openssl/opensslconf.h> 17 18 # ifndef OPENSSL_NO_ECX 19 20 # include <openssl/core.h> 21 # include <openssl/e_os2.h> 22 # include <openssl/crypto.h> 23 # include "internal/refcount.h" 24 # include "crypto/types.h" 25 26 # define X25519_KEYLEN 32 27 # define X448_KEYLEN 56 28 # define ED25519_KEYLEN 32 29 # define ED448_KEYLEN 57 30 31 # define MAX_KEYLEN ED448_KEYLEN 32 33 # define X25519_BITS 253 34 # define X25519_SECURITY_BITS 128 35 36 # define X448_BITS 448 37 # define X448_SECURITY_BITS 224 38 39 # define ED25519_BITS 256 40 /* RFC8032 Section 8.5 */ 41 # define ED25519_SECURITY_BITS 128 42 # define ED25519_SIGSIZE 64 43 44 # define ED448_BITS 456 45 /* RFC8032 Section 8.5 */ 46 # define ED448_SECURITY_BITS 224 47 # define ED448_SIGSIZE 114 48 49 50 typedef enum { 51 ECX_KEY_TYPE_X25519, 52 ECX_KEY_TYPE_X448, 53 ECX_KEY_TYPE_ED25519, 54 ECX_KEY_TYPE_ED448 55 } ECX_KEY_TYPE; 56 57 #define KEYTYPE2NID(type) \ 58 ((type) == ECX_KEY_TYPE_X25519 \ 59 ? EVP_PKEY_X25519 \ 60 : ((type) == ECX_KEY_TYPE_X448 \ 61 ? EVP_PKEY_X448 \ 62 : ((type) == ECX_KEY_TYPE_ED25519 \ 63 ? EVP_PKEY_ED25519 \ 64 : EVP_PKEY_ED448))) 65 66 struct ecx_key_st { 67 OSSL_LIB_CTX *libctx; 68 char *propq; 69 unsigned int haspubkey:1; 70 unsigned char pubkey[MAX_KEYLEN]; 71 unsigned char *privkey; 72 size_t keylen; 73 ECX_KEY_TYPE type; 74 CRYPTO_REF_COUNT references; 75 }; 76 77 size_t ossl_ecx_key_length(ECX_KEY_TYPE type); 78 ECX_KEY *ossl_ecx_key_new(OSSL_LIB_CTX *libctx, ECX_KEY_TYPE type, 79 int haspubkey, const char *propq); 80 void ossl_ecx_key_set0_libctx(ECX_KEY *key, OSSL_LIB_CTX *libctx); 81 unsigned char *ossl_ecx_key_allocate_privkey(ECX_KEY *key); 82 void ossl_ecx_key_free(ECX_KEY *key); 83 int ossl_ecx_key_up_ref(ECX_KEY *key); 84 ECX_KEY *ossl_ecx_key_dup(const ECX_KEY *key, int selection); 85 int ossl_ecx_compute_key(ECX_KEY *peer, ECX_KEY *priv, size_t keylen, 86 unsigned char *secret, size_t *secretlen, 87 size_t outlen); 88 89 int ossl_x25519(uint8_t out_shared_key[32], const uint8_t private_key[32], 90 const uint8_t peer_public_value[32]); 91 void ossl_x25519_public_from_private(uint8_t out_public_value[32], 92 const uint8_t private_key[32]); 93 94 int 95 ossl_ed25519_public_from_private(OSSL_LIB_CTX *ctx, uint8_t out_public_key[32], 96 const uint8_t private_key[32], 97 const char *propq); 98 int 99 ossl_ed25519_sign(uint8_t *out_sig, const uint8_t *tbs, size_t tbs_len, 100 const uint8_t public_key[32], const uint8_t private_key[32], 101 const uint8_t dom2flag, const uint8_t phflag, const uint8_t csflag, 102 const uint8_t *context, size_t context_len, 103 OSSL_LIB_CTX *libctx, const char *propq); 104 int 105 ossl_ed25519_verify(const uint8_t *tbs, size_t tbs_len, 106 const uint8_t signature[64], const uint8_t public_key[32], 107 const uint8_t dom2flag, const uint8_t phflag, const uint8_t csflag, 108 const uint8_t *context, size_t context_len, 109 OSSL_LIB_CTX *libctx, const char *propq); 110 int 111 ossl_ed25519_pubkey_verify(const uint8_t *pub, size_t pub_len); 112 int 113 ossl_ed448_public_from_private(OSSL_LIB_CTX *ctx, uint8_t out_public_key[57], 114 const uint8_t private_key[57], const char *propq); 115 int 116 ossl_ed448_sign(OSSL_LIB_CTX *ctx, uint8_t *out_sig, 117 const uint8_t *message, size_t message_len, 118 const uint8_t public_key[57], const uint8_t private_key[57], 119 const uint8_t *context, size_t context_len, 120 const uint8_t phflag, const char *propq); 121 122 int 123 ossl_ed448_verify(OSSL_LIB_CTX *ctx, 124 const uint8_t *message, size_t message_len, 125 const uint8_t signature[114], const uint8_t public_key[57], 126 const uint8_t *context, size_t context_len, 127 const uint8_t phflag, const char *propq); 128 129 int 130 ossl_ed448_pubkey_verify(const uint8_t *pub, size_t pub_len); 131 132 int 133 ossl_x448(uint8_t out_shared_key[56], const uint8_t private_key[56], 134 const uint8_t peer_public_value[56]); 135 void 136 ossl_x448_public_from_private(uint8_t out_public_value[56], 137 const uint8_t private_key[56]); 138 139 140 /* Backend support */ 141 typedef enum { 142 KEY_OP_PUBLIC, 143 KEY_OP_PRIVATE, 144 KEY_OP_KEYGEN 145 } ecx_key_op_t; 146 147 ECX_KEY *ossl_ecx_key_op(const X509_ALGOR *palg, 148 const unsigned char *p, int plen, 149 int pkey_id, ecx_key_op_t op, 150 OSSL_LIB_CTX *libctx, const char *propq); 151 152 int ossl_ecx_public_from_private(ECX_KEY *key); 153 int ossl_ecx_key_fromdata(ECX_KEY *ecx, const OSSL_PARAM params[], 154 int include_private); 155 ECX_KEY *ossl_ecx_key_from_pkcs8(const PKCS8_PRIV_KEY_INFO *p8inf, 156 OSSL_LIB_CTX *libctx, const char *propq); 157 158 ECX_KEY *ossl_evp_pkey_get1_X25519(EVP_PKEY *pkey); 159 ECX_KEY *ossl_evp_pkey_get1_X448(EVP_PKEY *pkey); 160 ECX_KEY *ossl_evp_pkey_get1_ED25519(EVP_PKEY *pkey); 161 ECX_KEY *ossl_evp_pkey_get1_ED448(EVP_PKEY *pkey); 162 # endif /* OPENSSL_NO_ECX */ 163 #endif 164
