0309a83af84f37e8e13634f29caacd5ac7b0cba2
[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 #if __GNUC__ >= 3
79 #define LIKELY( expr )    __builtin_expect( !!(expr), 1 )
80 #define UNLIKELY( expr )  __builtin_expect( !!(expr), 0 )
81 #else
82 #define LIKELY( expr )    (!!(expr))
83 #define UNLIKELY( expr )  (!!(expr))
84 #endif
85
86 /* Gettext macros.  */
87
88 #define _(a)  _gcry_gettext(a)
89 #define N_(a) (a)
90
91 /* Some handy macros */
92 #ifndef STR
93 #define STR(v) #v
94 #endif
95 #define STR2(v) STR(v)
96 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
97 #define DIMof(type,member)   DIM(((type *)0)->member)
98
99 \f
100
101 /*-- src/global.c -*/
102 int _gcry_global_is_operational (void);
103 gcry_err_code_t _gcry_vcontrol (enum gcry_ctl_cmds cmd, va_list arg_ptr);
104 void _gcry_check_heap (const void *a);
105 void _gcry_pre_syscall (void);
106 void _gcry_post_syscall (void);
107 int _gcry_get_debug_flag (unsigned int mask);
108
109 /* Malloc functions and common wrapper macros.  */
110 void *_gcry_malloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
111 void *_gcry_calloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
112 void *_gcry_malloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
113 void *_gcry_calloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
114 void *_gcry_realloc (void *a, size_t n);
115 char *_gcry_strdup (const char *string) _GCRY_GCC_ATTR_MALLOC;
116 void *_gcry_xmalloc (size_t n) _GCRY_GCC_ATTR_MALLOC;
117 void *_gcry_xcalloc (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
118 void *_gcry_xmalloc_secure (size_t n) _GCRY_GCC_ATTR_MALLOC;
119 void *_gcry_xcalloc_secure (size_t n, size_t m) _GCRY_GCC_ATTR_MALLOC;
120 void *_gcry_xrealloc (void *a, size_t n);
121 char *_gcry_xstrdup (const char * a) _GCRY_GCC_ATTR_MALLOC;
122 void  _gcry_free (void *a);
123 int   _gcry_is_secure (const void *a) _GCRY_GCC_ATTR_PURE;
124
125 #define xtrymalloc(a)    _gcry_malloc ((a))
126 #define xtrycalloc(a,b)  _gcry_calloc ((a),(b))
127 #define xtrymalloc_secure(a)   _gcry_malloc_secure ((a))
128 #define xtrycalloc_secure(a,b) _gcry_calloc_secure ((a),(b))
129 #define xtryrealloc(a,b) _gcry_realloc ((a),(b))
130 #define xtrystrdup(a)    _gcry_strdup ((a))
131 #define xmalloc(a)       _gcry_xmalloc ((a))
132 #define xcalloc(a,b)     _gcry_xcalloc ((a),(b))
133 #define xmalloc_secure(a)   _gcry_xmalloc_secure ((a))
134 #define xcalloc_secure(a,b) _gcry_xcalloc_secure ((a),(b))
135 #define xrealloc(a,b)    _gcry_xrealloc ((a),(b))
136 #define xstrdup(a)       _gcry_xstrdup ((a))
137 #define xfree(a)         _gcry_free ((a))
138
139
140 /*-- src/misc.c --*/
141
142 #if defined(JNLIB_GCC_M_FUNCTION) || __STDC_VERSION__ >= 199901L
143 void _gcry_bug (const char *file, int line,
144                 const char *func) GCC_ATTR_NORETURN;
145 void _gcry_assert_failed (const char *expr, const char *file, int line,
146                           const char *func) GCC_ATTR_NORETURN;
147 #else
148 void _gcry_bug (const char *file, int line);
149 void _gcry_assert_failed (const char *expr, const char *file, int line);
150 #endif
151
152 void _gcry_divide_by_zero (void) JNLIB_GCC_A_NR;
153
154 const char *_gcry_gettext (const char *key) GCC_ATTR_FORMAT_ARG(1);
155 void _gcry_fatal_error(int rc, const char *text ) JNLIB_GCC_A_NR;
156 void _gcry_logv (int level,
157                  const char *fmt, va_list arg_ptr) JNLIB_GCC_A_PRINTF(2,0);
158 void _gcry_log( int level, const char *fmt, ... ) JNLIB_GCC_A_PRINTF(2,3);
159 void _gcry_log_bug( const char *fmt, ... )   JNLIB_GCC_A_NR_PRINTF(1,2);
160 void _gcry_log_fatal( const char *fmt, ... ) JNLIB_GCC_A_NR_PRINTF(1,2);
161 void _gcry_log_error( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
162 void _gcry_log_info( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
163 int  _gcry_log_info_with_dummy_fp (FILE *fp, const char *fmt, ... )
164                                              JNLIB_GCC_A_PRINTF(2,3);
165 void _gcry_log_debug( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
166 void _gcry_log_printf ( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
167 void _gcry_log_printhex (const char *text, const void *buffer, size_t length);
168 void _gcry_log_printmpi (const char *text, gcry_mpi_t mpi);
169 void _gcry_log_printsxp (const char *text, gcry_sexp_t sexp);
170
171 void _gcry_set_log_verbosity( int level );
172 int _gcry_log_verbosity( int level );
173
174 #ifdef JNLIB_GCC_M_FUNCTION
175 #define BUG() _gcry_bug( __FILE__ , __LINE__, __FUNCTION__ )
176 #define gcry_assert(expr) (LIKELY(expr)? (void)0 \
177          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __FUNCTION__))
178 #elif __STDC_VERSION__ >= 199901L
179 #define BUG() _gcry_bug( __FILE__ , __LINE__, __func__ )
180 #define gcry_assert(expr) (LIKELY(expr)? (void)0 \
181          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __func__))
182 #else
183 #define BUG() _gcry_bug( __FILE__ , __LINE__ )
184 #define gcry_assert(expr) (LIKELY(expr)? (void)0 \
185          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__))
186 #endif
187
188
189 #define log_bug     _gcry_log_bug
190 #define log_fatal   _gcry_log_fatal
191 #define log_error   _gcry_log_error
192 #define log_info    _gcry_log_info
193 #define log_debug   _gcry_log_debug
194 #define log_printf  _gcry_log_printf
195 #define log_printhex _gcry_log_printhex
196 #define log_printmpi _gcry_log_printmpi
197 #define log_printsxp _gcry_log_printsxp
198
199 /* Compatibility macro.  */
200 #define log_mpidump _gcry_log_printmpi
201
202 /* Tokeninze STRING and return a malloced array.  */
203 char **_gcry_strtokenize (const char *string, const char *delim);
204
205
206 /*-- src/hwfeatures.c --*/
207 #define HWF_PADLOCK_RNG         (1 << 0)
208 #define HWF_PADLOCK_AES         (1 << 1)
209 #define HWF_PADLOCK_SHA         (1 << 2)
210 #define HWF_PADLOCK_MMUL        (1 << 3)
211
212 #define HWF_INTEL_CPU           (1 << 4)
213 #define HWF_INTEL_FAST_SHLD     (1 << 5)
214 #define HWF_INTEL_BMI2          (1 << 6)
215 #define HWF_INTEL_SSSE3         (1 << 7)
216 #define HWF_INTEL_SSE4_1        (1 << 8)
217 #define HWF_INTEL_PCLMUL        (1 << 9)
218 #define HWF_INTEL_AESNI         (1 << 10)
219 #define HWF_INTEL_RDRAND        (1 << 11)
220 #define HWF_INTEL_AVX           (1 << 12)
221 #define HWF_INTEL_AVX2          (1 << 13)
222 #define HWF_INTEL_FAST_VPGATHER (1 << 14)
223
224 #define HWF_ARM_NEON            (1 << 15)
225 #define HWF_ARM_AES             (1 << 16)
226 #define HWF_ARM_SHA1            (1 << 17)
227 #define HWF_ARM_SHA2            (1 << 18)
228 #define HWF_ARM_PMULL           (1 << 19)
229
230
231 gpg_err_code_t _gcry_disable_hw_feature (const char *name);
232 void _gcry_detect_hw_features (void);
233 unsigned int _gcry_get_hw_features (void);
234 const char *_gcry_enum_hw_features (int idx, unsigned int *r_feature);
235
236
237 /*-- mpi/mpiutil.c --*/
238 const char *_gcry_mpi_get_hw_config (void);
239
240
241 /*-- cipher/pubkey.c --*/
242
243 /* FIXME: shouldn't this go into mpi.h?  */
244 #ifndef mpi_powm
245 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
246 #endif
247
248 /*-- primegen.c --*/
249 gcry_err_code_t _gcry_primegen_init (void);
250 gcry_mpi_t _gcry_generate_secret_prime (unsigned int nbits,
251                                  gcry_random_level_t random_level,
252                                  int (*extra_check)(void*, gcry_mpi_t),
253                                  void *extra_check_arg);
254 gcry_mpi_t _gcry_generate_public_prime (unsigned int nbits,
255                                  gcry_random_level_t random_level,
256                                  int (*extra_check)(void*, gcry_mpi_t),
257                                  void *extra_check_arg);
258 gcry_err_code_t _gcry_generate_elg_prime (int mode,
259                                           unsigned int pbits,
260                                           unsigned int qbits,
261                                           gcry_mpi_t g,
262                                           gcry_mpi_t *r_prime,
263                                           gcry_mpi_t **factors);
264 gcry_mpi_t _gcry_derive_x931_prime (const gcry_mpi_t xp,
265                                     const gcry_mpi_t xp1, const gcry_mpi_t xp2,
266                                     const gcry_mpi_t e,
267                                     gcry_mpi_t *r_p1, gcry_mpi_t *r_p2);
268 gpg_err_code_t _gcry_generate_fips186_2_prime
269                  (unsigned int pbits, unsigned int qbits,
270                   const void *seed, size_t seedlen,
271                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
272                   int *r_counter,
273                   void **r_seed, size_t *r_seedlen);
274 gpg_err_code_t _gcry_generate_fips186_3_prime
275                  (unsigned int pbits, unsigned int qbits,
276                   const void *seed, size_t seedlen,
277                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
278                   int *r_counter,
279                   void **r_seed, size_t *r_seedlen, int *r_hashalgo);
280
281 gpg_err_code_t _gcry_fips186_4_prime_check (const gcry_mpi_t x,
282                                             unsigned int bits);
283
284
285 /* Replacements of missing functions (missing-string.c).  */
286 #ifndef HAVE_STPCPY
287 char *stpcpy (char *a, const char *b);
288 #endif
289 #ifndef HAVE_STRCASECMP
290 int strcasecmp (const char *a, const char *b) _GCRY_GCC_ATTR_PURE;
291 #endif
292
293 #include "../compat/libcompat.h"
294
295
296 /* Macros used to rename missing functions.  */
297 #ifndef HAVE_STRTOUL
298 #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
299 #endif
300 #ifndef HAVE_MEMMOVE
301 #define memmove(d, s, n) bcopy((s), (d), (n))
302 #endif
303 #ifndef HAVE_STRICMP
304 #define stricmp(a,b)     strcasecmp( (a), (b) )
305 #endif
306 #ifndef HAVE_ATEXIT
307 #define atexit(a)    (on_exit((a),0))
308 #endif
309 #ifndef HAVE_RAISE
310 #define raise(a) kill(getpid(), (a))
311 #endif
312
313
314 /* Stack burning.  */
315
316 #ifdef HAVE_GCC_ASM_VOLATILE_MEMORY
317 #define  __gcry_burn_stack_dummy() asm volatile ("":::"memory")
318 #else
319 void __gcry_burn_stack_dummy (void);
320 #endif
321
322 void __gcry_burn_stack (unsigned int bytes);
323 #define _gcry_burn_stack(bytes) \
324         do { __gcry_burn_stack (bytes); \
325              __gcry_burn_stack_dummy (); } while(0)
326
327
328 /* To avoid that a compiler optimizes certain memset calls away, these
329    macros may be used instead. */
330 #define wipememory2(_ptr,_set,_len) do { \
331               volatile char *_vptr=(volatile char *)(_ptr); \
332               size_t _vlen=(_len); \
333               unsigned char _vset=(_set); \
334               fast_wipememory2(_vptr,_vset,_vlen); \
335               while(_vlen) { *_vptr=(_vset); _vptr++; _vlen--; } \
336                   } while(0)
337 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
338
339 #define FASTWIPE_T u64
340 #define FASTWIPE_MULT (U64_C(0x0101010101010101))
341
342 /* Following architectures can handle unaligned accesses fast.  */
343 #if defined(HAVE_GCC_ATTRIBUTE_PACKED) && \
344     defined(HAVE_GCC_ATTRIBUTE_ALIGNED) && \
345     defined(HAVE_GCC_ATTRIBUTE_MAY_ALIAS) && \
346     (defined(__i386__) || defined(__x86_64__) || \
347      defined(__powerpc__) || defined(__powerpc64__) || \
348      (defined(__arm__) && defined(__ARM_FEATURE_UNALIGNED)) || \
349      defined(__aarch64__))
350 #define fast_wipememory2_unaligned_head(_ptr,_set,_len) /*do nothing*/
351 typedef struct fast_wipememory_s
352 {
353   FASTWIPE_T a;
354 } __attribute__((packed, aligned(1), may_alias)) fast_wipememory_t;
355 #else
356 #define fast_wipememory2_unaligned_head(_vptr,_vset,_vlen) do { \
357               while(UNLIKELY((size_t)(_vptr)&(sizeof(FASTWIPE_T)-1)) && _vlen) \
358                 { *_vptr=(_vset); _vptr++; _vlen--; } \
359                   } while(0)
360 typedef struct fast_wipememory_s
361 {
362   FASTWIPE_T a;
363 } fast_wipememory_t;
364 #endif
365
366 /* fast_wipememory2 may leave tail bytes unhandled, in which case tail bytes
367    are handled by wipememory2. */
368 #define fast_wipememory2(_vptr,_vset,_vlen) do { \
369               FASTWIPE_T _vset_long = _vset; \
370               fast_wipememory2_unaligned_head(_vptr,_vset,_vlen); \
371               if (_vlen < sizeof(FASTWIPE_T)) \
372                 break; \
373               _vset_long *= FASTWIPE_MULT; \
374               do { \
375                 volatile fast_wipememory_t *_vptr_long = \
376                   (volatile void *)_vptr; \
377                 _vptr_long->a = _vset_long; \
378                 _vlen -= sizeof(FASTWIPE_T); \
379                 _vptr += sizeof(FASTWIPE_T); \
380               } while (_vlen >= sizeof(FASTWIPE_T)); \
381                   } while (0)
382
383
384 /* Digit predicates.  */
385
386 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
387 #define octdigitp(p) (*(p) >= '0' && *(p) <= '7')
388 #define alphap(a)    (   (*(a) >= 'A' && *(a) <= 'Z')  \
389                       || (*(a) >= 'a' && *(a) <= 'z'))
390 #define hexdigitp(a) (digitp (a)                     \
391                       || (*(a) >= 'A' && *(a) <= 'F')  \
392                       || (*(a) >= 'a' && *(a) <= 'f'))
393
394 /* Init functions.  */
395
396 gcry_err_code_t _gcry_cipher_init (void);
397 gcry_err_code_t _gcry_md_init (void);
398 gcry_err_code_t _gcry_mac_init (void);
399 gcry_err_code_t _gcry_pk_init (void);
400 gcry_err_code_t _gcry_secmem_module_init (void);
401 gcry_err_code_t _gcry_mpi_init (void);
402
403 /* Memory management.  */
404 #define GCRY_ALLOC_FLAG_SECURE (1 << 0)
405 #define GCRY_ALLOC_FLAG_XHINT  (1 << 1)  /* Called from xmalloc.  */
406
407
408 /*-- sexp.c --*/
409 gcry_err_code_t _gcry_sexp_vbuild (gcry_sexp_t *retsexp, size_t *erroff,
410                                    const char *format, va_list arg_ptr);
411 char *_gcry_sexp_nth_string (const gcry_sexp_t list, int number);
412 gpg_err_code_t _gcry_sexp_vextract_param (gcry_sexp_t sexp, const char *path,
413                                           const char *list, va_list arg_ptr);
414
415
416 /*-- fips.c --*/
417
418 void _gcry_initialize_fips_mode (int force);
419
420 int _gcry_fips_mode (void);
421 #define fips_mode() _gcry_fips_mode ()
422
423 int _gcry_enforced_fips_mode (void);
424
425 void _gcry_set_enforced_fips_mode (void);
426
427 void _gcry_inactivate_fips_mode (const char *text);
428 int _gcry_is_fips_mode_inactive (void);
429
430
431 void _gcry_fips_signal_error (const char *srcfile,
432                               int srcline,
433                               const char *srcfunc,
434                               int is_fatal,
435                               const char *description);
436 #ifdef JNLIB_GCC_M_FUNCTION
437 # define fips_signal_error(a) \
438            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 0, (a))
439 # define fips_signal_fatal_error(a) \
440            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 1, (a))
441 #else
442 # define fips_signal_error(a) \
443            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 0, (a))
444 # define fips_signal_fatal_error(a) \
445            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 1, (a))
446 #endif
447
448 int _gcry_fips_is_operational (void);
449 #define fips_is_operational()   (_gcry_global_is_operational ())
450 #define fips_not_operational()  (GPG_ERR_NOT_OPERATIONAL)
451
452 int _gcry_fips_test_operational (void);
453 int _gcry_fips_test_error_or_operational (void);
454
455 gpg_err_code_t _gcry_fips_run_selftests (int extended);
456
457 void _gcry_fips_noreturn (void);
458 #define fips_noreturn()  (_gcry_fips_noreturn ())
459
460
461
462 #endif /* G10LIB_H */