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