a326ad5fdfe735f7dbcb7ec0249c6cb5b8b47bd3
[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
100 /*-- src/misc.c --*/
101
102 #if defined(JNLIB_GCC_M_FUNCTION) || __STDC_VERSION__ >= 199901L
103 void _gcry_bug (const char *file, int line,
104                 const char *func) GCC_ATTR_NORETURN;
105 void _gcry_assert_failed (const char *expr, const char *file, int line,
106                           const char *func) GCC_ATTR_NORETURN;
107 #else
108 void _gcry_bug (const char *file, int line);
109 void _gcry_assert_failed (const char *expr, const char *file, int line);
110 #endif
111
112 void _gcry_divide_by_zero (void) JNLIB_GCC_A_NR;
113
114 const char *_gcry_gettext (const char *key) GCC_ATTR_FORMAT_ARG(1);
115 void _gcry_fatal_error(int rc, const char *text ) JNLIB_GCC_A_NR;
116 void _gcry_logv (int level,
117                  const char *fmt, va_list arg_ptr) JNLIB_GCC_A_PRINTF(2,0);
118 void _gcry_log( int level, const char *fmt, ... ) JNLIB_GCC_A_PRINTF(2,3);
119 void _gcry_log_bug( const char *fmt, ... )   JNLIB_GCC_A_NR_PRINTF(1,2);
120 void _gcry_log_fatal( const char *fmt, ... ) JNLIB_GCC_A_NR_PRINTF(1,2);
121 void _gcry_log_error( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
122 void _gcry_log_info( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
123 int  _gcry_log_info_with_dummy_fp (FILE *fp, const char *fmt, ... )
124                                              JNLIB_GCC_A_PRINTF(2,3);
125 void _gcry_log_debug( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
126 void _gcry_log_printf ( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
127 void _gcry_log_printhex (const char *text, const void *buffer, size_t length);
128 void _gcry_log_printmpi (const char *text, gcry_mpi_t mpi);
129 void _gcry_log_printsxp (const char *text, gcry_sexp_t sexp);
130
131 void _gcry_set_log_verbosity( int level );
132 int _gcry_log_verbosity( int level );
133
134 #ifdef JNLIB_GCC_M_FUNCTION
135 #define BUG() _gcry_bug( __FILE__ , __LINE__, __FUNCTION__ )
136 #define gcry_assert(expr) ((expr)? (void)0 \
137          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __FUNCTION__))
138 #elif __STDC_VERSION__ >= 199901L
139 #define BUG() _gcry_bug( __FILE__ , __LINE__, __func__ )
140 #define gcry_assert(expr) ((expr)? (void)0 \
141          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __func__))
142 #else
143 #define BUG() _gcry_bug( __FILE__ , __LINE__ )
144 #define gcry_assert(expr) ((expr)? (void)0 \
145          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__))
146 #endif
147
148
149 #define log_bug     _gcry_log_bug
150 #define log_fatal   _gcry_log_fatal
151 #define log_error   _gcry_log_error
152 #define log_info    _gcry_log_info
153 #define log_debug   _gcry_log_debug
154 #define log_printf  _gcry_log_printf
155 #define log_printhex _gcry_log_printhex
156 #define log_printmpi _gcry_log_printmpi
157 #define log_printsxp _gcry_log_printsxp
158
159 /* Compatibility macro.  */
160 #define log_mpidump _gcry_log_printmpi
161
162
163 /*-- src/hwfeatures.c --*/
164 /* (Do not change these values unless synced with the asm code.)  */
165 #define HWF_PADLOCK_RNG  1
166 #define HWF_PADLOCK_AES  2
167 #define HWF_PADLOCK_SHA  4
168 #define HWF_PADLOCK_MMUL 8
169
170 #define HWF_INTEL_PCLMUL 128
171 #define HWF_INTEL_AESNI  256
172 #define HWF_INTEL_RDRAND 512
173 #define HWF_INTEL_AVX    1024
174 #define HWF_INTEL_AVX2   2048
175
176 #define HWF_ARM_NEON     4096
177
178
179 unsigned int _gcry_get_hw_features (void);
180 void _gcry_detect_hw_features (unsigned int);
181
182
183 /*-- mpi/mpiutil.c --*/
184 const char *_gcry_mpi_get_hw_config (void);
185
186
187 /*-- cipher/pubkey.c --*/
188
189 /* FIXME: shouldn't this go into mpi.h?  */
190 #ifndef mpi_powm
191 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
192 #endif
193
194 /*-- primegen.c --*/
195 gcry_err_code_t _gcry_primegen_init (void);
196 gcry_mpi_t _gcry_generate_secret_prime (unsigned int nbits,
197                                  gcry_random_level_t random_level,
198                                  int (*extra_check)(void*, gcry_mpi_t),
199                                  void *extra_check_arg);
200 gcry_mpi_t _gcry_generate_public_prime (unsigned int nbits,
201                                  gcry_random_level_t random_level,
202                                  int (*extra_check)(void*, gcry_mpi_t),
203                                  void *extra_check_arg);
204 gcry_mpi_t _gcry_generate_elg_prime (int mode,
205                                      unsigned int pbits, unsigned int qbits,
206                                      gcry_mpi_t g, gcry_mpi_t **factors);
207 gcry_mpi_t _gcry_derive_x931_prime (const gcry_mpi_t xp,
208                                     const gcry_mpi_t xp1, const gcry_mpi_t xp2,
209                                     const gcry_mpi_t e,
210                                     gcry_mpi_t *r_p1, gcry_mpi_t *r_p2);
211 gpg_err_code_t _gcry_generate_fips186_2_prime
212                  (unsigned int pbits, unsigned int qbits,
213                   const void *seed, size_t seedlen,
214                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
215                   int *r_counter,
216                   void **r_seed, size_t *r_seedlen);
217 gpg_err_code_t _gcry_generate_fips186_3_prime
218                  (unsigned int pbits, unsigned int qbits,
219                   const void *seed, size_t seedlen,
220                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
221                   int *r_counter,
222                   void **r_seed, size_t *r_seedlen, int *r_hashalgo);
223
224
225 /* Replacements of missing functions (missing-string.c).  */
226 #ifndef HAVE_STPCPY
227 char *stpcpy (char *a, const char *b);
228 #endif
229 #ifndef HAVE_STRCASECMP
230 int strcasecmp (const char *a, const char *b) _GCRY_GCC_ATTR_PURE;
231 #endif
232
233 #include "../compat/libcompat.h"
234
235
236 /* Macros used to rename missing functions.  */
237 #ifndef HAVE_STRTOUL
238 #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
239 #endif
240 #ifndef HAVE_MEMMOVE
241 #define memmove(d, s, n) bcopy((s), (d), (n))
242 #endif
243 #ifndef HAVE_STRICMP
244 #define stricmp(a,b)     strcasecmp( (a), (b) )
245 #endif
246 #ifndef HAVE_ATEXIT
247 #define atexit(a)    (on_exit((a),0))
248 #endif
249 #ifndef HAVE_RAISE
250 #define raise(a) kill(getpid(), (a))
251 #endif
252
253
254 /* Stack burning.  */
255
256 #ifdef HAVE_GCC_ASM_VOLATILE_MEMORY
257 #define  __gcry_burn_stack_dummy() asm volatile ("":::"memory")
258 #else
259 void __gcry_burn_stack_dummy (void);
260 #endif
261
262 void __gcry_burn_stack (unsigned int bytes);
263 #define _gcry_burn_stack(bytes) \
264         do { __gcry_burn_stack (bytes); \
265              __gcry_burn_stack_dummy (); } while(0)
266
267
268 /* To avoid that a compiler optimizes certain memset calls away, these
269    macros may be used instead. */
270 #define wipememory2(_ptr,_set,_len) do { \
271               volatile char *_vptr=(volatile char *)(_ptr); \
272               size_t _vlen=(_len); \
273               unsigned char _vset=(_set); \
274               fast_wipememory2(_vptr,_vset,_vlen); \
275               while(_vlen) { *_vptr=(_vset); _vptr++; _vlen--; } \
276                   } while(0)
277 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
278
279 #ifdef HAVE_U64_TYPEDEF
280   #define FASTWIPE_T u64
281   #define FASTWIPE_MULT (U64_C(0x0101010101010101))
282 #else
283   #define FASTWIPE_T u32
284   #define FASTWIPE_MULT (0x01010101U)
285 #endif
286
287 /* Following architectures can handle unaligned accesses fast.  */
288 #if defined(__i386__) || defined(__x86_64__) || \
289     defined(__powerpc__) || defined(__powerpc64__) || \
290     (defined(__arm__) && defined(__ARM_FEATURE_UNALIGNED)) || \
291     defined(__aarch64__)
292 #define fast_wipememory2_unaligned_head(_ptr,_set,_len) /*do nothing*/
293 #else
294 #define fast_wipememory2_unaligned_head(_vptr,_vset,_vlen) do { \
295               while((size_t)(_vptr)&(sizeof(FASTWIPE_T)-1) && _vlen) \
296                 { *_vptr=(_vset); _vptr++; _vlen--; } \
297                   } while(0)
298 #endif
299
300 /* fast_wipememory2 may leave tail bytes unhandled, in which case tail bytes
301    are handled by wipememory2. */
302 #define fast_wipememory2(_vptr,_vset,_vlen) do { \
303               FASTWIPE_T _vset_long = _vset; \
304               fast_wipememory2_unaligned_head(_vptr,_vset,_vlen); \
305               if (_vlen < sizeof(FASTWIPE_T)) \
306                 break; \
307               _vset_long *= FASTWIPE_MULT; \
308               do { \
309                 volatile FASTWIPE_T *_vptr_long = (volatile void *)_vptr; \
310                 *_vptr_long = _vset_long; \
311                 _vlen -= sizeof(FASTWIPE_T); \
312                 _vptr += sizeof(FASTWIPE_T); \
313               } while (_vlen >= sizeof(FASTWIPE_T)); \
314                   } while (0)
315
316
317 /* Digit predicates.  */
318
319 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
320 #define octdigitp(p) (*(p) >= '0' && *(p) <= '7')
321 #define alphap(a)    (   (*(a) >= 'A' && *(a) <= 'Z')  \
322                       || (*(a) >= 'a' && *(a) <= 'z'))
323 #define hexdigitp(a) (digitp (a)                     \
324                       || (*(a) >= 'A' && *(a) <= 'F')  \
325                       || (*(a) >= 'a' && *(a) <= 'f'))
326
327 /* Init functions.  */
328
329 gcry_err_code_t _gcry_cipher_init (void);
330 gcry_err_code_t _gcry_md_init (void);
331 gcry_err_code_t _gcry_pk_init (void);
332 gcry_err_code_t _gcry_secmem_module_init (void);
333 gcry_err_code_t _gcry_mpi_init (void);
334
335 /* Memory management.  */
336 #define GCRY_ALLOC_FLAG_SECURE (1 << 0)
337
338
339 /*-- sexp.c --*/
340 gcry_err_code_t _gcry_sexp_vbuild (gcry_sexp_t *retsexp, size_t *erroff,
341                                    const char *format, va_list arg_ptr);
342 char *_gcry_sexp_nth_string (const gcry_sexp_t list, int number);
343 gpg_err_code_t _gcry_sexp_vextract_param (gcry_sexp_t sexp, const char *path,
344                                           const char *list, va_list arg_ptr);
345
346
347 /*-- fips.c --*/
348
349 void _gcry_initialize_fips_mode (int force);
350
351 int _gcry_fips_mode (void);
352 #define fips_mode() _gcry_fips_mode ()
353
354 int _gcry_enforced_fips_mode (void);
355
356 void _gcry_set_enforced_fips_mode (void);
357
358 void _gcry_inactivate_fips_mode (const char *text);
359 int _gcry_is_fips_mode_inactive (void);
360
361
362 void _gcry_fips_signal_error (const char *srcfile,
363                               int srcline,
364                               const char *srcfunc,
365                               int is_fatal,
366                               const char *description);
367 #ifdef JNLIB_GCC_M_FUNCTION
368 # define fips_signal_error(a) \
369            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 0, (a))
370 # define fips_signal_fatal_error(a) \
371            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 1, (a))
372 #else
373 # define fips_signal_error(a) \
374            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 0, (a))
375 # define fips_signal_fatal_error(a) \
376            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 1, (a))
377 #endif
378
379 int _gcry_fips_is_operational (void);
380 #define fips_is_operational()   (_gcry_global_is_operational ())
381 #define fips_not_operational()  (GPG_ERR_NOT_OPERATIONAL)
382
383 int _gcry_fips_test_operational (void);
384 int _gcry_fips_test_error_or_operational (void);
385
386 gpg_err_code_t _gcry_fips_run_selftests (int extended);
387
388 void _gcry_fips_noreturn (void);
389 #define fips_noreturn()  (_gcry_fips_noreturn ())
390
391
392
393 #endif /* G10LIB_H */