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_MAX 1
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)
28 typedef struct R3410_ec {
38 extern R3410_ec_params R3410_2001_paramset[],
39 *R3410_2012_256_paramset,
40 R3410_2012_512_paramset[];
42 extern const ENGINE_CMD_DEFN gost_cmds[];
43 int gost_control_func(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
44 const char *get_gost_engine_param(int param);
45 int gost_set_default_param(int param, const char *value);
46 void gost_param_free(void);
48 /* method registration */
50 int register_ameth_gost(int nid, EVP_PKEY_ASN1_METHOD **ameth,
51 const char *pemstr, const char *info);
52 int register_pmeth_gost(int id, EVP_PKEY_METHOD **pmeth, int flags);
54 /* Gost-specific pmeth control-function parameters */
55 /* For GOST R34.10 parameters */
56 # define param_ctrl_string "paramset"
57 # define EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
58 /* For GOST 28147 MAC */
59 # define key_ctrl_string "key"
60 # define hexkey_ctrl_string "hexkey"
61 # define maclen_ctrl_string "size"
62 # define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
63 # define EVP_PKEY_CTRL_MAC_LEN (EVP_PKEY_ALG_CTRL+5)
64 /* Pmeth internal representation */
65 struct gost_pmeth_data {
66 int sign_param_nid; /* Should be set whenever parameters are
69 unsigned char *shared_ukm;
73 struct gost_mac_pmeth_data {
77 unsigned char key[32];
79 /* GOST-specific ASN1 structures */
82 ASN1_OCTET_STRING *encrypted_key;
83 ASN1_OCTET_STRING *imit;
86 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
90 X509_PUBKEY *ephem_key;
91 ASN1_OCTET_STRING *eph_iv;
92 } GOST_KEY_AGREEMENT_INFO;
94 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
97 GOST_KEY_INFO *key_info;
98 GOST_KEY_AGREEMENT_INFO *key_agreement_info;
101 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
103 typedef struct { /* FIXME incomplete */
104 GOST_KEY_TRANSPORT *gkt;
105 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
108 * Hacks to shorten symbols to 31 characters or less, or OpenVMS. This mimics
109 * what's done in symhacks.h, but since this is a very local header file, I
110 * prefered to put this hack directly here. -- Richard Levitte
112 # ifdef OPENSSL_SYS_VMS
113 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
114 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it GOST_CLIENT_KEY_EXC_PARAMS_it
115 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
116 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new GOST_CLIENT_KEY_EXC_PARAMS_new
117 # undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
118 # define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free GOST_CLIENT_KEY_EXC_PARAMS_free
119 # undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
120 # define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS d2i_GOST_CLIENT_KEY_EXC_PARAMS
121 # undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
122 # define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS i2d_GOST_CLIENT_KEY_EXC_PARAMS
123 # endif /* End of hack */
124 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
126 ASN1_OBJECT *key_params;
127 ASN1_OBJECT *hash_params;
128 ASN1_OBJECT *cipher_params;
131 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
134 ASN1_OCTET_STRING *iv;
135 ASN1_OBJECT *enc_param_set;
136 } GOST_CIPHER_PARAMS;
138 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
141 ASN1_OCTET_STRING *masked_priv_key;
142 ASN1_OCTET_STRING *public_key;
145 DECLARE_ASN1_FUNCTIONS(MASKED_GOST_KEY)
147 /*============== Message digest and cipher related structures ==========*/
149 * Structure used as EVP_MD_CTX-md_data. It allows to avoid storing
150 * in the md-data pointers to dynamically allocated memory. I
151 * cannot invent better way to avoid memory leaks, because openssl
152 * insist on invoking Init on Final-ed digests, and there is no
153 * reliable way to find out whether pointer in the passed md_data is
156 struct ossl_gost_digest_ctx {
160 /* EVP_MD structure for GOST R 34.11 */
161 extern EVP_MD digest_gost;
162 /* EVP MD structure for GOST R 34.11-2012 algorithms */
163 extern EVP_MD digest_gost2012_256;
164 extern EVP_MD digest_gost2012_512;
165 /* EVP_MD structure for GOST 28147 in MAC mode */
166 extern EVP_MD imit_gost_cpa;
167 extern EVP_MD imit_gost_cp_12;
168 /* Cipher context used for EVP_CIPHER operation */
169 struct ossl_gost_cipher_ctx {
175 /* Structure to map parameter NID to S-block */
176 struct gost_cipher_info {
178 gost_subst_block *sblock;
181 /* Context for MAC */
182 struct ossl_gost_imit_ctx {
184 unsigned char buffer[8];
185 unsigned char partial_block[8];
192 /* Table which maps parameter NID to S-blocks */
193 extern struct gost_cipher_info gost_cipher_list[];
194 /* Find encryption params from ASN1_OBJECT */
195 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
196 /* Implementation of GOST 28147-89 cipher in CFB and CNT modes */
197 extern EVP_CIPHER cipher_gost;
198 extern EVP_CIPHER cipher_gost_cbc;
199 extern EVP_CIPHER cipher_gost_cpacnt;
200 extern EVP_CIPHER cipher_gost_cpcnt_12;
201 # define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
202 # define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
203 # define EVP_MD_CTRL_MAC_LEN (EVP_MD_CTRL_ALG_CTRL+5)
204 /* EVP_PKEY_METHOD key encryption callbacks */
205 /* From gost_ec_keyx.c */
206 int pkey_GOST_ECcp_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out,
207 size_t *outlen, const unsigned char *key,
210 int pkey_GOST_ECcp_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out,
211 size_t *outlen, const unsigned char *in,
213 /* derive functions */
214 /* From gost_ec_keyx.c */
215 int pkey_gost_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key,
217 int fill_GOST_EC_params(EC_KEY *eckey, int nid);
218 int gost_sign_keygen(DSA *dsa);
219 int gost_ec_keygen(EC_KEY *ec);
221 DSA_SIG *gost_ec_sign(const unsigned char *dgst, int dlen, EC_KEY *eckey);
223 int gost_do_verify(const unsigned char *dgst, int dgst_len,
224 DSA_SIG *sig, DSA *dsa);
225 int gost_ec_verify(const unsigned char *dgst, int dgst_len,
226 DSA_SIG *sig, EC_KEY *ec);
227 int gost_ec_compute_public(EC_KEY *ec);
228 /*============== miscellaneous functions============================= */
229 /* from gost_sign.c */
230 /* Convert GOST R 34.11 hash sum to bignum according to standard */
231 BIGNUM *hashsum2bn(const unsigned char *dgst, int len);
233 * Store bignum in byte array of given length, prepending by zeros if
236 int store_bignum(BIGNUM *bn, unsigned char *buf, int len);
237 /* Read bignum, which can have few MSB all-zeros from buffer*/
238 BIGNUM *getbnfrombuf(const unsigned char *buf, size_t len);
239 /* Pack GOST R 34.10 signature according to CryptoPro rules */
240 int pack_sign_cp(DSA_SIG *s, int order, unsigned char *sig, size_t *siglen);
242 /* Get private key as BIGNUM from both 34.10-2001 keys*/
243 /* Returns pointer into EVP_PKEY structure */
244 BIGNUM *gost_get0_priv_key(const EVP_PKEY *pkey);