62a8659624201acf298839f0ddc59ac08399a6ee
[openssl.git] / apps / apps.h
1 /* apps/apps.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58 /* ====================================================================
59  * Copyright (c) 1998-2001 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111
112 #ifndef HEADER_APPS_H
113 #define HEADER_APPS_H
114
115 #include "e_os.h"
116
117 #include <openssl/bio.h>
118 #include <openssl/x509.h>
119 #include <openssl/lhash.h>
120 #include <openssl/conf.h>
121 #include <openssl/txt_db.h>
122 #ifndef OPENSSL_NO_ENGINE
123 #include <openssl/engine.h>
124 #endif
125 #ifndef OPENSSL_NO_OCSP
126 #include <openssl/ocsp.h>
127 #endif
128 #include <openssl/ossl_typ.h>
129
130 int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
131 int app_RAND_write_file(const char *file, BIO *bio_e);
132 /* When `file' is NULL, use defaults.
133  * `bio_e' is for error messages. */
134 void app_RAND_allow_write_file(void);
135 long app_RAND_load_files(char *file); /* `file' is a list of files to read,
136                                        * separated by LIST_SEPARATOR_CHAR
137                                        * (see e_os.h).  The string is
138                                        * destroyed! */
139
140 #ifndef MONOLITH
141
142 #define MAIN(a,v)       main(a,v)
143
144 #ifndef NON_MAIN
145 CONF *config=NULL;
146 BIO *bio_err=NULL;
147 #else
148 extern CONF *config;
149 extern BIO *bio_err;
150 #endif
151
152 #else
153
154 #define MAIN(a,v)       PROG(a,v)
155 extern CONF *config;
156 extern char *default_config_file;
157 extern BIO *bio_err;
158
159 #endif
160
161 #ifndef OPENSSL_SYS_NETWARE
162 #include <signal.h>
163 #endif
164
165 #ifdef SIGPIPE
166 #define do_pipe_sig()   signal(SIGPIPE,SIG_IGN)
167 #else
168 #define do_pipe_sig()
169 #endif
170
171 #if defined(MONOLITH) && !defined(OPENSSL_C)
172 #  define apps_startup() \
173                 do_pipe_sig()
174 #  define apps_shutdown()
175 #else
176 #  ifndef OPENSSL_NO_ENGINE
177 #    define apps_startup() \
178                         do { do_pipe_sig(); CRYPTO_malloc_init(); \
179                         ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
180                         ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
181 #    define apps_shutdown() \
182                         do { CONF_modules_unload(1); destroy_ui_method(); \
183                         OBJ_cleanup(); EVP_cleanup(); ENGINE_cleanup(); \
184                         CRYPTO_cleanup_all_ex_data(); ERR_remove_thread_state(NULL); \
185                         ERR_free_strings(); COMP_zlib_cleanup();} while(0)
186 #  else
187 #    define apps_startup() \
188                         do { do_pipe_sig(); CRYPTO_malloc_init(); \
189                         ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
190                         setup_ui_method(); } while(0)
191 #    define apps_shutdown() \
192                         do { CONF_modules_unload(1); destroy_ui_method(); \
193                         OBJ_cleanup(); EVP_cleanup(); \
194                         CRYPTO_cleanup_all_ex_data(); ERR_remove_thread_state(NULL); \
195                         ERR_free_strings(); } while(0)
196 #  endif
197 #endif
198
199 #ifdef OPENSSL_SYSNAME_WIN32
200 #  define openssl_fdset(a,b) FD_SET((unsigned int)a, b)
201 #else
202 #  define openssl_fdset(a,b) FD_SET(a, b)
203 #endif
204
205
206 typedef struct args_st
207         {
208         char **data;
209         int count;
210         } ARGS;
211
212 #define PW_MIN_LENGTH 4
213 typedef struct pw_cb_data
214         {
215         const void *password;
216         const char *prompt_info;
217         } PW_CB_DATA;
218
219 int password_callback(char *buf, int bufsiz, int verify,
220         PW_CB_DATA *cb_data);
221
222 int setup_ui_method(void);
223 void destroy_ui_method(void);
224
225 int should_retry(int i);
226 int args_from_file(char *file, int *argc, char **argv[]);
227 int str2fmt(char *s);
228 void program_name(char *in,char *out,int size);
229 int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]);
230 #ifdef HEADER_X509_H
231 int dump_cert_text(BIO *out, X509 *x);
232 void print_name(BIO *out, const char *title, X509_NAME *nm, unsigned long lflags);
233 #endif
234 int set_cert_ex(unsigned long *flags, const char *arg);
235 int set_name_ex(unsigned long *flags, const char *arg);
236 int set_ext_copy(int *copy_type, const char *arg);
237 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
238 int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
239 int add_oid_section(BIO *err, CONF *conf);
240 X509 *load_cert(BIO *err, const char *file, int format,
241         const char *pass, ENGINE *e, const char *cert_descrip);
242 EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin,
243         const char *pass, ENGINE *e, const char *key_descrip);
244 EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin,
245         const char *pass, ENGINE *e, const char *key_descrip);
246 STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
247         const char *pass, ENGINE *e, const char *cert_descrip);
248 X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
249 #ifndef OPENSSL_NO_ENGINE
250 ENGINE *setup_engine(BIO *err, const char *engine, int debug);
251 #endif
252
253 #ifndef OPENSSL_NO_OCSP
254 OCSP_RESPONSE *process_responder(BIO *err, OCSP_REQUEST *req,
255                         char *host, char *path, char *port, int use_ssl,
256                         int req_timeout);
257 #endif
258
259 int load_config(BIO *err, CONF *cnf);
260 char *make_config_name(void);
261
262 /* Functions defined in ca.c and also used in ocsp.c */
263 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
264                         ASN1_GENERALIZEDTIME **pinvtm, const char *str);
265
266 #define DB_type         0
267 #define DB_exp_date     1
268 #define DB_rev_date     2
269 #define DB_serial       3       /* index - unique */
270 #define DB_file         4       
271 #define DB_name         5       /* index - unique when active and not disabled */
272 #define DB_NUMBER       6
273
274 #define DB_TYPE_REV     'R'
275 #define DB_TYPE_EXP     'E'
276 #define DB_TYPE_VAL     'V'
277
278 typedef struct db_attr_st
279         {
280         int unique_subject;
281         } DB_ATTR;
282 typedef struct ca_db_st
283         {
284         DB_ATTR attributes;
285         TXT_DB *db;
286         } CA_DB;
287
288 BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
289 int save_serial(char *serialfile, char *suffix, BIGNUM *serial, ASN1_INTEGER **retai);
290 int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
291 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
292 CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
293 int index_index(CA_DB *db);
294 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
295 int rotate_index(const char *dbfile, const char *new_suffix, const char *old_suffix);
296 void free_index(CA_DB *db);
297 #define index_name_cmp_noconst(a, b) \
298         index_name_cmp((const CSTRING *)CHECKED_PTR_OF(STRING, a), \
299         (const CSTRING *)CHECKED_PTR_OF(STRING, b))
300 int index_name_cmp(const CSTRING *a, const CSTRING *b);
301 int parse_yesno(const char *str, int def);
302
303 X509_NAME *parse_name(char *str, long chtype, int multirdn);
304 int args_verify(char ***pargs, int *pargc,
305                         int *badarg, BIO *err, X509_VERIFY_PARAM **pm);
306 void policies_print(BIO *out, X509_STORE_CTX *ctx);
307 int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
308 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, char *value);
309 int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx,
310                         const char *algname, ENGINE *e, int do_param);
311 #ifdef OPENSSL_EXPERIMENTAL_JPAKE
312 extern char *psk_key;
313 void jpake_client_auth(BIO *out, BIO *conn, const char *secret);
314 void jpake_server_auth(BIO *out, BIO *conn, const char *secret);
315 #endif
316
317 #define FORMAT_UNDEF    0
318 #define FORMAT_ASN1     1
319 #define FORMAT_TEXT     2
320 #define FORMAT_PEM      3
321 #define FORMAT_NETSCAPE 4
322 #define FORMAT_PKCS12   5
323 #define FORMAT_SMIME    6
324 #define FORMAT_ENGINE   7
325 #define FORMAT_IISSGC   8       /* XXX this stupid macro helps us to avoid
326                                  * adding yet another param to load_*key() */
327 #define FORMAT_PEMRSA   9       /* PEM RSAPubicKey format */
328 #define FORMAT_ASN1RSA  10      /* DER RSAPubicKey format */
329 #define FORMAT_MSBLOB   11      /* MS Key blob format */
330 #define FORMAT_PVK      12      /* MS PVK file format */
331
332 #define EXT_COPY_NONE   0
333 #define EXT_COPY_ADD    1
334 #define EXT_COPY_ALL    2
335
336 #define NETSCAPE_CERT_HDR       "certificate"
337
338 #define APP_PASS_LEN    1024
339
340 #define SERIAL_RAND_BITS        64
341
342 int app_isdir(const char *);
343 int raw_read_stdin(void *,int);
344 int raw_write_stdout(const void *,int);
345
346 #define TM_START        0
347 #define TM_STOP         1
348 double app_tminterval (int stop,int usertime);
349 #endif