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