3 /**********************************************************************
5 * Copyright (c) 2006 Cryptocom LTD *
6 * Copyright (c) 2020 Vitaly Chikunov <vt@altlinux.org> *
7 * This file is distributed under the same license as OpenSSL *
9 * Internal declarations used in GOST engine *
10 * OpenSSL 0.9.9 libraries required to compile and use *
12 **********************************************************************/
13 # include <openssl/bn.h>
14 # include <openssl/evp.h>
15 # include <openssl/asn1t.h>
16 # include <openssl/x509.h>
17 # include <openssl/engine.h>
18 # include <openssl/ec.h>
20 # include "gosthash.h"
21 /* Control commands */
22 # define GOST_PARAM_CRYPT_PARAMS 0
23 # define GOST_PARAM_PBE_PARAMS 1
24 # define GOST_PARAM_PK_FORMAT 2
25 # define GOST_PARAM_MAX 3
26 # define GOST_CTRL_CRYPT_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_CRYPT_PARAMS)
27 # define GOST_CTRL_PBE_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_PBE_PARAMS)
28 # define GOST_CTRL_PK_FORMAT (ENGINE_CMD_BASE+GOST_PARAM_PK_FORMAT)
30 typedef struct R3410_ec {
42 extern R3410_ec_params R3410_2001_paramset[],
43 *R3410_2012_256_paramset, R3410_2012_512_paramset[];
45 void free_cached_groups(void);
47 extern const ENGINE_CMD_DEFN gost_cmds[];
48 int gost_control_func(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
49 const char *get_gost_engine_param(int param);
50 int gost_set_default_param(int param, const char *value);
51 void gost_param_free(void);
53 /* method registration */
55 int register_ameth_gost(int nid, EVP_PKEY_ASN1_METHOD **ameth,
56 const char *pemstr, const char *info);
57 int register_pmeth_gost(int id, EVP_PKEY_METHOD **pmeth, int flags);
59 /* Gost-specific pmeth control-function parameters */
60 /* For GOST R34.10 parameters */
61 # define param_ctrl_string "paramset"
62 # define ukm_ctrl_string "ukmhex"
63 # define vko_ctrl_string "vko"
64 # define EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
65 /* For GOST 28147 MAC */
66 # define key_ctrl_string "key"
67 # define hexkey_ctrl_string "hexkey"
68 # define maclen_ctrl_string "size"
69 # define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
70 # define EVP_PKEY_CTRL_MAC_LEN (EVP_PKEY_ALG_CTRL+5)
71 # define EVP_PKEY_CTRL_SET_VKO (EVP_PKEY_ALG_CTRL+11)
72 /* Pmeth internal representation */
73 struct gost_pmeth_data {
74 int sign_param_nid; /* Should be set whenever parameters are
77 unsigned char shared_ukm[32];
78 size_t shared_ukm_size;
80 int cipher_nid; /* KExp15/KImp15 algs */
84 struct gost_mac_pmeth_data {
89 unsigned char key[32];
94 unsigned char key[32];
97 /* GOST-specific ASN1 structures */
100 ASN1_OCTET_STRING *encrypted_key;
101 ASN1_OCTET_STRING *imit;
104 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
108 X509_PUBKEY *ephem_key;
109 ASN1_OCTET_STRING *eph_iv;
110 } GOST_KEY_AGREEMENT_INFO;
112 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
115 GOST_KEY_INFO *key_info;
116 GOST_KEY_AGREEMENT_INFO *key_agreement_info;
117 } GOST_KEY_TRANSPORT;
119 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
121 typedef struct { /* FIXME incomplete */
122 GOST_KEY_TRANSPORT *gkt;
123 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
125 /* PSKeyTransport ::= SEQUENCE {
127 ephemeralPublicKey SubjectPublicKeyInfo
129 SubjectPublicKeyInfo ::= SEQUENCE {
130 algorithm AlgorithmIdentifier,
131 subjectPublicKey BITSTRING
133 AlgorithmIdentifier ::= SEQUENCE {
134 algorithm OBJECT IDENTIFIER,
135 parameters ANY OPTIONAL
137 typedef struct PSKeyTransport_st {
138 ASN1_OCTET_STRING *psexp;
139 X509_PUBKEY *ephem_key;
140 ASN1_OCTET_STRING *ukm;
141 } PSKeyTransport_gost;
143 DECLARE_ASN1_FUNCTIONS(PSKeyTransport_gost)
145 * Hacks to shorten symbols to 31 characters or less, or OpenVMS. This mimics
146 * what's done in symhacks.h, but since this is a very local header file, I
147 * prefered to put this hack directly here. -- Richard Levitte
149 # ifdef OPENSSL_SYS_VMS
150 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
151 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it GOST_CLIENT_KEY_EXC_PARAMS_it
152 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
153 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new GOST_CLIENT_KEY_EXC_PARAMS_new
154 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
155 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free GOST_CLIENT_KEY_EXC_PARAMS_free
156 # undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
157 # define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS d2i_GOST_CLIENT_KEY_EXC_PARAMS
158 # undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
159 # define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS i2d_GOST_CLIENT_KEY_EXC_PARAMS
160 # endif /* End of hack */
161 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
163 ASN1_OBJECT *key_params;
164 ASN1_OBJECT *hash_params;
165 ASN1_OBJECT *cipher_params;
168 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
171 ASN1_OCTET_STRING *iv;
172 ASN1_OBJECT *enc_param_set;
173 } GOST_CIPHER_PARAMS;
175 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
178 ASN1_OCTET_STRING *ukm;
179 } GOST2015_CIPHER_PARAMS;
181 DECLARE_ASN1_FUNCTIONS(GOST2015_CIPHER_PARAMS)
184 ASN1_OCTET_STRING *masked_priv_key;
185 ASN1_OCTET_STRING *public_key;
188 DECLARE_ASN1_FUNCTIONS(MASKED_GOST_KEY)
190 /*============== Message digest and cipher related structures ==========*/
192 * Structure used as EVP_MD_CTX-md_data. It allows to avoid storing
193 * in the md-data pointers to dynamically allocated memory. I
194 * cannot invent better way to avoid memory leaks, because openssl
195 * insist on invoking Init on Final-ed digests, and there is no
196 * reliable way to find out whether pointer in the passed md_data is
199 struct ossl_gost_digest_ctx {
203 /* Cipher context used for EVP_CIPHER operation */
204 struct ossl_gost_cipher_ctx {
208 unsigned char kdf_seed[8];
209 unsigned char tag[8];
211 EVP_MD_CTX *omac_ctx;
213 /* Structure to map parameter NID to S-block */
214 struct gost_cipher_info {
216 gost_subst_block *sblock;
219 /* Context for MAC */
220 struct ossl_gost_imit_ctx {
222 unsigned char buffer[8];
223 unsigned char partial_block[8];
230 /* Find encryption params from ASN1_OBJECT */
231 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
233 void inc_counter(unsigned char *counter, size_t counter_bytes);
235 # define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
236 # define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
237 /* EVP_PKEY_METHOD key encryption callbacks */
238 /* From gost_ec_keyx.c */
239 int pkey_gost_encrypt(EVP_PKEY_CTX *pctx, unsigned char *out,
240 size_t *out_len, const unsigned char *key,
243 int pkey_gost_decrypt(EVP_PKEY_CTX *pctx, unsigned char *key,
244 size_t *key_len, const unsigned char *in,
246 /* derive functions */
247 /* From gost_ec_keyx.c */
248 int pkey_gost_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
249 int fill_GOST_EC_params(EC_KEY *eckey, int nid);
250 int gost_ec_keygen(EC_KEY *ec);
252 ECDSA_SIG *gost_ec_sign(const unsigned char *dgst, int dlen, EC_KEY *eckey);
253 int gost_ec_verify(const unsigned char *dgst, int dgst_len,
254 ECDSA_SIG *sig, EC_KEY *ec);
255 int gost_ec_compute_public(EC_KEY *ec);
256 int gost_ec_point_mul(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n,
257 const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);
259 #define CURVEDEF(a) \
260 int point_mul_##a(const EC_GROUP *group, EC_POINT *r, const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);\
261 int point_mul_g_##a(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, BN_CTX *ctx);\
262 int point_mul_two_##a(const EC_GROUP *group, EC_POINT *r, const BIGNUM *n, const EC_POINT *q, const BIGNUM *m, BN_CTX *ctx);
264 CURVEDEF(id_GostR3410_2001_CryptoPro_A_ParamSet)
265 CURVEDEF(id_GostR3410_2001_CryptoPro_B_ParamSet)
266 CURVEDEF(id_GostR3410_2001_CryptoPro_C_ParamSet)
267 CURVEDEF(id_GostR3410_2001_TestParamSet)
268 CURVEDEF(id_tc26_gost_3410_2012_256_paramSetA)
269 CURVEDEF(id_tc26_gost_3410_2012_512_paramSetA)
270 CURVEDEF(id_tc26_gost_3410_2012_512_paramSetB)
271 CURVEDEF(id_tc26_gost_3410_2012_512_paramSetC)
274 int VKO_compute_key(unsigned char *shared_key,
275 const EC_POINT *pub_key, const EC_KEY *priv_key,
276 const unsigned char *ukm, const size_t ukm_size,
277 const int vko_dgst_nid);
280 int gost_kdftree2012_256(unsigned char *keyout, size_t keyout_len,
281 const unsigned char *key, size_t keylen,
282 const unsigned char *label, size_t label_len,
283 const unsigned char *seed, size_t seed_len,
284 const size_t representation);
286 int gost_tlstree(int cipher_nid, const unsigned char *in, unsigned char *out,
287 const unsigned char *tlsseq);
289 int gost_kexp15(const unsigned char *shared_key, const int shared_len,
290 int cipher_nid, const unsigned char *cipher_key,
291 int mac_nid, unsigned char *mac_key,
292 const unsigned char *iv, const size_t ivlen,
293 unsigned char *out, int *out_len);
294 int gost_kimp15(const unsigned char *expkey, const size_t expkeylen,
295 int cipher_nid, const unsigned char *cipher_key,
296 int mac_nid, unsigned char *mac_key,
297 const unsigned char *iv, const size_t ivlen,
298 unsigned char *shared_key);
299 /*============== miscellaneous functions============================= */
301 * Store bignum in byte array of given length, prepending by zeros if
304 int store_bignum(const BIGNUM *bn, unsigned char *buf, int len);
305 /* Pack GOST R 34.10 signature according to CryptoPro rules */
306 int pack_sign_cp(ECDSA_SIG *s, int order, unsigned char *sig, size_t *siglen);
308 /* Get private key as BIGNUM from both 34.10-2001 keys*/
309 /* Returns pointer into EVP_PKEY structure */
310 BIGNUM *gost_get0_priv_key(const EVP_PKEY *pkey);
311 /* from gost_crypt.c */
312 /* Decrements 8-byte sequence */
313 int decrement_sequence(unsigned char *seq, int decrement);
315 /* Struct describing cipher and used for init/deinit.*/
316 struct gost_cipher_st {
317 struct gost_cipher_st *template; /* template struct */
320 int block_size; /* (bytes) */
321 int key_len; /* (bytes) */
324 int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
325 const unsigned char *iv, int enc);
326 int (*do_cipher)(EVP_CIPHER_CTX *ctx, unsigned char *out,
327 const unsigned char *in, size_t inl);
328 int (*cleanup)(EVP_CIPHER_CTX *);
330 int (*set_asn1_parameters)(EVP_CIPHER_CTX *, ASN1_TYPE *);
331 int (*get_asn1_parameters)(EVP_CIPHER_CTX *, ASN1_TYPE *);
332 int (*ctrl)(EVP_CIPHER_CTX *, int type, int arg, void *ptr);
334 typedef struct gost_cipher_st GOST_cipher;
336 EVP_CIPHER *GOST_init_cipher(GOST_cipher *c);
337 void GOST_deinit_cipher(GOST_cipher *c);
339 extern GOST_cipher Gost28147_89_cipher;
340 extern GOST_cipher Gost28147_89_cbc_cipher;
341 extern GOST_cipher Gost28147_89_cnt_cipher;
342 extern GOST_cipher Gost28147_89_cnt_12_cipher;
343 extern GOST_cipher magma_ctr_cipher;
344 extern GOST_cipher magma_ctr_acpkm_cipher;
345 extern GOST_cipher magma_ctr_acpkm_omac_cipher;
346 extern GOST_cipher magma_cbc_cipher;
347 extern GOST_cipher grasshopper_ecb_cipher;
348 extern GOST_cipher grasshopper_cbc_cipher;
349 extern GOST_cipher grasshopper_cfb_cipher;
350 extern GOST_cipher grasshopper_ofb_cipher;
351 extern GOST_cipher grasshopper_ctr_cipher;
352 extern GOST_cipher grasshopper_ctr_acpkm_cipher;
353 extern GOST_cipher grasshopper_ctr_acpkm_omac_cipher;
354 extern GOST_cipher magma_kexp15_cipher;
355 extern GOST_cipher kuznyechik_kexp15_cipher;
357 struct gost_digest_st {
358 struct gost_digest_st *template;
366 int (*init)(EVP_MD_CTX *ctx);
367 int (*update)(EVP_MD_CTX *ctx, const void *data, size_t count);
368 int (*final)(EVP_MD_CTX *ctx, unsigned char *md);
369 int (*copy)(EVP_MD_CTX *to, const EVP_MD_CTX *from);
370 int (*cleanup)(EVP_MD_CTX *ctx);
371 int (*ctrl)(EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
373 typedef struct gost_digest_st GOST_digest;
375 EVP_MD *GOST_init_digest(GOST_digest *d);
376 void GOST_deinit_digest(GOST_digest *d);
378 extern GOST_digest GostR3411_94_digest;
379 extern GOST_digest Gost28147_89_MAC_digest;
380 extern GOST_digest Gost28147_89_mac_12_digest;
381 extern GOST_digest GostR3411_2012_256_digest;
382 extern GOST_digest GostR3411_2012_512_digest;
383 extern GOST_digest magma_mac_digest;
384 extern GOST_digest grasshopper_mac_digest;
385 extern GOST_digest kuznyechik_ctracpkm_omac_digest;
388 /* vim: set expandtab cinoptions=\:0,l1,t0,g0,(0 sw=4 : */