ecx: add key generation support.
[openssl.git] / include / crypto / ecx.h
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 /* Internal EC functions for other submodules: not for application use */
11
12 #ifndef OSSL_CRYPTO_ECX_H
13 # define OSSL_CRYPTO_ECX_H
14 # include <openssl/opensslconf.h>
15
16 # ifndef OPENSSL_NO_EC
17
18 #  include <openssl/core.h>
19 #  include <openssl/e_os2.h>
20 #  include <openssl/crypto.h>
21 #  include "internal/refcount.h"
22
23 #  define X25519_KEYLEN         32
24 #  define X448_KEYLEN           56
25 #  define ED25519_KEYLEN        32
26 #  define ED448_KEYLEN          57
27
28 #  define MAX_KEYLEN  ED448_KEYLEN
29
30 #  define X25519_BITS           253
31 #  define X25519_SECURITY_BITS  128
32
33 #  define X448_BITS             448
34 #  define X448_SECURITY_BITS    224
35
36 #  define ED25519_BITS          256
37 /* RFC8032 Section 8.5 */
38 #  define ED25519_SECURITY_BITS 128
39 #  define ED25519_SIGSIZE       64
40
41 #  define ED448_BITS            456
42 /* RFC8032 Section 8.5 */
43 #  define ED448_SECURITY_BITS   224
44 #  define ED448_SIGSIZE         114
45
46
47 typedef enum {
48     ECX_KEY_TYPE_X25519,
49     ECX_KEY_TYPE_X448,
50     ECX_KEY_TYPE_ED25519,
51     ECX_KEY_TYPE_ED448
52 } ECX_KEY_TYPE;
53
54 #define KEYTYPE2NID(type) \
55     ((type) == ECX_KEY_TYPE_X25519 \
56      ?  EVP_PKEY_X25519 \
57      : ((type) == ECX_KEY_TYPE_X448 \
58         ? EVP_PKEY_X448 \
59         : ((type) == ECX_KEY_TYPE_ED25519 \
60            ? EVP_PKEY_ED25519 \
61            : EVP_PKEY_ED448)))
62
63 struct ecx_key_st {
64     unsigned int haspubkey:1;
65     unsigned char pubkey[MAX_KEYLEN];
66     unsigned char *privkey;
67     size_t keylen;
68     ECX_KEY_TYPE type;
69     CRYPTO_REF_COUNT references;
70     CRYPTO_RWLOCK *lock;
71 };
72
73 typedef struct ecx_key_st ECX_KEY;
74
75 size_t ecx_key_length(ECX_KEY_TYPE type);
76 ECX_KEY *ecx_key_new(ECX_KEY_TYPE type, int haspubkey);
77 unsigned char *ecx_key_allocate_privkey(ECX_KEY *key);
78 void ecx_key_free(ECX_KEY *key);
79 int ecx_key_up_ref(ECX_KEY *key);
80
81 int X25519(uint8_t out_shared_key[32], const uint8_t private_key[32],
82            const uint8_t peer_public_value[32]);
83 void X25519_public_from_private(uint8_t out_public_value[32],
84                                 const uint8_t private_key[32]);
85
86 int ED25519_public_from_private(OPENSSL_CTX *ctx, uint8_t out_public_key[32],
87                                 const uint8_t private_key[32]);
88 int ED25519_sign(uint8_t *out_sig, const uint8_t *message, size_t message_len,
89                  const uint8_t public_key[32], const uint8_t private_key[32],
90                  OPENSSL_CTX *libctx, const char *propq);
91 int ED25519_verify(const uint8_t *message, size_t message_len,
92                    const uint8_t signature[64], const uint8_t public_key[32],
93                    OPENSSL_CTX *libctx, const char *propq);
94
95 int ED448_public_from_private(OPENSSL_CTX *ctx, uint8_t out_public_key[57],
96                               const uint8_t private_key[57]);
97 int ED448_sign(OPENSSL_CTX *ctx, uint8_t *out_sig, const uint8_t *message,
98                size_t message_len, const uint8_t public_key[57],
99                const uint8_t private_key[57], const uint8_t *context,
100                size_t context_len);
101
102 int ED448_verify(OPENSSL_CTX *ctx, const uint8_t *message, size_t message_len,
103                  const uint8_t signature[114], const uint8_t public_key[57],
104                  const uint8_t *context, size_t context_len);
105
106 int X448(uint8_t out_shared_key[56], const uint8_t private_key[56],
107          const uint8_t peer_public_value[56]);
108 void X448_public_from_private(uint8_t out_public_value[56],
109                               const uint8_t private_key[56]);
110
111 int s390x_x25519_mul(unsigned char u_dst[32],
112                      const unsigned char u_src[32],
113                      const unsigned char d_src[32]);
114 int s390x_x448_mul(unsigned char u_dst[56],
115                    const unsigned char u_src[56],
116                    const unsigned char d_src[56]);
117
118 /* Backend support */
119 int ecx_key_fromdata(ECX_KEY *ecx, const OSSL_PARAM params[],
120                      int include_private);
121
122 # endif /* OPENSSL_NO_EC */
123 #endif