include/internal/ffc.h

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef OSSL_INTERNAL_FFC_H
  11 # define OSSL_INTERNAL_FFC_H
  12
  13 # include <openssl/bn.h>
  14 # include <openssl/evp.h>
  15 # include <openssl/dh.h> /* Uses Error codes from DH */
  16
  17 /* Default value for gindex when canonical generation of g is not used */
  18 # define FFC_UNVERIFIABLE_GINDEX -1
  19
  20 /* The different types of FFC keys */
  21 # define FFC_PARAM_TYPE_DSA  0
  22 # define FFC_PARAM_TYPE_DH   1
  23
  24 /* Return codes for generation and validation of FFC parameters */
  25 #define FFC_PARAMS_RET_STATUS_FAILED         0
  26 #define FFC_PARAMS_RET_STATUS_SUCCESS        1
  27 /* Returned if validating and g is only partially verifiable */
  28 #define FFC_PARAMS_RET_STATUS_UNVERIFIABLE_G 2
  29
  30 /* Validation flags */
  31 # define FFC_PARAMS_GENERATE     0x00
  32 # define FFC_PARAMS_VALIDATE_PQ  0x01
  33 # define FFC_PARAMS_VALIDATE_G   0x02
  34 # define FFC_PARAMS_VALIDATE_ALL (FFC_PARAMS_VALIDATE_PQ | FFC_PARAMS_VALIDATE_G)
  35
  36 # define FFC_CHECK_P_NOT_PRIME                DH_CHECK_P_NOT_PRIME
  37 # define FFC_CHECK_P_NOT_SAFE_PRIME           DH_CHECK_P_NOT_SAFE_PRIME
  38 # define FFC_CHECK_UNKNOWN_GENERATOR          DH_UNABLE_TO_CHECK_GENERATOR
  39 # define FFC_CHECK_NOT_SUITABLE_GENERATOR     DH_NOT_SUITABLE_GENERATOR
  40 # define FFC_CHECK_Q_NOT_PRIME                DH_CHECK_Q_NOT_PRIME
  41 # define FFC_CHECK_INVALID_Q_VALUE            DH_CHECK_INVALID_Q_VALUE
  42 # define FFC_CHECK_INVALID_J_VALUE            DH_CHECK_INVALID_J_VALUE
  43 # define FFC_CHECK_BAD_LN_PAIR                0x00080
  44 # define FFC_CHECK_INVALID_SEED_SIZE          0x00100
  45 # define FFC_CHECK_MISSING_SEED_OR_COUNTER    0x00200
  46 # define FFC_CHECK_INVALID_G                  0x00400
  47 # define FFC_CHECK_INVALID_PQ                 0x00800
  48 # define FFC_CHECK_INVALID_COUNTER            0x01000
  49 # define FFC_CHECK_P_MISMATCH                 0x02000
  50 # define FFC_CHECK_Q_MISMATCH                 0x04000
  51 # define FFC_CHECK_G_MISMATCH                 0x08000
  52 # define FFC_CHECK_COUNTER_MISMATCH           0x10000
  53
  54 /*
  55  * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
  56  * Refer to FIPS186_4 Appendix A & B.
  57  */
  58 typedef struct ffc_params_st {
  59     /* Primes */
  60     BIGNUM *p;
  61     BIGNUM *q;
  62     /* Generator */
  63     BIGNUM *g;
  64     /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
  65     BIGNUM *j;
  66
  67     /* Required for FIPS186_4 validation of p, q and optionally canonical g */
  68     unsigned char *seed;
  69     /* If this value is zero the hash size is used as the seed length */
  70     size_t seedlen;
  71     /* Required for FIPS186_4 validation of p and q */
  72     int pcounter;
  73     int nid; /* The identity of a named group */
  74
  75     /*
  76      * Required for FIPS186_4 generation & validation of canonical g.
  77      * It uses unverifiable g if this value is -1.
  78      */
  79     int gindex;
  80     int h; /* loop counter for unverifiable g */
  81 } FFC_PARAMS;
  82
  83 void ffc_params_init(FFC_PARAMS *params);
  84 void ffc_params_cleanup(FFC_PARAMS *params);
  85 void ffc_params_set0_pqg(FFC_PARAMS *params, BIGNUM *p, BIGNUM *q, BIGNUM *g);
  86 void ffc_params_get0_pqg(const FFC_PARAMS *params, const BIGNUM **p,
  87                          const BIGNUM **q, const BIGNUM **g);
  88 void ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j);
  89 int ffc_params_set_validate_params(FFC_PARAMS *params,
  90                                    const unsigned char *seed, size_t seedlen,
  91                                    int counter);
  92 void ffc_params_get_validate_params(const FFC_PARAMS *params,
  93                                     unsigned char **seed, size_t *seedlen,
  94                                     int *pcounter);
  95
  96 int ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src);
  97 int ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q);
  98
  99 #ifndef FIPS_MODE
 100 int ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent);
 101 #endif /* FIPS_MODE */
 102
 103
 104 int ffc_params_FIPS186_4_generate(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 105                                   int type, size_t L, size_t N,
 106                                   const EVP_MD *evpmd, int *res, BN_GENCB *cb);
 107 int ffc_params_FIPS186_2_generate(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 108                                   int type, size_t L, size_t N,
 109                                   const EVP_MD *evpmd, int *res, BN_GENCB *cb);
 110
 111 int ffc_param_FIPS186_4_gen_verify(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 112                                    int type, size_t L, size_t N,
 113                                    const EVP_MD *evpmd, int validate_flags,
 114                                    int *res, BN_GENCB *cb);
 115 int ffc_param_FIPS186_2_gen_verify(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 116                                    int type, size_t L, size_t N,
 117                                    const EVP_MD *evpmd, int validate_flags,
 118                                    int *res, BN_GENCB *cb);
 119
 120 int ffc_generate_private_key(BN_CTX *ctx, const FFC_PARAMS *params,
 121                              int N, int s, BIGNUM *priv);
 122
 123 int ffc_params_validate_unverifiable_g(BN_CTX *ctx, BN_MONT_CTX *mont,
 124                                        const BIGNUM *p, const BIGNUM *q,
 125                                        const BIGNUM *g, BIGNUM *tmp, int *ret);
 126
 127 #endif /* OSSL_INTERNAL_FFC_H */