]> git.ipfire.org Git - thirdparty/openssl.git/blame - apps/apps.h
Eliminate crypto/tmdiff.[ch].
[thirdparty/openssl.git] / apps / apps.h
CommitLineData
d02b48c6 1/* apps/apps.h */
58964a49 2/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6
RE
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 */
a661b653
BM
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 */
d02b48c6
RE
111
112#ifndef HEADER_APPS_H
113#define HEADER_APPS_H
114
41d2a336 115#include "e_os.h"
d02b48c6 116
ec577822 117#include <openssl/bio.h>
954ef7ef 118#include <openssl/x509.h>
431b0cce 119#include <openssl/lhash.h>
095aadc4 120#include <openssl/conf.h>
ee306a13 121#include <openssl/txt_db.h>
0b13e9f0 122#ifndef OPENSSL_NO_ENGINE
032c49b8 123#include <openssl/engine.h>
0b13e9f0 124#endif
2aa9043a 125#include <openssl/ossl_typ.h>
d02b48c6 126
a31011e8
BM
127int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
128int app_RAND_write_file(const char *file, BIO *bio_e);
129/* When `file' is NULL, use defaults.
130 * `bio_e' is for error messages. */
131void app_RAND_allow_write_file(void);
132long 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
d02b48c6
RE
137#ifndef MONOLITH
138
139#define MAIN(a,v) main(a,v)
140
141#ifndef NON_MAIN
0e2cc42c 142CONF *config=NULL;
d02b48c6
RE
143BIO *bio_err=NULL;
144#else
0e2cc42c 145extern CONF *config;
d02b48c6
RE
146extern BIO *bio_err;
147#endif
148
149#else
150
151#define MAIN(a,v) PROG(a,v)
b7a26e6d 152extern CONF *config;
d02b48c6
RE
153extern char *default_config_file;
154extern BIO *bio_err;
155
156#endif
157
4d8743f4 158#ifndef OPENSSL_SYS_NETWARE
d02b48c6 159#include <signal.h>
4d8743f4 160#endif
d02b48c6
RE
161
162#ifdef SIGPIPE
163#define do_pipe_sig() signal(SIGPIPE,SIG_IGN)
164#else
165#define do_pipe_sig()
166#endif
167
e290c7d4 168#if defined(MONOLITH) && !defined(OPENSSL_C)
870d9861
RL
169# define apps_startup() \
170 do_pipe_sig()
171# define apps_shutdown()
d02b48c6 172#else
0b13e9f0 173# ifndef OPENSSL_NO_ENGINE
53261831
AP
174# define apps_startup() \
175 do { do_pipe_sig(); CRYPTO_malloc_init(); \
0b13e9f0
RL
176 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
177 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
0b13e9f0
RL
178# define apps_shutdown() \
179 do { CONF_modules_unload(1); destroy_ui_method(); \
180 EVP_cleanup(); ENGINE_cleanup(); \
181 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
182 ERR_free_strings(); } while(0)
d02b48c6 183# else
53261831
AP
184# define apps_startup() \
185 do { do_pipe_sig(); CRYPTO_malloc_init(); \
0b13e9f0
RL
186 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
187 setup_ui_method(); } while(0)
0b13e9f0
RL
188# define apps_shutdown() \
189 do { CONF_modules_unload(1); destroy_ui_method(); \
190 EVP_cleanup(); \
191 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \
192 ERR_free_strings(); } while(0)
d02b48c6
RE
193# endif
194#endif
195
196typedef struct args_st
b1c4fe36
BM
197 {
198 char **data;
d02b48c6 199 int count;
b1c4fe36 200 } ARGS;
d02b48c6 201
30b4c272
RL
202#define PW_MIN_LENGTH 4
203typedef struct pw_cb_data
204 {
205 const void *password;
206 const char *prompt_info;
207 } PW_CB_DATA;
208
209int password_callback(char *buf, int bufsiz, int verify,
210 PW_CB_DATA *cb_data);
211
40889b9c
LJ
212int setup_ui_method(void);
213void destroy_ui_method(void);
2fe5adc3 214
d02b48c6
RE
215int should_retry(int i);
216int args_from_file(char *file, int *argc, char **argv[]);
217int str2fmt(char *s);
218void program_name(char *in,char *out,int size);
219int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]);
954ef7ef
DSH
220#ifdef HEADER_X509_H
221int dump_cert_text(BIO *out, X509 *x);
7d727231 222void print_name(BIO *out, const char *title, X509_NAME *nm, unsigned long lflags);
954ef7ef 223#endif
8ca533e3 224int set_cert_ex(unsigned long *flags, const char *arg);
a657546f 225int set_name_ex(unsigned long *flags, const char *arg);
791bd0cd
DSH
226int set_ext_copy(int *copy_type, const char *arg);
227int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
a3fe382e 228int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
b7a26e6d 229int add_oid_section(BIO *err, CONF *conf);
30b4c272
RL
230X509 *load_cert(BIO *err, const char *file, int format,
231 const char *pass, ENGINE *e, const char *cert_descrip);
da9b9724 232EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin,
30b4c272 233 const char *pass, ENGINE *e, const char *key_descrip);
da9b9724 234EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin,
30b4c272
RL
235 const char *pass, ENGINE *e, const char *key_descrip);
236STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
237 const char *pass, ENGINE *e, const char *cert_descrip);
81f169e9 238X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
0b13e9f0 239#ifndef OPENSSL_NO_ENGINE
531d630b 240ENGINE *setup_engine(BIO *err, const char *engine, int debug);
0b13e9f0 241#endif
90ae4673 242
3647bee2 243int load_config(BIO *err, CONF *cnf);
54a656ef 244char *make_config_name(void);
3647bee2 245
ee306a13
DSH
246/* Functions defined in ca.c and also used in ocsp.c */
247int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
7d727231 248 ASN1_GENERALIZEDTIME **pinvtm, const char *str);
f85b68cd
RL
249
250#define DB_type 0
251#define DB_exp_date 1
252#define DB_rev_date 2
253#define DB_serial 3 /* index - unique */
254#define DB_file 4
255#define DB_name 5 /* index - unique when active and not disabled */
256#define DB_NUMBER 6
257
258#define DB_TYPE_REV 'R'
259#define DB_TYPE_EXP 'E'
260#define DB_TYPE_VAL 'V'
261
262typedef struct db_attr_st
263 {
264 int unique_subject;
265 } DB_ATTR;
266typedef struct ca_db_st
267 {
268 DB_ATTR attributes;
269 TXT_DB *db;
270 } CA_DB;
271
272BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
4c771796
RL
273int save_serial(char *serialfile, char *suffix, BIGNUM *serial, ASN1_INTEGER **retai);
274int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
64674bcc 275int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
f85b68cd
RL
276CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
277int index_index(CA_DB *db);
7d727231
NL
278int save_index(const char *dbfile, const char *suffix, CA_DB *db);
279int rotate_index(const char *dbfile, const char *new_suffix, const char *old_suffix);
f85b68cd
RL
280void free_index(CA_DB *db);
281int index_name_cmp(const char **a, const char **b);
ff990440 282int parse_yesno(const char *str, int def);
ee306a13 283
d45a0984 284X509_NAME *parse_name(char *str, long chtype, int multirdn);
c431798e
DSH
285int args_verify(char ***pargs, int *pargc,
286 int *badarg, BIO *err, X509_VERIFY_PARAM **pm);
287void policies_print(BIO *out, X509_STORE_CTX *ctx);
eee6c81a 288
d02b48c6
RE
289#define FORMAT_UNDEF 0
290#define FORMAT_ASN1 1
291#define FORMAT_TEXT 2
292#define FORMAT_PEM 3
293#define FORMAT_NETSCAPE 4
90ae4673 294#define FORMAT_PKCS12 5
094fe66d 295#define FORMAT_SMIME 6
5270e702 296#define FORMAT_ENGINE 7
80bb905d
RL
297#define FORMAT_IISSGC 8 /* XXX this stupid macro helps us to avoid
298 * adding yet another param to load_*key() */
eea374fd
DSH
299#define FORMAT_PEMRSA 9 /* PEM RSAPubicKey format */
300#define FORMAT_ASN1RSA 10 /* DER RSAPubicKey format */
a0156a92
DSH
301#define FORMAT_MSBLOB 11 /* MS Key blob format */
302#define FORMAT_PVK 12 /* MS PVK file format */
90ae4673 303
791bd0cd
DSH
304#define EXT_COPY_NONE 0
305#define EXT_COPY_ADD 1
306#define EXT_COPY_ALL 2
307
90ae4673 308#define NETSCAPE_CERT_HDR "certificate"
d02b48c6 309
a3fe382e
DSH
310#define APP_PASS_LEN 1024
311
64674bcc
DSH
312#define SERIAL_RAND_BITS 64
313
ffa10187
AP
314int app_isdir(const char *);
315int raw_read_stdin(void *,int);
316int raw_write_stdout(const void *,int);
d02b48c6 317#endif