8026a2de9ef3b10b3083b33648cd13ead1e598dc
[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 <unistd.h>
20 #include "gost89.h"
21 #include "gosthash.h"
22 /* Control commands */
23 #define GOST_PARAM_CRYPT_PARAMS 0
24 #define GOST_PARAM_MAX 0
25 #define GOST_CTRL_CRYPT_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_CRYPT_PARAMS)
26
27         extern const ENGINE_CMD_DEFN gost_cmds[];
28         int gost_control_func(ENGINE *e,int cmd, long i, void *p, void (*f)(void));
29         const char *get_gost_engine_param(int param);   
30         int gost_set_default_param(int param, const char *value); 
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_PKEY *eph_seckey;
49                 EVP_MD *md;
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 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
87 typedef struct {
88         ASN1_OBJECT *key_params;
89         ASN1_OBJECT *hash_params;
90         ASN1_OBJECT *cipher_params;
91 } GOST_KEY_PARAMS;
92
93 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
94
95 typedef struct {
96         ASN1_OCTET_STRING *iv;
97         ASN1_OBJECT *enc_param_set;
98 } GOST_CIPHER_PARAMS; 
99
100 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
101 /*============== Message digest  and cipher related structures  ==========*/
102          /* Structure used as EVP_MD_CTX-md_data. 
103           * It allows to avoid storing in the md-data pointers to
104           * dynamically allocated memory.
105           *
106           * I cannot invent better way to avoid memory leaks, because
107           * openssl insist on invoking Init on Final-ed digests, and there
108           * is no reliable way to find out whether pointer in the passed
109           * md_data is valid or not.
110           * */
111 struct ossl_gost_digest_ctx {
112         gost_hash_ctx dctx;
113         gost_ctx cctx;
114 };      
115 /* EVP_MD structure for GOST R 34.11 */
116 extern EVP_MD digest_gost;
117 /* EVP_MD structure for GOST 28147 in MAC mode */
118 extern EVP_MD imit_gost_cpa;
119 /* Cipher context used for EVP_CIPHER operation */
120 struct ossl_gost_cipher_ctx {
121         int paramNID;
122         off_t count;
123         int key_meshing;
124         gost_ctx cctx;
125 };      
126 /* Structure to map parameter NID to S-block */
127 struct gost_cipher_info {
128         int nid;
129         gost_subst_block *sblock;
130         int key_meshing;
131 };
132 /* Context for MAC */
133 struct ossl_gost_imit_ctx {
134         gost_ctx cctx;
135         unsigned char buffer[8];
136         unsigned char partial_block[8];
137         off_t count;
138         int key_meshing;
139         int bytes_left;
140         int key_set;
141 };      
142 /* Table which maps parameter NID to S-blocks */
143 extern struct gost_cipher_info gost_cipher_list[];
144 /* Find encryption params from ASN1_OBJECT */
145 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
146 /* Implementation of GOST 28147-89 cipher in CFB and CNT modes */
147 extern EVP_CIPHER cipher_gost;
148 extern EVP_CIPHER cipher_gost_cpacnt;
149 #ifdef USE_SSL
150 #define EVP_MD_FLAG_NEEDS_KEY 0x20
151 #define EVP_MD_CTRL_GET_TLS_MAC_KEY_LENGTH (EVP_MD_CTRL_ALG_CTRL+1)
152 #define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+2)
153 /* Ciphers and MACs specific for GOST TLS draft */
154 extern EVP_CIPHER cipher_gost_vizircfb;
155 extern EVP_CIPHER cipher_gost_cpacnt;
156 extern EVP_MD imit_gost_vizir;
157 extern EVP_MD imit_gost_cpa;
158 #endif
159 #define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
160 #define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
161 /* EVP_PKEY_METHOD key encryption callbacks */
162 /* From gost94_keyx.c */
163 int pkey_GOST94cp_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* key, size_t key_len );
164 int pkey_GOST94cc_encrypt (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,  const unsigned char *   key,size_t key_len);
165
166 int pkey_GOST94cp_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* in, size_t in_len );
167 int pkey_GOST94cc_decrypt (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,  const unsigned char *   in,size_t in_len);
168 /* From gost2001_keyx.c */
169 int pkey_GOST01cp_encrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* key, size_t key_len );
170 int pkey_GOST01cc_encrypt (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen,  const unsigned char *   key,size_t key_len);
171
172 int pkey_GOST01cp_decrypt(EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char* in, size_t in_len );
173 int pkey_GOST01cc_decrypt (EVP_PKEY_CTX *ctx, unsigned char *out, size_t *outlen, const unsigned char *   in,size_t in_len);
174
175 /* Internal functions to make error processing happy */
176 int decrypt_cryptocom_key(unsigned char *sess_key,int max_key_len,
177                 const unsigned char *crypted_key,int crypted_key_len, gost_ctx *ctx);
178 int encrypt_cryptocom_key(const unsigned char *sess_key,int key_len,
179                 unsigned char *crypted_key, gost_ctx *ctx);
180 /* Internal functions for signature algorithms */
181 int fill_GOST94_params(DSA *dsa,int nid);
182 int fill_GOST2001_params(EC_KEY *eckey, int nid);
183 int gost_sign_keygen(DSA *dsa) ;
184 int gost2001_keygen(EC_KEY *ec) ;
185
186 DSA_SIG *gost_do_sign(const unsigned char *dgst,int dlen, DSA *dsa) ;
187 DSA_SIG *gost2001_do_sign(const unsigned char *dgst,int dlen, EC_KEY *eckey);
188
189 int gost_do_verify(const unsigned char *dgst, int dgst_len,
190                 DSA_SIG *sig, DSA *dsa) ;
191 int gost2001_do_verify(const unsigned char *dgst,int dgst_len,
192                         DSA_SIG *sig, EC_KEY *ec);
193 int gost2001_compute_public(EC_KEY *ec) ;
194 int gost94_compute_public(DSA *dsa) ;
195 /*============== miscellaneous functions============================= */
196 /* from gost_sign.c */
197 /* Convert GOST R 34.11 hash sum to bignum according to standard */
198 BIGNUM *hashsum2bn(const unsigned char *dgst) ;
199 /* Store bignum in byte array of given length, prepending by zeros
200  * if nesseccary */
201 int store_bignum(BIGNUM *bn, unsigned char *buf,int len);
202 /* Read bignum, which can have few MSB all-zeros    from buffer*/ 
203 BIGNUM *getbnfrombuf(const unsigned char *buf,size_t len);
204 /* Pack GOST R 34.10 signature according to CryptoCom rules */
205 int pack_sign_cc(DSA_SIG *s,int order,unsigned char *sig, size_t *siglen);
206 /* Pack GOST R 34.10 signature according to CryptoPro rules */
207 int pack_sign_cp(DSA_SIG *s,int order,unsigned char *sig, size_t *siglen); 
208 /* Unpack GOST R 34.10 signature according to CryptoCom rules */
209 DSA_SIG *unpack_cc_signature(const unsigned char *sig,size_t siglen) ;
210 /* Unpack GOST R 34.10 signature according to CryptoPro rules */
211 DSA_SIG *unpack_cp_signature(const unsigned char *sig,size_t siglen) ;
212 /* from ameth.c */
213 /* Get private key as BIGNUM from both R 34.10-94 and R 34.10-2001  keys*/
214 BIGNUM* gost_get_priv_key(const EVP_PKEY *pkey) ;
215 /* Find NID by GOST 94 parameters */
216 int gost94_nid_by_params(DSA *p) ;
217
218
219 #endif