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