1 /* Copyright (C) 1995-1998 Eric Young (eay (at) cryptsoft.com) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young (eay (at) cryptsoft.com). 6 * The implementation was written so as to conform with Netscapes SSL. 7 * 8 * This library is free for commercial and non-commercial use as long as 9 * the following conditions are aheared to. The following conditions 10 * apply to all code found in this distribution, be it the RC4, RSA, 11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 12 * included with this distribution is covered by the same copyright terms 13 * except that the holder is Tim Hudson (tjh (at) cryptsoft.com). 14 * 15 * Copyright remains Eric Young's, and as such any Copyright notices in 16 * the code are not to be removed. 17 * If this package is used in a product, Eric Young should be given attribution 18 * as the author of the parts of the library used. 19 * This can be in the form of a textual message at program startup or 20 * in documentation (online or textual) provided with the package. 21 * 22 * Redistribution and use in source and binary forms, with or without 23 * modification, are permitted provided that the following conditions 24 * are met: 25 * 1. Redistributions of source code must retain the copyright 26 * notice, this list of conditions and the following disclaimer. 27 * 2. Redistributions in binary form must reproduce the above copyright 28 * notice, this list of conditions and the following disclaimer in the 29 * documentation and/or other materials provided with the distribution. 30 * 3. All advertising materials mentioning features or use of this software 31 * must display the following acknowledgement: 32 * "This product includes cryptographic software written by 33 * Eric Young (eay (at) cryptsoft.com)" 34 * The word 'cryptographic' can be left out if the rouines from the library 35 * being used are not cryptographic related :-). 36 * 4. If you include any Windows specific code (or a derivative thereof) from 37 * the apps directory (application code) you must include an acknowledgement: 38 * "This product includes software written by Tim Hudson (tjh (at) cryptsoft.com)" 39 * 40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50 * SUCH DAMAGE. 51 * 52 * The licence and distribution terms for any publically available version or 53 * derivative of this code cannot be changed. i.e. this code cannot simply be 54 * copied and put under another distribution licence 55 * [including the GNU Public Licence.] */ 56 57 #ifndef OPENSSL_HEADER_EVP_INTERNAL_H 58 #define OPENSSL_HEADER_EVP_INTERNAL_H 59 60 #include <openssl/base.h> 61 62 #include <openssl/rsa.h> 63 64 #if defined(__cplusplus) 65 extern "C" { 66 #endif 67 68 69 struct evp_pkey_asn1_method_st { 70 int pkey_id; 71 uint8_t oid[9]; 72 uint8_t oid_len; 73 74 // pub_decode decodes |params| and |key| as a SubjectPublicKeyInfo 75 // and writes the result into |out|. It returns one on success and zero on 76 // error. |params| is the AlgorithmIdentifier after the OBJECT IDENTIFIER 77 // type field, and |key| is the contents of the subjectPublicKey with the 78 // leading padding byte checked and removed. Although X.509 uses BIT STRINGs 79 // to represent SubjectPublicKeyInfo, every key type defined encodes the key 80 // as a byte string with the same conversion to BIT STRING. 81 int (*pub_decode)(EVP_PKEY *out, CBS *params, CBS *key); 82 83 // pub_encode encodes |key| as a SubjectPublicKeyInfo and appends the result 84 // to |out|. It returns one on success and zero on error. 85 int (*pub_encode)(CBB *out, const EVP_PKEY *key); 86 87 int (*pub_cmp)(const EVP_PKEY *a, const EVP_PKEY *b); 88 89 // priv_decode decodes |params| and |key| as a PrivateKeyInfo and writes the 90 // result into |out|. It returns one on success and zero on error. |params| is 91 // the AlgorithmIdentifier after the OBJECT IDENTIFIER type field, and |key| 92 // is the contents of the OCTET STRING privateKey field. 93 int (*priv_decode)(EVP_PKEY *out, CBS *params, CBS *key); 94 95 // priv_encode encodes |key| as a PrivateKeyInfo and appends the result to 96 // |out|. It returns one on success and zero on error. 97 int (*priv_encode)(CBB *out, const EVP_PKEY *key); 98 99 // pkey_opaque returns 1 if the |pk| is opaque. Opaque keys are backed by 100 // custom implementations which do not expose key material and parameters. 101 int (*pkey_opaque)(const EVP_PKEY *pk); 102 103 int (*pkey_size)(const EVP_PKEY *pk); 104 int (*pkey_bits)(const EVP_PKEY *pk); 105 106 int (*param_missing)(const EVP_PKEY *pk); 107 int (*param_copy)(EVP_PKEY *to, const EVP_PKEY *from); 108 int (*param_cmp)(const EVP_PKEY *a, const EVP_PKEY *b); 109 110 void (*pkey_free)(EVP_PKEY *pkey); 111 } /* EVP_PKEY_ASN1_METHOD */; 112 113 114 #define EVP_PKEY_OP_UNDEFINED 0 115 #define EVP_PKEY_OP_KEYGEN (1 << 2) 116 #define EVP_PKEY_OP_SIGN (1 << 3) 117 #define EVP_PKEY_OP_VERIFY (1 << 4) 118 #define EVP_PKEY_OP_VERIFYRECOVER (1 << 5) 119 #define EVP_PKEY_OP_ENCRYPT (1 << 6) 120 #define EVP_PKEY_OP_DECRYPT (1 << 7) 121 #define EVP_PKEY_OP_DERIVE (1 << 8) 122 123 #define EVP_PKEY_OP_TYPE_SIG \ 124 (EVP_PKEY_OP_SIGN | EVP_PKEY_OP_VERIFY | EVP_PKEY_OP_VERIFYRECOVER) 125 126 #define EVP_PKEY_OP_TYPE_CRYPT (EVP_PKEY_OP_ENCRYPT | EVP_PKEY_OP_DECRYPT) 127 128 #define EVP_PKEY_OP_TYPE_NOGEN \ 129 (EVP_PKEY_OP_SIG | EVP_PKEY_OP_CRYPT | EVP_PKEY_OP_DERIVE) 130 131 #define EVP_PKEY_OP_TYPE_GEN EVP_PKEY_OP_KEYGEN 132 133 // EVP_PKEY_CTX_ctrl performs |cmd| on |ctx|. The |keytype| and |optype| 134 // arguments can be -1 to specify that any type and operation are acceptable, 135 // otherwise |keytype| must match the type of |ctx| and the bits of |optype| 136 // must intersect the operation flags set on |ctx|. 137 // 138 // The |p1| and |p2| arguments depend on the value of |cmd|. 139 // 140 // It returns one on success and zero on error. 141 OPENSSL_EXPORT int EVP_PKEY_CTX_ctrl(EVP_PKEY_CTX *ctx, int keytype, int optype, 142 int cmd, int p1, void *p2); 143 144 #define EVP_PKEY_CTRL_MD 1 145 #define EVP_PKEY_CTRL_GET_MD 2 146 147 // EVP_PKEY_CTRL_PEER_KEY is called with different values of |p1|: 148 // 0: Is called from |EVP_PKEY_derive_set_peer| and |p2| contains a peer key. 149 // If the return value is <= 0, the key is rejected. 150 // 1: Is called at the end of |EVP_PKEY_derive_set_peer| and |p2| contains a 151 // peer key. If the return value is <= 0, the key is rejected. 152 // 2: Is called with |p2| == NULL to test whether the peer's key was used. 153 // (EC)DH always return one in this case. 154 // 3: Is called with |p2| == NULL to set whether the peer's key was used. 155 // (EC)DH always return one in this case. This was only used for GOST. 156 #define EVP_PKEY_CTRL_PEER_KEY 3 157 158 // EVP_PKEY_ALG_CTRL is the base value from which key-type specific ctrl 159 // commands are numbered. 160 #define EVP_PKEY_ALG_CTRL 0x1000 161 162 #define EVP_PKEY_CTRL_RSA_PADDING (EVP_PKEY_ALG_CTRL + 1) 163 #define EVP_PKEY_CTRL_GET_RSA_PADDING (EVP_PKEY_ALG_CTRL + 2) 164 #define EVP_PKEY_CTRL_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 3) 165 #define EVP_PKEY_CTRL_GET_RSA_PSS_SALTLEN (EVP_PKEY_ALG_CTRL + 4) 166 #define EVP_PKEY_CTRL_RSA_KEYGEN_BITS (EVP_PKEY_ALG_CTRL + 5) 167 #define EVP_PKEY_CTRL_RSA_KEYGEN_PUBEXP (EVP_PKEY_ALG_CTRL + 6) 168 #define EVP_PKEY_CTRL_RSA_OAEP_MD (EVP_PKEY_ALG_CTRL + 7) 169 #define EVP_PKEY_CTRL_GET_RSA_OAEP_MD (EVP_PKEY_ALG_CTRL + 8) 170 #define EVP_PKEY_CTRL_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 9) 171 #define EVP_PKEY_CTRL_GET_RSA_MGF1_MD (EVP_PKEY_ALG_CTRL + 10) 172 #define EVP_PKEY_CTRL_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 11) 173 #define EVP_PKEY_CTRL_GET_RSA_OAEP_LABEL (EVP_PKEY_ALG_CTRL + 12) 174 175 struct evp_pkey_ctx_st { 176 // Method associated with this operation 177 const EVP_PKEY_METHOD *pmeth; 178 // Engine that implements this method or NULL if builtin 179 ENGINE *engine; 180 // Key: may be NULL 181 EVP_PKEY *pkey; 182 // Peer key for key agreement, may be NULL 183 EVP_PKEY *peerkey; 184 // operation contains one of the |EVP_PKEY_OP_*| values. 185 int operation; 186 // Algorithm specific data 187 void *data; 188 } /* EVP_PKEY_CTX */; 189 190 struct evp_pkey_method_st { 191 int pkey_id; 192 193 int (*init)(EVP_PKEY_CTX *ctx); 194 int (*copy)(EVP_PKEY_CTX *dst, EVP_PKEY_CTX *src); 195 void (*cleanup)(EVP_PKEY_CTX *ctx); 196 197 int (*keygen)(EVP_PKEY_CTX *ctx, EVP_PKEY *pkey); 198 199 int (*sign)(EVP_PKEY_CTX *ctx, uint8_t *sig, size_t *siglen, 200 const uint8_t *tbs, size_t tbslen); 201 202 int (*sign_message)(EVP_PKEY_CTX *ctx, uint8_t *sig, size_t *siglen, 203 const uint8_t *tbs, size_t tbslen); 204 205 int (*verify)(EVP_PKEY_CTX *ctx, const uint8_t *sig, size_t siglen, 206 const uint8_t *tbs, size_t tbslen); 207 208 int (*verify_message)(EVP_PKEY_CTX *ctx, const uint8_t *sig, size_t siglen, 209 const uint8_t *tbs, size_t tbslen); 210 211 int (*verify_recover)(EVP_PKEY_CTX *ctx, uint8_t *out, size_t *out_len, 212 const uint8_t *sig, size_t sig_len); 213 214 int (*encrypt)(EVP_PKEY_CTX *ctx, uint8_t *out, size_t *outlen, 215 const uint8_t *in, size_t inlen); 216 217 int (*decrypt)(EVP_PKEY_CTX *ctx, uint8_t *out, size_t *outlen, 218 const uint8_t *in, size_t inlen); 219 220 int (*derive)(EVP_PKEY_CTX *ctx, uint8_t *key, size_t *keylen); 221 222 int (*ctrl)(EVP_PKEY_CTX *ctx, int type, int p1, void *p2); 223 } /* EVP_PKEY_METHOD */; 224 225 typedef struct { 226 union { 227 uint8_t priv[64]; 228 struct { 229 // Shift the location of the public key to align with where it is in the 230 // private key representation. 231 uint8_t pad[32]; 232 uint8_t value[32]; 233 } pub; 234 } key; 235 char has_private; 236 } ED25519_KEY; 237 238 extern const EVP_PKEY_ASN1_METHOD dsa_asn1_meth; 239 extern const EVP_PKEY_ASN1_METHOD ec_asn1_meth; 240 extern const EVP_PKEY_ASN1_METHOD rsa_asn1_meth; 241 extern const EVP_PKEY_ASN1_METHOD ed25519_asn1_meth; 242 243 extern const EVP_PKEY_METHOD rsa_pkey_meth; 244 extern const EVP_PKEY_METHOD ec_pkey_meth; 245 extern const EVP_PKEY_METHOD ed25519_pkey_meth; 246 247 248 #if defined(__cplusplus) 249 } // extern C 250 #endif 251 252 #endif // OPENSSL_HEADER_EVP_INTERNAL_H 253
