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/asn1t.h>
  15 # include <openssl/x509.h>
  16 # include <openssl/engine.h>
  17 # include <openssl/ec.h>
  18 # include "gost89.h"
  19 # include "gosthash.h"
  20 /* Control commands */
  21 # define GOST_PARAM_CRYPT_PARAMS 0
  22 # define GOST_PARAM_PBE_PARAMS 1
  23 # define GOST_PARAM_PK_FORMAT 2
  24 # define GOST_PARAM_MAX 3
  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 # define GOST_CTRL_PK_FORMAT   (ENGINE_CMD_BASE+GOST_PARAM_PK_FORMAT)
  28
  29 typedef struct R3410_ec {
  30     int nid;
  31     char *a;
  32     char *b;
  33     char *p;
  34     char *q;
  35     char *x;
  36     char *y;
  37     char *cofactor;
  38 } R3410_ec_params;
  39
  40 extern R3410_ec_params R3410_2001_paramset[],
  41     *R3410_2012_256_paramset, R3410_2012_512_paramset[];
  42
  43 extern const ENGINE_CMD_DEFN gost_cmds[];
  44 int gost_control_func(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
  45 const char *get_gost_engine_param(int param);
  46 int gost_set_default_param(int param, const char *value);
  47 void gost_param_free(void);
  48
  49 /* method registration */
  50
  51 int register_ameth_gost(int nid, EVP_PKEY_ASN1_METHOD **ameth,
  52                         const char *pemstr, const char *info);
  53 int register_pmeth_gost(int id, EVP_PKEY_METHOD **pmeth, int flags);
  54
  55 /* Gost-specific pmeth control-function parameters */
  56 /* For GOST R34.10 parameters */
  57 # define param_ctrl_string "paramset"
  58 # define ukm_ctrl_string "ukmhex"
  59 # define EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
  60 /* For GOST 28147 MAC */
  61 # define key_ctrl_string "key"
  62 # define hexkey_ctrl_string "hexkey"
  63 # define maclen_ctrl_string "size"
  64 # define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
  65 # define EVP_PKEY_CTRL_MAC_LEN (EVP_PKEY_ALG_CTRL+5)
  66 /* Pmeth internal representation */
  67 struct gost_pmeth_data {
  68     int sign_param_nid;         /* Should be set whenever parameters are
  69                                  * filled */
  70     EVP_MD *md;
  71     unsigned char *shared_ukm;
  72     size_t shared_ukm_size;     /* XXX temporary use shared_ukm and hash for 2018 CKE */
  73     int peer_key_used;
  74     int cipher_nid;             /* KExp15/KImp15 algs */
  75 };
  76
  77 struct gost_mac_pmeth_data {
  78     short int key_set;
  79     short int mac_size;
  80     int mac_param_nid;
  81     EVP_MD *md;
  82     unsigned char key[32];
  83 };
  84
  85 struct gost_mac_key {
  86     int mac_param_nid;
  87     unsigned char key[32];
  88     short int mac_size;
  89 };
  90 /* GOST-specific ASN1 structures */
  91
  92 typedef struct {
  93     ASN1_OCTET_STRING *encrypted_key;
  94     ASN1_OCTET_STRING *imit;
  95 } GOST_KEY_INFO;
  96
  97 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
  98
  99 typedef struct {
 100     ASN1_OBJECT *cipher;
 101     X509_PUBKEY *ephem_key;
 102     ASN1_OCTET_STRING *eph_iv;
 103 } GOST_KEY_AGREEMENT_INFO;
 104
 105 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
 106
 107 typedef struct {
 108     GOST_KEY_INFO *key_info;
 109     GOST_KEY_AGREEMENT_INFO *key_agreement_info;
 110 } GOST_KEY_TRANSPORT;
 111
 112 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
 113
 114 typedef struct {                /* FIXME incomplete */
 115     GOST_KEY_TRANSPORT *gkt;
 116 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
 117
 118 /*   PSKeyTransport ::= SEQUENCE {
 119        PSEXP OCTET STRING,
 120        ephemeralPublicKey SubjectPublicKeyInfo
 121    }
 122    SubjectPublicKeyInfo ::= SEQUENCE {
 123        algorithm AlgorithmIdentifier,
 124        subjectPublicKey BITSTRING
 125    }
 126    AlgorithmIdentifier ::= SEQUENCE {
 127        algorithm OBJECT IDENTIFIER,
 128        parameters ANY OPTIONAL
 129    }*/
 130 typedef struct PSKeyTransport_st {
 131     ASN1_OCTET_STRING *psexp;
 132     X509_PUBKEY       *ephem_key;
 133 } PSKeyTransport_gost;
 134
 135 DECLARE_ASN1_FUNCTIONS(PSKeyTransport_gost)
 136 /*
 137  * Hacks to shorten symbols to 31 characters or less, or OpenVMS. This mimics
 138  * what's done in symhacks.h, but since this is a very local header file, I
 139  * prefered to put this hack directly here. -- Richard Levitte
 140  */
 141 # ifdef OPENSSL_SYS_VMS
 142 #  undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
 143 #  define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it      GOST_CLIENT_KEY_EXC_PARAMS_it
 144 #  undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
 145 #  define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new     GOST_CLIENT_KEY_EXC_PARAMS_new
 146 #  undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
 147 #  define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free    GOST_CLIENT_KEY_EXC_PARAMS_free
 148 #  undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
 149 #  define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS     d2i_GOST_CLIENT_KEY_EXC_PARAMS
 150 #  undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
 151 #  define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS     i2d_GOST_CLIENT_KEY_EXC_PARAMS
 152 # endif                         /* End of hack */
 153 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
 154 typedef struct {
 155     ASN1_OBJECT *key_params;
 156     ASN1_OBJECT *hash_params;
 157     ASN1_OBJECT *cipher_params;
 158 } GOST_KEY_PARAMS;
 159
 160 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
 161
 162 typedef struct {
 163     ASN1_OCTET_STRING *iv;
 164     ASN1_OBJECT *enc_param_set;
 165 } GOST_CIPHER_PARAMS;
 166
 167 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
 168
 169 typedef struct {
 170     ASN1_OCTET_STRING *masked_priv_key;
 171     ASN1_OCTET_STRING *public_key;
 172 } MASKED_GOST_KEY;
 173
 174 DECLARE_ASN1_FUNCTIONS(MASKED_GOST_KEY)
 175
 176 /*============== Message digest  and cipher related structures  ==========*/
 177     /*
 178      * Structure used as EVP_MD_CTX-md_data. It allows to avoid storing
 179      * in the md-data pointers to dynamically allocated memory. I
 180      * cannot invent better way to avoid memory leaks, because openssl
 181      * insist on invoking Init on Final-ed digests, and there is no
 182      * reliable way to find out whether pointer in the passed md_data is
 183      * valid or not.
 184      */
 185 struct ossl_gost_digest_ctx {
 186     gost_hash_ctx dctx;
 187     gost_ctx cctx;
 188 };
 189 /* EVP_MD structure for GOST R 34.11 */
 190 EVP_MD *digest_gost(void);
 191 void digest_gost_destroy(void);
 192 /* EVP MD structure for GOST R 34.11-2012 algorithms */
 193 EVP_MD *digest_gost2012_256(void);
 194 EVP_MD *digest_gost2012_512(void);
 195 void digest_gost2012_256_destroy(void);
 196 void digest_gost2012_512_destroy(void);
 197 /* EVP_MD structure for GOST 28147 in MAC mode */
 198 EVP_MD *imit_gost_cpa(void);
 199 void imit_gost_cpa_destroy(void);
 200 EVP_MD *imit_gost_cp_12(void);
 201 void imit_gost_cp_12_destroy(void);
 202 EVP_MD *magma_omac(void);
 203 void magma_omac_destroy(void);
 204 EVP_MD *grasshopper_omac(void);
 205 EVP_MD *grasshopper_omac_acpkm(void);
 206 void grasshopper_omac_destroy(void);
 207 void grasshopper_omac_acpkm_destroy(void);
 208 /* Cipher context used for EVP_CIPHER operation */
 209 struct ossl_gost_cipher_ctx {
 210     int paramNID;
 211     unsigned int count;
 212     int key_meshing;
 213     gost_ctx cctx;
 214 };
 215 /* Structure to map parameter NID to S-block */
 216 struct gost_cipher_info {
 217     int nid;
 218     gost_subst_block *sblock;
 219     int key_meshing;
 220 };
 221 /* Context for MAC */
 222 struct ossl_gost_imit_ctx {
 223     gost_ctx cctx;
 224     unsigned char buffer[8];
 225     unsigned char partial_block[8];
 226     unsigned int count;
 227     int key_meshing;
 228     int bytes_left;
 229     int key_set;
 230     int dgst_size;
 231 };
 232 /* Table which maps parameter NID to S-blocks */
 233 extern struct gost_cipher_info gost_cipher_list[];
 234 /* Find encryption params from ASN1_OBJECT */
 235 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
 236 /* Implementation of GOST 28147-89 cipher in CFB and CNT modes */
 237 const EVP_CIPHER *cipher_gost();
 238 const EVP_CIPHER *cipher_gost_cbc();
 239 const EVP_CIPHER *cipher_gost_cpacnt();
 240 const EVP_CIPHER *cipher_gost_cpcnt_12();
 241 const EVP_CIPHER *cipher_magma_cbc();
 242 const EVP_CIPHER *cipher_magma_ctr();
 243 void cipher_gost_destroy();
 244
 245 void inc_counter(unsigned char *counter, size_t counter_bytes);
 246
 247 # define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
 248 # define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
 249 /* EVP_PKEY_METHOD key encryption callbacks */
 250 /* From gost_ec_keyx.c */
 251 int pkey_gost_encrypt(EVP_PKEY_CTX *pctx, unsigned char *out,
 252                            size_t *out_len, const unsigned char *key,
 253                            size_t key_len);
 254
 255 int pkey_gost_decrypt(EVP_PKEY_CTX *pctx, unsigned char *key,
 256                            size_t *key_len, const unsigned char *in,
 257                            size_t in_len);
 258 /* derive functions */
 259 /* From gost_ec_keyx.c */
 260 int pkey_gost_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
 261 int fill_GOST_EC_params(EC_KEY *eckey, int nid);
 262 int gost_ec_keygen(EC_KEY *ec);
 263
 264 ECDSA_SIG *gost_ec_sign(const unsigned char *dgst, int dlen, EC_KEY *eckey);
 265 int gost_ec_verify(const unsigned char *dgst, int dgst_len,
 266                    ECDSA_SIG *sig, EC_KEY *ec);
 267 int gost_ec_compute_public(EC_KEY *ec);
 268
 269 /* VKO */
 270 int VKO_compute_key(unsigned char *shared_key,
 271                     const EC_POINT *pub_key, const EC_KEY *priv_key,
 272                     const unsigned char *ukm, const size_t ukm_size,
 273                     const int vko_dgst_nid);
 274
 275 /* KDF TREE */
 276 int gost_kdftree2012_256(unsigned char *keyout, size_t keyout_len,
 277                          const unsigned char *key, size_t keylen,
 278                          const unsigned char *label, size_t label_len,
 279                          const unsigned char *seed, size_t seed_len,
 280                          const size_t representation);
 281
 282 int gost_tlstree(int cipher_nid, const unsigned char *in, unsigned char *out,
 283                  const unsigned char *tlsseq);
 284 /* KExp/KImp */
 285 int gost_kexp15(const unsigned char *shared_key, const int shared_len,
 286                 int cipher_nid, const unsigned char *cipher_key,
 287                 int mac_nid, unsigned char *mac_key,
 288                 const unsigned char *iv, const size_t ivlen,
 289                 unsigned char *out, int *out_len);
 290 int gost_kimp15(const unsigned char *expkey, const size_t expkeylen,
 291                 int cipher_nid, const unsigned char *cipher_key,
 292                 int mac_nid, unsigned char *mac_key,
 293                 const unsigned char *iv, const size_t ivlen,
 294                 unsigned char *shared_key);
 295 /*============== miscellaneous functions============================= */
 296 /*
 297  * Store bignum in byte array of given length, prepending by zeros if
 298  * nesseccary
 299  */
 300 int store_bignum(const BIGNUM *bn, unsigned char *buf, int len);
 301 /* Pack GOST R 34.10 signature according to CryptoPro rules */
 302 int pack_sign_cp(ECDSA_SIG *s, int order, unsigned char *sig, size_t *siglen);
 303 /* from ameth.c */
 304 /* Get private key as BIGNUM from both 34.10-2001 keys*/
 305 /* Returns pointer into EVP_PKEY structure */
 306 BIGNUM *gost_get0_priv_key(const EVP_PKEY *pkey);
 307 #endif