rsa: Add FIPS 186-4 compliant RSA probable prime key generator.
[libgcrypt.git] / src / hwfeatures.c
1 /* hwfeatures.c - Detect hardware features.
2  * Copyright (C) 2007, 2011  Free Software Foundation, Inc.
3  * Copyright (C) 2012  g10 Code GmbH
4  *
5  * This file is part of Libgcrypt.
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <ctype.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <stdarg.h>
27 #include <unistd.h>
28 #ifdef HAVE_SYSLOG
29 # include <syslog.h>
30 #endif /*HAVE_SYSLOG*/
31
32 #include "g10lib.h"
33 #include "hwf-common.h"
34
35 /* The name of a file used to globally disable selected features. */
36 #define HWF_DENY_FILE "/etc/gcrypt/hwf.deny"
37
38 /* A table to map hardware features to a string.  */
39 static struct
40 {
41   unsigned int flag;
42   const char *desc;
43 } hwflist[] =
44   {
45     { HWF_PADLOCK_RNG,     "padlock-rng" },
46     { HWF_PADLOCK_AES,     "padlock-aes" },
47     { HWF_PADLOCK_SHA,     "padlock-sha" },
48     { HWF_PADLOCK_MMUL,    "padlock-mmul"},
49     { HWF_INTEL_CPU,       "intel-cpu" },
50     { HWF_INTEL_FAST_SHLD, "intel-fast-shld" },
51     { HWF_INTEL_BMI2,      "intel-bmi2" },
52     { HWF_INTEL_SSSE3,     "intel-ssse3" },
53     { HWF_INTEL_SSE4_1,    "intel-sse4.1" },
54     { HWF_INTEL_PCLMUL,    "intel-pclmul" },
55     { HWF_INTEL_AESNI,     "intel-aesni" },
56     { HWF_INTEL_RDRAND,    "intel-rdrand" },
57     { HWF_INTEL_AVX,       "intel-avx" },
58     { HWF_INTEL_AVX2,      "intel-avx2" },
59     { HWF_ARM_NEON,        "arm-neon" }
60   };
61
62 /* A bit vector with the hardware features which shall not be used.
63    This variable must be set prior to any initialization.  */
64 static unsigned int disabled_hw_features;
65
66 /* A bit vector describing the hardware features currently
67    available. */
68 static unsigned int hw_features;
69
70 /* Convenience macros.  */
71 #define my_isascii(c) (!((c) & 0x80))
72
73
74 \f
75 /* Disable a feature by name.  This function must be called *before*
76    _gcry_detect_hw_features is called.  */
77 gpg_err_code_t
78 _gcry_disable_hw_feature (const char *name)
79 {
80   int i;
81
82   for (i=0; i < DIM (hwflist); i++)
83     if (!strcmp (hwflist[i].desc, name))
84       {
85         disabled_hw_features |= hwflist[i].flag;
86         return 0;
87       }
88   return GPG_ERR_INV_NAME;
89 }
90
91
92 /* Return a bit vector describing the available hardware features.
93    The HWF_ constants are used to test for them. */
94 unsigned int
95 _gcry_get_hw_features (void)
96 {
97   return hw_features;
98 }
99
100
101 /* Enumerate all features.  The caller is expected to start with an
102    IDX of 0 and then increment IDX until NULL is returned.  */
103 const char *
104 _gcry_enum_hw_features (int idx, unsigned int *r_feature)
105 {
106   if (idx < 0 || idx >= DIM (hwflist))
107     return NULL;
108   if (r_feature)
109     *r_feature = hwflist[idx].flag;
110   return hwflist[idx].desc;
111 }
112
113
114 /* Read a file with features which shall not be used.  The file is a
115    simple text file where empty lines and lines with the first non
116    white-space character being '#' are ignored.  */
117 static void
118 parse_hwf_deny_file (void)
119 {
120   const char *fname = HWF_DENY_FILE;
121   FILE *fp;
122   char buffer[256];
123   char *p, *pend;
124   int i, lnr = 0;
125
126   fp = fopen (fname, "r");
127   if (!fp)
128     return;
129
130   for (;;)
131     {
132       if (!fgets (buffer, sizeof buffer, fp))
133         {
134           if (!feof (fp))
135             {
136 #ifdef HAVE_SYSLOG
137               syslog (LOG_USER|LOG_WARNING,
138                       "Libgcrypt warning: error reading '%s', line %d",
139                       fname, lnr);
140 #endif /*HAVE_SYSLOG*/
141             }
142           fclose (fp);
143           return;
144         }
145       lnr++;
146       for (p=buffer; my_isascii (*p) && isspace (*p); p++)
147         ;
148       pend = strchr (p, '\n');
149       if (pend)
150         *pend = 0;
151       pend = p + (*p? (strlen (p)-1):0);
152       for ( ;pend > p; pend--)
153         if (my_isascii (*pend) && isspace (*pend))
154           *pend = 0;
155       if (!*p || *p == '#')
156         continue;
157
158       for (i=0; i < DIM (hwflist); i++)
159         {
160           if (!strcmp (hwflist[i].desc, p))
161             {
162               disabled_hw_features |= hwflist[i].flag;
163               break;
164             }
165         }
166       if (i == DIM (hwflist))
167         {
168 #ifdef HAVE_SYSLOG
169           syslog (LOG_USER|LOG_WARNING,
170                   "Libgcrypt warning: unknown feature in '%s', line %d",
171                   fname, lnr);
172 #endif /*HAVE_SYSLOG*/
173         }
174     }
175 }
176
177
178 /* Detect the available hardware features.  This function is called
179    once right at startup and we assume that no other threads are
180    running.  */
181 void
182 _gcry_detect_hw_features (void)
183 {
184   hw_features = 0;
185
186   if (fips_mode ())
187     return; /* Hardware support is not to be evaluated.  */
188
189   parse_hwf_deny_file ();
190
191 #if defined (HAVE_CPU_ARCH_X86)
192   {
193     hw_features = _gcry_hwf_detect_x86 ();
194   }
195 #endif /* HAVE_CPU_ARCH_X86 */
196 #if defined (HAVE_CPU_ARCH_ARM)
197   {
198     hw_features = _gcry_hwf_detect_arm ();
199   }
200 #endif /* HAVE_CPU_ARCH_ARM */
201
202   hw_features &= ~disabled_hw_features;
203 }