3 /**********************************************************************
5 * Copyright (c) 2006 Cryptocom LTD *
6 * This file is distributed under the same license as OpenSSL *
8 * Internal declarations used in GOST engine *
9 * OpenSSL 0.9.9 libraries required to compile and use *
11 **********************************************************************/
12 # include <openssl/bn.h>
13 # include <openssl/evp.h>
14 # include <openssl/asn1t.h>
15 # include <openssl/x509.h>
16 # include <openssl/engine.h>
17 # include <openssl/ec.h>
19 # include "gosthash.h"
20 /* Control commands */
21 # define GOST_PARAM_CRYPT_PARAMS 0
22 # define GOST_PARAM_PBE_PARAMS 1
23 # define GOST_PARAM_PK_FORMAT 2
24 # define GOST_PARAM_MAX 3
25 # define GOST_CTRL_CRYPT_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_CRYPT_PARAMS)
26 # define GOST_CTRL_PBE_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_PBE_PARAMS)
27 # define GOST_CTRL_PK_FORMAT (ENGINE_CMD_BASE+GOST_PARAM_PK_FORMAT)
29 typedef struct R3410_ec {
40 extern R3410_ec_params R3410_2001_paramset[],
41 *R3410_2012_256_paramset, R3410_2012_512_paramset[];
43 extern const ENGINE_CMD_DEFN gost_cmds[];
44 int gost_control_func(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
45 const char *get_gost_engine_param(int param);
46 int gost_set_default_param(int param, const char *value);
47 void gost_param_free(void);
49 /* method registration */
51 int register_ameth_gost(int nid, EVP_PKEY_ASN1_METHOD **ameth,
52 const char *pemstr, const char *info);
53 int register_pmeth_gost(int id, EVP_PKEY_METHOD **pmeth, int flags);
55 /* Gost-specific pmeth control-function parameters */
56 /* For GOST R34.10 parameters */
57 # define param_ctrl_string "paramset"
58 # define ukm_ctrl_string "ukmhex"
59 # define EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
60 /* For GOST 28147 MAC */
61 # define key_ctrl_string "key"
62 # define hexkey_ctrl_string "hexkey"
63 # define maclen_ctrl_string "size"
64 # define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
65 # define EVP_PKEY_CTRL_MAC_LEN (EVP_PKEY_ALG_CTRL+5)
66 /* Pmeth internal representation */
67 struct gost_pmeth_data {
68 int sign_param_nid; /* Should be set whenever parameters are
71 unsigned char *shared_ukm;
72 size_t shared_ukm_size; /* XXX temporary use shared_ukm and hash for 2018 CKE */
74 int cipher_nid; /* KExp15/KImp15 algs */
77 struct gost_mac_pmeth_data {
82 unsigned char key[32];
87 unsigned char key[32];
90 /* GOST-specific ASN1 structures */
93 ASN1_OCTET_STRING *encrypted_key;
94 ASN1_OCTET_STRING *imit;
97 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
101 X509_PUBKEY *ephem_key;
102 ASN1_OCTET_STRING *eph_iv;
103 } GOST_KEY_AGREEMENT_INFO;
105 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
108 GOST_KEY_INFO *key_info;
109 GOST_KEY_AGREEMENT_INFO *key_agreement_info;
110 } GOST_KEY_TRANSPORT;
112 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
114 typedef struct { /* FIXME incomplete */
115 GOST_KEY_TRANSPORT *gkt;
116 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
118 /* PSKeyTransport ::= SEQUENCE {
120 ephemeralPublicKey SubjectPublicKeyInfo
122 SubjectPublicKeyInfo ::= SEQUENCE {
123 algorithm AlgorithmIdentifier,
124 subjectPublicKey BITSTRING
126 AlgorithmIdentifier ::= SEQUENCE {
127 algorithm OBJECT IDENTIFIER,
128 parameters ANY OPTIONAL
130 typedef struct PSKeyTransport_st {
131 ASN1_OCTET_STRING *psexp;
132 X509_PUBKEY *ephem_key;
133 } PSKeyTransport_gost;
135 DECLARE_ASN1_FUNCTIONS(PSKeyTransport_gost)
137 * Hacks to shorten symbols to 31 characters or less, or OpenVMS. This mimics
138 * what's done in symhacks.h, but since this is a very local header file, I
139 * prefered to put this hack directly here. -- Richard Levitte
141 # ifdef OPENSSL_SYS_VMS
142 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
143 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it GOST_CLIENT_KEY_EXC_PARAMS_it
144 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
145 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new GOST_CLIENT_KEY_EXC_PARAMS_new
146 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
147 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free GOST_CLIENT_KEY_EXC_PARAMS_free
148 # undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
149 # define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS d2i_GOST_CLIENT_KEY_EXC_PARAMS
150 # undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
151 # define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS i2d_GOST_CLIENT_KEY_EXC_PARAMS
152 # endif /* End of hack */
153 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
155 ASN1_OBJECT *key_params;
156 ASN1_OBJECT *hash_params;
157 ASN1_OBJECT *cipher_params;
160 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
163 ASN1_OCTET_STRING *iv;
164 ASN1_OBJECT *enc_param_set;
165 } GOST_CIPHER_PARAMS;
167 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
170 ASN1_OCTET_STRING *masked_priv_key;
171 ASN1_OCTET_STRING *public_key;
174 DECLARE_ASN1_FUNCTIONS(MASKED_GOST_KEY)
176 /*============== Message digest and cipher related structures ==========*/
178 * Structure used as EVP_MD_CTX-md_data. It allows to avoid storing
179 * in the md-data pointers to dynamically allocated memory. I
180 * cannot invent better way to avoid memory leaks, because openssl
181 * insist on invoking Init on Final-ed digests, and there is no
182 * reliable way to find out whether pointer in the passed md_data is
185 struct ossl_gost_digest_ctx {
189 /* EVP_MD structure for GOST R 34.11 */
190 EVP_MD *digest_gost(void);
191 void digest_gost_destroy(void);
192 /* EVP MD structure for GOST R 34.11-2012 algorithms */
193 EVP_MD *digest_gost2012_256(void);
194 EVP_MD *digest_gost2012_512(void);
195 void digest_gost2012_256_destroy(void);
196 void digest_gost2012_512_destroy(void);
197 /* EVP_MD structure for GOST 28147 in MAC mode */
198 EVP_MD *imit_gost_cpa(void);
199 void imit_gost_cpa_destroy(void);
200 EVP_MD *imit_gost_cp_12(void);
201 void imit_gost_cp_12_destroy(void);
202 EVP_MD *magma_omac(void);
203 void magma_omac_destroy(void);
204 EVP_MD *grasshopper_omac(void);
205 EVP_MD *grasshopper_omac_acpkm(void);
206 void grasshopper_omac_destroy(void);
207 void grasshopper_omac_acpkm_destroy(void);
208 /* Cipher context used for EVP_CIPHER operation */
209 struct ossl_gost_cipher_ctx {
215 /* Structure to map parameter NID to S-block */
216 struct gost_cipher_info {
218 gost_subst_block *sblock;
221 /* Context for MAC */
222 struct ossl_gost_imit_ctx {
224 unsigned char buffer[8];
225 unsigned char partial_block[8];
232 /* Table which maps parameter NID to S-blocks */
233 extern struct gost_cipher_info gost_cipher_list[];
234 /* Find encryption params from ASN1_OBJECT */
235 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
236 /* Implementation of GOST 28147-89 cipher in CFB and CNT modes */
237 const EVP_CIPHER *cipher_gost();
238 const EVP_CIPHER *cipher_gost_cbc();
239 const EVP_CIPHER *cipher_gost_cpacnt();
240 const EVP_CIPHER *cipher_gost_cpcnt_12();
241 const EVP_CIPHER *cipher_magma_cbc();
242 const EVP_CIPHER *cipher_magma_ctr();
243 const EVP_CIPHER *cipher_magma_wrap();
244 const EVP_CIPHER *cipher_kuznyechik_wrap();
245 void cipher_gost_destroy();
246 void wrap_ciphers_destroy();
248 void inc_counter(unsigned char *counter, size_t counter_bytes);
250 # define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
251 # define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
252 /* EVP_PKEY_METHOD key encryption callbacks */
253 /* From gost_ec_keyx.c */
254 int pkey_gost_encrypt(EVP_PKEY_CTX *pctx, unsigned char *out,
255 size_t *out_len, const unsigned char *key,
258 int pkey_gost_decrypt(EVP_PKEY_CTX *pctx, unsigned char *key,
259 size_t *key_len, const unsigned char *in,
261 /* derive functions */
262 /* From gost_ec_keyx.c */
263 int pkey_gost_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
264 int fill_GOST_EC_params(EC_KEY *eckey, int nid);
265 int gost_ec_keygen(EC_KEY *ec);
267 ECDSA_SIG *gost_ec_sign(const unsigned char *dgst, int dlen, EC_KEY *eckey);
268 int gost_ec_verify(const unsigned char *dgst, int dgst_len,
269 ECDSA_SIG *sig, EC_KEY *ec);
270 int gost_ec_compute_public(EC_KEY *ec);
273 int VKO_compute_key(unsigned char *shared_key,
274 const EC_POINT *pub_key, const EC_KEY *priv_key,
275 const unsigned char *ukm, const size_t ukm_size,
276 const int vko_dgst_nid);
279 int gost_kdftree2012_256(unsigned char *keyout, size_t keyout_len,
280 const unsigned char *key, size_t keylen,
281 const unsigned char *label, size_t label_len,
282 const unsigned char *seed, size_t seed_len,
283 const size_t representation);
285 int gost_tlstree(int cipher_nid, const unsigned char *in, unsigned char *out,
286 const unsigned char *tlsseq);
288 int gost_kexp15(const unsigned char *shared_key, const int shared_len,
289 int cipher_nid, const unsigned char *cipher_key,
290 int mac_nid, unsigned char *mac_key,
291 const unsigned char *iv, const size_t ivlen,
292 unsigned char *out, int *out_len);
293 int gost_kimp15(const unsigned char *expkey, const size_t expkeylen,
294 int cipher_nid, const unsigned char *cipher_key,
295 int mac_nid, unsigned char *mac_key,
296 const unsigned char *iv, const size_t ivlen,
297 unsigned char *shared_key);
298 /*============== miscellaneous functions============================= */
300 * Store bignum in byte array of given length, prepending by zeros if
303 int store_bignum(const BIGNUM *bn, unsigned char *buf, int len);
304 /* Pack GOST R 34.10 signature according to CryptoPro rules */
305 int pack_sign_cp(ECDSA_SIG *s, int order, unsigned char *sig, size_t *siglen);
307 /* Get private key as BIGNUM from both 34.10-2001 keys*/
308 /* Returns pointer into EVP_PKEY structure */
309 BIGNUM *gost_get0_priv_key(const EVP_PKEY *pkey);