1 /* Copyright (C) 1995-1998 Eric Young ([email protected]) 2 * All rights reserved. 3 * 4 * This package is an SSL implementation written 5 * by Eric Young ([email protected]). 6 * The implementation was written so as to conform with Netscapes SSL. 7 * 8 * This library is free for commercial and non-commercial use as long as 9 * the following conditions are aheared to. The following conditions 10 * apply to all code found in this distribution, be it the RC4, RSA, 11 * lhash, DES, etc., code; not just the SSL code. The SSL documentation 12 * included with this distribution is covered by the same copyright terms 13 * except that the holder is Tim Hudson ([email protected]). 14 * 15 * Copyright remains Eric Young's, and as such any Copyright notices in 16 * the code are not to be removed. 17 * If this package is used in a product, Eric Young should be given attribution 18 * as the author of the parts of the library used. 19 * This can be in the form of a textual message at program startup or 20 * in documentation (online or textual) provided with the package. 21 * 22 * Redistribution and use in source and binary forms, with or without 23 * modification, are permitted provided that the following conditions 24 * are met: 25 * 1. Redistributions of source code must retain the copyright 26 * notice, this list of conditions and the following disclaimer. 27 * 2. Redistributions in binary form must reproduce the above copyright 28 * notice, this list of conditions and the following disclaimer in the 29 * documentation and/or other materials provided with the distribution. 30 * 3. All advertising materials mentioning features or use of this software 31 * must display the following acknowledgement: 32 * "This product includes cryptographic software written by 33 * Eric Young ([email protected])" 34 * The word 'cryptographic' can be left out if the rouines from the library 35 * being used are not cryptographic related :-). 36 * 4. If you include any Windows specific code (or a derivative thereof) from 37 * the apps directory (application code) you must include an acknowledgement: 38 * "This product includes software written by Tim Hudson ([email protected])" 39 * 40 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND 41 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 42 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 43 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 44 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 45 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 46 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 47 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 48 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 49 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 50 * SUCH DAMAGE. 51 * 52 * The licence and distribution terms for any publically available version or 53 * derivative of this code cannot be changed. i.e. this code cannot simply be 54 * copied and put under another distribution licence 55 * [including the GNU Public Licence.] 56 * 57 * The DSS routines are based on patches supplied by 58 * Steven Schoch <[email protected]>. */ 59 60 #ifndef OPENSSL_HEADER_DSA_H 61 #define OPENSSL_HEADER_DSA_H 62 63 #include <openssl/base.h> 64 65 #include <openssl/ex_data.h> 66 67 #if defined(__cplusplus) 68 extern "C" { 69 #endif 70 71 72 // DSA contains functions for signing and verifying with the Digital Signature 73 // Algorithm. 74 // 75 // This module is deprecated and retained for legacy reasons only. It is not 76 // considered a priority for performance or hardening work. Do not use it in 77 // new code. Use Ed25519, ECDSA with P-256, or RSA instead. 78 79 80 // Allocation and destruction. 81 // 82 // A |DSA| object represents a DSA key or group parameters. A given object may 83 // be used concurrently on multiple threads by non-mutating functions, provided 84 // no other thread is concurrently calling a mutating function. Unless otherwise 85 // documented, functions which take a |const| pointer are non-mutating and 86 // functions which take a non-|const| pointer are mutating. 87 88 // DSA_new returns a new, empty DSA object or NULL on error. 89 OPENSSL_EXPORT DSA *DSA_new(void); 90 91 // DSA_free decrements the reference count of |dsa| and frees it if the 92 // reference count drops to zero. 93 OPENSSL_EXPORT void DSA_free(DSA *dsa); 94 95 // DSA_up_ref increments the reference count of |dsa| and returns one. It does 96 // not mutate |dsa| for thread-safety purposes and may be used concurrently. 97 OPENSSL_EXPORT int DSA_up_ref(DSA *dsa); 98 99 100 // Properties. 101 102 // DSA_bits returns the size of |dsa|'s group modulus, in bits. 103 OPENSSL_EXPORT unsigned DSA_bits(const DSA *dsa); 104 105 // DSA_get0_pub_key returns |dsa|'s public key. 106 OPENSSL_EXPORT const BIGNUM *DSA_get0_pub_key(const DSA *dsa); 107 108 // DSA_get0_priv_key returns |dsa|'s private key, or NULL if |dsa| is a public 109 // key. 110 OPENSSL_EXPORT const BIGNUM *DSA_get0_priv_key(const DSA *dsa); 111 112 // DSA_get0_p returns |dsa|'s group modulus. 113 OPENSSL_EXPORT const BIGNUM *DSA_get0_p(const DSA *dsa); 114 115 // DSA_get0_q returns the size of |dsa|'s subgroup. 116 OPENSSL_EXPORT const BIGNUM *DSA_get0_q(const DSA *dsa); 117 118 // DSA_get0_g returns |dsa|'s group generator. 119 OPENSSL_EXPORT const BIGNUM *DSA_get0_g(const DSA *dsa); 120 121 // DSA_get0_key sets |*out_pub_key| and |*out_priv_key|, if non-NULL, to |dsa|'s 122 // public and private key, respectively. If |dsa| is a public key, the private 123 // key will be set to NULL. 124 OPENSSL_EXPORT void DSA_get0_key(const DSA *dsa, const BIGNUM **out_pub_key, 125 const BIGNUM **out_priv_key); 126 127 // DSA_get0_pqg sets |*out_p|, |*out_q|, and |*out_g|, if non-NULL, to |dsa|'s 128 // p, q, and g parameters, respectively. 129 OPENSSL_EXPORT void DSA_get0_pqg(const DSA *dsa, const BIGNUM **out_p, 130 const BIGNUM **out_q, const BIGNUM **out_g); 131 132 // DSA_set0_key sets |dsa|'s public and private key to |pub_key| and |priv_key|, 133 // respectively, if non-NULL. On success, it takes ownership of each argument 134 // and returns one. Otherwise, it returns zero. 135 // 136 // |priv_key| may be NULL, but |pub_key| must either be non-NULL or already 137 // configured on |dsa|. 138 OPENSSL_EXPORT int DSA_set0_key(DSA *dsa, BIGNUM *pub_key, BIGNUM *priv_key); 139 140 // DSA_set0_pqg sets |dsa|'s parameters to |p|, |q|, and |g|, if non-NULL, and 141 // takes ownership of them. On success, it takes ownership of each argument and 142 // returns one. Otherwise, it returns zero. 143 // 144 // Each argument must either be non-NULL or already configured on |dsa|. 145 OPENSSL_EXPORT int DSA_set0_pqg(DSA *dsa, BIGNUM *p, BIGNUM *q, BIGNUM *g); 146 147 148 // Parameter generation. 149 150 // DSA_generate_parameters_ex generates a set of DSA parameters by following 151 // the procedure given in FIPS 186-4, appendix A. 152 // (http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.186-4.pdf) 153 // 154 // The larger prime will have a length of |bits| (e.g. 2048). The |seed| value 155 // allows others to generate and verify the same parameters and should be 156 // random input which is kept for reference. If |out_counter| or |out_h| are 157 // not NULL then the counter and h value used in the generation are written to 158 // them. 159 // 160 // The |cb| argument is passed to |BN_generate_prime_ex| and is thus called 161 // during the generation process in order to indicate progress. See the 162 // comments for that function for details. In addition to the calls made by 163 // |BN_generate_prime_ex|, |DSA_generate_parameters_ex| will call it with 164 // |event| equal to 2 and 3 at different stages of the process. 165 // 166 // It returns one on success and zero otherwise. 167 OPENSSL_EXPORT int DSA_generate_parameters_ex(DSA *dsa, unsigned bits, 168 const uint8_t *seed, 169 size_t seed_len, int *out_counter, 170 unsigned long *out_h, 171 BN_GENCB *cb); 172 173 // DSAparams_dup returns a freshly allocated |DSA| that contains a copy of the 174 // parameters from |dsa|. It returns NULL on error. 175 OPENSSL_EXPORT DSA *DSAparams_dup(const DSA *dsa); 176 177 178 // Key generation. 179 180 // DSA_generate_key generates a public/private key pair in |dsa|, which must 181 // already have parameters setup. It returns one on success and zero on 182 // error. 183 OPENSSL_EXPORT int DSA_generate_key(DSA *dsa); 184 185 186 // Signatures. 187 188 // DSA_SIG_st (aka |DSA_SIG|) contains a DSA signature as a pair of integers. 189 struct DSA_SIG_st { 190 BIGNUM *r, *s; 191 }; 192 193 // DSA_SIG_new returns a freshly allocated, DIG_SIG structure or NULL on error. 194 // Both |r| and |s| in the signature will be NULL. 195 OPENSSL_EXPORT DSA_SIG *DSA_SIG_new(void); 196 197 // DSA_SIG_free frees the contents of |sig| and then frees |sig| itself. 198 OPENSSL_EXPORT void DSA_SIG_free(DSA_SIG *sig); 199 200 // DSA_SIG_get0 sets |*out_r| and |*out_s|, if non-NULL, to the two components 201 // of |sig|. 202 OPENSSL_EXPORT void DSA_SIG_get0(const DSA_SIG *sig, const BIGNUM **out_r, 203 const BIGNUM **out_s); 204 205 // DSA_SIG_set0 sets |sig|'s components to |r| and |s|, neither of which may be 206 // NULL. On success, it takes ownership of each argument and returns one. 207 // Otherwise, it returns zero. 208 OPENSSL_EXPORT int DSA_SIG_set0(DSA_SIG *sig, BIGNUM *r, BIGNUM *s); 209 210 // DSA_do_sign returns a signature of the hash in |digest| by the key in |dsa| 211 // and returns an allocated, DSA_SIG structure, or NULL on error. 212 OPENSSL_EXPORT DSA_SIG *DSA_do_sign(const uint8_t *digest, size_t digest_len, 213 const DSA *dsa); 214 215 // DSA_do_verify verifies that |sig| is a valid signature, by the public key in 216 // |dsa|, of the hash in |digest|. It returns one if so, zero if invalid and -1 217 // on error. 218 // 219 // WARNING: do not use. This function returns -1 for error, 0 for invalid and 1 220 // for valid. However, this is dangerously different to the usual OpenSSL 221 // convention and could be a disaster if a user did |if (DSA_do_verify(...))|. 222 // Because of this, |DSA_check_signature| is a safer version of this. 223 // 224 // TODO(fork): deprecate. 225 OPENSSL_EXPORT int DSA_do_verify(const uint8_t *digest, size_t digest_len, 226 const DSA_SIG *sig, const DSA *dsa); 227 228 // DSA_do_check_signature sets |*out_valid| to zero. Then it verifies that |sig| 229 // is a valid signature, by the public key in |dsa| of the hash in |digest| 230 // and, if so, it sets |*out_valid| to one. 231 // 232 // It returns one if it was able to verify the signature as valid or invalid, 233 // and zero on error. 234 OPENSSL_EXPORT int DSA_do_check_signature(int *out_valid, const uint8_t *digest, 235 size_t digest_len, const DSA_SIG *sig, 236 const DSA *dsa); 237 238 239 // ASN.1 signatures. 240 // 241 // These functions also perform DSA signature operations, but deal with ASN.1 242 // encoded signatures as opposed to raw |BIGNUM|s. If you don't know what 243 // encoding a DSA signature is in, it's probably ASN.1. 244 245 // DSA_sign signs |digest| with the key in |dsa| and writes the resulting 246 // signature, in ASN.1 form, to |out_sig| and the length of the signature to 247 // |*out_siglen|. There must be, at least, |DSA_size(dsa)| bytes of space in 248 // |out_sig|. It returns one on success and zero otherwise. 249 // 250 // (The |type| argument is ignored.) 251 OPENSSL_EXPORT int DSA_sign(int type, const uint8_t *digest, size_t digest_len, 252 uint8_t *out_sig, unsigned int *out_siglen, 253 const DSA *dsa); 254 255 // DSA_verify verifies that |sig| is a valid, ASN.1 signature, by the public 256 // key in |dsa|, of the hash in |digest|. It returns one if so, zero if invalid 257 // and -1 on error. 258 // 259 // (The |type| argument is ignored.) 260 // 261 // WARNING: do not use. This function returns -1 for error, 0 for invalid and 1 262 // for valid. However, this is dangerously different to the usual OpenSSL 263 // convention and could be a disaster if a user did |if (DSA_do_verify(...))|. 264 // Because of this, |DSA_check_signature| is a safer version of this. 265 // 266 // TODO(fork): deprecate. 267 OPENSSL_EXPORT int DSA_verify(int type, const uint8_t *digest, 268 size_t digest_len, const uint8_t *sig, 269 size_t sig_len, const DSA *dsa); 270 271 // DSA_check_signature sets |*out_valid| to zero. Then it verifies that |sig| 272 // is a valid, ASN.1 signature, by the public key in |dsa|, of the hash in 273 // |digest|. If so, it sets |*out_valid| to one. 274 // 275 // It returns one if it was able to verify the signature as valid or invalid, 276 // and zero on error. 277 OPENSSL_EXPORT int DSA_check_signature(int *out_valid, const uint8_t *digest, 278 size_t digest_len, const uint8_t *sig, 279 size_t sig_len, const DSA *dsa); 280 281 // DSA_size returns the size, in bytes, of an ASN.1 encoded, DSA signature 282 // generated by |dsa|. Parameters must already have been setup in |dsa|. 283 OPENSSL_EXPORT int DSA_size(const DSA *dsa); 284 285 286 // ASN.1 encoding. 287 288 // DSA_SIG_parse parses a DER-encoded DSA-Sig-Value structure from |cbs| and 289 // advances |cbs|. It returns a newly-allocated |DSA_SIG| or NULL on error. 290 OPENSSL_EXPORT DSA_SIG *DSA_SIG_parse(CBS *cbs); 291 292 // DSA_SIG_marshal marshals |sig| as a DER-encoded DSA-Sig-Value and appends the 293 // result to |cbb|. It returns one on success and zero on error. 294 OPENSSL_EXPORT int DSA_SIG_marshal(CBB *cbb, const DSA_SIG *sig); 295 296 // DSA_parse_public_key parses a DER-encoded DSA public key from |cbs| and 297 // advances |cbs|. It returns a newly-allocated |DSA| or NULL on error. 298 OPENSSL_EXPORT DSA *DSA_parse_public_key(CBS *cbs); 299 300 // DSA_marshal_public_key marshals |dsa| as a DER-encoded DSA public key and 301 // appends the result to |cbb|. It returns one on success and zero on 302 // failure. 303 OPENSSL_EXPORT int DSA_marshal_public_key(CBB *cbb, const DSA *dsa); 304 305 // DSA_parse_private_key parses a DER-encoded DSA private key from |cbs| and 306 // advances |cbs|. It returns a newly-allocated |DSA| or NULL on error. 307 OPENSSL_EXPORT DSA *DSA_parse_private_key(CBS *cbs); 308 309 // DSA_marshal_private_key marshals |dsa| as a DER-encoded DSA private key and 310 // appends the result to |cbb|. It returns one on success and zero on 311 // failure. 312 OPENSSL_EXPORT int DSA_marshal_private_key(CBB *cbb, const DSA *dsa); 313 314 // DSA_parse_parameters parses a DER-encoded Dss-Parms structure (RFC 3279) 315 // from |cbs| and advances |cbs|. It returns a newly-allocated |DSA| or NULL on 316 // error. 317 OPENSSL_EXPORT DSA *DSA_parse_parameters(CBS *cbs); 318 319 // DSA_marshal_parameters marshals |dsa| as a DER-encoded Dss-Parms structure 320 // (RFC 3279) and appends the result to |cbb|. It returns one on success and 321 // zero on failure. 322 OPENSSL_EXPORT int DSA_marshal_parameters(CBB *cbb, const DSA *dsa); 323 324 325 // Conversion. 326 327 // DSA_dup_DH returns a |DH| constructed from the parameters of |dsa|. This is 328 // sometimes needed when Diffie-Hellman parameters are stored in the form of 329 // DSA parameters. It returns an allocated |DH| on success or NULL on error. 330 OPENSSL_EXPORT DH *DSA_dup_DH(const DSA *dsa); 331 332 333 // ex_data functions. 334 // 335 // See |ex_data.h| for details. 336 337 OPENSSL_EXPORT int DSA_get_ex_new_index(long argl, void *argp, 338 CRYPTO_EX_unused *unused, 339 CRYPTO_EX_dup *dup_unused, 340 CRYPTO_EX_free *free_func); 341 OPENSSL_EXPORT int DSA_set_ex_data(DSA *dsa, int idx, void *arg); 342 OPENSSL_EXPORT void *DSA_get_ex_data(const DSA *dsa, int idx); 343 344 345 // Deprecated functions. 346 347 // d2i_DSA_SIG parses a DER-encoded DSA-Sig-Value structure from |len| bytes at 348 // |*inp|, as described in |d2i_SAMPLE|. 349 // 350 // Use |DSA_SIG_parse| instead. 351 OPENSSL_EXPORT DSA_SIG *d2i_DSA_SIG(DSA_SIG **out_sig, const uint8_t **inp, 352 long len); 353 354 // i2d_DSA_SIG marshals |in| to a DER-encoded DSA-Sig-Value structure, as 355 // described in |i2d_SAMPLE|. 356 // 357 // Use |DSA_SIG_marshal| instead. 358 OPENSSL_EXPORT int i2d_DSA_SIG(const DSA_SIG *in, uint8_t **outp); 359 360 // d2i_DSAPublicKey parses a DER-encoded DSA public key from |len| bytes at 361 // |*inp|, as described in |d2i_SAMPLE|. 362 // 363 // Use |DSA_parse_public_key| instead. 364 OPENSSL_EXPORT DSA *d2i_DSAPublicKey(DSA **out, const uint8_t **inp, long len); 365 366 // i2d_DSAPublicKey marshals |in| as a DER-encoded DSA public key, as described 367 // in |i2d_SAMPLE|. 368 // 369 // Use |DSA_marshal_public_key| instead. 370 OPENSSL_EXPORT int i2d_DSAPublicKey(const DSA *in, uint8_t **outp); 371 372 // d2i_DSAPrivateKey parses a DER-encoded DSA private key from |len| bytes at 373 // |*inp|, as described in |d2i_SAMPLE|. 374 // 375 // Use |DSA_parse_private_key| instead. 376 OPENSSL_EXPORT DSA *d2i_DSAPrivateKey(DSA **out, const uint8_t **inp, long len); 377 378 // i2d_DSAPrivateKey marshals |in| as a DER-encoded DSA private key, as 379 // described in |i2d_SAMPLE|. 380 // 381 // Use |DSA_marshal_private_key| instead. 382 OPENSSL_EXPORT int i2d_DSAPrivateKey(const DSA *in, uint8_t **outp); 383 384 // d2i_DSAparams parses a DER-encoded Dss-Parms structure (RFC 3279) from |len| 385 // bytes at |*inp|, as described in |d2i_SAMPLE|. 386 // 387 // Use |DSA_parse_parameters| instead. 388 OPENSSL_EXPORT DSA *d2i_DSAparams(DSA **out, const uint8_t **inp, long len); 389 390 // i2d_DSAparams marshals |in|'s parameters as a DER-encoded Dss-Parms structure 391 // (RFC 3279), as described in |i2d_SAMPLE|. 392 // 393 // Use |DSA_marshal_parameters| instead. 394 OPENSSL_EXPORT int i2d_DSAparams(const DSA *in, uint8_t **outp); 395 396 // DSA_generate_parameters is a deprecated version of 397 // |DSA_generate_parameters_ex| that creates and returns a |DSA*|. Don't use 398 // it. 399 OPENSSL_EXPORT DSA *DSA_generate_parameters(int bits, unsigned char *seed, 400 int seed_len, int *counter_ret, 401 unsigned long *h_ret, 402 void (*callback)(int, int, void *), 403 void *cb_arg); 404 405 406 #if defined(__cplusplus) 407 } // extern C 408 409 extern "C++" { 410 411 BSSL_NAMESPACE_BEGIN 412 413 BORINGSSL_MAKE_DELETER(DSA, DSA_free) 414 BORINGSSL_MAKE_UP_REF(DSA, DSA_up_ref) 415 BORINGSSL_MAKE_DELETER(DSA_SIG, DSA_SIG_free) 416 417 BSSL_NAMESPACE_END 418 419 } // extern C++ 420 421 #endif 422 423 #define DSA_R_BAD_Q_VALUE 100 424 #define DSA_R_MISSING_PARAMETERS 101 425 #define DSA_R_MODULUS_TOO_LARGE 102 426 #define DSA_R_NEED_NEW_SETUP_VALUES 103 427 #define DSA_R_BAD_VERSION 104 428 #define DSA_R_DECODE_ERROR 105 429 #define DSA_R_ENCODE_ERROR 106 430 #define DSA_R_INVALID_PARAMETERS 107 431 #define DSA_R_TOO_MANY_ITERATIONS 108 432 433 #endif // OPENSSL_HEADER_DSA_H 434