2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
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.
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).
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.
23 * Redistribution and use in source and binary forms, with or without
24 * modification, are permitted provided that the following conditions
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)"
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
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.]
58 /* ====================================================================
59 * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
61 * Redistribution and use in source and binary forms, with or without
62 * modification, are permitted provided that the following conditions
65 * 1. Redistributions of source code must retain the above copyright
66 * notice, this list of conditions and the following disclaimer.
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
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/)"
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.
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.
87 * 6. Redistributions of any form whatsoever must retain the following
89 * "This product includes software developed by the OpenSSL Project
90 * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
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 * ====================================================================
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).
112 #ifndef HEADER_APPS_H
113 #define HEADER_APPS_H
121 #include <openssl/bio.h>
122 #include <openssl/x509.h>
123 #include <openssl/lhash.h>
124 #include <openssl/conf.h>
125 #include <openssl/txt_db.h>
126 #ifndef OPENSSL_NO_ENGINE
127 #include <openssl/engine.h>
129 #include <openssl/ossl_typ.h>
131 int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
132 int app_RAND_write_file(const char *file, BIO *bio_e);
133 /* When `file' is NULL, use defaults.
134 * `bio_e' is for error messages. */
135 void app_RAND_allow_write_file(void);
136 long 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
141 #ifdef OPENSSL_SYS_WIN32
142 #define rename(from,to) WIN32_rename((from),(to))
143 int WIN32_rename(const char *oldname,const char *newname);
148 #define MAIN(a,v) main(a,v)
160 #define MAIN(a,v) PROG(a,v)
162 extern char *default_config_file;
168 #ifndef OPENSSL_SYS_NETWARE
175 #define do_pipe_sig() signal(SIGPIPE,SIG_IGN)
177 #define do_pipe_sig()
180 #define do_pipe_sig()
182 #if defined(MONOLITH) && !defined(OPENSSL_C)
183 # define apps_startup() \
185 # define apps_shutdown()
187 # ifndef OPENSSL_NO_ENGINE
188 # if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
189 defined(OPENSSL_SYS_WIN32)
191 # define apps_startup() \
192 do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
193 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
194 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
196 # define apps_startup() \
197 do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
198 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
199 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
202 # define apps_startup() \
203 do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
204 ERR_load_crypto_strings(); ENGINE_load_builtin_engines(); \
205 setup_ui_method(); } while(0)
207 # define apps_shutdown() \
208 do { CONF_modules_unload(1); destroy_ui_method(); \
209 EVP_cleanup(); ENGINE_cleanup(); \
210 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
211 ERR_free_strings(); } while(0)
213 # if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
214 defined(OPENSSL_SYS_WIN32)
216 # define apps_startup() \
217 do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
218 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
219 setup_ui_method(); } while(0)
221 # define apps_startup() \
222 do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
223 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
224 setup_ui_method(); } while(0)
227 # define apps_startup() \
228 do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
229 ERR_load_crypto_strings(); \
230 setup_ui_method(); } while(0)
232 # define apps_shutdown() \
233 do { CONF_modules_unload(1); destroy_ui_method(); \
235 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
236 ERR_free_strings(); } while(0)
240 typedef struct args_st
246 #define PW_MIN_LENGTH 4
247 typedef struct pw_cb_data
249 const void *password;
250 const char *prompt_info;
253 int password_callback(char *buf, int bufsiz, int verify,
254 PW_CB_DATA *cb_data);
256 int setup_ui_method(void);
257 void destroy_ui_method(void);
259 int should_retry(int i);
260 int args_from_file(char *file, int *argc, char **argv[]);
261 int str2fmt(char *s);
262 void program_name(char *in,char *out,int size);
263 int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]);
265 int dump_cert_text(BIO *out, X509 *x);
266 void print_name(BIO *out, const char *title, X509_NAME *nm, unsigned long lflags);
268 int set_cert_ex(unsigned long *flags, const char *arg);
269 int set_name_ex(unsigned long *flags, const char *arg);
270 int set_ext_copy(int *copy_type, const char *arg);
271 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
272 int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
273 int add_oid_section(BIO *err, CONF *conf);
274 X509 *load_cert(BIO *err, const char *file, int format,
275 const char *pass, ENGINE *e, const char *cert_descrip);
276 EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin,
277 const char *pass, ENGINE *e, const char *key_descrip);
278 EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin,
279 const char *pass, ENGINE *e, const char *key_descrip);
280 STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
281 const char *pass, ENGINE *e, const char *cert_descrip);
282 X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
283 #ifndef OPENSSL_NO_ENGINE
284 ENGINE *setup_engine(BIO *err, const char *engine, int debug);
287 int load_config(BIO *err, CONF *cnf);
288 char *make_config_name(void);
290 /* Functions defined in ca.c and also used in ocsp.c */
291 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
292 ASN1_GENERALIZEDTIME **pinvtm, const char *str);
295 #define DB_exp_date 1
296 #define DB_rev_date 2
297 #define DB_serial 3 /* index - unique */
299 #define DB_name 5 /* index - unique when active and not disabled */
302 #define DB_TYPE_REV 'R'
303 #define DB_TYPE_EXP 'E'
304 #define DB_TYPE_VAL 'V'
306 typedef struct db_attr_st
310 typedef struct ca_db_st
316 BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
317 int save_serial(char *serialfile, char *suffix, BIGNUM *serial, ASN1_INTEGER **retai);
318 int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
319 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
320 CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
321 int index_index(CA_DB *db);
322 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
323 int rotate_index(const char *dbfile, const char *new_suffix, const char *old_suffix);
324 void free_index(CA_DB *db);
325 int index_name_cmp(const char **a, const char **b);
326 int parse_yesno(const char *str, int def);
328 X509_NAME *parse_name(char *str, long chtype, int multirdn);
329 int args_verify(char ***pargs, int *pargc,
330 int *badarg, BIO *err, X509_VERIFY_PARAM **pm);
331 void policies_print(BIO *out, X509_STORE_CTX *ctx);
333 #define FORMAT_UNDEF 0
334 #define FORMAT_ASN1 1
335 #define FORMAT_TEXT 2
337 #define FORMAT_NETSCAPE 4
338 #define FORMAT_PKCS12 5
339 #define FORMAT_SMIME 6
340 #define FORMAT_ENGINE 7
341 #define FORMAT_IISSGC 8 /* XXX this stupid macro helps us to avoid
342 * adding yet another param to load_*key() */
344 #define EXT_COPY_NONE 0
345 #define EXT_COPY_ADD 1
346 #define EXT_COPY_ALL 2
348 #define NETSCAPE_CERT_HDR "certificate"
350 #define APP_PASS_LEN 1024
352 #define SERIAL_RAND_BITS 64