contrib/openssl/include/openssl/dsa.h

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