Bump to 1.14.1
[platform/upstream/augeas.git] / lib / gc.h
1 /* gc.h --- Header file for implementation agnostic crypto wrapper API.
2  * Copyright (C) 2002-2005, 2007-2008, 2011-2016 Free Software Foundation, Inc.
3  *
4  * This file is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published
6  * by the Free Software Foundation; either version 2, or (at your
7  * option) any later version.
8  *
9  * This file is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this file; if not, see <http://www.gnu.org/licenses/>.
16  *
17  */
18
19 #ifndef GC_H
20 # define GC_H
21
22 /* Get size_t. */
23 # include <stddef.h>
24
25 enum Gc_rc
26 {
27   GC_OK = 0,
28   GC_MALLOC_ERROR,
29   GC_INIT_ERROR,
30   GC_RANDOM_ERROR,
31   GC_INVALID_CIPHER,
32   GC_INVALID_HASH,
33   GC_PKCS5_INVALID_ITERATION_COUNT,
34   GC_PKCS5_INVALID_DERIVED_KEY_LENGTH,
35   GC_PKCS5_DERIVED_KEY_TOO_LONG
36 };
37 typedef enum Gc_rc Gc_rc;
38
39 /* Hash types. */
40 enum Gc_hash
41 {
42   GC_MD4,
43   GC_MD5,
44   GC_SHA1,
45   GC_MD2,
46   GC_RMD160,
47   GC_SHA256,
48   GC_SHA384,
49   GC_SHA512,
50   GC_SHA224
51 };
52 typedef enum Gc_hash Gc_hash;
53
54 enum Gc_hash_mode
55 {
56   GC_HMAC = 1
57 };
58 typedef enum Gc_hash_mode Gc_hash_mode;
59
60 typedef void *gc_hash_handle;
61
62 #define GC_MD2_DIGEST_SIZE 16
63 #define GC_MD4_DIGEST_SIZE 16
64 #define GC_MD5_DIGEST_SIZE 16
65 #define GC_RMD160_DIGEST_SIZE 20
66 #define GC_SHA1_DIGEST_SIZE 20
67 #define GC_SHA256_DIGEST_SIZE 32
68 #define GC_SHA384_DIGEST_SIZE 48
69 #define GC_SHA512_DIGEST_SIZE 64
70 #define GC_SHA224_DIGEST_SIZE 24
71
72 /* Cipher types. */
73 enum Gc_cipher
74 {
75   GC_AES128,
76   GC_AES192,
77   GC_AES256,
78   GC_3DES,
79   GC_DES,
80   GC_ARCFOUR128,
81   GC_ARCFOUR40,
82   GC_ARCTWO40,
83   GC_CAMELLIA128,
84   GC_CAMELLIA256
85 };
86 typedef enum Gc_cipher Gc_cipher;
87
88 enum Gc_cipher_mode
89 {
90   GC_ECB,
91   GC_CBC,
92   GC_STREAM
93 };
94 typedef enum Gc_cipher_mode Gc_cipher_mode;
95
96 typedef void *gc_cipher_handle;
97
98 /* Call before respectively after any other functions. */
99 extern Gc_rc gc_init (void);
100 extern void gc_done (void);
101
102 /* Memory allocation (avoid). */
103 typedef void *(*gc_malloc_t) (size_t n);
104 typedef int (*gc_secure_check_t) (const void *);
105 typedef void *(*gc_realloc_t) (void *p, size_t n);
106 typedef void (*gc_free_t) (void *);
107 extern void gc_set_allocators (gc_malloc_t func_malloc,
108                                gc_malloc_t secure_malloc,
109                                gc_secure_check_t secure_check,
110                                gc_realloc_t func_realloc,
111                                gc_free_t func_free);
112
113 /* Randomness. */
114 extern Gc_rc gc_nonce (char *data, size_t datalen);
115 extern Gc_rc gc_pseudo_random (char *data, size_t datalen);
116 extern Gc_rc gc_random (char *data, size_t datalen);
117
118 /* Ciphers. */
119 extern Gc_rc gc_cipher_open (Gc_cipher cipher, Gc_cipher_mode mode,
120                              gc_cipher_handle *outhandle);
121 extern Gc_rc gc_cipher_setkey (gc_cipher_handle handle,
122                                size_t keylen, const char *key);
123 extern Gc_rc gc_cipher_setiv (gc_cipher_handle handle,
124                               size_t ivlen, const char *iv);
125 extern Gc_rc gc_cipher_encrypt_inline (gc_cipher_handle handle,
126                                        size_t len, char *data);
127 extern Gc_rc gc_cipher_decrypt_inline (gc_cipher_handle handle,
128                                        size_t len, char *data);
129 extern Gc_rc gc_cipher_close (gc_cipher_handle handle);
130
131 /* Hashes. */
132
133 extern Gc_rc gc_hash_open (Gc_hash hash, Gc_hash_mode mode,
134                            gc_hash_handle *outhandle);
135 extern Gc_rc gc_hash_clone (gc_hash_handle handle, gc_hash_handle *outhandle);
136 extern size_t gc_hash_digest_length (Gc_hash hash);
137 extern void gc_hash_hmac_setkey (gc_hash_handle handle,
138                                  size_t len, const char *key);
139 extern void gc_hash_write (gc_hash_handle handle,
140                            size_t len, const char *data);
141 extern const char *gc_hash_read (gc_hash_handle handle);
142 extern void gc_hash_close (gc_hash_handle handle);
143
144 /* Compute a hash value over buffer IN of INLEN bytes size using the
145    algorithm HASH, placing the result in the pre-allocated buffer OUT.
146    The required size of OUT depends on HASH, and is generally
147    GC_<HASH>_DIGEST_SIZE.  For example, for GC_MD5 the output buffer
148    must be 16 bytes.  The return value is 0 (GC_OK) on success, or
149    another Gc_rc error code. */
150 extern Gc_rc
151 gc_hash_buffer (Gc_hash hash, const void *in, size_t inlen, char *out);
152
153 /* One-call interface. */
154 extern Gc_rc gc_md2 (const void *in, size_t inlen, void *resbuf);
155 extern Gc_rc gc_md4 (const void *in, size_t inlen, void *resbuf);
156 extern Gc_rc gc_md5 (const void *in, size_t inlen, void *resbuf);
157 extern Gc_rc gc_sha1 (const void *in, size_t inlen, void *resbuf);
158 extern Gc_rc gc_hmac_md5 (const void *key, size_t keylen,
159                           const void *in, size_t inlen, char *resbuf);
160 extern Gc_rc gc_hmac_sha1 (const void *key, size_t keylen,
161                            const void *in, size_t inlen, char *resbuf);
162 extern Gc_rc gc_hmac_sha256 (const void *key, size_t keylen,
163                              const void *in, size_t inlen, char *resbuf);
164 extern Gc_rc gc_hmac_sha512 (const void *key, size_t keylen,
165                              const void *in, size_t inlen, char *resbuf);
166
167 /* Derive cryptographic keys from a password P of length PLEN, with
168    salt S of length SLEN, placing the result in pre-allocated buffer
169    DK of length DKLEN.  An iteration count is specified in C, where a
170    larger value means this function take more time (typical iteration
171    counts are 1000-20000).  This function "stretches" the key to be
172    exactly dkLen bytes long.  GC_OK is returned on success, otherwise
173    a Gc_rc error code is returned.  */
174 extern Gc_rc
175 gc_pbkdf2_sha1 (const char *P, size_t Plen,
176                 const char *S, size_t Slen,
177                 unsigned int c, char *DK, size_t dkLen);
178
179 /*
180   TODO:
181
182   From: Simon Josefsson <jas@extundo.com>
183   Subject: Re: generic crypto
184   Newsgroups: gmane.comp.lib.gnulib.bugs
185   Cc: bug-gnulib@gnu.org
186   Date: Fri, 07 Oct 2005 12:50:57 +0200
187   Mail-Copies-To: nobody
188
189   Paul Eggert <eggert@CS.UCLA.EDU> writes:
190
191   > Simon Josefsson <jas@extundo.com> writes:
192   >
193   >> * Perhaps the /dev/?random reading should be separated into a separate
194   >>   module?  It might be useful outside of the gc layer too.
195   >
196   > Absolutely.  I've been meaning to do that for months (for a "shuffle"
197   > program I want to add to coreutils), but hadn't gotten around to it.
198   > It would have to be generalized a bit.  I'd like to have the file
199   > descriptor cached, for example.
200
201   I'll write a separate module for that part.
202
203   I think we should even add a good PRNG that is re-seeded from
204   /dev/?random frequently.  GnuTLS can need a lot of random data on a
205   big server, more than /dev/random can supply.  And /dev/urandom might
206   not be strong enough.  Further, the security of /dev/?random can also
207   be questionable.
208
209   >>   I'm also not sure about the names of those functions, they suggest
210   >>   a more higher-level API than what is really offered (i.e., the
211   >>   names "nonce" and "pseudo_random" and "random" imply certain
212   >>   cryptographic properties).
213   >
214   > Could you expand a bit more on that?  What is the relationship between
215   > nonce/pseudorandom/random and the /dev/ values you are using?
216
217   There is none, that is the problem.
218
219   Applications generally need different kind of "random" numbers.
220   Sometimes they just need some random data and doesn't care whether it
221   is possible for an attacker to compute the string (aka a "nonce").
222   Sometimes they need data that is very difficult to compute (i.e.,
223   computing it require inverting SHA1 or similar).  Sometimes they need
224   data that is not possible to compute, i.e., it wants real entropy
225   collected over time on the system.  Collecting the last kind of random
226   data is very expensive, so it must not be used too often.  The second
227   kind of random data ("pseudo random") is typically generated by
228   seeding a good PRNG with a couple of hundred bytes of real entropy
229   from the "real random" data pool.  The "nonce" is usually computed
230   using the PRNG as well, because PRNGs are usually fast.
231
232   Pseudo-random data is typically used for session keys.  Strong random
233   data is often used to generate long-term keys (e.g., private RSA
234   keys).
235
236   Of course, there are many subtleties.  There are several different
237   kind of nonce:s.  Sometimes a nonce is just an ever-increasing
238   integer, starting from 0.  Sometimes it is assumed to be unlikely to
239   be the same as previous nonces, but without a requirement that the
240   nonce is possible to guess.  MD5(system clock) would thus suffice, if
241   it isn't called too often.  You can guess what the next value will be,
242   but it will always be different.
243
244   The problem is that /dev/?random doesn't offer any kind of semantic
245   guarantees.  But applications need an API that make that promise.
246
247   I think we should do this in several steps:
248
249   1) Write a module that can read from /dev/?random.
250
251   2) Add a module for a known-good PRNG suitable for random number
252   generation, that can be continuously re-seeded.
253
254   3) Add a high-level module that provide various different randomness
255   functions.  One for nonces, perhaps even different kind of nonces,
256   one for pseudo random data, and one for strong random data.  It is
257   not clear whether we can hope to achieve the last one in a portable
258   way.
259
260   Further, it would be useful to allow users to provide their own
261   entropy source as a file, used to seed the PRNG or initialize the
262   strong randomness pool.  This is used on embedded platforms that
263   doesn't have enough interrupts to hope to generate good random data.
264
265   > For example, why not use OpenBSD's /dev/arandom?
266
267   I don't trust ARC4.  For example, recent cryptographic efforts
268   indicate that you must throw away the first 512 bytes generated from
269   the PRNG for it to be secure.  I don't know whether OpenBSD do this.
270   Further, I recall some eprint paper on RC4 security that didn't
271   inspire confidence.
272
273   While I trust the random devices in OpenBSD more than
274   Solaris/AIX/HPUX/etc, I think that since we need something better on
275   Solaris/AIX/HPUX we'd might as well use it on OpenBSD or even Linux
276   too.
277
278   > Here is one thought.  The user could specify a desired quality level
279   > range, and the implementation then would supply random data that is at
280   > least as good as the lower bound of the range.  I.e., ihe
281   > implementation refuses to produce any random data if it can't generate
282   > data that is at least as good as the lower end of the range.  The
283   > upper bound of the range is advice from the user not to be any more
284   > expensive than that, but the implementation can ignore the advice if
285   > it doesn't have anything cheaper.
286
287   I'm not sure this is a good idea.  Users can't really be expected to
288   understand this.  Further, applications need many different kind of
289   random data.  Selecting the randomness level for each by the user will
290   be too complicated.
291
292   I think it is better if the application decide, from its cryptographic
293   requirement, what entropy quality it require, and call the proper API.
294   Meeting the implied semantic properties should be the job for gnulib.
295
296   >> Perhaps gc_dev_random and gc_dev_urandom?
297   >
298   > To some extent.  I'd rather insulate the user from the details of
299   > where the random numbers come from.  On the other hand we need to
300   > provide a way for applications to specify a file that contains
301   > random bits, so that people can override the defaults.
302
303   Agreed.
304
305   This may require some thinking before it is finalized.  Is it ok to
306   install the GC module as-is meanwhile?  Then I can continue to add the
307   stuff that GnuTLS need, and then come back to re-working the
308   randomness module.  That way, we have two different projects that use
309   the code.  GnuTLS includes the same randomness code that was in GNU
310   SASL and that is in the current gc module.  I feel much more
311   comfortable working in small steps at a time, rather then working on
312   this for a long time in gnulib and only later integrate the stuff in
313   GnuTLS.
314
315   Thanks,
316   Simon
317  */
318
319 #endif /* GC_H */