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