always include <string.h> (we do this in various other header files,
[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/buffer.h>
118 #include <openssl/bio.h>
119 #include <openssl/crypto.h>
120 #include <openssl/x509.h>
121 #include <openssl/lhash.h>
122 #include <openssl/conf.h>
123 #include <openssl/txt_db.h>
124 #include <openssl/engine.h>
125 #include <openssl/ossl_typ.h>
126
127 int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
128 int app_RAND_write_file(const char *file, BIO *bio_e);
129 /* When `file' is NULL, use defaults.
130  * `bio_e' is for error messages. */
131 void app_RAND_allow_write_file(void);
132 long app_RAND_load_files(char *file); /* `file' is a list of files to read,
133                                        * separated by LIST_SEPARATOR_CHAR
134                                        * (see e_os.h).  The string is
135                                        * destroyed! */
136
137 #ifdef OPENSSL_SYS_WIN32
138 #define rename(from,to) WIN32_rename((from),(to))
139 int WIN32_rename(char *oldname,char *newname);
140 #endif
141
142 #ifndef MONOLITH
143
144 #define MAIN(a,v)       main(a,v)
145
146 #ifndef NON_MAIN
147 BIO *bio_err=NULL;
148 #else
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 #include <signal.h>
162
163 #ifdef SIGPIPE
164 #define do_pipe_sig()   signal(SIGPIPE,SIG_IGN)
165 #else
166 #define do_pipe_sig()
167 #endif
168
169 #if defined(MONOLITH) && !defined(OPENSSL_C)
170 #  define apps_startup() \
171                 do_pipe_sig()
172 #  define apps_shutdown()
173 #else
174 #  if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
175    defined(OPENSSL_SYS_WIN32)
176 #    ifdef _O_BINARY
177 #      define apps_startup() \
178                 do { _fmode=_O_BINARY; 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 #    else
182 #      define apps_startup() \
183                 do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
184                 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
185                 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
186 #    endif
187 #  else
188 #    define apps_startup() \
189                 do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
190                 ERR_load_crypto_strings(); ENGINE_load_builtin_engines(); \
191                 setup_ui_method(); } while(0)
192 #  endif
193 #  define apps_shutdown() \
194                 do { CONF_modules_unload(1); destroy_ui_method(); \
195                 EVP_cleanup(); ENGINE_cleanup(); \
196                 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
197                 ERR_free_strings(); } while(0)
198 #endif
199
200 typedef struct args_st
201         {
202         char **data;
203         int count;
204         } ARGS;
205
206 #define PW_MIN_LENGTH 4
207 typedef struct pw_cb_data
208         {
209         const void *password;
210         const char *prompt_info;
211         } PW_CB_DATA;
212
213 int password_callback(char *buf, int bufsiz, int verify,
214         PW_CB_DATA *cb_data);
215
216 int setup_ui_method(void);
217 void destroy_ui_method(void);
218
219 int should_retry(int i);
220 int args_from_file(char *file, int *argc, char **argv[]);
221 int str2fmt(char *s);
222 void program_name(char *in,char *out,int size);
223 int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]);
224 #ifdef HEADER_X509_H
225 int dump_cert_text(BIO *out, X509 *x);
226 void print_name(BIO *out, char *title, X509_NAME *nm, unsigned long lflags);
227 #endif
228 int set_cert_ex(unsigned long *flags, const char *arg);
229 int set_name_ex(unsigned long *flags, const char *arg);
230 int set_ext_copy(int *copy_type, const char *arg);
231 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
232 int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
233 int add_oid_section(BIO *err, CONF *conf);
234 X509 *load_cert(BIO *err, const char *file, int format,
235         const char *pass, ENGINE *e, const char *cert_descrip);
236 EVP_PKEY *load_key(BIO *err, const char *file, int format,
237         const char *pass, ENGINE *e, const char *key_descrip);
238 EVP_PKEY *load_pubkey(BIO *err, const char *file, int format,
239         const char *pass, ENGINE *e, const char *key_descrip);
240 STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
241         const char *pass, ENGINE *e, const char *cert_descrip);
242 X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
243 ENGINE *setup_engine(BIO *err, const char *engine, int debug);
244
245 int load_config(BIO *err, CONF *cnf);
246
247 /* Functions defined in ca.c and also used in ocsp.c */
248 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
249                         ASN1_GENERALIZEDTIME **pinvtm, char *str);
250 int make_serial_index(TXT_DB *db);
251
252 X509_NAME *do_subject(char *str, long chtype);
253
254 #define FORMAT_UNDEF    0
255 #define FORMAT_ASN1     1
256 #define FORMAT_TEXT     2
257 #define FORMAT_PEM      3
258 #define FORMAT_NETSCAPE 4
259 #define FORMAT_PKCS12   5
260 #define FORMAT_SMIME    6
261 #define FORMAT_ENGINE   7
262 #define FORMAT_IISSGC   8       /* XXX this stupid macro helps us to avoid
263                                  * adding yet another param to load_*key() */
264
265 #define EXT_COPY_NONE   0
266 #define EXT_COPY_ADD    1
267 #define EXT_COPY_ALL    2
268
269 #define NETSCAPE_CERT_HDR       "certificate"
270
271 #define APP_PASS_LEN    1024
272
273 #endif