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