1 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
4 /* ====================================================================
5 * Copyright (c) 2006 The OpenSSL Project. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in
16 * the documentation and/or other materials provided with the
19 * 3. All advertising materials mentioning features or use of this
20 * software must display the following acknowledgment:
21 * "This product includes software developed by the OpenSSL Project
22 * for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24 * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
25 * endorse or promote products derived from this software without
26 * prior written permission. For written permission, please contact
27 * licensing@OpenSSL.org.
29 * 5. Products derived from this software may not be called "OpenSSL"
30 * nor may "OpenSSL" appear in their names without prior written
31 * permission of the OpenSSL Project.
33 * 6. Redistributions of any form whatsoever must retain the following
35 * "This product includes software developed by the OpenSSL Project
36 * for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38 * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
39 * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
40 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
41 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
42 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
44 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
45 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
46 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
47 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
49 * OF THE POSSIBILITY OF SUCH DAMAGE.
50 * ====================================================================
52 * This product includes cryptographic software written by Eric Young
53 * (eay@cryptsoft.com). This product includes software written by Tim
54 * Hudson (tjh@cryptsoft.com). */
56 #include <openssl/evp.h>
58 #include <openssl/asn1.h>
59 #include <openssl/asn1t.h>
60 #include <openssl/digest.h>
61 #include <openssl/err.h>
62 #include <openssl/mem.h>
63 #include <openssl/obj.h>
64 #include <openssl/rsa.h>
65 #include <openssl/x509.h>
67 #include "../rsa/internal.h"
71 static int rsa_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey) {
72 uint8_t *encoded = NULL;
74 len = i2d_RSAPublicKey(pkey->pkey.rsa, &encoded);
80 if (!X509_PUBKEY_set0_param(pk, OBJ_nid2obj(EVP_PKEY_RSA), V_ASN1_NULL, NULL,
82 OPENSSL_free(encoded);
89 static int rsa_pub_decode(EVP_PKEY *pkey, X509_PUBKEY *pubkey) {
94 if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, NULL, pubkey)) {
97 rsa = d2i_RSAPublicKey(NULL, &p, pklen);
99 OPENSSL_PUT_ERROR(EVP, rsa_pub_decode, ERR_R_RSA_LIB);
102 EVP_PKEY_assign_RSA(pkey, rsa);
106 static int rsa_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b) {
107 return BN_cmp(b->pkey.rsa->n, a->pkey.rsa->n) == 0 &&
108 BN_cmp(b->pkey.rsa->e, a->pkey.rsa->e) == 0;
111 static int rsa_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey) {
115 rklen = i2d_RSAPrivateKey(pkey->pkey.rsa, &rk);
118 OPENSSL_PUT_ERROR(EVP, rsa_priv_encode, ERR_R_MALLOC_FAILURE);
122 /* TODO(fork): const correctness in next line. */
123 if (!PKCS8_pkey_set0(p8, (ASN1_OBJECT *)OBJ_nid2obj(NID_rsaEncryption), 0,
124 V_ASN1_NULL, NULL, rk, rklen)) {
125 OPENSSL_PUT_ERROR(EVP, rsa_priv_encode, ERR_R_MALLOC_FAILURE);
132 static int rsa_priv_decode(EVP_PKEY *pkey, PKCS8_PRIV_KEY_INFO *p8) {
137 if (!PKCS8_pkey_get0(NULL, &p, &pklen, NULL, p8)) {
138 OPENSSL_PUT_ERROR(EVP, rsa_priv_decode, ERR_R_MALLOC_FAILURE);
142 rsa = d2i_RSAPrivateKey(NULL, &p, pklen);
144 OPENSSL_PUT_ERROR(EVP, rsa_priv_decode, ERR_R_RSA_LIB);
148 EVP_PKEY_assign_RSA(pkey, rsa);
152 static int rsa_opaque(const EVP_PKEY *pkey) {
153 return RSA_is_opaque(pkey->pkey.rsa);
156 static int int_rsa_size(const EVP_PKEY *pkey) {
157 return RSA_size(pkey->pkey.rsa);
160 static int rsa_bits(const EVP_PKEY *pkey) {
161 return BN_num_bits(pkey->pkey.rsa->n);
164 static void int_rsa_free(EVP_PKEY *pkey) { RSA_free(pkey->pkey.rsa); }
166 static void update_buflen(const BIGNUM *b, size_t *pbuflen) {
179 static int do_rsa_print(BIO *out, const RSA *rsa, int off,
180 int include_private) {
184 int ret = 0, mod_len = 0;
187 update_buflen(rsa->n, &buf_len);
188 update_buflen(rsa->e, &buf_len);
190 if (include_private) {
191 update_buflen(rsa->d, &buf_len);
192 update_buflen(rsa->p, &buf_len);
193 update_buflen(rsa->q, &buf_len);
194 update_buflen(rsa->dmp1, &buf_len);
195 update_buflen(rsa->dmq1, &buf_len);
196 update_buflen(rsa->iqmp, &buf_len);
199 m = (uint8_t *)OPENSSL_malloc(buf_len + 10);
201 OPENSSL_PUT_ERROR(EVP, do_rsa_print, ERR_R_MALLOC_FAILURE);
205 if (rsa->n != NULL) {
206 mod_len = BN_num_bits(rsa->n);
209 if (!BIO_indent(out, off, 128)) {
213 if (include_private && rsa->d) {
214 if (BIO_printf(out, "Private-Key: (%d bit)\n", mod_len) <= 0) {
218 s = "publicExponent:";
220 if (BIO_printf(out, "Public-Key: (%d bit)\n", mod_len) <= 0) {
226 if (!ASN1_bn_print(out, str, rsa->n, m, off) ||
227 !ASN1_bn_print(out, s, rsa->e, m, off)) {
231 if (include_private) {
232 if (!ASN1_bn_print(out, "privateExponent:", rsa->d, m, off) ||
233 !ASN1_bn_print(out, "prime1:", rsa->p, m, off) ||
234 !ASN1_bn_print(out, "prime2:", rsa->q, m, off) ||
235 !ASN1_bn_print(out, "exponent1:", rsa->dmp1, m, off) ||
236 !ASN1_bn_print(out, "exponent2:", rsa->dmq1, m, off) ||
237 !ASN1_bn_print(out, "coefficient:", rsa->iqmp, m, off)) {
250 static int rsa_pub_print(BIO *bp, const EVP_PKEY *pkey, int indent,
252 return do_rsa_print(bp, pkey->pkey.rsa, indent, 0);
256 static int rsa_priv_print(BIO *bp, const EVP_PKEY *pkey, int indent,
258 return do_rsa_print(bp, pkey->pkey.rsa, indent, 1);
261 /* Given an MGF1 Algorithm ID decode to an Algorithm Identifier */
262 static X509_ALGOR *rsa_mgf1_decode(X509_ALGOR *alg) {
267 OBJ_obj2nid(alg->algorithm) != NID_mgf1 ||
268 alg->parameter->type != V_ASN1_SEQUENCE) {
272 p = alg->parameter->value.sequence->data;
273 plen = alg->parameter->value.sequence->length;
274 return d2i_X509_ALGOR(NULL, &p, plen);
277 static RSA_PSS_PARAMS *rsa_pss_decode(const X509_ALGOR *alg,
278 X509_ALGOR **pmaskHash) {
285 if (!alg->parameter || alg->parameter->type != V_ASN1_SEQUENCE) {
288 p = alg->parameter->value.sequence->data;
289 plen = alg->parameter->value.sequence->length;
290 pss = d2i_RSA_PSS_PARAMS(NULL, &p, plen);
296 *pmaskHash = rsa_mgf1_decode(pss->maskGenAlgorithm);
301 static int rsa_pss_param_print(BIO *bp, RSA_PSS_PARAMS *pss,
302 X509_ALGOR *maskHash, int indent) {
306 if (BIO_puts(bp, " (INVALID PSS PARAMETERS)\n") <= 0) {
312 if (BIO_puts(bp, "\n") <= 0 ||
313 !BIO_indent(bp, indent, 128) ||
314 BIO_puts(bp, "Hash Algorithm: ") <= 0) {
318 if (pss->hashAlgorithm) {
319 if (i2a_ASN1_OBJECT(bp, pss->hashAlgorithm->algorithm) <= 0) {
322 } else if (BIO_puts(bp, "sha1 (default)") <= 0) {
326 if (BIO_puts(bp, "\n") <= 0 ||
327 !BIO_indent(bp, indent, 128) ||
328 BIO_puts(bp, "Mask Algorithm: ") <= 0) {
332 if (pss->maskGenAlgorithm) {
333 if (i2a_ASN1_OBJECT(bp, pss->maskGenAlgorithm->algorithm) <= 0 ||
334 BIO_puts(bp, " with ") <= 0) {
339 if (i2a_ASN1_OBJECT(bp, maskHash->algorithm) <= 0) {
342 } else if (BIO_puts(bp, "INVALID") <= 0) {
345 } else if (BIO_puts(bp, "mgf1 with sha1 (default)") <= 0) {
350 if (!BIO_indent(bp, indent, 128) ||
351 BIO_puts(bp, "Salt Length: 0x") <= 0) {
355 if (pss->saltLength) {
356 if (i2a_ASN1_INTEGER(bp, pss->saltLength) <= 0) {
359 } else if (BIO_puts(bp, "14 (default)") <= 0) {
364 if (!BIO_indent(bp, indent, 128) ||
365 BIO_puts(bp, "Trailer Field: 0x") <= 0) {
369 if (pss->trailerField) {
370 if (i2a_ASN1_INTEGER(bp, pss->trailerField) <= 0) {
373 } else if (BIO_puts(bp, "BC (default)") <= 0) {
384 static int rsa_sig_print(BIO *bp, const X509_ALGOR *sigalg,
385 const ASN1_STRING *sig, int indent, ASN1_PCTX *pctx) {
386 if (OBJ_obj2nid(sigalg->algorithm) == NID_rsassaPss) {
389 X509_ALGOR *maskHash;
391 pss = rsa_pss_decode(sigalg, &maskHash);
392 rv = rsa_pss_param_print(bp, pss, maskHash, indent);
394 RSA_PSS_PARAMS_free(pss);
397 X509_ALGOR_free(maskHash);
402 } else if (!sig && BIO_puts(bp, "\n") <= 0) {
407 return X509_signature_dump(bp, sig, indent);
412 static int rsa_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2) {
413 X509_ALGOR *alg = NULL;
415 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
416 *(int *)arg2 = NID_sha1;
424 X509_ALGOR_set0(alg, OBJ_nid2obj(NID_rsaEncryption), V_ASN1_NULL, 0);
430 static int old_rsa_priv_decode(EVP_PKEY *pkey, const unsigned char **pder,
432 RSA *rsa = d2i_RSAPrivateKey(NULL, pder, derlen);
434 OPENSSL_PUT_ERROR(EVP, old_rsa_priv_decode, ERR_R_RSA_LIB);
437 EVP_PKEY_assign_RSA(pkey, rsa);
441 static int old_rsa_priv_encode(const EVP_PKEY *pkey, unsigned char **pder) {
442 return i2d_RSAPrivateKey(pkey->pkey.rsa, pder);
445 /* allocate and set algorithm ID from EVP_MD, default SHA1 */
446 static int rsa_md_to_algor(X509_ALGOR **palg, const EVP_MD *md) {
447 if (EVP_MD_type(md) == NID_sha1) {
450 *palg = X509_ALGOR_new();
454 X509_ALGOR_set_md(*palg, md);
458 /* Allocate and set MGF1 algorithm ID from EVP_MD */
459 static int rsa_md_to_mgf1(X509_ALGOR **palg, const EVP_MD *mgf1md) {
460 X509_ALGOR *algtmp = NULL;
461 ASN1_STRING *stmp = NULL;
464 if (EVP_MD_type(mgf1md) == NID_sha1) {
467 /* need to embed algorithm ID inside another */
468 if (!rsa_md_to_algor(&algtmp, mgf1md) ||
469 !ASN1_item_pack(algtmp, ASN1_ITEM_rptr(X509_ALGOR), &stmp)) {
472 *palg = X509_ALGOR_new();
476 X509_ALGOR_set0(*palg, OBJ_nid2obj(NID_mgf1), V_ASN1_SEQUENCE, stmp);
481 ASN1_STRING_free(stmp);
483 X509_ALGOR_free(algtmp);
490 /* convert algorithm ID to EVP_MD, default SHA1 */
491 static const EVP_MD *rsa_algor_to_md(X509_ALGOR *alg) {
496 md = EVP_get_digestbyobj(alg->algorithm);
498 OPENSSL_PUT_ERROR(EVP, rsa_algor_to_md, EVP_R_UNKNOWN_DIGEST);
503 /* convert MGF1 algorithm ID to EVP_MD, default SHA1 */
504 static const EVP_MD *rsa_mgf1_to_md(X509_ALGOR *alg, X509_ALGOR *maskHash) {
509 /* Check mask and lookup mask hash algorithm */
510 if (OBJ_obj2nid(alg->algorithm) != NID_mgf1) {
511 OPENSSL_PUT_ERROR(EVP, rsa_mgf1_to_md, EVP_R_UNSUPPORTED_MASK_ALGORITHM);
515 OPENSSL_PUT_ERROR(EVP, rsa_mgf1_to_md, EVP_R_UNSUPPORTED_MASK_PARAMETER);
518 md = EVP_get_digestbyobj(maskHash->algorithm);
520 OPENSSL_PUT_ERROR(EVP, rsa_mgf1_to_md, EVP_R_UNKNOWN_MASK_DIGEST);
526 /* rsa_ctx_to_pss converts EVP_PKEY_CTX in PSS mode into corresponding
527 * algorithm parameter, suitable for setting as an AlgorithmIdentifier. */
528 static ASN1_STRING *rsa_ctx_to_pss(EVP_PKEY_CTX *pkctx) {
529 const EVP_MD *sigmd, *mgf1md;
530 RSA_PSS_PARAMS *pss = NULL;
531 ASN1_STRING *os = NULL;
532 EVP_PKEY *pk = EVP_PKEY_CTX_get0_pkey(pkctx);
535 if (EVP_PKEY_CTX_get_signature_md(pkctx, &sigmd) <= 0 ||
536 EVP_PKEY_CTX_get_rsa_mgf1_md(pkctx, &mgf1md) <= 0 ||
537 !EVP_PKEY_CTX_get_rsa_pss_saltlen(pkctx, &saltlen)) {
542 saltlen = EVP_MD_size(sigmd);
543 } else if (saltlen == -2) {
544 saltlen = EVP_PKEY_size(pk) - EVP_MD_size(sigmd) - 2;
545 if (((EVP_PKEY_bits(pk) - 1) & 0x7) == 0) {
552 pss = RSA_PSS_PARAMS_new();
558 pss->saltLength = ASN1_INTEGER_new();
559 if (!pss->saltLength ||
560 !ASN1_INTEGER_set(pss->saltLength, saltlen)) {
565 if (!rsa_md_to_algor(&pss->hashAlgorithm, sigmd) ||
566 !rsa_md_to_mgf1(&pss->maskGenAlgorithm, mgf1md)) {
570 /* Finally create string with pss parameter encoding. */
571 if (!ASN1_item_pack(pss, ASN1_ITEM_rptr(RSA_PSS_PARAMS), &os)) {
578 RSA_PSS_PARAMS_free(pss);
582 ASN1_STRING_free(os);
586 /* From PSS AlgorithmIdentifier set public key parameters. */
587 static int rsa_pss_to_ctx(EVP_MD_CTX *ctx, X509_ALGOR *sigalg, EVP_PKEY *pkey) {
590 const EVP_MD *mgf1md = NULL, *md = NULL;
592 X509_ALGOR *maskHash;
595 /* Sanity check: make sure it is PSS */
596 if (OBJ_obj2nid(sigalg->algorithm) != NID_rsassaPss) {
597 OPENSSL_PUT_ERROR(EVP, rsa_pss_to_ctx, EVP_R_UNSUPPORTED_SIGNATURE_TYPE);
600 /* Decode PSS parameters */
601 pss = rsa_pss_decode(sigalg, &maskHash);
603 OPENSSL_PUT_ERROR(EVP, rsa_pss_to_ctx, EVP_R_INVALID_PSS_PARAMETERS);
607 mgf1md = rsa_mgf1_to_md(pss->maskGenAlgorithm, maskHash);
611 md = rsa_algor_to_md(pss->hashAlgorithm);
617 if (pss->saltLength) {
618 saltlen = ASN1_INTEGER_get(pss->saltLength);
620 /* Could perform more salt length sanity checks but the main
621 * RSA routines will trap other invalid values anyway. */
623 OPENSSL_PUT_ERROR(EVP, rsa_pss_to_ctx, EVP_R_INVALID_SALT_LENGTH);
628 /* low-level routines support only trailer field 0xbc (value 1)
629 * and PKCS#1 says we should reject any other value anyway. */
630 if (pss->trailerField && ASN1_INTEGER_get(pss->trailerField) != 1) {
631 OPENSSL_PUT_ERROR(EVP, rsa_pss_to_ctx, EVP_R_INVALID_TRAILER);
635 if (!EVP_DigestVerifyInit(ctx, &pkctx, md, NULL, pkey) ||
636 EVP_PKEY_CTX_set_rsa_padding(pkctx, RSA_PKCS1_PSS_PADDING) <= 0 ||
637 EVP_PKEY_CTX_set_rsa_pss_saltlen(pkctx, saltlen) <= 0 ||
638 EVP_PKEY_CTX_set_rsa_mgf1_md(pkctx, mgf1md) <= 0) {
645 RSA_PSS_PARAMS_free(pss);
647 X509_ALGOR_free(maskHash);
652 /* Customised RSA AlgorithmIdentifier handling. This is called when a signature
653 * is encountered requiring special handling. We currently only handle PSS. */
654 static int rsa_digest_verify_init_from_algorithm(EVP_MD_CTX *ctx,
657 /* Sanity check: make sure it is PSS */
658 if (OBJ_obj2nid(sigalg->algorithm) != NID_rsassaPss) {
659 OPENSSL_PUT_ERROR(EVP, rsa_digest_verify_init_from_algorithm,
660 EVP_R_UNSUPPORTED_SIGNATURE_TYPE);
663 return rsa_pss_to_ctx(ctx, sigalg, pkey);
666 static evp_digest_sign_algorithm_result_t rsa_digest_sign_algorithm(
667 EVP_MD_CTX *ctx, X509_ALGOR *sigalg) {
669 EVP_PKEY_CTX *pkctx = ctx->pctx;
670 if (EVP_PKEY_CTX_get_rsa_padding(pkctx, &pad_mode) <= 0) {
671 return EVP_DIGEST_SIGN_ALGORITHM_ERROR;
673 if (pad_mode == RSA_PKCS1_PSS_PADDING) {
674 ASN1_STRING *os1 = rsa_ctx_to_pss(pkctx);
676 return EVP_DIGEST_SIGN_ALGORITHM_ERROR;
678 X509_ALGOR_set0(sigalg, OBJ_nid2obj(NID_rsassaPss), V_ASN1_SEQUENCE, os1);
679 return EVP_DIGEST_SIGN_ALGORITHM_SUCCESS;
682 /* Other padding schemes use the default behavior. */
683 return EVP_DIGEST_SIGN_ALGORITHM_DEFAULT;
686 const EVP_PKEY_ASN1_METHOD rsa_asn1_meth = {
689 ASN1_PKEY_SIGPARAM_NULL,
692 "OpenSSL RSA method",
717 rsa_digest_verify_init_from_algorithm,
718 rsa_digest_sign_algorithm,