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  *             Copyright (c) 2020 Vitaly Chikunov <vt@altlinux.org>   *
   7  *       This file is distributed under the same license as OpenSSL   *
   8  *                                                                    *
   9  *         Internal declarations  used in GOST engine                 *
  10  *         OpenSSL 0.9.9 libraries required to compile and use        *
  11  *                              this code                             *
  12  **********************************************************************/
  13 # include <openssl/bn.h>
  14 # include <openssl/evp.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_PK_FORMAT 2
  25 # define GOST_PARAM_MAX 3
  26 # define GOST_CTRL_CRYPT_PARAMS (ENGINE_CMD_BASE+GOST_PARAM_CRYPT_PARAMS)
  27 # define GOST_CTRL_PBE_PARAMS   (ENGINE_CMD_BASE+GOST_PARAM_PBE_PARAMS)
  28 # define GOST_CTRL_PK_FORMAT   (ENGINE_CMD_BASE+GOST_PARAM_PK_FORMAT)
  29
  30 typedef struct R3410_ec {
  31     int nid;
  32     char *a;
  33     char *b;
  34     char *p;
  35     char *q;
  36     char *x;
  37     char *y;
  38     char *cofactor;
  39 } R3410_ec_params;
  40
  41 extern R3410_ec_params R3410_2001_paramset[],
  42     *R3410_2012_256_paramset, R3410_2012_512_paramset[];
  43
  44 extern const ENGINE_CMD_DEFN gost_cmds[];
  45 int gost_control_func(ENGINE *e, int cmd, long i, void *p, void (*f) (void));
  46 const char *get_gost_engine_param(int param);
  47 int gost_set_default_param(int param, const char *value);
  48 void gost_param_free(void);
  49
  50 /* method registration */
  51
  52 int register_ameth_gost(int nid, EVP_PKEY_ASN1_METHOD **ameth,
  53                         const char *pemstr, const char *info);
  54 int register_pmeth_gost(int id, EVP_PKEY_METHOD **pmeth, int flags);
  55
  56 /* Gost-specific pmeth control-function parameters */
  57 /* For GOST R34.10 parameters */
  58 # define param_ctrl_string "paramset"
  59 # define ukm_ctrl_string "ukmhex"
  60 # define EVP_PKEY_CTRL_GOST_PARAMSET (EVP_PKEY_ALG_CTRL+1)
  61 /* For GOST 28147 MAC */
  62 # define key_ctrl_string "key"
  63 # define hexkey_ctrl_string "hexkey"
  64 # define maclen_ctrl_string "size"
  65 # define EVP_PKEY_CTRL_GOST_MAC_HEXKEY (EVP_PKEY_ALG_CTRL+3)
  66 # define EVP_PKEY_CTRL_MAC_LEN (EVP_PKEY_ALG_CTRL+5)
  67 /* Pmeth internal representation */
  68 struct gost_pmeth_data {
  69     int sign_param_nid;         /* Should be set whenever parameters are
  70                                  * filled */
  71     EVP_MD *md;
  72     unsigned char shared_ukm[32];
  73     size_t shared_ukm_size;
  74     int peer_key_used;
  75     int cipher_nid;             /* KExp15/KImp15 algs */
  76 };
  77
  78 struct gost_mac_pmeth_data {
  79     short int key_set;
  80     short int mac_size;
  81     int mac_param_nid;
  82     EVP_MD *md;
  83     unsigned char key[32];
  84 };
  85
  86 struct gost_mac_key {
  87     int mac_param_nid;
  88     unsigned char key[32];
  89     short int mac_size;
  90 };
  91 /* GOST-specific ASN1 structures */
  92
  93 typedef struct {
  94     ASN1_OCTET_STRING *encrypted_key;
  95     ASN1_OCTET_STRING *imit;
  96 } GOST_KEY_INFO;
  97
  98 DECLARE_ASN1_FUNCTIONS(GOST_KEY_INFO)
  99
 100 typedef struct {
 101     ASN1_OBJECT *cipher;
 102     X509_PUBKEY *ephem_key;
 103     ASN1_OCTET_STRING *eph_iv;
 104 } GOST_KEY_AGREEMENT_INFO;
 105
 106 DECLARE_ASN1_FUNCTIONS(GOST_KEY_AGREEMENT_INFO)
 107
 108 typedef struct {
 109     GOST_KEY_INFO *key_info;
 110     GOST_KEY_AGREEMENT_INFO *key_agreement_info;
 111 } GOST_KEY_TRANSPORT;
 112
 113 DECLARE_ASN1_FUNCTIONS(GOST_KEY_TRANSPORT)
 114
 115 typedef struct {                /* FIXME incomplete */
 116     GOST_KEY_TRANSPORT *gkt;
 117 } GOST_CLIENT_KEY_EXCHANGE_PARAMS;
 118
 119 /*   PSKeyTransport ::= SEQUENCE {
 120        PSEXP OCTET STRING,
 121        ephemeralPublicKey SubjectPublicKeyInfo
 122    }
 123    SubjectPublicKeyInfo ::= SEQUENCE {
 124        algorithm AlgorithmIdentifier,
 125        subjectPublicKey BITSTRING
 126    }
 127    AlgorithmIdentifier ::= SEQUENCE {
 128        algorithm OBJECT IDENTIFIER,
 129        parameters ANY OPTIONAL
 130    }*/
 131 typedef struct PSKeyTransport_st {
 132     ASN1_OCTET_STRING *psexp;
 133     X509_PUBKEY       *ephem_key;
 134     ASN1_OCTET_STRING *ukm;
 135 } PSKeyTransport_gost;
 136
 137 DECLARE_ASN1_FUNCTIONS(PSKeyTransport_gost)
 138 /*
 139  * Hacks to shorten symbols to 31 characters or less, or OpenVMS. This mimics
 140  * what's done in symhacks.h, but since this is a very local header file, I
 141  * prefered to put this hack directly here. -- Richard Levitte
 142  */
 143 # ifdef OPENSSL_SYS_VMS
 144 #  undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_it
 145 #  define GOST_CLIENT_KEY_EXCHANGE_PARAMS_it      GOST_CLIENT_KEY_EXC_PARAMS_it
 146 #  undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_new
 147 #  define GOST_CLIENT_KEY_EXCHANGE_PARAMS_new     GOST_CLIENT_KEY_EXC_PARAMS_new
 148 #  undef GOST_CLIENT_KEY_EXCHANGE_PARAMS_free
 149 #  define GOST_CLIENT_KEY_EXCHANGE_PARAMS_free    GOST_CLIENT_KEY_EXC_PARAMS_free
 150 #  undef d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS
 151 #  define d2i_GOST_CLIENT_KEY_EXCHANGE_PARAMS     d2i_GOST_CLIENT_KEY_EXC_PARAMS
 152 #  undef i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS
 153 #  define i2d_GOST_CLIENT_KEY_EXCHANGE_PARAMS     i2d_GOST_CLIENT_KEY_EXC_PARAMS
 154 # endif                         /* End of hack */
 155 DECLARE_ASN1_FUNCTIONS(GOST_CLIENT_KEY_EXCHANGE_PARAMS)
 156 typedef struct {
 157     ASN1_OBJECT *key_params;
 158     ASN1_OBJECT *hash_params;
 159     ASN1_OBJECT *cipher_params;
 160 } GOST_KEY_PARAMS;
 161
 162 DECLARE_ASN1_FUNCTIONS(GOST_KEY_PARAMS)
 163
 164 typedef struct {
 165     ASN1_OCTET_STRING *iv;
 166     ASN1_OBJECT *enc_param_set;
 167 } GOST_CIPHER_PARAMS;
 168
 169 DECLARE_ASN1_FUNCTIONS(GOST_CIPHER_PARAMS)
 170
 171 typedef struct {
 172         ASN1_OCTET_STRING *ukm;
 173         } GOST2015_CIPHER_PARAMS;
 174
 175 DECLARE_ASN1_FUNCTIONS(GOST2015_CIPHER_PARAMS)
 176
 177 typedef struct {
 178     ASN1_OCTET_STRING *masked_priv_key;
 179     ASN1_OCTET_STRING *public_key;
 180 } MASKED_GOST_KEY;
 181
 182 DECLARE_ASN1_FUNCTIONS(MASKED_GOST_KEY)
 183
 184 /*============== Message digest  and cipher related structures  ==========*/
 185     /*
 186      * Structure used as EVP_MD_CTX-md_data. It allows to avoid storing
 187      * in the md-data pointers to dynamically allocated memory. I
 188      * cannot invent better way to avoid memory leaks, because openssl
 189      * insist on invoking Init on Final-ed digests, and there is no
 190      * reliable way to find out whether pointer in the passed md_data is
 191      * valid or not.
 192      */
 193 struct ossl_gost_digest_ctx {
 194     gost_hash_ctx dctx;
 195     gost_ctx cctx;
 196 };
 197 /* Cipher context used for EVP_CIPHER operation */
 198 struct ossl_gost_cipher_ctx {
 199     int paramNID;
 200     unsigned int count;
 201     int key_meshing;
 202     unsigned char kdf_seed[8];
 203     unsigned char tag[8];
 204     gost_ctx cctx;
 205     EVP_MD_CTX *omac_ctx;
 206 };
 207 /* Structure to map parameter NID to S-block */
 208 struct gost_cipher_info {
 209     int nid;
 210     gost_subst_block *sblock;
 211     int key_meshing;
 212 };
 213 /* Context for MAC */
 214 struct ossl_gost_imit_ctx {
 215     gost_ctx cctx;
 216     unsigned char buffer[8];
 217     unsigned char partial_block[8];
 218     unsigned int count;
 219     int key_meshing;
 220     int bytes_left;
 221     int key_set;
 222     int dgst_size;
 223 };
 224 /* Find encryption params from ASN1_OBJECT */
 225 const struct gost_cipher_info *get_encryption_params(ASN1_OBJECT *obj);
 226
 227 void inc_counter(unsigned char *counter, size_t counter_bytes);
 228
 229 # define EVP_MD_CTRL_KEY_LEN (EVP_MD_CTRL_ALG_CTRL+3)
 230 # define EVP_MD_CTRL_SET_KEY (EVP_MD_CTRL_ALG_CTRL+4)
 231 /* EVP_PKEY_METHOD key encryption callbacks */
 232 /* From gost_ec_keyx.c */
 233 int pkey_gost_encrypt(EVP_PKEY_CTX *pctx, unsigned char *out,
 234                            size_t *out_len, const unsigned char *key,
 235                            size_t key_len);
 236
 237 int pkey_gost_decrypt(EVP_PKEY_CTX *pctx, unsigned char *key,
 238                            size_t *key_len, const unsigned char *in,
 239                            size_t in_len);
 240 /* derive functions */
 241 /* From gost_ec_keyx.c */
 242 int pkey_gost_ec_derive(EVP_PKEY_CTX *ctx, unsigned char *key, size_t *keylen);
 243 int fill_GOST_EC_params(EC_KEY *eckey, int nid);
 244 int gost_ec_keygen(EC_KEY *ec);
 245
 246 ECDSA_SIG *gost_ec_sign(const unsigned char *dgst, int dlen, EC_KEY *eckey);
 247 int gost_ec_verify(const unsigned char *dgst, int dgst_len,
 248                    ECDSA_SIG *sig, EC_KEY *ec);
 249 int gost_ec_compute_public(EC_KEY *ec);
 250
 251 /* VKO */
 252 int VKO_compute_key(unsigned char *shared_key,
 253                     const EC_POINT *pub_key, const EC_KEY *priv_key,
 254                     const unsigned char *ukm, const size_t ukm_size,
 255                     const int vko_dgst_nid);
 256
 257 /* KDF TREE */
 258 int gost_kdftree2012_256(unsigned char *keyout, size_t keyout_len,
 259                          const unsigned char *key, size_t keylen,
 260                          const unsigned char *label, size_t label_len,
 261                          const unsigned char *seed, size_t seed_len,
 262                          const size_t representation);
 263
 264 int gost_tlstree(int cipher_nid, const unsigned char *in, unsigned char *out,
 265                  const unsigned char *tlsseq);
 266 /* KExp/KImp */
 267 int gost_kexp15(const unsigned char *shared_key, const int shared_len,
 268                 int cipher_nid, const unsigned char *cipher_key,
 269                 int mac_nid, unsigned char *mac_key,
 270                 const unsigned char *iv, const size_t ivlen,
 271                 unsigned char *out, int *out_len);
 272 int gost_kimp15(const unsigned char *expkey, const size_t expkeylen,
 273                 int cipher_nid, const unsigned char *cipher_key,
 274                 int mac_nid, unsigned char *mac_key,
 275                 const unsigned char *iv, const size_t ivlen,
 276                 unsigned char *shared_key);
 277 /*============== miscellaneous functions============================= */
 278 /*
 279  * Store bignum in byte array of given length, prepending by zeros if
 280  * nesseccary
 281  */
 282 int store_bignum(const BIGNUM *bn, unsigned char *buf, int len);
 283 /* Pack GOST R 34.10 signature according to CryptoPro rules */
 284 int pack_sign_cp(ECDSA_SIG *s, int order, unsigned char *sig, size_t *siglen);
 285 /* from ameth.c */
 286 /* Get private key as BIGNUM from both 34.10-2001 keys*/
 287 /* Returns pointer into EVP_PKEY structure */
 288 BIGNUM *gost_get0_priv_key(const EVP_PKEY *pkey);
 289
 290 /* Struct describing cipher and used for init/deinit.*/
 291 struct gost_cipher_st {
 292     struct gost_cipher_st *template; /* template struct */
 293     int nid;
 294     EVP_CIPHER *cipher;
 295     int block_size;     /* (bytes) */
 296     int key_len;        /* (bytes) */
 297     int iv_len;
 298     int flags;
 299     int (*init) (EVP_CIPHER_CTX *ctx, const unsigned char *key,
 300                  const unsigned char *iv, int enc);
 301     int (*do_cipher)(EVP_CIPHER_CTX *ctx, unsigned char *out,
 302                      const unsigned char *in, size_t inl);
 303     int (*cleanup)(EVP_CIPHER_CTX *);
 304     int ctx_size;
 305     int (*set_asn1_parameters)(EVP_CIPHER_CTX *, ASN1_TYPE *);
 306     int (*get_asn1_parameters)(EVP_CIPHER_CTX *, ASN1_TYPE *);
 307     int (*ctrl)(EVP_CIPHER_CTX *, int type, int arg, void *ptr);
 308 };
 309 typedef struct gost_cipher_st GOST_cipher;
 310
 311 EVP_CIPHER *GOST_init_cipher(GOST_cipher *c);
 312 void GOST_deinit_cipher(GOST_cipher *c);
 313
 314 extern GOST_cipher Gost28147_89_cipher;
 315 extern GOST_cipher Gost28147_89_cbc_cipher;
 316 extern GOST_cipher Gost28147_89_cnt_cipher;
 317 extern GOST_cipher Gost28147_89_cnt_12_cipher;
 318 extern GOST_cipher magma_ctr_cipher;
 319 extern GOST_cipher magma_ctr_acpkm_cipher;
 320 extern GOST_cipher magma_ctr_acpkm_omac_cipher;
 321 extern GOST_cipher magma_cbc_cipher;
 322 extern GOST_cipher grasshopper_ecb_cipher;
 323 extern GOST_cipher grasshopper_cbc_cipher;
 324 extern GOST_cipher grasshopper_cfb_cipher;
 325 extern GOST_cipher grasshopper_ofb_cipher;
 326 extern GOST_cipher grasshopper_ctr_cipher;
 327 extern GOST_cipher grasshopper_ctr_acpkm_cipher;
 328 extern GOST_cipher grasshopper_ctr_acpkm_omac_cipher;
 329 extern GOST_cipher magma_kexp15_cipher;
 330 extern GOST_cipher kuznyechik_kexp15_cipher;
 331
 332 struct gost_digest_st {
 333     struct gost_digest_st *template;
 334     int nid;
 335     const char *alias;
 336     EVP_MD *digest;
 337     int result_size;
 338     int input_blocksize;
 339     int app_datasize;
 340     int flags;
 341     int (*init)(EVP_MD_CTX *ctx);
 342     int (*update)(EVP_MD_CTX *ctx, const void *data, size_t count);
 343     int (*final)(EVP_MD_CTX *ctx, unsigned char *md);
 344     int (*copy)(EVP_MD_CTX *to, const EVP_MD_CTX *from);
 345     int (*cleanup)(EVP_MD_CTX *ctx);
 346     int (*ctrl)(EVP_MD_CTX *ctx, int cmd, int p1, void *p2);
 347 };
 348 typedef struct gost_digest_st GOST_digest;
 349
 350 EVP_MD *GOST_init_digest(GOST_digest *d);
 351 void GOST_deinit_digest(GOST_digest *d);
 352
 353 extern GOST_digest GostR3411_94_digest;
 354 extern GOST_digest Gost28147_89_MAC_digest;
 355 extern GOST_digest Gost28147_89_mac_12_digest;
 356 extern GOST_digest GostR3411_2012_256_digest;
 357 extern GOST_digest GostR3411_2012_512_digest;
 358 extern GOST_digest magma_mac_digest;
 359 extern GOST_digest grasshopper_mac_digest;
 360 extern GOST_digest kuznyechik_ctracpkm_omac_digest;
 361
 362 #endif
 363 /* vim: set expandtab cinoptions=\:0,l1,t0,g0,(0 sw=4 : */