b2c9695449aea8aeb9f92b9af59c654d23b47a79
[gnupg.git] / common / compliance.h
1 /* compliance.h - Definitions for compliance modi
2  * Copyright (C) 2017 g10 Code GmbH
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <https://www.gnu.org/licenses/>.
28  */
29
30 #ifndef GNUPG_COMMON_COMPLIANCE_H
31 #define GNUPG_COMMON_COMPLIANCE_H
32
33 #include <gcrypt.h>
34 #include "openpgpdefs.h"
35
36 void gnupg_initialize_compliance (int gnupg_module_name);
37
38 enum gnupg_compliance_mode
39   {
40     CO_GNUPG, CO_RFC4880, CO_RFC2440,
41     CO_PGP6, CO_PGP7, CO_PGP8, CO_DE_VS
42   };
43
44 enum pk_use_case
45   {
46     PK_USE_ENCRYPTION, PK_USE_DECRYPTION,
47     PK_USE_SIGNING, PK_USE_VERIFICATION,
48   };
49
50 int gnupg_pk_is_compliant (enum gnupg_compliance_mode compliance, int algo,
51                            gcry_mpi_t key[], unsigned int keylength,
52                            const char *curvename);
53 int gnupg_pk_is_allowed (enum gnupg_compliance_mode compliance,
54                          enum pk_use_case use, int algo, gcry_mpi_t key[],
55                          unsigned int keylength, const char *curvename);
56 int gnupg_cipher_is_compliant (enum gnupg_compliance_mode compliance,
57                                cipher_algo_t cipher,
58                                enum gcry_cipher_modes mode);
59 int gnupg_cipher_is_allowed (enum gnupg_compliance_mode compliance, int producer,
60                              cipher_algo_t cipher,
61                              enum gcry_cipher_modes mode);
62 int gnupg_digest_is_compliant (enum gnupg_compliance_mode compliance,
63                                digest_algo_t digest);
64 int gnupg_digest_is_allowed (enum gnupg_compliance_mode compliance, int producer,
65                              digest_algo_t digest);
66 const char *gnupg_status_compliance_flag (enum gnupg_compliance_mode compliance);
67
68 struct gnupg_compliance_option
69 {
70   const char *keyword;
71   int value;
72 };
73
74 int gnupg_parse_compliance_option (const char *string,
75                                    struct gnupg_compliance_option options[],
76                                    size_t length,
77                                    int quiet);
78 const char *gnupg_compliance_option_string (enum gnupg_compliance_mode compliance);
79
80
81 #endif /*GNUPG_COMMON_COMPLIANCE_H*/