81fecd38a29bf3df6f685739e0bf1a51420eaf16
[openssl.git] / engines / ccgost / gost_lcl.h
1 #ifndef GOST_TOOLS_H
2 #define GOST_TOOLS_H
3 /**********************************************************************
4  *                        gost_lcl.h                                  *
5  *             Copyright (c) 2006 Cryptocom LTD                       *
6  *       This file is distributed under the same license as OpenSSL   *
7  *                                                                    *
8  *         Internal declarations  used in GOST engine                *
9  *         OpenSSL 0.9.9 libraries required to compile and use        *
10  *                              this code                             *
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>
19 #include "gost89.h"
20 #include "gosthash.h"
21 /* Control commands */
22 #define GOST_PARAM_CRYPT_PARAMS 0
23 #define GOST_PARAM_MAX 0
24 #define GOST_CTRL_CRYPT_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_CRYPT_PARAMS)
25
26         extern const ENGINE_CMD_DEFN gost_cmds[];
27         int gost_control_func(ENGINE *e,int cmd, long i, void *p, void (*f)(void));
28         const char *get_gost_engine_param(int param);   
29         int gost_set_default_param(int param, const char *value); 
30         void gost_param_free(void);
31
32 /* method registration */
33
34         int register_ameth_gost (int nid, EVP_PKEY_ASN1_METHOD **ameth, const char* pemstr, const char* info);
35         int register_pmeth_gost (int id, EVP_PKEY_METHOD **pmeth, int flags);
36
37 /* Gost-specific pmeth control-function parameters */
38 /* For GOST R34.10 parameters */
39 #define param_ctrl_string "paramset"
40 #define EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
41 /* For GOST 28147 MAC */
42 #define key_ctrl_string "key"
43 #define hexkey_ctrl_string "hexkey"
44 #define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
45 /* Pmeth internal representation */
46         struct gost_pmeth_data {
47             int sign_param_nid; /* Should be set whenever parameters are filled */
48                 EVP_MD *md;
49                 unsigned char *shared_ukm;
50         };
51
52         struct gost_mac_pmeth_data {
53                 int key_set;
54                 EVP_MD *md;
55                 unsigned char key[32];
56         }       ;
57 /* GOST-specific ASN1 structures */
58
59
60 typedef struct {
61         ASN1_OCTET_STRING *encrypted_key;
62         ASN1_OCTET_STRING *imit;
63 } GOST_KEY_INFO;
64
65 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
66
67 typedef struct {
68         ASN1_OBJECT *cipher;
69         X509_PUBKEY *ephem_key;
70         ASN1_OCTET_STRING *eph_iv;
71 } GOST_KEY_AGREEMENT_INFO;
72
73 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
74         
75 typedef struct {
76         GOST_KEY_INFO *key_info;
77         GOST_KEY_AGREEMENT_INFO *key_agreement_info;
78 } GOST_KEY_TRANSPORT;
79
80 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
81
82 typedef struct { /* FIXME incomplete */
83         GOST_KEY_TRANSPORT *gkt;
84 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
85
86 /* Hacks to shorten symbols to 31 characters or less, or OpenVMS.
87    This mimics what's done in symhacks.h, but since this is a very
88    local header file, I prefered to put this hack directly here.
89    -- Richard Levitte */
90 #ifdef OPENSSL_SYS_VMS
91 #undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
92 #define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it      GOST_CLIENT_KEY_EXC_PARAMS_it
93 #undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
94 #define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new     GOST_CLIENT_KEY_EXC_PARAMS_new
95 #undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
96 #define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free    GOST_CLIENT_KEY_EXC_PARAMS_free
97 #undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
98 #define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS     d2i_GOST_CLIENT_KEY_EXC_PARAMS
99 #undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
100 #define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS     i2d_GOST_CLIENT_KEY_EXC_PARAMS
101 #endif /* End of hack */
102 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
103 typedef struct {
104         ASN1_OBJECT *key_params;
105         ASN1_OBJECT *hash_params;
106         ASN1_OBJECT *cipher_params;
107 } GOST_KEY_PARAMS;
108
109 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
110
111 typedef struct {
112         ASN1_OCTET_STRING *iv;
113         ASN1_OBJECT *enc_param_set;
114 } GOST_CIPHER_PARAMS; 
115
116 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
117 /*============== Message digest  and cipher related structures  ==========*/
118          /* Structure used as EVP_MD_CTX-md_data. 
119           * It allows to avoid storing in the md-data pointers to
120           * dynamically allocated memory.
121           *
122           * I cannot invent better way to avoid memory leaks, because
123           * openssl insist on invoking Init on Final-ed digests, and there
124           * is no reliable way to find out whether pointer in the passed
125           * md_data is valid or not.
126           * */
127 struct ossl_gost_digest_ctx {
128         gost_hash_ctx dctx;
129         gost_ctx cctx;
130 };      
131 /* EVP_MD structure for GOST R 34.11 */
132 extern EVP_MD digest_gost;
133 /* EVP_MD structure for GOST 28147 in MAC mode */
134 extern EVP_MD imit_gost_cpa;
135 /* Cipher context used for EVP_CIPHER operation */
136 struct ossl_gost_cipher_ctx {
137         int paramNID;
138         off_t count;
139         int key_meshing;
140         gost_ctx cctx;
141 };      
142 /* Structure to map parameter NID to S-block */
143 struct gost_cipher_info {
144         int nid;
145         gost_subst_block *sblock;
146         int key_meshing;
147 };
148 /* Context for MAC */
149 struct ossl_gost_imit_ctx {
150         gost_ctx cctx;
151         unsigned char buffer[8];
152         unsigned char partial_block[8];
153         off_t count;
154         int key_meshing;
155         int bytes_left;
156         int key_set;
157 };      
158 /* Table which maps parameter NID to S-blocks */
159 extern struct gost_cipher_info gost_cipher_list[];
160 /* Find encryption params from ASN1_OBJECT */
161 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
162 /* Implementation of GOST 28147-89 cipher in CFB and CNT modes */
163 extern EVP_CIPHER cipher_gost;
164 extern EVP_CIPHER cipher_gost_cpacnt;
165 #define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
166 #define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
167 /* EVP_PKEY_METHOD key encryption callbacks */
168 /* From gost94_keyx.c */
169 int pkey_GOST94cp_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* key, size_t key_len );
170
171 int pkey_GOST94cp_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* in, size_t in_len );
172 /* From gost2001_keyx.c */
173 int pkey_GOST01cp_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* key, size_t key_len );
174
175 int pkey_GOST01cp_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* in, size_t in_len );
176 /* derive functions */
177 /* From gost2001_keyx.c */
178 int pkey_gost2001_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
179 /* From gost94_keyx.c */
180 int pkey_gost94_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
181 /* Internal functions for signature algorithms */
182 int fill_GOST94_params(DSA *dsa,int nid);
183 int fill_GOST2001_params(EC_KEY *eckey, int nid);
184 int gost_sign_keygen(DSA *dsa) ;
185 int gost2001_keygen(EC_KEY *ec) ;
186
187 DSA_SIG *gost_do_sign(const unsigned char *dgst,int dlen, DSA *dsa) ;
188 DSA_SIG *gost2001_do_sign(const unsigned char *dgst,int dlen, EC_KEY *eckey);
189
190 int gost_do_verify(const unsigned char *dgst, int dgst_len,
191                 DSA_SIG *sig, DSA *dsa) ;
192 int gost2001_do_verify(const unsigned char *dgst,int dgst_len,
193                         DSA_SIG *sig, EC_KEY *ec);
194 int gost2001_compute_public(EC_KEY *ec) ;
195 int gost94_compute_public(DSA *dsa) ;
196 /*============== miscellaneous functions============================= */
197 /* from gost_sign.c */
198 /* Convert GOST R 34.11 hash sum to bignum according to standard */
199 BIGNUM *hashsum2bn(const unsigned char *dgst) ;
200 /* Store bignum in byte array of given length, prepending by zeros
201  * if nesseccary */
202 int store_bignum(BIGNUM *bn, unsigned char *buf,int len);
203 /* Read bignum, which can have few MSB all-zeros    from buffer*/ 
204 BIGNUM *getbnfrombuf(const unsigned char *buf,size_t len);
205 /* Pack GOST R 34.10 signature according to CryptoPro rules */
206 int pack_sign_cp(DSA_SIG *s,int order,unsigned char *sig, size_t *siglen); 
207 /* Unpack GOST R 34.10 signature according to CryptoPro rules */
208 DSA_SIG *unpack_cp_signature(const unsigned char *sig,size_t siglen) ;
209 /* from ameth.c */
210 /* Get private key as BIGNUM from both R 34.10-94 and R 34.10-2001  keys*/
211 /* Returns pointer into EVP_PKEY structure */
212 BIGNUM* gost_get0_priv_key(const EVP_PKEY *pkey) ;
213 /* Find NID by GOST 94 parameters */
214 int gost94_nid_by_params(DSA *p) ;
215
216
217 #endif