Add a configuration file to disable hardware features.
[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_PCLMUL,"intel-pclmul" },
50     { HWF_INTEL_AESNI, "intel-aesni" },
51     { HWF_INTEL_RDRAND,"intel-rdrand" },
52     { HWF_INTEL_AVX,   "intel-avx" },
53     { HWF_INTEL_AVX2,  "intel-avx2" },
54     { HWF_ARM_NEON,    "arm-neon" }
55   };
56
57 /* A bit vector with the hardware features which shall not be used.
58    This variable must be set prior to any initialization.  */
59 static unsigned int disabled_hw_features;
60
61 /* A bit vector describing the hardware features currently
62    available. */
63 static unsigned int hw_features;
64
65 /* Convenience macros.  */
66 #define my_isascii(c) (!((c) & 0x80))
67
68
69 \f
70 /* Disable a feature by name.  This function must be called *before*
71    _gcry_detect_hw_features is called.  */
72 gpg_err_code_t
73 _gcry_disable_hw_feature (const char *name)
74 {
75   int i;
76
77   for (i=0; i < DIM (hwflist); i++)
78     if (!strcmp (hwflist[i].desc, name))
79       {
80         disabled_hw_features |= hwflist[i].flag;
81         return 0;
82       }
83   return GPG_ERR_INV_NAME;
84 }
85
86
87 /* Return a bit vector describing the available hardware features.
88    The HWF_ constants are used to test for them. */
89 unsigned int
90 _gcry_get_hw_features (void)
91 {
92   return hw_features;
93 }
94
95
96 /* Enumerate all features.  The caller is expected to start with an
97    IDX of 0 and then increment IDX until NULL is returned.  */
98 const char *
99 _gcry_enum_hw_features (int idx, unsigned int *r_feature)
100 {
101   if (idx < 0 || idx >= DIM (hwflist))
102     return NULL;
103   if (r_feature)
104     *r_feature = hwflist[idx].flag;
105   return hwflist[idx].desc;
106 }
107
108
109 /* Read a file with features which shall not be used.  The file is a
110    simple text file where empty lines and lines with the first non
111    white-space character being '#' are ignored.  */
112 static void
113 parse_hwf_deny_file (void)
114 {
115   const char *fname = HWF_DENY_FILE;
116   FILE *fp;
117   char buffer[256];
118   char *p, *pend;
119   int i, lnr = 0;
120
121   fp = fopen (fname, "r");
122   if (!fp)
123     return;
124
125   for (;;)
126     {
127       if (!fgets (buffer, sizeof buffer, fp))
128         {
129           if (!feof (fp))
130             {
131 #ifdef HAVE_SYSLOG
132               syslog (LOG_USER|LOG_WARNING,
133                       "Libgcrypt warning: error reading '%s', line %d",
134                       fname, lnr);
135 #endif /*HAVE_SYSLOG*/
136             }
137           fclose (fp);
138           return;
139         }
140       lnr++;
141       for (p=buffer; my_isascii (*p) && isspace (*p); p++)
142         ;
143       pend = strchr (p, '\n');
144       if (pend)
145         *pend = 0;
146       pend = p + (*p? (strlen (p)-1):0);
147       for ( ;pend > p; pend--)
148         if (my_isascii (*pend) && isspace (*pend))
149           *pend = 0;
150       if (!*p || *p == '#')
151         continue;
152
153       for (i=0; i < DIM (hwflist); i++)
154         {
155           if (!strcmp (hwflist[i].desc, p))
156             {
157               disabled_hw_features |= hwflist[i].flag;
158               break;
159             }
160         }
161       if (i == DIM (hwflist))
162         {
163 #ifdef HAVE_SYSLOG
164           syslog (LOG_USER|LOG_WARNING,
165                   "Libgcrypt warning: unknown feature in '%s', line %d",
166                   fname, lnr);
167 #endif /*HAVE_SYSLOG*/
168         }
169     }
170 }
171
172
173 /* Detect the available hardware features.  This function is called
174    once right at startup and we assume that no other threads are
175    running.  */
176 void
177 _gcry_detect_hw_features (void)
178 {
179   hw_features = 0;
180
181   if (fips_mode ())
182     return; /* Hardware support is not to be evaluated.  */
183
184   parse_hwf_deny_file ();
185
186 #if defined (HAVE_CPU_ARCH_X86)
187   {
188     hw_features = _gcry_hwf_detect_x86 ();
189   }
190 #endif /* HAVE_CPU_ARCH_X86 */
191 #if defined (HAVE_CPU_ARCH_ARM)
192   {
193     hw_features = _gcry_hwf_detect_arm ();
194   }
195 #endif /* HAVE_CPU_ARCH_ARM */
196
197   hw_features &= ~disabled_hw_features;
198 }