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