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 /*
  37  * NB: These values must align with the equivalently named macros in
  38  * openssl/dh.h. We cannot use those macros here in case DH has been disabled.
  39  */
  40 # define FFC_CHECK_P_NOT_PRIME                0x00001
  41 # define FFC_CHECK_P_NOT_SAFE_PRIME           0x00002
  42 # define FFC_CHECK_UNKNOWN_GENERATOR          0x00004
  43 # define FFC_CHECK_NOT_SUITABLE_GENERATOR     0x00008
  44 # define FFC_CHECK_Q_NOT_PRIME                0x00010
  45 # define FFC_CHECK_INVALID_Q_VALUE            0x00020
  46 # define FFC_CHECK_INVALID_J_VALUE            0x00040
  47
  48 # define FFC_CHECK_BAD_LN_PAIR                0x00080
  49 # define FFC_CHECK_INVALID_SEED_SIZE          0x00100
  50 # define FFC_CHECK_MISSING_SEED_OR_COUNTER    0x00200
  51 # define FFC_CHECK_INVALID_G                  0x00400
  52 # define FFC_CHECK_INVALID_PQ                 0x00800
  53 # define FFC_CHECK_INVALID_COUNTER            0x01000
  54 # define FFC_CHECK_P_MISMATCH                 0x02000
  55 # define FFC_CHECK_Q_MISMATCH                 0x04000
  56 # define FFC_CHECK_G_MISMATCH                 0x08000
  57 # define FFC_CHECK_COUNTER_MISMATCH           0x10000
  58
  59 /* Validation Return codes */
  60 # define FFC_ERROR_PUBKEY_TOO_SMALL       0x01
  61 # define FFC_ERROR_PUBKEY_TOO_LARGE       0x02
  62 # define FFC_ERROR_PUBKEY_INVALID         0x04
  63 # define FFC_ERROR_NOT_SUITABLE_GENERATOR 0x08
  64 # define FFC_ERROR_PRIVKEY_TOO_SMALL      0x10
  65 # define FFC_ERROR_PRIVKEY_TOO_LARGE      0x20
  66
  67 /*
  68  * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
  69  * Refer to FIPS186_4 Appendix A & B.
  70  */
  71 typedef struct ffc_params_st {
  72     /* Primes */
  73     BIGNUM *p;
  74     BIGNUM *q;
  75     /* Generator */
  76     BIGNUM *g;
  77     /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
  78     BIGNUM *j;
  79
  80     /* Required for FIPS186_4 validation of p, q and optionally canonical g */
  81     unsigned char *seed;
  82     /* If this value is zero the hash size is used as the seed length */
  83     size_t seedlen;
  84     /* Required for FIPS186_4 validation of p and q */
  85     int pcounter;
  86     int nid; /* The identity of a named group */
  87
  88     /*
  89      * Required for FIPS186_4 generation & validation of canonical g.
  90      * It uses unverifiable g if this value is -1.
  91      */
  92     int gindex;
  93     int h; /* loop counter for unverifiable g */
  94 } FFC_PARAMS;
  95
  96 void ffc_params_init(FFC_PARAMS *params);
  97 void ffc_params_cleanup(FFC_PARAMS *params);
  98 void ffc_params_set0_pqg(FFC_PARAMS *params, BIGNUM *p, BIGNUM *q, BIGNUM *g);
  99 void ffc_params_get0_pqg(const FFC_PARAMS *params, const BIGNUM **p,
 100                          const BIGNUM **q, const BIGNUM **g);
 101 void ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j);
 102 int ffc_params_set_validate_params(FFC_PARAMS *params,
 103                                    const unsigned char *seed, size_t seedlen,
 104                                    int counter);
 105 void ffc_params_get_validate_params(const FFC_PARAMS *params,
 106                                     unsigned char **seed, size_t *seedlen,
 107                                     int *pcounter);
 108
 109 int ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src);
 110 int ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q);
 111
 112 #ifndef FIPS_MODE
 113 int ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent);
 114 #endif /* FIPS_MODE */
 115
 116
 117 int ffc_params_FIPS186_4_generate(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 118                                   int type, size_t L, size_t N,
 119                                   const EVP_MD *evpmd, int *res, BN_GENCB *cb);
 120 int ffc_params_FIPS186_2_generate(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 121                                   int type, size_t L, size_t N,
 122                                   const EVP_MD *evpmd, int *res, BN_GENCB *cb);
 123
 124 int ffc_params_FIPS186_4_gen_verify(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 125                                     int type, size_t L, size_t N,
 126                                     const EVP_MD *evpmd, int validate_flags,
 127                                     int *res, BN_GENCB *cb);
 128 int ffc_params_FIPS186_2_gen_verify(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 129                                     int type, size_t L, size_t N,
 130                                     const EVP_MD *evpmd, int validate_flags,
 131                                     int *res, BN_GENCB *cb);
 132
 133 int ffc_params_FIPS186_4_validate(const FFC_PARAMS *params, int type,
 134                                   const EVP_MD *evpmd, int validate_flags,
 135                                   int *res, BN_GENCB *cb);
 136 int ffc_params_FIPS186_2_validate(const FFC_PARAMS *params, int type,
 137                                   const EVP_MD *evpmd, int validate_flags,
 138                                   int *res, BN_GENCB *cb);
 139
 140
 141 int ffc_generate_private_key(BN_CTX *ctx, const FFC_PARAMS *params,
 142                              int N, int s, BIGNUM *priv);
 143 int ffc_generate_private_key_fips(BN_CTX *ctx, const FFC_PARAMS *params,
 144                                   int N, int s, BIGNUM *priv);
 145
 146 int ffc_params_validate_unverifiable_g(BN_CTX *ctx, BN_MONT_CTX *mont,
 147                                        const BIGNUM *p, const BIGNUM *q,
 148                                        const BIGNUM *g, BIGNUM *tmp, int *ret);
 149
 150 int ffc_validate_public_key(const FFC_PARAMS *params, const BIGNUM *pub_key,
 151                             int *ret);
 152 int ffc_validate_public_key_partial(const FFC_PARAMS *params,
 153                                     const BIGNUM *pub_key, int *ret);
 154 int ffc_validate_private_key(const BIGNUM *upper, const BIGNUM *priv_key,
 155                              int *ret);
 156
 157 #endif /* OSSL_INTERNAL_FFC_H */