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/core.h>
  14 # include <openssl/bn.h>
  15 # include <openssl/evp.h>
  16 # include <openssl/dh.h> /* Uses Error codes from DH */
  17 # include <openssl/params.h>
  18 # include <openssl/param_build.h>
  19 # include "internal/sizes.h"
  20
  21 /* Default value for gindex when canonical generation of g is not used */
  22 # define FFC_UNVERIFIABLE_GINDEX -1
  23
  24 /* The different types of FFC keys */
  25 # define FFC_PARAM_TYPE_DSA  0
  26 # define FFC_PARAM_TYPE_DH   1
  27
  28 /*
  29  * The mode used by functions that share code for both generation and
  30  * verification. See ffc_params_FIPS186_4_gen_verify().
  31  */
  32 #define FFC_PARAM_MODE_VERIFY   0
  33 #define FFC_PARAM_MODE_GENERATE 1
  34
  35 /* Return codes for generation and validation of FFC parameters */
  36 #define FFC_PARAM_RET_STATUS_FAILED         0
  37 #define FFC_PARAM_RET_STATUS_SUCCESS        1
  38 /* Returned if validating and g is only partially verifiable */
  39 #define FFC_PARAM_RET_STATUS_UNVERIFIABLE_G 2
  40
  41 /* Validation flags */
  42 # define FFC_PARAM_FLAG_VALIDATE_PQ  0x01
  43 # define FFC_PARAM_FLAG_VALIDATE_G   0x02
  44 # define FFC_PARAM_FLAG_VALIDATE_ALL                                           \
  45     (FFC_PARAM_FLAG_VALIDATE_PQ | FFC_PARAM_FLAG_VALIDATE_G)
  46
  47 /*
  48  * NB: These values must align with the equivalently named macros in
  49  * openssl/dh.h. We cannot use those macros here in case DH has been disabled.
  50  */
  51 # define FFC_CHECK_P_NOT_PRIME                0x00001
  52 # define FFC_CHECK_P_NOT_SAFE_PRIME           0x00002
  53 # define FFC_CHECK_UNKNOWN_GENERATOR          0x00004
  54 # define FFC_CHECK_NOT_SUITABLE_GENERATOR     0x00008
  55 # define FFC_CHECK_Q_NOT_PRIME                0x00010
  56 # define FFC_CHECK_INVALID_Q_VALUE            0x00020
  57 # define FFC_CHECK_INVALID_J_VALUE            0x00040
  58
  59 # define FFC_CHECK_BAD_LN_PAIR                0x00080
  60 # define FFC_CHECK_INVALID_SEED_SIZE          0x00100
  61 # define FFC_CHECK_MISSING_SEED_OR_COUNTER    0x00200
  62 # define FFC_CHECK_INVALID_G                  0x00400
  63 # define FFC_CHECK_INVALID_PQ                 0x00800
  64 # define FFC_CHECK_INVALID_COUNTER            0x01000
  65 # define FFC_CHECK_P_MISMATCH                 0x02000
  66 # define FFC_CHECK_Q_MISMATCH                 0x04000
  67 # define FFC_CHECK_G_MISMATCH                 0x08000
  68 # define FFC_CHECK_COUNTER_MISMATCH           0x10000
  69
  70 /* Validation Return codes */
  71 # define FFC_ERROR_PUBKEY_TOO_SMALL       0x01
  72 # define FFC_ERROR_PUBKEY_TOO_LARGE       0x02
  73 # define FFC_ERROR_PUBKEY_INVALID         0x04
  74 # define FFC_ERROR_NOT_SUITABLE_GENERATOR 0x08
  75 # define FFC_ERROR_PRIVKEY_TOO_SMALL      0x10
  76 # define FFC_ERROR_PRIVKEY_TOO_LARGE      0x20
  77
  78 /*
  79  * Finite field cryptography (FFC) domain parameters are used by DH and DSA.
  80  * Refer to FIPS186_4 Appendix A & B.
  81  */
  82 typedef struct ffc_params_st {
  83     /* Primes */
  84     BIGNUM *p;
  85     BIGNUM *q;
  86     /* Generator */
  87     BIGNUM *g;
  88     /* DH X9.42 Optional Subgroup factor j >= 2 where p = j * q + 1 */
  89     BIGNUM *j;
  90
  91     /* Required for FIPS186_4 validation of p, q and optionally canonical g */
  92     unsigned char *seed;
  93     /* If this value is zero the hash size is used as the seed length */
  94     size_t seedlen;
  95     /* Required for FIPS186_4 validation of p and q */
  96     int pcounter;
  97     int nid; /* The identity of a named group */
  98
  99     /*
 100      * Required for FIPS186_4 generation & validation of canonical g.
 101      * It uses unverifiable g if this value is -1.
 102      */
 103     int gindex;
 104     int h; /* loop counter for unverifiable g */
 105
 106     unsigned int flags; /* See FFC_PARAM_FLAG_VALIDATE_ALL */
 107     /*
 108      * The digest to use for generation or validation. If this value is NULL,
 109      * then the digest is chosen using the value of N.
 110      */
 111     const char *mdname;
 112     const char *mdprops;
 113 } FFC_PARAMS;
 114
 115 void ffc_params_init(FFC_PARAMS *params);
 116 void ffc_params_cleanup(FFC_PARAMS *params);
 117 void ffc_params_set0_pqg(FFC_PARAMS *params, BIGNUM *p, BIGNUM *q, BIGNUM *g);
 118 void ffc_params_get0_pqg(const FFC_PARAMS *params, const BIGNUM **p,
 119                          const BIGNUM **q, const BIGNUM **g);
 120 void ffc_params_set0_j(FFC_PARAMS *d, BIGNUM *j);
 121 int ffc_params_set_seed(FFC_PARAMS *params,
 122                         const unsigned char *seed, size_t seedlen);
 123 void ffc_params_set_gindex(FFC_PARAMS *params, int index);
 124 void ffc_params_set_pcounter(FFC_PARAMS *params, int index);
 125 void ffc_params_set_h(FFC_PARAMS *params, int index);
 126 void ffc_params_set_flags(FFC_PARAMS *params, unsigned int flags);
 127 int ffc_set_digest(FFC_PARAMS *params, const char *alg, const char *props);
 128
 129 int ffc_params_set_validate_params(FFC_PARAMS *params,
 130                                    const unsigned char *seed, size_t seedlen,
 131                                    int counter);
 132 void ffc_params_get_validate_params(const FFC_PARAMS *params,
 133                                     unsigned char **seed, size_t *seedlen,
 134                                     int *pcounter);
 135
 136 int ffc_params_copy(FFC_PARAMS *dst, const FFC_PARAMS *src);
 137 int ffc_params_cmp(const FFC_PARAMS *a, const FFC_PARAMS *b, int ignore_q);
 138
 139 #ifndef FIPS_MODULE
 140 int ffc_params_print(BIO *bp, const FFC_PARAMS *ffc, int indent);
 141 #endif /* FIPS_MODULE */
 142
 143
 144 int ffc_params_FIPS186_4_generate(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 145                                   int type, size_t L, size_t N,
 146                                   int *res, BN_GENCB *cb);
 147 int ffc_params_FIPS186_2_generate(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 148                                   int type, size_t L, size_t N,
 149                                   int *res, BN_GENCB *cb);
 150
 151 int ffc_params_FIPS186_4_gen_verify(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 152                                     int mode, int type, size_t L, size_t N,
 153                                     int *res, BN_GENCB *cb);
 154 int ffc_params_FIPS186_2_gen_verify(OPENSSL_CTX *libctx, FFC_PARAMS *params,
 155                                     int mode, int type, size_t L, size_t N,
 156                                     int *res, BN_GENCB *cb);
 157
 158 int ffc_params_FIPS186_4_validate(OPENSSL_CTX *libctx, const FFC_PARAMS *params,
 159                                   int type, int *res, BN_GENCB *cb);
 160 int ffc_params_FIPS186_2_validate(OPENSSL_CTX *libctx, const FFC_PARAMS *params,
 161                                   int type, int *res, BN_GENCB *cb);
 162
 163 int ffc_generate_private_key(BN_CTX *ctx, const FFC_PARAMS *params,
 164                              int N, int s, BIGNUM *priv);
 165
 166 int ffc_params_validate_unverifiable_g(BN_CTX *ctx, BN_MONT_CTX *mont,
 167                                        const BIGNUM *p, const BIGNUM *q,
 168                                        const BIGNUM *g, BIGNUM *tmp, int *ret);
 169
 170 int ffc_validate_public_key(const FFC_PARAMS *params, const BIGNUM *pub_key,
 171                             int *ret);
 172 int ffc_validate_public_key_partial(const FFC_PARAMS *params,
 173                                     const BIGNUM *pub_key, int *ret);
 174 int ffc_validate_private_key(const BIGNUM *upper, const BIGNUM *priv_key,
 175                              int *ret);
 176
 177 int ffc_params_todata(const FFC_PARAMS *ffc, OSSL_PARAM_BLD *tmpl,
 178                       OSSL_PARAM params[]);
 179 int ffc_params_fromdata(FFC_PARAMS *ffc, const OSSL_PARAM params[]);
 180 int ffc_set_group_pqg(FFC_PARAMS *ffc, const char *group_name);
 181 int ffc_named_group_to_uid(const char *name);
 182 const char *ffc_named_group_from_uid(int nid);
 183 int ffc_set_group_pqg(FFC_PARAMS *ffc, const char *group_name);
 184 const char *ffc_params_flags_to_name(int flags);
 185 int ffc_params_flags_from_name(const char *name);
 186
 187 #endif /* OSSL_INTERNAL_FFC_H */