typo
[openssl.git] / crypto / rsa / rsa_ameth.c
1 /* crypto/rsa/rsa_ameth.c */
2 /* Written by Dr Stephen N Henson (steve@openssl.org) for the OpenSSL
3  * project 2006.
4  */
5 /* ====================================================================
6  * Copyright (c) 2006 The OpenSSL Project.  All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer. 
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in
17  *    the documentation and/or other materials provided with the
18  *    distribution.
19  *
20  * 3. All advertising materials mentioning features or use of this
21  *    software must display the following acknowledgment:
22  *    "This product includes software developed by the OpenSSL Project
23  *    for use in the OpenSSL Toolkit. (http://www.OpenSSL.org/)"
24  *
25  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
26  *    endorse or promote products derived from this software without
27  *    prior written permission. For written permission, please contact
28  *    licensing@OpenSSL.org.
29  *
30  * 5. Products derived from this software may not be called "OpenSSL"
31  *    nor may "OpenSSL" appear in their names without prior written
32  *    permission of the OpenSSL Project.
33  *
34  * 6. Redistributions of any form whatsoever must retain the following
35  *    acknowledgment:
36  *    "This product includes software developed by the OpenSSL Project
37  *    for use in the OpenSSL Toolkit (http://www.OpenSSL.org/)"
38  *
39  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
40  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
43  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
45  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
46  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
47  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
48  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
49  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
50  * OF THE POSSIBILITY OF SUCH DAMAGE.
51  * ====================================================================
52  *
53  * This product includes cryptographic software written by Eric Young
54  * (eay@cryptsoft.com).  This product includes software written by Tim
55  * Hudson (tjh@cryptsoft.com).
56  *
57  */
58
59 #include <stdio.h>
60 #include "cryptlib.h"
61 #include <openssl/asn1t.h>
62 #include <openssl/x509.h>
63 #include <openssl/rsa.h>
64 #include <openssl/bn.h>
65 #ifndef OPENSSL_NO_CMS
66 #include <openssl/cms.h>
67 #endif
68 #include "asn1_locl.h"
69
70 static int rsa_pub_encode(X509_PUBKEY *pk, const EVP_PKEY *pkey)
71         {
72         unsigned char *penc = NULL;
73         int penclen;
74         penclen = i2d_RSAPublicKey(pkey->pkey.rsa, &penc);
75         if (penclen <= 0)
76                 return 0;
77         if (X509_PUBKEY_set0_param(pk, OBJ_nid2obj(EVP_PKEY_RSA),
78                                 V_ASN1_NULL, NULL, penc, penclen))
79                 return 1;
80
81         OPENSSL_free(penc);
82         return 0;
83         }
84
85 static int rsa_pub_decode(EVP_PKEY *pkey, X509_PUBKEY *pubkey)
86         {
87         const unsigned char *p;
88         int pklen;
89         RSA *rsa = NULL;
90         if (!X509_PUBKEY_get0_param(NULL, &p, &pklen, NULL, pubkey))
91                 return 0;
92         if (!(rsa = d2i_RSAPublicKey(NULL, &p, pklen)))
93                 {
94                 RSAerr(RSA_F_RSA_PUB_DECODE, ERR_R_RSA_LIB);
95                 return 0;
96                 }
97         EVP_PKEY_assign_RSA (pkey, rsa);
98         return 1;
99         }
100
101 static int rsa_pub_cmp(const EVP_PKEY *a, const EVP_PKEY *b)
102         {
103         if (BN_cmp(b->pkey.rsa->n,a->pkey.rsa->n) != 0
104                 || BN_cmp(b->pkey.rsa->e,a->pkey.rsa->e) != 0)
105                         return 0;
106         return 1;
107         }
108
109 static int old_rsa_priv_decode(EVP_PKEY *pkey,
110                                         const unsigned char **pder, int derlen)
111         {
112         RSA *rsa;
113         if (!(rsa = d2i_RSAPrivateKey (NULL, pder, derlen)))
114                 {
115                 RSAerr(RSA_F_OLD_RSA_PRIV_DECODE, ERR_R_RSA_LIB);
116                 return 0;
117                 }
118         EVP_PKEY_assign_RSA(pkey, rsa);
119         return 1;
120         }
121
122 static int old_rsa_priv_encode(const EVP_PKEY *pkey, unsigned char **pder)
123         {
124         return i2d_RSAPrivateKey(pkey->pkey.rsa, pder);
125         }
126
127 static int rsa_priv_encode(PKCS8_PRIV_KEY_INFO *p8, const EVP_PKEY *pkey)
128         {
129         unsigned char *rk = NULL;
130         int rklen;
131         rklen = i2d_RSAPrivateKey(pkey->pkey.rsa, &rk);
132
133         if (rklen <= 0)
134                 {
135                 RSAerr(RSA_F_RSA_PRIV_ENCODE,ERR_R_MALLOC_FAILURE);
136                 return 0;
137                 }
138
139         if (!PKCS8_pkey_set0(p8, OBJ_nid2obj(NID_rsaEncryption), 0,
140                                 V_ASN1_NULL, NULL, rk, rklen))
141                 {
142                 RSAerr(RSA_F_RSA_PRIV_ENCODE,ERR_R_MALLOC_FAILURE);
143                 return 0;
144                 }
145
146         return 1;
147         }
148
149 static int rsa_priv_decode(EVP_PKEY *pkey, PKCS8_PRIV_KEY_INFO *p8)
150         {
151         const unsigned char *p;
152         int pklen;
153         if (!PKCS8_pkey_get0(NULL, &p, &pklen, NULL, p8))
154                 return 0;
155         return old_rsa_priv_decode(pkey, &p, pklen);
156         }
157
158 static int int_rsa_size(const EVP_PKEY *pkey)
159         {
160         return RSA_size(pkey->pkey.rsa);
161         }
162
163 static int rsa_bits(const EVP_PKEY *pkey)
164         {
165         return BN_num_bits(pkey->pkey.rsa->n);
166         }
167
168 static void int_rsa_free(EVP_PKEY *pkey)
169         {
170         RSA_free(pkey->pkey.rsa);
171         }
172
173
174 static void update_buflen(const BIGNUM *b, size_t *pbuflen)
175         {
176         size_t i;
177         if (!b)
178                 return;
179         if (*pbuflen < (i = (size_t)BN_num_bytes(b)))
180                         *pbuflen = i;
181         }
182
183 static int do_rsa_print(BIO *bp, const RSA *x, int off, int priv)
184         {
185         char *str;
186         const char *s;
187         unsigned char *m=NULL;
188         int ret=0, mod_len = 0;
189         size_t buf_len=0;
190
191         update_buflen(x->n, &buf_len);
192         update_buflen(x->e, &buf_len);
193
194         if (priv)
195                 {
196                 update_buflen(x->d, &buf_len);
197                 update_buflen(x->p, &buf_len);
198                 update_buflen(x->q, &buf_len);
199                 update_buflen(x->dmp1, &buf_len);
200                 update_buflen(x->dmq1, &buf_len);
201                 update_buflen(x->iqmp, &buf_len);
202                 }
203
204         m=(unsigned char *)OPENSSL_malloc(buf_len+10);
205         if (m == NULL)
206                 {
207                 RSAerr(RSA_F_DO_RSA_PRINT,ERR_R_MALLOC_FAILURE);
208                 goto err;
209                 }
210
211         if (x->n != NULL)
212                 mod_len = BN_num_bits(x->n);
213
214         if(!BIO_indent(bp,off,128))
215                 goto err;
216
217         if (priv && x->d)
218                 {
219                 if (BIO_printf(bp,"Private-Key: (%d bit)\n", mod_len)
220                         <= 0) goto err;
221                 str = "modulus:";
222                 s = "publicExponent:";
223                 }
224         else
225                 {
226                 if (BIO_printf(bp,"Public-Key: (%d bit)\n", mod_len)
227                         <= 0) goto err;
228                 str = "Modulus:";
229                 s= "Exponent:";
230                 }
231         if (!ASN1_bn_print(bp,str,x->n,m,off)) goto err;
232         if (!ASN1_bn_print(bp,s,x->e,m,off))
233                 goto err;
234         if (priv)
235                 {
236                 if (!ASN1_bn_print(bp,"privateExponent:",x->d,m,off))
237                         goto err;
238                 if (!ASN1_bn_print(bp,"prime1:",x->p,m,off))
239                         goto err;
240                 if (!ASN1_bn_print(bp,"prime2:",x->q,m,off))
241                         goto err;
242                 if (!ASN1_bn_print(bp,"exponent1:",x->dmp1,m,off))
243                         goto err;
244                 if (!ASN1_bn_print(bp,"exponent2:",x->dmq1,m,off))
245                         goto err;
246                 if (!ASN1_bn_print(bp,"coefficient:",x->iqmp,m,off))
247                         goto err;
248                 }
249         ret=1;
250 err:
251         if (m != NULL) OPENSSL_free(m);
252         return(ret);
253         }
254
255 static int rsa_pub_print(BIO *bp, const EVP_PKEY *pkey, int indent,
256                                                         ASN1_PCTX *ctx)
257         {
258         return do_rsa_print(bp, pkey->pkey.rsa, indent, 0);
259         }
260
261
262 static int rsa_priv_print(BIO *bp, const EVP_PKEY *pkey, int indent,
263                                                         ASN1_PCTX *ctx)
264         {
265         return do_rsa_print(bp, pkey->pkey.rsa, indent, 1);
266         }
267
268 static RSA_PSS_PARAMS *rsa_pss_decode(const X509_ALGOR *alg,
269                                         X509_ALGOR **pmaskHash)
270         {
271         const unsigned char *p;
272         int plen;
273         RSA_PSS_PARAMS *pss;
274
275         *pmaskHash = NULL;
276
277         if (!alg->parameter || alg->parameter->type != V_ASN1_SEQUENCE)
278                 return NULL;
279         p = alg->parameter->value.sequence->data;
280         plen = alg->parameter->value.sequence->length;
281         pss = d2i_RSA_PSS_PARAMS(NULL, &p, plen);
282
283         if (!pss)
284                 return NULL;
285         
286         if (pss->maskGenAlgorithm)
287                 {
288                 ASN1_TYPE *param = pss->maskGenAlgorithm->parameter;
289                 if (OBJ_obj2nid(pss->maskGenAlgorithm->algorithm) == NID_mgf1
290                         && param->type == V_ASN1_SEQUENCE)
291                         {
292                         p = param->value.sequence->data;
293                         plen = param->value.sequence->length;
294                         *pmaskHash = d2i_X509_ALGOR(NULL, &p, plen);
295                         }
296                 }
297
298         return pss;
299         }
300
301 static int rsa_pss_param_print(BIO *bp, RSA_PSS_PARAMS *pss, 
302                                 X509_ALGOR *maskHash, int indent)
303         {
304         int rv = 0;
305         if (!pss)
306                 {
307                 if (BIO_puts(bp, " (INVALID PSS PARAMETERS)\n") <= 0)
308                         return 0;
309                 return 1;
310                 }
311         if (BIO_puts(bp, "\n") <= 0)
312                 goto err;
313         if (!BIO_indent(bp, indent, 128))
314                 goto err;
315         if (BIO_puts(bp, "Hash Algorithm: ") <= 0)
316                 goto err;
317
318         if (pss->hashAlgorithm)
319                 {
320                 if (i2a_ASN1_OBJECT(bp, pss->hashAlgorithm->algorithm) <= 0)
321                         goto err;
322                 }
323         else if (BIO_puts(bp, "sha1 (default)") <= 0)
324                 goto err;
325
326         if (BIO_puts(bp, "\n") <= 0)
327                 goto err;
328
329         if (!BIO_indent(bp, indent, 128))
330                 goto err;
331
332         if (BIO_puts(bp, "Mask Algorithm: ") <= 0)
333                         goto err;
334         if (pss->maskGenAlgorithm)
335                 {
336                 if (i2a_ASN1_OBJECT(bp, pss->maskGenAlgorithm->algorithm) <= 0)
337                         goto err;
338                 if (BIO_puts(bp, " with ") <= 0)
339                         goto err;
340                 if (maskHash)
341                         {
342                         if (i2a_ASN1_OBJECT(bp, maskHash->algorithm) <= 0)
343                         goto err;
344                         }
345                 else if (BIO_puts(bp, "INVALID") <= 0)
346                         goto err;
347                 }
348         else if (BIO_puts(bp, "mgf1 with sha1 (default)") <= 0)
349                 goto err;
350         BIO_puts(bp, "\n");
351
352         if (!BIO_indent(bp, indent, 128))
353                 goto err;
354         if (BIO_puts(bp, "Salt Length: ") <= 0)
355                         goto err;
356         if (pss->saltLength)
357                 {
358                 if (i2a_ASN1_INTEGER(bp, pss->saltLength) <= 0)
359                         goto err;
360                 }
361         else if (BIO_puts(bp, "20 (default)") <= 0)
362                 goto err;
363         BIO_puts(bp, "\n");
364
365         if (!BIO_indent(bp, indent, 128))
366                 goto err;
367         if (BIO_puts(bp, "Trailer Field: ") <= 0)
368                         goto err;
369         if (pss->trailerField)
370                 {
371                 if (i2a_ASN1_INTEGER(bp, pss->trailerField) <= 0)
372                         goto err;
373                 }
374         else if (BIO_puts(bp, "0xbc (default)") <= 0)
375                 goto err;
376         BIO_puts(bp, "\n");
377         
378         rv = 1;
379
380         err:
381         return rv;
382
383         }
384
385 static int rsa_sig_print(BIO *bp, const X509_ALGOR *sigalg,
386                                         const ASN1_STRING *sig,
387                                         int indent, ASN1_PCTX *pctx)
388         {
389         if (OBJ_obj2nid(sigalg->algorithm) == NID_rsassaPss)
390                 {
391                 int rv;
392                 RSA_PSS_PARAMS *pss;
393                 X509_ALGOR *maskHash;
394                 pss = rsa_pss_decode(sigalg, &maskHash);
395                 rv = rsa_pss_param_print(bp, pss, maskHash, indent);
396                 if (pss)
397                         RSA_PSS_PARAMS_free(pss);
398                 if (maskHash)
399                         X509_ALGOR_free(maskHash);
400                 if (!rv)
401                         return 0;
402                 }
403         if (sig)
404                 return X509_signature_dump(bp, sig, indent);
405         return 1;
406         }
407
408 static int rsa_pkey_ctrl(EVP_PKEY *pkey, int op, long arg1, void *arg2)
409         {
410         X509_ALGOR *alg = NULL;
411         switch (op)
412                 {
413
414                 case ASN1_PKEY_CTRL_PKCS7_SIGN:
415                 if (arg1 == 0)
416                         PKCS7_SIGNER_INFO_get0_algs(arg2, NULL, NULL, &alg);
417                 break;
418
419                 case ASN1_PKEY_CTRL_PKCS7_ENCRYPT:
420                 if (arg1 == 0)
421                         PKCS7_RECIP_INFO_get0_alg(arg2, &alg);
422                 break;
423 #ifndef OPENSSL_NO_CMS
424                 case ASN1_PKEY_CTRL_CMS_SIGN:
425                 if (arg1 == 0)
426                         CMS_SignerInfo_get0_algs(arg2, NULL, NULL, NULL, &alg);
427                 break;
428
429                 case ASN1_PKEY_CTRL_CMS_ENVELOPE:
430                 if (arg1 == 0)
431                         CMS_RecipientInfo_ktri_get0_algs(arg2, NULL, NULL, &alg);
432                 break;
433 #endif
434
435                 case ASN1_PKEY_CTRL_DEFAULT_MD_NID:
436                 *(int *)arg2 = NID_sha1;
437                 return 1;
438
439                 default:
440                 return -2;
441
442                 }
443
444         if (alg)
445                 X509_ALGOR_set0(alg, OBJ_nid2obj(NID_rsaEncryption),
446                                                         V_ASN1_NULL, 0);
447
448         return 1;
449
450         }
451
452 /* Customised RSA item verification routine. This is called 
453  * when a signature is encountered requiring special handling. We 
454  * currently only handle PSS.
455  */
456
457
458 static int rsa_item_verify(EVP_MD_CTX *ctx, const ASN1_ITEM *it, void *asn,
459                         X509_ALGOR *sigalg, ASN1_BIT_STRING *sig,
460                         EVP_PKEY *pkey)
461         {
462         int rv = -1;
463         int saltlen;
464         const EVP_MD *mgf1md = NULL, *md = NULL;
465         RSA_PSS_PARAMS *pss;
466         X509_ALGOR *maskHash;
467         EVP_PKEY_CTX *pkctx;
468         /* Sanity check: make sure it is PSS */
469         if (OBJ_obj2nid(sigalg->algorithm) != NID_rsassaPss)
470                 {
471                 RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_UNSUPPORTED_SIGNATURE_TYPE);
472                 return -1;
473                 }
474         /* Decode PSS parameters */
475         pss = rsa_pss_decode(sigalg, &maskHash);
476
477         if (pss == NULL)
478                 {
479                 RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_INVALID_PSS_PARAMETERS);
480                 goto err;
481                 }
482         /* Check mask and lookup mask hash algorithm */
483         if (pss->maskGenAlgorithm)
484                 {
485                 if (OBJ_obj2nid(pss->maskGenAlgorithm->algorithm) != NID_mgf1)
486                         {
487                         RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_UNSUPPORTED_MASK_ALGORITHM);
488                         goto err;
489                         }
490                 if (!maskHash)
491                         {
492                         RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_UNSUPPORTED_MASK_PARAMETER);
493                         goto err;
494                         }
495                 mgf1md = EVP_get_digestbyobj(maskHash->algorithm);
496                 if (mgf1md == NULL)
497                         {
498                         RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_UNKNOWN_MASK_DIGEST);
499                         goto err;
500                         }
501                 }
502         else
503                 mgf1md = EVP_sha1();
504
505         if (pss->hashAlgorithm)
506                 {
507                 md = EVP_get_digestbyobj(pss->hashAlgorithm->algorithm);
508                 if (md == NULL)
509                         {
510                         RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_UNKNOWN_PSS_DIGEST);
511                         goto err;
512                         }
513                 }
514         else
515                 md = EVP_sha1();
516
517         if (pss->saltLength)
518                 {
519                 saltlen = ASN1_INTEGER_get(pss->saltLength);
520
521                 /* Could perform more salt length sanity checks but the main
522                  * RSA routines will trap other invalid values anyway.
523                  */
524                 if (saltlen < 0)
525                         {
526                         RSAerr(RSA_F_RSA_ITEM_VERIFY, RSA_R_INVALID_SALT_LENGTH);
527                         goto err;
528                         }
529                 }
530         else
531                 saltlen = 20;
532
533         /* We have all parameters now set up context */
534
535         if (!EVP_DigestVerifyInit(ctx, &pkctx, md, NULL, pkey))
536                 goto err;
537
538         if (!EVP_PKEY_CTX_set_rsa_padding(pkctx, RSA_PKCS1_PSS_PADDING))
539                 goto err;
540
541         if (!EVP_PKEY_CTX_set_rsa_pss_saltlen(pkctx, saltlen))
542                 goto err;
543
544         if (!EVP_PKEY_CTX_set_rsa_mgf1_md(pkctx, mgf1md))
545                 goto err;
546         /* Carry on */
547         rv = 2;
548
549         err:
550         RSA_PSS_PARAMS_free(pss);
551         if (maskHash)
552                 X509_ALGOR_free(maskHash);
553         return rv;
554         }
555
556 const EVP_PKEY_ASN1_METHOD rsa_asn1_meths[] = 
557         {
558                 {
559                 EVP_PKEY_RSA,
560                 EVP_PKEY_RSA,
561                 ASN1_PKEY_SIGPARAM_NULL,
562
563                 "RSA",
564                 "OpenSSL RSA method",
565
566                 rsa_pub_decode,
567                 rsa_pub_encode,
568                 rsa_pub_cmp,
569                 rsa_pub_print,
570
571                 rsa_priv_decode,
572                 rsa_priv_encode,
573                 rsa_priv_print,
574
575                 int_rsa_size,
576                 rsa_bits,
577
578                 0,0,0,0,0,0,
579
580                 rsa_sig_print,
581                 int_rsa_free,
582                 rsa_pkey_ctrl,
583                 old_rsa_priv_decode,
584                 old_rsa_priv_encode,
585                 rsa_item_verify
586                 },
587
588                 {
589                 EVP_PKEY_RSA2,
590                 EVP_PKEY_RSA,
591                 ASN1_PKEY_ALIAS
592                 }
593         };