apps.h revision 296465 
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
130int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
131int app_RAND_write_file(const char *file, BIO *bio_e);
132/*
133 * When `file' is NULL, use defaults. `bio_e' is for error messages.
134 */
135void app_RAND_allow_write_file(void);
136long app_RAND_load_files(char *file); /* `file' is a list of files to read,
137                                       * separated by LIST_SEPARATOR_CHAR
138                                       * (see e_os.h).  The string is
139                                       * destroyed! */
140
141# ifdef OPENSSL_SYS_WIN32
142#  define rename(from,to) WIN32_rename((from),(to))
143int WIN32_rename(const char *oldname, const char *newname);
144# endif
145
146# ifndef MONOLITH
147
148#  define MAIN(a,v)       main(a,v)
149
150#  ifndef NON_MAIN
151CONF *config = NULL;
152BIO *bio_err = NULL;
153int in_FIPS_mode = 0;
154#  else
155extern CONF *config;
156extern BIO *bio_err;
157extern int in_FIPS_mode;
158#  endif
159
160# else
161
162#  define MAIN(a,v)       PROG(a,v)
163extern CONF *config;
164extern char *default_config_file;
165extern BIO *bio_err;
166extern int in_FIPS_mode;
167
168# endif
169
170# ifndef OPENSSL_SYS_NETWARE
171#  include <signal.h>
172# endif
173
174# ifdef SIGPIPE
175#  define do_pipe_sig()   signal(SIGPIPE,SIG_IGN)
176# else
177#  define do_pipe_sig()
178# endif
179
180# if defined(MONOLITH) && !defined(OPENSSL_C)
181#  define apps_startup() \
182                do_pipe_sig()
183#  define apps_shutdown()
184# else
185#  ifndef OPENSSL_NO_ENGINE
186#   if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
187     defined(OPENSSL_SYS_WIN32)
188#    ifdef _O_BINARY
189#     define apps_startup() \
190                        do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
191                        ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
192                        ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
193#    else
194#     define apps_startup() \
195                        do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
196                        ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
197                        ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
198#    endif
199#   else
200#    define apps_startup() \
201                        do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
202                        ERR_load_crypto_strings(); ENGINE_load_builtin_engines(); \
203                        setup_ui_method(); } while(0)
204#   endif
205#   define apps_shutdown() \
206                        do { CONF_modules_unload(1); destroy_ui_method(); \
207                        EVP_cleanup(); ENGINE_cleanup(); \
208                        CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
209                        ERR_free_strings(); } while(0)
210#  else
211#   if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
212     defined(OPENSSL_SYS_WIN32)
213#    ifdef _O_BINARY
214#     define apps_startup() \
215                        do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
216                        ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
217                        setup_ui_method(); } while(0)
218#    else
219#     define apps_startup() \
220                        do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
221                        ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
222                        setup_ui_method(); } while(0)
223#    endif
224#   else
225#    define apps_startup() \
226                        do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
227                        ERR_load_crypto_strings(); \
228                        setup_ui_method(); } while(0)
229#   endif
230#   define apps_shutdown() \
231                        do { CONF_modules_unload(1); destroy_ui_method(); \
232                        EVP_cleanup(); \
233                        CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
234                        ERR_free_strings(); } while(0)
235#  endif
236# endif
237
238# ifdef OPENSSL_SYSNAME_WIN32
239#  define openssl_fdset(a,b) FD_SET((unsigned int)a, b)
240# else
241#  define openssl_fdset(a,b) FD_SET(a, b)
242# endif
243
244typedef struct args_st {
245    char **data;
246    int count;
247} ARGS;
248
249# define PW_MIN_LENGTH 4
250typedef struct pw_cb_data {
251    const void *password;
252    const char *prompt_info;
253} PW_CB_DATA;
254
255int password_callback(char *buf, int bufsiz, int verify, PW_CB_DATA *cb_data);
256
257int setup_ui_method(void);
258void destroy_ui_method(void);
259
260int should_retry(int i);
261int args_from_file(char *file, int *argc, char **argv[]);
262int str2fmt(char *s);
263void program_name(char *in, char *out, int size);
264int chopup_args(ARGS *arg, char *buf, int *argc, char **argv[]);
265# ifdef HEADER_X509_H
266int dump_cert_text(BIO *out, X509 *x);
267void print_name(BIO *out, const char *title, X509_NAME *nm,
268                unsigned long lflags);
269# endif
270int set_cert_ex(unsigned long *flags, const char *arg);
271int set_name_ex(unsigned long *flags, const char *arg);
272int set_ext_copy(int *copy_type, const char *arg);
273int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
274int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
275int add_oid_section(BIO *err, CONF *conf);
276X509 *load_cert(BIO *err, const char *file, int format,
277                const char *pass, ENGINE *e, const char *cert_descrip);
278EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin,
279                   const char *pass, ENGINE *e, const char *key_descrip);
280EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin,
281                      const char *pass, ENGINE *e, const char *key_descrip);
282STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
283                           const char *pass, ENGINE *e,
284                           const char *cert_descrip);
285X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
286# ifndef OPENSSL_NO_ENGINE
287ENGINE *setup_engine(BIO *err, const char *engine, int debug);
288# endif
289
290# ifndef OPENSSL_NO_OCSP
291OCSP_RESPONSE *process_responder(BIO *err, OCSP_REQUEST *req,
292                                 char *host, char *path, char *port,
293                                 int use_ssl, int req_timeout);
294# endif
295
296int load_config(BIO *err, CONF *cnf);
297char *make_config_name(void);
298
299/* Functions defined in ca.c and also used in ocsp.c */
300int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
301                   ASN1_GENERALIZEDTIME **pinvtm, const char *str);
302
303# define DB_type         0
304# define DB_exp_date     1
305# define DB_rev_date     2
306# define DB_serial       3      /* index - unique */
307# define DB_file         4
308# define DB_name         5      /* index - unique when active and not
309                                 * disabled */
310# define DB_NUMBER       6
311
312# define DB_TYPE_REV     'R'
313# define DB_TYPE_EXP     'E'
314# define DB_TYPE_VAL     'V'
315
316typedef struct db_attr_st {
317    int unique_subject;
318} DB_ATTR;
319typedef struct ca_db_st {
320    DB_ATTR attributes;
321    TXT_DB *db;
322} CA_DB;
323
324BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
325int save_serial(char *serialfile, char *suffix, BIGNUM *serial,
326                ASN1_INTEGER **retai);
327int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
328int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
329CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
330int index_index(CA_DB *db);
331int save_index(const char *dbfile, const char *suffix, CA_DB *db);
332int rotate_index(const char *dbfile, const char *new_suffix,
333                 const char *old_suffix);
334void free_index(CA_DB *db);
335int index_name_cmp(const char **a, const char **b);
336int parse_yesno(const char *str, int def);
337
338X509_NAME *parse_name(char *str, long chtype, int multirdn);
339int args_verify(char ***pargs, int *pargc,
340                int *badarg, BIO *err, X509_VERIFY_PARAM **pm);
341void policies_print(BIO *out, X509_STORE_CTX *ctx);
342# ifndef OPENSSL_NO_JPAKE
343void jpake_client_auth(BIO *out, BIO *conn, const char *secret);
344void jpake_server_auth(BIO *out, BIO *conn, const char *secret);
345# endif
346
347# define FORMAT_UNDEF    0
348# define FORMAT_ASN1     1
349# define FORMAT_TEXT     2
350# define FORMAT_PEM      3
351# define FORMAT_NETSCAPE 4
352# define FORMAT_PKCS12   5
353# define FORMAT_SMIME    6
354# define FORMAT_ENGINE   7
355# define FORMAT_IISSGC   8      /* XXX this stupid macro helps us to avoid
356                                 * adding yet another param to load_*key() */
357
358# define EXT_COPY_NONE   0
359# define EXT_COPY_ADD    1
360# define EXT_COPY_ALL    2
361
362# define NETSCAPE_CERT_HDR       "certificate"
363
364# define APP_PASS_LEN    1024
365
366# define SERIAL_RAND_BITS        64
367
368#endif
369