gpg,gpgsm: Fix compliance check for DSA and avoid an assert.
[gnupg.git] / common / compliance.c
1 /* compliance.c - Functions for compliance modi
2  * Copyright (C) 2017 g10 Code GmbH
3  * Copyright (C) 2017 Bundesamt für Sicherheit in der Informationstechnik
4  *
5  * This file is part of GnuPG.
6  *
7  * This file is free software; you can redistribute it and/or modify
8  * it under the terms of either
9  *
10  *   - the GNU Lesser General Public License as published by the Free
11  *     Software Foundation; either version 3 of the License, or (at
12  *     your option) any later version.
13  *
14  * or
15  *
16  *   - the GNU General Public License as published by the Free
17  *     Software Foundation; either version 2 of the License, or (at
18  *     your option) any later version.
19  *
20  * or both in parallel, as here.
21  *
22  * This file is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, see <https://www.gnu.org/licenses/>.
29  */
30
31 #include <config.h>
32 #include <gcrypt.h>
33
34 #include "openpgpdefs.h"
35 #include "logging.h"
36 #include "util.h"
37 #include "i18n.h"
38 #include "compliance.h"
39
40 static int initialized;
41 static int module;
42
43 /* Initializes the module.  Must be called with the current
44  * GNUPG_MODULE_NAME.  Checks a few invariants, and tunes the policies
45  * for the given module.  */
46 void
47 gnupg_initialize_compliance (int gnupg_module_name)
48 {
49   log_assert (! initialized);
50
51   /* We accept both OpenPGP-style and gcrypt-style algorithm ids.
52    * Assert that they are compatible.  */
53   log_assert ((int) GCRY_PK_RSA          == (int) PUBKEY_ALGO_RSA);
54   log_assert ((int) GCRY_PK_RSA_E        == (int) PUBKEY_ALGO_RSA_E);
55   log_assert ((int) GCRY_PK_RSA_S        == (int) PUBKEY_ALGO_RSA_S);
56   log_assert ((int) GCRY_PK_ELG_E        == (int) PUBKEY_ALGO_ELGAMAL_E);
57   log_assert ((int) GCRY_PK_DSA          == (int) PUBKEY_ALGO_DSA);
58   log_assert ((int) GCRY_PK_ECC          == (int) PUBKEY_ALGO_ECDH);
59   log_assert ((int) GCRY_PK_ELG          == (int) PUBKEY_ALGO_ELGAMAL);
60   log_assert ((int) GCRY_CIPHER_NONE     == (int) CIPHER_ALGO_NONE);
61   log_assert ((int) GCRY_CIPHER_IDEA     == (int) CIPHER_ALGO_IDEA);
62   log_assert ((int) GCRY_CIPHER_3DES     == (int) CIPHER_ALGO_3DES);
63   log_assert ((int) GCRY_CIPHER_CAST5    == (int) CIPHER_ALGO_CAST5);
64   log_assert ((int) GCRY_CIPHER_BLOWFISH == (int) CIPHER_ALGO_BLOWFISH);
65   log_assert ((int) GCRY_CIPHER_AES      == (int) CIPHER_ALGO_AES);
66   log_assert ((int) GCRY_CIPHER_AES192   == (int) CIPHER_ALGO_AES192);
67   log_assert ((int) GCRY_CIPHER_AES256   == (int) CIPHER_ALGO_AES256);
68   log_assert ((int) GCRY_CIPHER_TWOFISH  == (int) CIPHER_ALGO_TWOFISH);
69   log_assert ((int) GCRY_MD_MD5          == (int) DIGEST_ALGO_MD5);
70   log_assert ((int) GCRY_MD_SHA1         == (int) DIGEST_ALGO_SHA1);
71   log_assert ((int) GCRY_MD_RMD160       == (int) DIGEST_ALGO_RMD160);
72   log_assert ((int) GCRY_MD_SHA256       == (int) DIGEST_ALGO_SHA256);
73   log_assert ((int) GCRY_MD_SHA384       == (int) DIGEST_ALGO_SHA384);
74   log_assert ((int) GCRY_MD_SHA512       == (int) DIGEST_ALGO_SHA512);
75   log_assert ((int) GCRY_MD_SHA224       == (int) DIGEST_ALGO_SHA224);
76
77   switch (gnupg_module_name)
78     {
79     case GNUPG_MODULE_NAME_GPGSM:
80     case GNUPG_MODULE_NAME_GPG:
81       break;
82
83     default:
84       log_assert (!"no policies for this module");
85     }
86
87   module = gnupg_module_name;
88   initialized = 1;
89 }
90
91 /* Return true if ALGO with a key of KEYLENGTH is compliant to the
92  * given COMPLIANCE mode.  If KEY is not NULL, various bits of
93  * information will be extracted from it.  If CURVENAME is not NULL, it
94  * is assumed to be the already computed.  ALGO may be either an
95  * OpenPGP-style pubkey_algo_t, or a gcrypt-style enum gcry_pk_algos,
96  * both are compatible from the point of view of this function.  */
97 int
98 gnupg_pk_is_compliant (enum gnupg_compliance_mode compliance, int algo,
99                        gcry_mpi_t key[], unsigned int keylength,
100                        const char *curvename)
101 {
102   enum { is_rsa, is_dsa, is_pgp5, is_elg_sign, is_ecc } algotype;
103   int result = 0;
104
105   if (! initialized)
106     return 0;
107
108   switch (algo)
109     {
110     case PUBKEY_ALGO_RSA:
111     case PUBKEY_ALGO_RSA_E:
112     case PUBKEY_ALGO_RSA_S:
113       algotype = is_rsa;
114       break;
115
116     case PUBKEY_ALGO_DSA:
117       algotype = is_dsa;
118       break;
119
120     case PUBKEY_ALGO_ELGAMAL_E:
121       algotype = is_pgp5;
122       break;
123
124     case PUBKEY_ALGO_ECDH:
125     case PUBKEY_ALGO_ECDSA:
126     case PUBKEY_ALGO_EDDSA:
127       algotype = is_ecc;
128       break;
129
130     case PUBKEY_ALGO_ELGAMAL:
131       algotype = is_elg_sign;
132       break;
133
134     default: /* Unknown.  */
135       return 0;
136     }
137
138   if (compliance == CO_DE_VS)
139     {
140       char *curve = NULL;
141
142       switch (algotype)
143         {
144         case is_pgp5:
145           result = 0;
146           break;
147
148         case is_rsa:
149           result = (keylength == 2048
150                     || keylength == 3072
151                     || keylength == 4096);
152           break;
153
154         case is_dsa:
155           if (key)
156             {
157               size_t P = gcry_mpi_get_nbits (key[0]);
158               size_t Q = gcry_mpi_get_nbits (key[1]);
159               result = (Q == 256
160                         && (P == 2048 || P == 3072));
161             }
162           break;
163
164         case is_ecc:
165           if (!curvename && key)
166             {
167               curve = openpgp_oid_to_str (key[0]);
168               curvename = openpgp_oid_to_curve (curve, 0);
169               if (!curvename)
170                 curvename = curve;
171             }
172
173           result = (curvename
174                     && (algo == PUBKEY_ALGO_ECDH
175                         || algo == PUBKEY_ALGO_ECDSA)
176                     && (!strcmp (curvename, "brainpoolP256r1")
177                         || !strcmp (curvename, "brainpoolP384r1")
178                         || !strcmp (curvename, "brainpoolP512r1")));
179           break;
180
181         default:
182           result = 0;
183         }
184       xfree (curve);
185     }
186   else if (algotype == is_elg_sign)
187     {
188       /* An Elgamal signing key is only RFC-2440 compliant.  */
189       result = (compliance == CO_RFC2440);
190     }
191   else
192     {
193       result = 1; /* Assume compliance.  */
194     }
195
196   return result;
197 }
198
199
200 /* Return true if ALGO with the given KEYLENGTH is allowed in the
201  * given COMPLIANCE mode.  USE specifies for which use case the
202  * predicate is evaluated.  This way policies can be strict in what
203  * they produce, and liberal in what they accept.  */
204 int
205 gnupg_pk_is_allowed (enum gnupg_compliance_mode compliance,
206                      enum pk_use_case use, int algo, gcry_mpi_t key[],
207                      unsigned int keylength, const char *curvename)
208 {
209   if (! initialized)
210     return 1;
211
212   switch (compliance)
213     {
214     case CO_DE_VS:
215       switch (algo)
216         {
217         case PUBKEY_ALGO_RSA:
218         case PUBKEY_ALGO_RSA_E:
219         case PUBKEY_ALGO_RSA_S:
220           switch (use)
221             {
222             case PK_USE_ENCRYPTION:
223               return 1;
224             case PK_USE_DECRYPTION:
225             case PK_USE_SIGNING:
226               return (keylength == 2048
227                       || keylength == 3072
228                       || keylength == 4096);
229             case PK_USE_VERIFICATION:
230               return (keylength == 2048
231                       || keylength == 3072
232                       || keylength == 4096
233                       || keylength < 2048);
234             default:
235               log_assert (!"reached");
236             }
237           log_assert (!"reached");
238
239         case PUBKEY_ALGO_DSA:
240           if (key)
241             {
242               size_t P = gcry_mpi_get_nbits (key[0]);
243               size_t Q = gcry_mpi_get_nbits (key[1]);
244               return ((use == PK_USE_SIGNING
245                        && Q == 256
246                        && (P == 2048 || P == 3072))
247                       || (use == PK_USE_VERIFICATION
248                           && P < 2048));
249             }
250           else
251             return 0;
252           log_assert (!"reached");
253
254         case PUBKEY_ALGO_ELGAMAL:
255         case PUBKEY_ALGO_ELGAMAL_E:
256           return use == PK_USE_ENCRYPTION;
257
258         case PUBKEY_ALGO_ECDH:
259           return use == PK_USE_ENCRYPTION;
260
261         case PUBKEY_ALGO_ECDSA:
262           {
263             int result = 0;
264             char *curve = NULL;
265
266             if (! curvename && key)
267               {
268                 curve = openpgp_oid_to_str (key[0]);
269                 curvename = openpgp_oid_to_curve (curve, 0);
270                 if (!curvename)
271                   curvename = curve;
272               }
273
274             result = ((use == PK_USE_SIGNING
275                        && curvename
276                        && (!strcmp (curvename, "brainpoolP256r1")
277                            || !strcmp (curvename, "brainpoolP384r1")
278                            || !strcmp (curvename, "brainpoolP512r1")))
279                       || use == PK_USE_VERIFICATION);
280
281             xfree (curve);
282             return result;
283           }
284
285         case PUBKEY_ALGO_EDDSA:
286           return 0;
287
288         default:
289           return 0;
290         }
291       log_assert (!"reached");
292
293     default:
294       /* The default policy is to allow all algorithms.  */
295       return 1;
296     }
297
298   log_assert (!"reached");
299 }
300
301
302 /* Return true if (CIPHER, MODE) is compliant to the given COMPLIANCE mode.  */
303 int
304 gnupg_cipher_is_compliant (enum gnupg_compliance_mode compliance,
305                            cipher_algo_t cipher,
306                            enum gcry_cipher_modes mode)
307 {
308   if (! initialized)
309     return 0;
310
311   switch (compliance)
312     {
313     case CO_DE_VS:
314       switch (cipher)
315         {
316         case CIPHER_ALGO_AES:
317         case CIPHER_ALGO_AES192:
318         case CIPHER_ALGO_AES256:
319         case CIPHER_ALGO_3DES:
320           switch (module)
321             {
322             case GNUPG_MODULE_NAME_GPG:
323               return mode == GCRY_CIPHER_MODE_CFB;
324             case GNUPG_MODULE_NAME_GPGSM:
325               return mode == GCRY_CIPHER_MODE_CBC;
326             }
327           log_assert (!"reached");
328
329         default:
330           return 0;
331         }
332       log_assert (!"reached");
333
334     default:
335       return 0;
336     }
337
338   log_assert (!"reached");
339 }
340
341
342 /* Return true if CIPHER is allowed in the given COMPLIANCE mode.  If
343  * PRODUCER is true, the predicate is evaluated for the producer, if
344  * false for the consumer.  This way policies can be strict in what
345  * they produce, and liberal in what they accept.  */
346 int
347 gnupg_cipher_is_allowed (enum gnupg_compliance_mode compliance, int producer,
348                          cipher_algo_t cipher,
349                          enum gcry_cipher_modes mode)
350 {
351   if (! initialized)
352     return 1;
353
354   switch (compliance)
355     {
356     case CO_DE_VS:
357       switch (cipher)
358         {
359         case CIPHER_ALGO_AES:
360         case CIPHER_ALGO_AES192:
361         case CIPHER_ALGO_AES256:
362         case CIPHER_ALGO_3DES:
363           switch (module)
364             {
365             case GNUPG_MODULE_NAME_GPG:
366               return (mode == GCRY_CIPHER_MODE_NONE
367                       || mode == GCRY_CIPHER_MODE_CFB);
368             case GNUPG_MODULE_NAME_GPGSM:
369               return (mode == GCRY_CIPHER_MODE_NONE
370                       || mode == GCRY_CIPHER_MODE_CBC);
371             }
372           log_assert (!"reached");
373
374         case CIPHER_ALGO_BLOWFISH:
375         case CIPHER_ALGO_CAMELLIA128:
376         case CIPHER_ALGO_CAMELLIA192:
377         case CIPHER_ALGO_CAMELLIA256:
378         case CIPHER_ALGO_CAST5:
379         case CIPHER_ALGO_IDEA:
380         case CIPHER_ALGO_TWOFISH:
381           return (module == GNUPG_MODULE_NAME_GPG
382                   && (mode == GCRY_CIPHER_MODE_NONE
383                       || mode == GCRY_CIPHER_MODE_CFB)
384                   && ! producer);
385         default:
386           return 0;
387         }
388       log_assert (!"reached");
389
390     default:
391       /* The default policy is to allow all algorithms.  */
392       return 1;
393     }
394
395   log_assert (!"reached");
396 }
397
398
399 /* Return true if DIGEST is compliant to the given COMPLIANCE mode.  */
400 int
401 gnupg_digest_is_compliant (enum gnupg_compliance_mode compliance,
402                            digest_algo_t digest)
403 {
404   if (! initialized)
405     return 0;
406
407   switch (compliance)
408     {
409     case CO_DE_VS:
410       switch (digest)
411         {
412         case DIGEST_ALGO_SHA256:
413         case DIGEST_ALGO_SHA384:
414         case DIGEST_ALGO_SHA512:
415           return 1;
416         default:
417           return 0;
418         }
419       log_assert (!"reached");
420
421     default:
422       return 0;
423     }
424
425   log_assert (!"reached");
426 }
427
428
429 /* Return true if DIGEST is allowed in the given COMPLIANCE mode.  If
430  * PRODUCER is true, the predicate is evaluated for the producer, if
431  * false for the consumer.  This way policies can be strict in what
432  * they produce, and liberal in what they accept.  */
433 int
434 gnupg_digest_is_allowed (enum gnupg_compliance_mode compliance, int producer,
435                          digest_algo_t digest)
436 {
437   if (! initialized)
438     return 1;
439
440   switch (compliance)
441     {
442     case CO_DE_VS:
443       switch (digest)
444         {
445         case DIGEST_ALGO_SHA256:
446         case DIGEST_ALGO_SHA384:
447         case DIGEST_ALGO_SHA512:
448           return 1;
449         case DIGEST_ALGO_SHA1:
450         case DIGEST_ALGO_SHA224:
451         case DIGEST_ALGO_RMD160:
452           return ! producer;
453         case DIGEST_ALGO_MD5:
454           return ! producer && module == GNUPG_MODULE_NAME_GPGSM;
455         default:
456           return 0;
457         }
458       log_assert (!"reached");
459
460     default:
461       /* The default policy is to allow all algorithms.  */
462       return 1;
463     }
464
465   log_assert (!"reached");
466 }
467
468
469 const char *
470 gnupg_status_compliance_flag (enum gnupg_compliance_mode compliance)
471 {
472   switch (compliance)
473     {
474     case CO_GNUPG:
475       return "8";
476     case CO_RFC4880:
477     case CO_RFC2440:
478     case CO_PGP6:
479     case CO_PGP7:
480     case CO_PGP8:
481       log_assert (!"no status code assigned for this compliance mode");
482     case CO_DE_VS:
483       return "23";
484     }
485   log_assert (!"invalid compliance mode");
486 }
487
488
489 /* Parse the value of --compliance.  Returns the value corresponding
490  * to the given STRING according to OPTIONS of size LENGTH, or -1
491  * indicating that the lookup was unsuccessful, or the list of options
492  * was printed.  If quiet is false, an additional hint to use 'help'
493  * is printed on unsuccessful lookups.  */
494 int
495 gnupg_parse_compliance_option (const char *string,
496                                struct gnupg_compliance_option options[],
497                                size_t length,
498                                int quiet)
499 {
500   size_t i;
501
502   if (! ascii_strcasecmp (string, "help"))
503     {
504       log_info (_("valid values for option '%s':\n"), "--compliance");
505       for (i = 0; i < length; i++)
506         log_info ("  %s\n", options[i].keyword);
507       return -1;
508     }
509
510   for (i = 0; i < length; i++)
511     if (! ascii_strcasecmp (string, options[i].keyword))
512       return options[i].value;
513
514   log_error (_("invalid value for option '%s'\n"), "--compliance");
515   if (! quiet)
516     log_info (_("(use \"help\" to list choices)\n"));
517   return -1;
518 }
519
520
521 /* Return the command line option for the given COMPLIANCE mode.  */
522 const char *
523 gnupg_compliance_option_string (enum gnupg_compliance_mode compliance)
524 {
525   switch (compliance)
526     {
527     case CO_GNUPG:   return "--compliance=gnupg";
528     case CO_RFC4880: return "--compliance=openpgp";
529     case CO_RFC2440: return "--compliance=rfc2440";
530     case CO_PGP6:    return "--compliance=pgp6";
531     case CO_PGP7:    return "--compliance=pgp7";
532     case CO_PGP8:    return "--compliance=pgp8";
533     case CO_DE_VS:   return "--compliance=de-vs";
534     }
535
536   log_assert (!"invalid compliance mode");
537 }