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