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