1 /* $OpenBSD: dsa.h,v 1.43 2023/04/18 08:47:28 tb Exp $ */ 2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 3 * All rights reserved. 4 * 5 * This package is an SSL implementation written 6 * by Eric Young (eay@cryptsoft.com). 7 * The implementation was written so as to conform with Netscapes SSL. 8 * 9 * This library is free for commercial and non-commercial use as long as 10 * the following conditions are aheared to. The following conditions 11 * apply to all code found in this distribution, be it the RC4, RSA, 12 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 13 * included with this distribution is covered by the same copyright terms 14 * except that the holder is Tim Hudson (tjh@cryptsoft.com). 15 * 16 * Copyright remains Eric Young's, and as such any Copyright notices in 17 * the code are not to be removed. 18 * If this package is used in a product, Eric Young should be given attribution 19 * as the author of the parts of the library used. 20 * This can be in the form of a textual message at program startup or 21 * in documentation (online or textual) provided with the package. 22 * 23 * Redistribution and use in source and binary forms, with or without 24 * modification, are permitted provided that the following conditions 25 * are met: 26 * 1. Redistributions of source code must retain the copyright 27 * notice, this list of conditions and the following disclaimer. 28 * 2. Redistributions in binary form must reproduce the above copyright 29 * notice, this list of conditions and the following disclaimer in the 30 * documentation and/or other materials provided with the distribution. 31 * 3. All advertising materials mentioning features or use of this software 32 * must display the following acknowledgement: 33 * "This product includes cryptographic software written by 34 * Eric Young (eay@cryptsoft.com)" 35 * The word 'cryptographic' can be left out if the rouines from the library 36 * being used are not cryptographic related :-). 37 * 4. If you include any Windows specific code (or a derivative thereof) from 38 * the apps directory (application code) you must include an acknowledgement: 39 * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)" 40 * 41 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 42 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 43 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 44 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 45 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 46 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 47 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 48 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 49 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 50 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 51 * SUCH DAMAGE. 52 * 53 * The licence and distribution terms for any publically available version or 54 * derivative of this code cannot be changed. i.e. this code cannot simply be 55 * copied and put under another distribution licence 56 * [including the GNU Public Licence.] 57 */ 58 59 /* 60 * The DSS routines are based on patches supplied by 61 * Steven Schoch <schoch@sheba.arc.nasa.gov>. He basically did the 62 * work and I have just tweaked them a little to fit into my 63 * stylistic vision for SSLeay :-) */ 64 65 #ifndef HEADER_DSA_H 66 #define HEADER_DSA_H 67 68 #include <openssl/opensslconf.h> 69 70 #ifdef OPENSSL_NO_DSA 71 #error DSA is disabled. 72 #endif 73 74 #ifndef OPENSSL_NO_BIO 75 #include <openssl/bio.h> 76 #endif 77 #include <openssl/bn.h> 78 #include <openssl/crypto.h> 79 #ifndef OPENSSL_NO_DH 80 # include <openssl/dh.h> 81 #endif 82 83 #include <openssl/ossl_typ.h> 84 85 #ifndef OPENSSL_DSA_MAX_MODULUS_BITS 86 # define OPENSSL_DSA_MAX_MODULUS_BITS 10000 87 #endif 88 89 #define DSA_FLAG_CACHE_MONT_P 0x01 90 91 /* If this flag is set the DSA method is FIPS compliant and can be used 92 * in FIPS mode. This is set in the validated module method. If an 93 * application sets this flag in its own methods it is its reposibility 94 * to ensure the result is compliant. 95 */ 96 97 #define DSA_FLAG_FIPS_METHOD 0x0400 98 99 /* If this flag is set the operations normally disabled in FIPS mode are 100 * permitted it is then the applications responsibility to ensure that the 101 * usage is compliant. 102 */ 103 104 #define DSA_FLAG_NON_FIPS_ALLOW 0x0400 105 106 #ifdef __cplusplus 107 extern "C" { 108 #endif 109 110 typedef struct DSA_SIG_st DSA_SIG; 111 112 DSA *d2i_DSAparams_bio(BIO *bp, DSA **a); 113 int i2d_DSAparams_bio(BIO *bp, DSA *a); 114 DSA *d2i_DSAparams_fp(FILE *fp, DSA **a); 115 int i2d_DSAparams_fp(FILE *fp, DSA *a); 116 117 DSA *DSAparams_dup(DSA *x); 118 DSA_SIG * DSA_SIG_new(void); 119 void DSA_SIG_free(DSA_SIG *a); 120 int i2d_DSA_SIG(const DSA_SIG *a, unsigned char **pp); 121 DSA_SIG * d2i_DSA_SIG(DSA_SIG **v, const unsigned char **pp, long length); 122 void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **pr, const BIGNUM **ps); 123 int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s); 124 125 DSA_SIG * DSA_do_sign(const unsigned char *dgst,int dlen,DSA *dsa); 126 int DSA_do_verify(const unsigned char *dgst,int dgst_len, 127 DSA_SIG *sig,DSA *dsa); 128 129 const DSA_METHOD *DSA_OpenSSL(void); 130 131 void DSA_set_default_method(const DSA_METHOD *); 132 const DSA_METHOD *DSA_get_default_method(void); 133 int DSA_set_method(DSA *dsa, const DSA_METHOD *); 134 135 DSA * DSA_new(void); 136 DSA * DSA_new_method(ENGINE *engine); 137 void DSA_free(DSA *r); 138 /* "up" the DSA object's reference count */ 139 int DSA_up_ref(DSA *r); 140 int DSA_size(const DSA *); 141 int DSA_bits(const DSA *d); 142 /* next 4 return -1 on error */ 143 int DSA_sign_setup( DSA *dsa,BN_CTX *ctx_in,BIGNUM **kinvp,BIGNUM **rp); 144 int DSA_sign(int type,const unsigned char *dgst,int dlen, 145 unsigned char *sig, unsigned int *siglen, DSA *dsa); 146 int DSA_verify(int type,const unsigned char *dgst,int dgst_len, 147 const unsigned char *sigbuf, int siglen, DSA *dsa); 148 int DSA_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func, 149 CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func); 150 int DSA_set_ex_data(DSA *d, int idx, void *arg); 151 void *DSA_get_ex_data(DSA *d, int idx); 152 int DSA_security_bits(const DSA *d); 153 154 DSA *d2i_DSAPublicKey(DSA **a, const unsigned char **pp, long length); 155 int i2d_DSAPublicKey(const DSA *a, unsigned char **pp); 156 extern const ASN1_ITEM DSAPublicKey_it; 157 158 DSA *d2i_DSAPrivateKey(DSA **a, const unsigned char **pp, long length); 159 int i2d_DSAPrivateKey(const DSA *a, unsigned char **pp); 160 extern const ASN1_ITEM DSAPrivateKey_it; 161 162 DSA *d2i_DSAparams(DSA **a, const unsigned char **pp, long length); 163 int i2d_DSAparams(const DSA *a,unsigned char **pp); 164 extern const ASN1_ITEM DSAparams_it; 165 166 /* Wrapped in OPENSSL_NO_DEPRECATED in 0.9.8. Still used in 2023. */ 167 DSA * DSA_generate_parameters(int bits, 168 unsigned char *seed,int seed_len, 169 int *counter_ret, unsigned long *h_ret,void 170 (*callback)(int, int, void *),void *cb_arg); 171 172 /* New version */ 173 int DSA_generate_parameters_ex(DSA *dsa, int bits, 174 const unsigned char *seed,int seed_len, 175 int *counter_ret, unsigned long *h_ret, BN_GENCB *cb); 176 177 int DSA_generate_key(DSA *a); 178 179 #ifndef OPENSSL_NO_BIO 180 int DSAparams_print(BIO *bp, const DSA *x); 181 int DSA_print(BIO *bp, const DSA *x, int off); 182 #endif 183 int DSAparams_print_fp(FILE *fp, const DSA *x); 184 int DSA_print_fp(FILE *bp, const DSA *x, int off); 185 186 /* 187 * Primality test according to FIPS PUB 186-4, Appendix C.3. Set the number 188 * to 64 rounds of Miller-Rabin, which corresponds to 128 bits of security. 189 * This is necessary for keys of size >= 3072. 190 */ 191 #define DSS_prime_checks 64 192 #define DSA_is_prime(n, callback, cb_arg) \ 193 BN_is_prime(n, DSS_prime_checks, callback, NULL, cb_arg) 194 195 #ifndef OPENSSL_NO_DH 196 /* Convert DSA structure (key or just parameters) into DH structure 197 * (be careful to avoid small subgroup attacks when using this!) */ 198 DH *DSA_dup_DH(const DSA *r); 199 #endif 200 201 void DSA_get0_pqg(const DSA *d, const BIGNUM **p, const BIGNUM **q, 202 const BIGNUM **g); 203 int DSA_set0_pqg(DSA *d, BIGNUM *p, BIGNUM *q, BIGNUM *g); 204 void DSA_get0_key(const DSA *d, const BIGNUM **pub_key, const BIGNUM **priv_key); 205 int DSA_set0_key(DSA *d, BIGNUM *pub_key, BIGNUM *priv_key); 206 const BIGNUM *DSA_get0_p(const DSA *d); 207 const BIGNUM *DSA_get0_q(const DSA *d); 208 const BIGNUM *DSA_get0_g(const DSA *d); 209 const BIGNUM *DSA_get0_pub_key(const DSA *d); 210 const BIGNUM *DSA_get0_priv_key(const DSA *d); 211 void DSA_clear_flags(DSA *d, int flags); 212 int DSA_test_flags(const DSA *d, int flags); 213 void DSA_set_flags(DSA *d, int flags); 214 ENGINE *DSA_get0_engine(DSA *d); 215 216 DSA_METHOD *DSA_meth_new(const char *name, int flags); 217 void DSA_meth_free(DSA_METHOD *meth); 218 DSA_METHOD *DSA_meth_dup(const DSA_METHOD *meth); 219 const char *DSA_meth_get0_name(const DSA_METHOD *meth); 220 int DSA_meth_set1_name(DSA_METHOD *meth, const char *name); 221 int DSA_meth_set_sign(DSA_METHOD *meth, 222 DSA_SIG *(*sign)(const unsigned char *, int, DSA *)); 223 int DSA_meth_set_finish(DSA_METHOD *meth, int (*finish)(DSA *)); 224 225 #define EVP_PKEY_CTX_set_dsa_paramgen_bits(ctx, nbits) \ 226 EVP_PKEY_CTX_ctrl(ctx, EVP_PKEY_DSA, EVP_PKEY_OP_PARAMGEN, \ 227 EVP_PKEY_CTRL_DSA_PARAMGEN_BITS, nbits, NULL) 228 229 #define EVP_PKEY_CTRL_DSA_PARAMGEN_BITS (EVP_PKEY_ALG_CTRL + 1) 230 #define EVP_PKEY_CTRL_DSA_PARAMGEN_Q_BITS (EVP_PKEY_ALG_CTRL + 2) 231 #define EVP_PKEY_CTRL_DSA_PARAMGEN_MD (EVP_PKEY_ALG_CTRL + 3) 232 233 void ERR_load_DSA_strings(void); 234 235 /* Error codes for the DSA functions. */ 236 237 /* Function codes. */ 238 #define DSA_F_D2I_DSA_SIG 110 239 #define DSA_F_DO_DSA_PRINT 104 240 #define DSA_F_DSAPARAMS_PRINT 100 241 #define DSA_F_DSAPARAMS_PRINT_FP 101 242 #define DSA_F_DSA_DO_SIGN 112 243 #define DSA_F_DSA_DO_VERIFY 113 244 #define DSA_F_DSA_GENERATE_KEY 124 245 #define DSA_F_DSA_GENERATE_PARAMETERS_EX 123 246 #define DSA_F_DSA_NEW_METHOD 103 247 #define DSA_F_DSA_PARAM_DECODE 119 248 #define DSA_F_DSA_PRINT_FP 105 249 #define DSA_F_DSA_PRIV_DECODE 115 250 #define DSA_F_DSA_PRIV_ENCODE 116 251 #define DSA_F_DSA_PUB_DECODE 117 252 #define DSA_F_DSA_PUB_ENCODE 118 253 #define DSA_F_DSA_SIGN 106 254 #define DSA_F_DSA_SIGN_SETUP 107 255 #define DSA_F_DSA_SIG_NEW 109 256 #define DSA_F_DSA_SIG_PRINT 125 257 #define DSA_F_DSA_VERIFY 108 258 #define DSA_F_I2D_DSA_SIG 111 259 #define DSA_F_OLD_DSA_PRIV_DECODE 122 260 #define DSA_F_PKEY_DSA_CTRL 120 261 #define DSA_F_PKEY_DSA_KEYGEN 121 262 #define DSA_F_SIG_CB 114 263 264 /* Reason codes. */ 265 #define DSA_R_BAD_Q_VALUE 102 266 #define DSA_R_BN_DECODE_ERROR 108 267 #define DSA_R_BN_ERROR 109 268 #define DSA_R_DATA_TOO_LARGE_FOR_KEY_SIZE 100 269 #define DSA_R_DECODE_ERROR 104 270 #define DSA_R_INVALID_DIGEST_TYPE 106 271 #define DSA_R_INVALID_PARAMETERS 112 272 #define DSA_R_MISSING_PARAMETERS 101 273 #define DSA_R_MODULUS_TOO_LARGE 103 274 #define DSA_R_NEED_NEW_SETUP_VALUES 110 275 #define DSA_R_NON_FIPS_DSA_METHOD 111 276 #define DSA_R_NO_PARAMETERS_SET 107 277 #define DSA_R_PARAMETER_ENCODING_ERROR 105 278 279 #ifdef __cplusplus 280 } 281 #endif 282 #endif 283