wipememory: use one-byte aligned type for unaligned memory accesses
[libgcrypt.git] / src / g10lib.h
1 /* g10lib.h - Internal definitions for libgcrypt
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2005
3  *               2007, 2011 Free Software Foundation, Inc.
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 /* This header is to be used inside of libgcrypt in place of gcrypt.h.
22    This way we can better distinguish between internal and external
23    usage of gcrypt.h. */
24
25 #ifndef G10LIB_H
26 #define G10LIB_H 1
27
28 #ifdef _GCRYPT_H
29 #error  gcrypt.h already included
30 #endif
31
32 #ifndef _GCRYPT_IN_LIBGCRYPT
33 #error something is wrong with config.h
34 #endif
35
36 #include <stdio.h>
37 #include <stdarg.h>
38
39 #include "visibility.h"
40 #include "types.h"
41
42
43 \f
44
45 /* Attribute handling macros.  */
46
47 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
48 #define JNLIB_GCC_M_FUNCTION 1
49 #define JNLIB_GCC_A_NR       __attribute__ ((noreturn))
50 #define JNLIB_GCC_A_PRINTF( f, a )  __attribute__ ((format (printf,f,a)))
51 #define JNLIB_GCC_A_NR_PRINTF( f, a ) \
52                             __attribute__ ((noreturn, format (printf,f,a)))
53 #define GCC_ATTR_NORETURN  __attribute__ ((__noreturn__))
54 #else
55 #define JNLIB_GCC_A_NR
56 #define JNLIB_GCC_A_PRINTF( f, a )
57 #define JNLIB_GCC_A_NR_PRINTF( f, a )
58 #define GCC_ATTR_NORETURN
59 #endif
60
61 #if __GNUC__ >= 3
62 /* According to glibc this attribute is available since 2.8 however we
63    better play safe and use it only with gcc 3 or newer. */
64 #define GCC_ATTR_FORMAT_ARG(a)  __attribute__ ((format_arg (a)))
65 #else
66 #define GCC_ATTR_FORMAT_ARG(a)
67 #endif
68
69 /* I am not sure since when the unused attribute is really supported.
70    In any case it it only needed for gcc versions which print a
71    warning.  Thus let us require gcc >= 3.5.  */
72 #if __GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 5 )
73 #define GCC_ATTR_UNUSED  __attribute__ ((unused))
74 #else
75 #define GCC_ATTR_UNUSED
76 #endif
77
78 /* Gettext macros.  */
79
80 #define _(a)  _gcry_gettext(a)
81 #define N_(a) (a)
82
83 /* Some handy macros */
84 #ifndef STR
85 #define STR(v) #v
86 #endif
87 #define STR2(v) STR(v)
88 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
89 #define DIMof(type,member)   DIM(((type *)0)->member)
90
91 \f
92
93 /*-- src/global.c -*/
94 int _gcry_global_is_operational (void);
95 gcry_error_t _gcry_vcontrol (enum gcry_ctl_cmds cmd, va_list arg_ptr);
96 void  _gcry_check_heap (const void *a);
97 int _gcry_get_debug_flag (unsigned int mask);
98
99 /* Malloc functions and common wrapper macros.  */
100 void *_gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
101 void *_gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
102 void *_gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
103 void *_gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
104 void *_gcry_realloc (void *a, size_t n);
105 char *_gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
106 void *_gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
107 void *_gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
108 void *_gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
109 void *_gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
110 void *_gcry_xrealloc (void *a, size_t n);
111 char *_gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
112 void  _gcry_free (void *a);
113 int   _gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
114
115 #define xtrymalloc(a)    _gcry_malloc ((a))
116 #define xtrycalloc(a,b)  _gcry_calloc ((a),(b))
117 #define xtrymalloc_secure(a)   _gcry_malloc_secure ((a))
118 #define xtrycalloc_secure(a,b) _gcry_calloc_secure ((a),(b))
119 #define xtryrealloc(a,b) _gcry_realloc ((a),(b))
120 #define xtrystrdup(a)    _gcry_strdup ((a))
121 #define xmalloc(a)       _gcry_xmalloc ((a))
122 #define xcalloc(a,b)     _gcry_xcalloc ((a),(b))
123 #define xmalloc_secure(a)   _gcry_xmalloc_secure ((a))
124 #define xcalloc_secure(a,b) _gcry_xcalloc_secure ((a),(b))
125 #define xrealloc(a,b)    _gcry_xrealloc ((a),(b))
126 #define xstrdup(a)       _gcry_xstrdup ((a))
127 #define xfree(a)         _gcry_free ((a))
128
129
130 /*-- src/misc.c --*/
131
132 #if defined(JNLIB_GCC_M_FUNCTION) || __STDC_VERSION__ >= 199901L
133 void _gcry_bug (const char *file, int line,
134                 const char *func) GCC_ATTR_NORETURN;
135 void _gcry_assert_failed (const char *expr, const char *file, int line,
136                           const char *func) GCC_ATTR_NORETURN;
137 #else
138 void _gcry_bug (const char *file, int line);
139 void _gcry_assert_failed (const char *expr, const char *file, int line);
140 #endif
141
142 void _gcry_divide_by_zero (void) JNLIB_GCC_A_NR;
143
144 const char *_gcry_gettext (const char *key) GCC_ATTR_FORMAT_ARG(1);
145 void _gcry_fatal_error(int rc, const char *text ) JNLIB_GCC_A_NR;
146 void _gcry_logv (int level,
147                  const char *fmt, va_list arg_ptr) JNLIB_GCC_A_PRINTF(2,0);
148 void _gcry_log( int level, const char *fmt, ... ) JNLIB_GCC_A_PRINTF(2,3);
149 void _gcry_log_bug( const char *fmt, ... )   JNLIB_GCC_A_NR_PRINTF(1,2);
150 void _gcry_log_fatal( const char *fmt, ... ) JNLIB_GCC_A_NR_PRINTF(1,2);
151 void _gcry_log_error( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
152 void _gcry_log_info( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
153 int  _gcry_log_info_with_dummy_fp (FILE *fp, const char *fmt, ... )
154                                              JNLIB_GCC_A_PRINTF(2,3);
155 void _gcry_log_debug( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
156 void _gcry_log_printf ( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
157 void _gcry_log_printhex (const char *text, const void *buffer, size_t length);
158 void _gcry_log_printmpi (const char *text, gcry_mpi_t mpi);
159 void _gcry_log_printsxp (const char *text, gcry_sexp_t sexp);
160
161 void _gcry_set_log_verbosity( int level );
162 int _gcry_log_verbosity( int level );
163
164 #ifdef JNLIB_GCC_M_FUNCTION
165 #define BUG() _gcry_bug( __FILE__ , __LINE__, __FUNCTION__ )
166 #define gcry_assert(expr) ((expr)? (void)0 \
167          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __FUNCTION__))
168 #elif __STDC_VERSION__ >= 199901L
169 #define BUG() _gcry_bug( __FILE__ , __LINE__, __func__ )
170 #define gcry_assert(expr) ((expr)? (void)0 \
171          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __func__))
172 #else
173 #define BUG() _gcry_bug( __FILE__ , __LINE__ )
174 #define gcry_assert(expr) ((expr)? (void)0 \
175          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__))
176 #endif
177
178
179 #define log_bug     _gcry_log_bug
180 #define log_fatal   _gcry_log_fatal
181 #define log_error   _gcry_log_error
182 #define log_info    _gcry_log_info
183 #define log_debug   _gcry_log_debug
184 #define log_printf  _gcry_log_printf
185 #define log_printhex _gcry_log_printhex
186 #define log_printmpi _gcry_log_printmpi
187 #define log_printsxp _gcry_log_printsxp
188
189 /* Compatibility macro.  */
190 #define log_mpidump _gcry_log_printmpi
191
192
193 /*-- src/hwfeatures.c --*/
194 /* (Do not change these values unless synced with the asm code.)  */
195 #define HWF_PADLOCK_RNG  1
196 #define HWF_PADLOCK_AES  2
197 #define HWF_PADLOCK_SHA  4
198 #define HWF_PADLOCK_MMUL 8
199
200 #define HWF_INTEL_CPU    16
201 #define HWF_INTEL_BMI2   32
202 #define HWF_INTEL_SSSE3  64
203 #define HWF_INTEL_PCLMUL 128
204 #define HWF_INTEL_AESNI  256
205 #define HWF_INTEL_RDRAND 512
206 #define HWF_INTEL_AVX    1024
207 #define HWF_INTEL_AVX2   2048
208
209 #define HWF_ARM_NEON     4096
210
211
212 gpg_err_code_t _gcry_disable_hw_feature (const char *name);
213 void _gcry_detect_hw_features (void);
214 unsigned int _gcry_get_hw_features (void);
215 const char *_gcry_enum_hw_features (int idx, unsigned int *r_feature);
216
217
218 /*-- mpi/mpiutil.c --*/
219 const char *_gcry_mpi_get_hw_config (void);
220
221
222 /*-- cipher/pubkey.c --*/
223
224 /* FIXME: shouldn't this go into mpi.h?  */
225 #ifndef mpi_powm
226 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
227 #endif
228
229 /*-- primegen.c --*/
230 gcry_err_code_t _gcry_primegen_init (void);
231 gcry_mpi_t _gcry_generate_secret_prime (unsigned int nbits,
232                                  gcry_random_level_t random_level,
233                                  int (*extra_check)(void*, gcry_mpi_t),
234                                  void *extra_check_arg);
235 gcry_mpi_t _gcry_generate_public_prime (unsigned int nbits,
236                                  gcry_random_level_t random_level,
237                                  int (*extra_check)(void*, gcry_mpi_t),
238                                  void *extra_check_arg);
239 gcry_err_code_t _gcry_generate_elg_prime (int mode,
240                                           unsigned int pbits,
241                                           unsigned int qbits,
242                                           gcry_mpi_t g,
243                                           gcry_mpi_t *r_prime,
244                                           gcry_mpi_t **factors);
245 gcry_mpi_t _gcry_derive_x931_prime (const gcry_mpi_t xp,
246                                     const gcry_mpi_t xp1, const gcry_mpi_t xp2,
247                                     const gcry_mpi_t e,
248                                     gcry_mpi_t *r_p1, gcry_mpi_t *r_p2);
249 gpg_err_code_t _gcry_generate_fips186_2_prime
250                  (unsigned int pbits, unsigned int qbits,
251                   const void *seed, size_t seedlen,
252                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
253                   int *r_counter,
254                   void **r_seed, size_t *r_seedlen);
255 gpg_err_code_t _gcry_generate_fips186_3_prime
256                  (unsigned int pbits, unsigned int qbits,
257                   const void *seed, size_t seedlen,
258                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
259                   int *r_counter,
260                   void **r_seed, size_t *r_seedlen, int *r_hashalgo);
261
262
263 /* Replacements of missing functions (missing-string.c).  */
264 #ifndef HAVE_STPCPY
265 char *stpcpy (char *a, const char *b);
266 #endif
267 #ifndef HAVE_STRCASECMP
268 int strcasecmp (const char *a, const char *b) _GCRY_GCC_ATTR_PURE;
269 #endif
270
271 #include "../compat/libcompat.h"
272
273
274 /* Macros used to rename missing functions.  */
275 #ifndef HAVE_STRTOUL
276 #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
277 #endif
278 #ifndef HAVE_MEMMOVE
279 #define memmove(d, s, n) bcopy((s), (d), (n))
280 #endif
281 #ifndef HAVE_STRICMP
282 #define stricmp(a,b)     strcasecmp( (a), (b) )
283 #endif
284 #ifndef HAVE_ATEXIT
285 #define atexit(a)    (on_exit((a),0))
286 #endif
287 #ifndef HAVE_RAISE
288 #define raise(a) kill(getpid(), (a))
289 #endif
290
291
292 /* Stack burning.  */
293
294 #ifdef HAVE_GCC_ASM_VOLATILE_MEMORY
295 #define  __gcry_burn_stack_dummy() asm volatile ("":::"memory")
296 #else
297 void __gcry_burn_stack_dummy (void);
298 #endif
299
300 void __gcry_burn_stack (unsigned int bytes);
301 #define _gcry_burn_stack(bytes) \
302         do { __gcry_burn_stack (bytes); \
303              __gcry_burn_stack_dummy (); } while(0)
304
305
306 /* To avoid that a compiler optimizes certain memset calls away, these
307    macros may be used instead. */
308 #define wipememory2(_ptr,_set,_len) do { \
309               volatile char *_vptr=(volatile char *)(_ptr); \
310               size_t _vlen=(_len); \
311               unsigned char _vset=(_set); \
312               fast_wipememory2(_vptr,_vset,_vlen); \
313               while(_vlen) { *_vptr=(_vset); _vptr++; _vlen--; } \
314                   } while(0)
315 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
316
317 #ifdef HAVE_U64_TYPEDEF
318   #define FASTWIPE_T u64
319   #define FASTWIPE_MULT (U64_C(0x0101010101010101))
320 #else
321   #define FASTWIPE_T u32
322   #define FASTWIPE_MULT (0x01010101U)
323 #endif
324
325 /* Following architectures can handle unaligned accesses fast.  */
326 #if defined(HAVE_GCC_ATTRIBUTE_PACKED) && \
327     defined(HAVE_GCC_ATTRIBUTE_ALIGNED) && \
328     (defined(__i386__) || defined(__x86_64__) || \
329      defined(__powerpc__) || defined(__powerpc64__) || \
330      (defined(__arm__) && defined(__ARM_FEATURE_UNALIGNED)) || \
331      defined(__aarch64__))
332 #define fast_wipememory2_unaligned_head(_ptr,_set,_len) /*do nothing*/
333 typedef struct fast_wipememory_s
334 {
335   FASTWIPE_T a;
336 } __attribute__((packed, aligned(1))) fast_wipememory_t;
337 #else
338 #define fast_wipememory2_unaligned_head(_vptr,_vset,_vlen) do { \
339               while((size_t)(_vptr)&(sizeof(FASTWIPE_T)-1) && _vlen) \
340                 { *_vptr=(_vset); _vptr++; _vlen--; } \
341                   } while(0)
342 typedef struct fast_wipememory_s
343 {
344   FASTWIPE_T a;
345 } fast_wipememory_t;
346 #endif
347
348 /* fast_wipememory2 may leave tail bytes unhandled, in which case tail bytes
349    are handled by wipememory2. */
350 #define fast_wipememory2(_vptr,_vset,_vlen) do { \
351               FASTWIPE_T _vset_long = _vset; \
352               fast_wipememory2_unaligned_head(_vptr,_vset,_vlen); \
353               if (_vlen < sizeof(FASTWIPE_T)) \
354                 break; \
355               _vset_long *= FASTWIPE_MULT; \
356               do { \
357                 volatile fast_wipememory_t *_vptr_long = \
358                   (volatile void *)_vptr; \
359                 _vptr_long->a = _vset_long; \
360                 _vlen -= sizeof(FASTWIPE_T); \
361                 _vptr += sizeof(FASTWIPE_T); \
362               } while (_vlen >= sizeof(FASTWIPE_T)); \
363                   } while (0)
364
365
366 /* Digit predicates.  */
367
368 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
369 #define octdigitp(p) (*(p) >= '0' && *(p) <= '7')
370 #define alphap(a)    (   (*(a) >= 'A' && *(a) <= 'Z')  \
371                       || (*(a) >= 'a' && *(a) <= 'z'))
372 #define hexdigitp(a) (digitp (a)                     \
373                       || (*(a) >= 'A' && *(a) <= 'F')  \
374                       || (*(a) >= 'a' && *(a) <= 'f'))
375
376 /* Init functions.  */
377
378 gcry_err_code_t _gcry_cipher_init (void);
379 gcry_err_code_t _gcry_md_init (void);
380 gcry_err_code_t _gcry_pk_init (void);
381 gcry_err_code_t _gcry_secmem_module_init (void);
382 gcry_err_code_t _gcry_mpi_init (void);
383
384 /* Memory management.  */
385 #define GCRY_ALLOC_FLAG_SECURE (1 << 0)
386
387
388 /*-- sexp.c --*/
389 gcry_err_code_t _gcry_sexp_vbuild (gcry_sexp_t *retsexp, size_t *erroff,
390                                    const char *format, va_list arg_ptr);
391 char *_gcry_sexp_nth_string (const gcry_sexp_t list, int number);
392 gpg_err_code_t _gcry_sexp_vextract_param (gcry_sexp_t sexp, const char *path,
393                                           const char *list, va_list arg_ptr);
394
395
396 /*-- fips.c --*/
397
398 void _gcry_initialize_fips_mode (int force);
399
400 int _gcry_fips_mode (void);
401 #define fips_mode() _gcry_fips_mode ()
402
403 int _gcry_enforced_fips_mode (void);
404
405 void _gcry_set_enforced_fips_mode (void);
406
407 void _gcry_inactivate_fips_mode (const char *text);
408 int _gcry_is_fips_mode_inactive (void);
409
410
411 void _gcry_fips_signal_error (const char *srcfile,
412                               int srcline,
413                               const char *srcfunc,
414                               int is_fatal,
415                               const char *description);
416 #ifdef JNLIB_GCC_M_FUNCTION
417 # define fips_signal_error(a) \
418            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 0, (a))
419 # define fips_signal_fatal_error(a) \
420            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 1, (a))
421 #else
422 # define fips_signal_error(a) \
423            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 0, (a))
424 # define fips_signal_fatal_error(a) \
425            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 1, (a))
426 #endif
427
428 int _gcry_fips_is_operational (void);
429 #define fips_is_operational()   (_gcry_global_is_operational ())
430 #define fips_not_operational()  (GPG_ERR_NOT_OPERATIONAL)
431
432 int _gcry_fips_test_operational (void);
433 int _gcry_fips_test_error_or_operational (void);
434
435 gpg_err_code_t _gcry_fips_run_selftests (int extended);
436
437 void _gcry_fips_noreturn (void);
438 #define fips_noreturn()  (_gcry_fips_noreturn ())
439
440
441
442 #endif /* G10LIB_H */