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/dsa.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 2
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 {
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 EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
59 /* For GOST 28147 MAC */
60 # define key_ctrl_string "key"
61 # define hexkey_ctrl_string "hexkey"
62 # define maclen_ctrl_string "size"
63 # define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
64 # define EVP_PKEY_CTRL_MAC_LEN (EVP_PKEY_ALG_CTRL+5)
65 /* Pmeth internal representation */
66 struct gost_pmeth_data {
67 int sign_param_nid; /* Should be set whenever parameters are
70 unsigned char *shared_ukm;
74 struct gost_mac_pmeth_data {
79 unsigned char key[32];
84 unsigned char key[32];
87 /* GOST-specific ASN1 structures */
90 ASN1_OCTET_STRING *encrypted_key;
91 ASN1_OCTET_STRING *imit;
94 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
98 X509_PUBKEY *ephem_key;
99 ASN1_OCTET_STRING *eph_iv;
100 } GOST_KEY_AGREEMENT_INFO;
102 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
105 GOST_KEY_INFO *key_info;
106 GOST_KEY_AGREEMENT_INFO *key_agreement_info;
107 } GOST_KEY_TRANSPORT;
109 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
111 typedef struct { /* FIXME incomplete */
112 GOST_KEY_TRANSPORT *gkt;
113 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
116 * Hacks to shorten symbols to 31 characters or less, or OpenVMS. This mimics
117 * what's done in symhacks.h, but since this is a very local header file, I
118 * prefered to put this hack directly here. -- Richard Levitte
120 # ifdef OPENSSL_SYS_VMS
121 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
122 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it GOST_CLIENT_KEY_EXC_PARAMS_it
123 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
124 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new GOST_CLIENT_KEY_EXC_PARAMS_new
125 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
126 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free GOST_CLIENT_KEY_EXC_PARAMS_free
127 # undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
128 # define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS d2i_GOST_CLIENT_KEY_EXC_PARAMS
129 # undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
130 # define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS i2d_GOST_CLIENT_KEY_EXC_PARAMS
131 # endif /* End of hack */
132 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
134 ASN1_OBJECT *key_params;
135 ASN1_OBJECT *hash_params;
136 ASN1_OBJECT *cipher_params;
139 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
142 ASN1_OCTET_STRING *iv;
143 ASN1_OBJECT *enc_param_set;
144 } GOST_CIPHER_PARAMS;
146 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
149 ASN1_OCTET_STRING *masked_priv_key;
150 ASN1_OCTET_STRING *public_key;
153 DECLARE_ASN1_FUNCTIONS(MASKED_GOST_KEY)
155 /*============== Message digest and cipher related structures ==========*/
157 * Structure used as EVP_MD_CTX-md_data. It allows to avoid storing
158 * in the md-data pointers to dynamically allocated memory. I
159 * cannot invent better way to avoid memory leaks, because openssl
160 * insist on invoking Init on Final-ed digests, and there is no
161 * reliable way to find out whether pointer in the passed md_data is
164 struct ossl_gost_digest_ctx {
168 /* EVP_MD structure for GOST R 34.11 */
169 EVP_MD *digest_gost(void);
170 void digest_gost_destroy(void);
171 /* EVP MD structure for GOST R 34.11-2012 algorithms */
172 EVP_MD *digest_gost2012_256(void);
173 EVP_MD *digest_gost2012_512(void);
174 void digest_gost2012_256_destroy(void);
175 void digest_gost2012_512_destroy(void);
176 /* EVP_MD structure for GOST 28147 in MAC mode */
177 EVP_MD *imit_gost_cpa(void);
178 void imit_gost_cpa_destroy(void);
179 EVP_MD *imit_gost_cp_12(void);
180 void imit_gost_cp_12_destroy(void);
181 EVP_MD *magma_omac(void);
182 void magma_omac_destroy(void);
183 EVP_MD *grasshopper_omac(void);
184 void grasshopper_omac_destroy(void);
185 /* Cipher context used for EVP_CIPHER operation */
186 struct ossl_gost_cipher_ctx {
192 /* Structure to map parameter NID to S-block */
193 struct gost_cipher_info {
195 gost_subst_block *sblock;
198 /* Context for MAC */
199 struct ossl_gost_imit_ctx {
201 unsigned char buffer[8];
202 unsigned char partial_block[8];
209 /* Table which maps parameter NID to S-blocks */
210 extern struct gost_cipher_info gost_cipher_list[];
211 /* Find encryption params from ASN1_OBJECT */
212 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
213 /* Implementation of GOST 28147-89 cipher in CFB and CNT modes */
214 const EVP_CIPHER *cipher_gost();
215 const EVP_CIPHER *cipher_gost_cbc();
216 const EVP_CIPHER *cipher_gost_cpacnt();
217 const EVP_CIPHER *cipher_gost_cpcnt_12();
218 const EVP_CIPHER *cipher_magma_cbc();
219 const EVP_CIPHER *cipher_magma_ctr();
220 void cipher_gost_destroy();
222 void inc_counter(unsigned char* buffer, size_t buf_len);
224 # define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
225 # define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
226 # define EVP_MD_CTRL_MAC_LEN (EVP_MD_CTRL_ALG_CTRL+5)
227 /* EVP_PKEY_METHOD key encryption callbacks */
228 /* From gost_ec_keyx.c */
229 int pkey_GOST_ECcp_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out,
230 size_t *outlen, const unsigned char *key,
233 int pkey_GOST_ECcp_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out,
234 size_t *outlen, const unsigned char *in,
236 /* derive functions */
237 /* From gost_ec_keyx.c */
238 int pkey_gost_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
240 int fill_GOST_EC_params(EC_KEY *eckey, int nid);
241 int gost_sign_keygen(DSA *dsa);
242 int gost_ec_keygen(EC_KEY *ec);
244 DSA_SIG *gost_ec_sign(const unsigned char *dgst, int dlen, EC_KEY *eckey);
246 int gost_do_verify(const unsigned char *dgst, int dgst_len,
247 DSA_SIG *sig, DSA *dsa);
248 int gost_ec_verify(const unsigned char *dgst, int dgst_len,
249 DSA_SIG *sig, EC_KEY *ec);
250 int gost_ec_compute_public(EC_KEY *ec);
251 /*============== miscellaneous functions============================= */
252 /* from gost_sign.c */
253 /* Convert GOST R 34.11 hash sum to bignum according to standard */
254 BIGNUM *hashsum2bn(const unsigned char *dgst, int len);
256 * Store bignum in byte array of given length, prepending by zeros if
259 int store_bignum(const BIGNUM *bn, unsigned char *buf, int len);
260 /* Pack GOST R 34.10 signature according to CryptoPro rules */
261 int pack_sign_cp(DSA_SIG *s, int order, unsigned char *sig, size_t *siglen);
263 /* Get private key as BIGNUM from both 34.10-2001 keys*/
264 /* Returns pointer into EVP_PKEY structure */
265 BIGNUM *gost_get0_priv_key(const EVP_PKEY *pkey);