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