'make update'
[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 #ifndef HEADER_APPS_H
60 #define HEADER_APPS_H
61
62 #include "e_os.h"
63
64 #include <openssl/buffer.h>
65 #include <openssl/bio.h>
66 #include <openssl/crypto.h>
67 #include <openssl/x509.h>
68 #include <openssl/lhash.h>
69 #include <openssl/conf.h>
70 #include <openssl/txt_db.h>
71 #include <openssl/ossl_typ.h>
72
73 int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
74 int app_RAND_write_file(const char *file, BIO *bio_e);
75 /* When `file' is NULL, use defaults.
76  * `bio_e' is for error messages. */
77 void app_RAND_allow_write_file(void);
78 long app_RAND_load_files(char *file); /* `file' is a list of files to read,
79                                        * separated by LIST_SEPARATOR_CHAR
80                                        * (see e_os.h).  The string is
81                                        * destroyed! */
82
83 #ifdef OPENSSL_NO_STDIO
84 BIO_METHOD *BIO_s_file();
85 #endif
86
87 #ifdef OPENSSL_SYS_WIN32
88 #define rename(from,to) WIN32_rename((from),(to))
89 int WIN32_rename(char *oldname,char *newname);
90 #endif
91
92 #ifndef MONOLITH
93
94 #define MAIN(a,v)       main(a,v)
95
96 #ifndef NON_MAIN
97 BIO *bio_err=NULL;
98 #else
99 extern BIO *bio_err;
100 #endif
101
102 #else
103
104 #define MAIN(a,v)       PROG(a,v)
105 extern CONF *config;
106 extern char *default_config_file;
107 extern BIO *bio_err;
108
109 #endif
110
111 #include <signal.h>
112
113 #ifdef SIGPIPE
114 #define do_pipe_sig()   signal(SIGPIPE,SIG_IGN)
115 #else
116 #define do_pipe_sig()
117 #endif
118
119 #if defined(MONOLITH) && !defined(OPENSSL_C)
120 #  define apps_startup() \
121                 do_pipe_sig()
122 #  define apps_shutdown()
123 #else
124 #  if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
125    defined(OPENSSL_SYS_WIN32)
126 #    ifdef _O_BINARY
127 #      define apps_startup() \
128                 do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
129                 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
130                 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
131 #    else
132 #      define apps_startup() \
133                 do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
134                 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \
135                 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
136 #    endif
137 #  else
138 #    define apps_startup() \
139                 do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
140                 ERR_load_crypto_strings(); ENGINE_load_builtin_engines(); \
141                 setup_ui_method(); } while(0)
142 #  endif
143 #  define apps_shutdown() \
144                 do { destroy_ui_method(); EVP_cleanup(); \
145                 ENGINE_cleanup(); CRYPTO_cleanup_all_ex_data(); \
146                 ERR_remove_state(0); ERR_free_strings(); } while(0)
147 #endif
148
149 typedef struct args_st
150         {
151         char **data;
152         int count;
153         } ARGS;
154
155 #define PW_MIN_LENGTH 4
156 typedef struct pw_cb_data
157         {
158         const void *password;
159         const char *prompt_info;
160         } PW_CB_DATA;
161
162 int password_callback(char *buf, int bufsiz, int verify,
163         PW_CB_DATA *cb_data);
164
165 int setup_ui_method();
166 void destroy_ui_method();
167
168 int should_retry(int i);
169 int args_from_file(char *file, int *argc, char **argv[]);
170 int str2fmt(char *s);
171 void program_name(char *in,char *out,int size);
172 int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]);
173 #ifdef HEADER_X509_H
174 int dump_cert_text(BIO *out, X509 *x);
175 void print_name(BIO *out, char *title, X509_NAME *nm, unsigned long lflags);
176 #endif
177 int set_cert_ex(unsigned long *flags, const char *arg);
178 int set_name_ex(unsigned long *flags, const char *arg);
179 int set_ext_copy(int *copy_type, const char *arg);
180 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
181 int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
182 int add_oid_section(BIO *err, CONF *conf);
183 X509 *load_cert(BIO *err, const char *file, int format,
184         const char *pass, ENGINE *e, const char *cert_descrip);
185 EVP_PKEY *load_key(BIO *err, const char *file, int format,
186         const char *pass, ENGINE *e, const char *key_descrip);
187 EVP_PKEY *load_pubkey(BIO *err, const char *file, int format,
188         const char *pass, ENGINE *e, const char *key_descrip);
189 STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
190         const char *pass, ENGINE *e, const char *cert_descrip);
191 X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
192 ENGINE *setup_engine(BIO *err, const char *engine, int debug);
193
194 /* Functions defined in ca.c and also used in ocsp.c */
195 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
196                         ASN1_GENERALIZEDTIME **pinvtm, char *str);
197 int make_serial_index(TXT_DB *db);
198
199 #define FORMAT_UNDEF    0
200 #define FORMAT_ASN1     1
201 #define FORMAT_TEXT     2
202 #define FORMAT_PEM      3
203 #define FORMAT_NETSCAPE 4
204 #define FORMAT_PKCS12   5
205 #define FORMAT_SMIME    6
206 #define FORMAT_ENGINE   7
207
208 #define EXT_COPY_NONE   0
209 #define EXT_COPY_ADD    1
210 #define EXT_COPY_ALL    2
211
212 #define NETSCAPE_CERT_HDR       "certificate"
213
214 #define APP_PASS_LEN    1024
215
216 #endif