c580c08507301dd17711056584c29a7961ad6044
[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
70 /* Gettext macros.  */
71
72 #define _(a)  _gcry_gettext(a)
73 #define N_(a) (a)
74
75 /* Some handy macros */
76 #ifndef STR
77 #define STR(v) #v
78 #endif
79 #define STR2(v) STR(v)
80 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
81 #define DIMof(type,member)   DIM(((type *)0)->member)
82
83 \f
84
85 /*-- src/global.c -*/
86 int _gcry_global_is_operational (void);
87 gcry_error_t _gcry_vcontrol (enum gcry_ctl_cmds cmd, va_list arg_ptr);
88 void  _gcry_check_heap (const void *a);
89 int _gcry_get_debug_flag (unsigned int mask);
90
91
92 /*-- src/misc.c --*/
93
94 #if defined(JNLIB_GCC_M_FUNCTION) || __STDC_VERSION__ >= 199901L
95 void _gcry_bug (const char *file, int line,
96                 const char *func) GCC_ATTR_NORETURN;
97 void _gcry_assert_failed (const char *expr, const char *file, int line,
98                           const char *func) GCC_ATTR_NORETURN;
99 #else
100 void _gcry_bug (const char *file, int line);
101 void _gcry_assert_failed (const char *expr, const char *file, int line);
102 #endif
103
104 void _gcry_divide_by_zero (void) JNLIB_GCC_A_NR;
105
106 const char *_gcry_gettext (const char *key) GCC_ATTR_FORMAT_ARG(1);
107 void _gcry_fatal_error(int rc, const char *text ) JNLIB_GCC_A_NR;
108 void _gcry_log( int level, const char *fmt, ... ) JNLIB_GCC_A_PRINTF(2,3);
109 void _gcry_log_bug( const char *fmt, ... )   JNLIB_GCC_A_NR_PRINTF(1,2);
110 void _gcry_log_fatal( const char *fmt, ... ) JNLIB_GCC_A_NR_PRINTF(1,2);
111 void _gcry_log_error( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
112 void _gcry_log_info( const char *fmt, ... )  JNLIB_GCC_A_PRINTF(1,2);
113 int  _gcry_log_info_with_dummy_fp (FILE *fp, const char *fmt, ... )
114                                              JNLIB_GCC_A_PRINTF(2,3);
115 void _gcry_log_debug( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
116 void _gcry_log_printf ( const char *fmt, ... ) JNLIB_GCC_A_PRINTF(1,2);
117 void _gcry_log_printhex (const char *text, const void *buffer, size_t length);
118
119 void _gcry_set_log_verbosity( int level );
120 int _gcry_log_verbosity( int level );
121
122 #ifdef JNLIB_GCC_M_FUNCTION
123 #define BUG() _gcry_bug( __FILE__ , __LINE__, __FUNCTION__ )
124 #define gcry_assert(expr) ((expr)? (void)0 \
125          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __FUNCTION__))
126 #elif __STDC_VERSION__ >= 199901L
127 #define BUG() _gcry_bug( __FILE__ , __LINE__, __func__ )
128 #define gcry_assert(expr) ((expr)? (void)0 \
129          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__, __func__))
130 #else
131 #define BUG() _gcry_bug( __FILE__ , __LINE__ )
132 #define gcry_assert(expr) ((expr)? (void)0 \
133          : _gcry_assert_failed (STR(expr), __FILE__, __LINE__))
134 #endif
135
136
137 #define log_bug     _gcry_log_bug
138 #define log_fatal   _gcry_log_fatal
139 #define log_error   _gcry_log_error
140 #define log_info    _gcry_log_info
141 #define log_debug   _gcry_log_debug
142 #define log_printf  _gcry_log_printf
143 #define log_printhex _gcry_log_printhex
144
145
146 /*-- src/hwfeatures.c --*/
147 /* (Do not change these values unless synced with the asm code.)  */
148 #define HWF_PADLOCK_RNG  1
149 #define HWF_PADLOCK_AES  2
150 #define HWF_PADLOCK_SHA  4
151 #define HWF_PADLOCK_MMUL 8
152
153 #define HWF_INTEL_AESNI  256
154
155
156 unsigned int _gcry_get_hw_features (void);
157 void _gcry_detect_hw_features (unsigned int);
158
159
160 /*-- mpi/mpiutil.c --*/
161 const char *_gcry_mpi_get_hw_config (void);
162
163
164 /*-- cipher/pubkey.c --*/
165
166 /* FIXME: shouldn't this go into mpi.h?  */
167 #ifndef mpi_powm
168 #define mpi_powm(w,b,e,m)   gcry_mpi_powm( (w), (b), (e), (m) )
169 #endif
170
171 /*-- primegen.c --*/
172 gcry_err_code_t _gcry_primegen_init (void);
173 gcry_mpi_t _gcry_generate_secret_prime (unsigned int nbits,
174                                  gcry_random_level_t random_level,
175                                  int (*extra_check)(void*, gcry_mpi_t),
176                                  void *extra_check_arg);
177 gcry_mpi_t _gcry_generate_public_prime (unsigned int nbits,
178                                  gcry_random_level_t random_level,
179                                  int (*extra_check)(void*, gcry_mpi_t),
180                                  void *extra_check_arg);
181 gcry_mpi_t _gcry_generate_elg_prime (int mode,
182                                      unsigned int pbits, unsigned int qbits,
183                                      gcry_mpi_t g, gcry_mpi_t **factors);
184 gcry_mpi_t _gcry_derive_x931_prime (const gcry_mpi_t xp,
185                                     const gcry_mpi_t xp1, const gcry_mpi_t xp2,
186                                     const gcry_mpi_t e,
187                                     gcry_mpi_t *r_p1, gcry_mpi_t *r_p2);
188 gpg_err_code_t _gcry_generate_fips186_2_prime
189                  (unsigned int pbits, unsigned int qbits,
190                   const void *seed, size_t seedlen,
191                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
192                   int *r_counter,
193                   void **r_seed, size_t *r_seedlen);
194 gpg_err_code_t _gcry_generate_fips186_3_prime
195                  (unsigned int pbits, unsigned int qbits,
196                   const void *seed, size_t seedlen,
197                   gcry_mpi_t *r_q, gcry_mpi_t *r_p,
198                   int *r_counter,
199                   void **r_seed, size_t *r_seedlen, int *r_hashalgo);
200
201
202 /* Replacements of missing functions (missing-string.c).  */
203 #ifndef HAVE_STPCPY
204 char *stpcpy (char *a, const char *b);
205 #endif
206 #ifndef HAVE_STRCASECMP
207 int strcasecmp (const char *a, const char *b) _GCRY_GCC_ATTR_PURE;
208 #endif
209
210 #include "../compat/libcompat.h"
211
212
213 /* Macros used to rename missing functions.  */
214 #ifndef HAVE_STRTOUL
215 #define strtoul(a,b,c)  ((unsigned long)strtol((a),(b),(c)))
216 #endif
217 #ifndef HAVE_MEMMOVE
218 #define memmove(d, s, n) bcopy((s), (d), (n))
219 #endif
220 #ifndef HAVE_STRICMP
221 #define stricmp(a,b)     strcasecmp( (a), (b) )
222 #endif
223 #ifndef HAVE_ATEXIT
224 #define atexit(a)    (on_exit((a),0))
225 #endif
226 #ifndef HAVE_RAISE
227 #define raise(a) kill(getpid(), (a))
228 #endif
229
230
231 /* Stack burning.  */
232
233 void _gcry_burn_stack (int bytes);
234
235
236 /* To avoid that a compiler optimizes certain memset calls away, these
237    macros may be used instead. */
238 #define wipememory2(_ptr,_set,_len) do { \
239               volatile char *_vptr=(volatile char *)(_ptr); \
240               size_t _vlen=(_len); \
241               while(_vlen) { *_vptr=(_set); _vptr++; _vlen--; } \
242                   } while(0)
243 #define wipememory(_ptr,_len) wipememory2(_ptr,0,_len)
244
245
246
247 /* Digit predicates.  */
248
249 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
250 #define octdigitp(p) (*(p) >= '0' && *(p) <= '7')
251 #define alphap(a)    (   (*(a) >= 'A' && *(a) <= 'Z')  \
252                       || (*(a) >= 'a' && *(a) <= 'z'))
253 #define hexdigitp(a) (digitp (a)                     \
254                       || (*(a) >= 'A' && *(a) <= 'F')  \
255                       || (*(a) >= 'a' && *(a) <= 'f'))
256
257 /* Management for ciphers/digests/pubkey-ciphers.  */
258
259 /* Structure for each registered `module'.  */
260 struct gcry_module
261 {
262   struct gcry_module *next;     /* List pointers.      */
263   struct gcry_module **prevp;
264   void *spec;                   /* Pointer to the subsystem-specific
265                                    specification structure.  */
266   void *extraspec;              /* Pointer to the subsystem-specific
267                                    extra specification structure.  */
268   int flags;                    /* Associated flags.   */
269   int counter;                  /* Use counter.        */
270   unsigned int mod_id;          /* ID of this module.  */
271 };
272
273 /* Flags for the `flags' member of gcry_module_t.  */
274 #define FLAG_MODULE_DISABLED (1 << 0)
275
276 gcry_err_code_t _gcry_module_add (gcry_module_t *entries,
277                                   unsigned int id,
278                                   void *spec,
279                                   void *extraspec,
280                                   gcry_module_t *module);
281
282 typedef int (*gcry_module_lookup_t) (void *spec, void *data);
283
284 /* Lookup a module specification by it's ID.  After a successful
285    lookup, the module has it's resource counter incremented.  */
286 gcry_module_t _gcry_module_lookup_id (gcry_module_t entries,
287                                        unsigned int id);
288
289 /* Internal function.  Lookup a module specification.  */
290 gcry_module_t _gcry_module_lookup (gcry_module_t entries, void *data,
291                                     gcry_module_lookup_t func);
292
293 /* Release a module.  In case the use-counter reaches zero, destroy
294    the module.  */
295 void _gcry_module_release (gcry_module_t entry);
296
297 /* Add a reference to a module.  */
298 void _gcry_module_use (gcry_module_t module);
299
300 /* Return a list of module IDs.  */
301 gcry_err_code_t _gcry_module_list (gcry_module_t modules,
302                                   int *list, int *list_length);
303
304 gcry_err_code_t _gcry_cipher_init (void);
305 gcry_err_code_t _gcry_md_init (void);
306 gcry_err_code_t _gcry_pk_init (void);
307 gcry_err_code_t _gcry_secmem_module_init (void);
308
309 gcry_err_code_t _gcry_pk_module_lookup (int id, gcry_module_t *module);
310 void _gcry_pk_module_release (gcry_module_t module);
311 gcry_err_code_t _gcry_pk_get_elements (int algo, char **enc, char **sig);
312
313 /* Memory management.  */
314 #define GCRY_ALLOC_FLAG_SECURE (1 << 0)
315
316
317 /*-- sexp.c --*/
318 gcry_error_t _gcry_sexp_vbuild (gcry_sexp_t *retsexp, size_t *erroff,
319                                 const char *format, va_list arg_ptr);
320 char *_gcry_sexp_nth_string (const gcry_sexp_t list, int number);
321
322
323 /*-- fips.c --*/
324
325 void _gcry_initialize_fips_mode (int force);
326
327 int _gcry_fips_mode (void);
328 #define fips_mode() _gcry_fips_mode ()
329
330 int _gcry_enforced_fips_mode (void);
331
332 void _gcry_set_enforced_fips_mode (void);
333
334 void _gcry_inactivate_fips_mode (const char *text);
335 int _gcry_is_fips_mode_inactive (void);
336
337
338 void _gcry_fips_signal_error (const char *srcfile,
339                               int srcline,
340                               const char *srcfunc,
341                               int is_fatal,
342                               const char *description);
343 #ifdef JNLIB_GCC_M_FUNCTION
344 # define fips_signal_error(a) \
345            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 0, (a))
346 # define fips_signal_fatal_error(a) \
347            _gcry_fips_signal_error (__FILE__, __LINE__, __FUNCTION__, 1, (a))
348 #else
349 # define fips_signal_error(a) \
350            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 0, (a))
351 # define fips_signal_fatal_error(a) \
352            _gcry_fips_signal_error (__FILE__, __LINE__, NULL, 1, (a))
353 #endif
354
355 int _gcry_fips_is_operational (void);
356 #define fips_is_operational()   (_gcry_global_is_operational ())
357 #define fips_not_operational()  (GCRY_GPG_ERR_NOT_OPERATIONAL)
358
359 int _gcry_fips_test_operational (void);
360 int _gcry_fips_test_error_or_operational (void);
361
362 gpg_err_code_t _gcry_fips_run_selftests (int extended);
363
364 void _gcry_fips_noreturn (void);
365 #define fips_noreturn()  (_gcry_fips_noreturn ())
366
367
368
369 #endif /* G10LIB_H */