apps.h revision 160815
119370Spst/* apps/apps.h */ 298944Sobrien/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com) 319370Spst * All rights reserved. 498944Sobrien * 519370Spst * This package is an SSL implementation written 698944Sobrien * by Eric Young (eay@cryptsoft.com). 798944Sobrien * The implementation was written so as to conform with Netscapes SSL. 898944Sobrien * 998944Sobrien * This library is free for commercial and non-commercial use as long as 1019370Spst * the following conditions are aheared to. The following conditions 1198944Sobrien * apply to all code found in this distribution, be it the RC4, RSA, 1298944Sobrien * lhash, DES, etc., code; not just the SSL code. The SSL documentation 1398944Sobrien * included with this distribution is covered by the same copyright terms 1498944Sobrien * except that the holder is Tim Hudson (tjh@cryptsoft.com). 1519370Spst * 1698944Sobrien * Copyright remains Eric Young's, and as such any Copyright notices in 1798944Sobrien * the code are not to be removed. 1898944Sobrien * If this package is used in a product, Eric Young should be given attribution 1998944Sobrien * as the author of the parts of the library used. 2019370Spst * This can be in the form of a textual message at program startup or 2198944Sobrien * in documentation (online or textual) provided with the package. 2219370Spst * 2398944Sobrien * Redistribution and use in source and binary forms, with or without 2419370Spst * modification, are permitted provided that the following conditions 2598944Sobrien * are met: 2698944Sobrien * 1. Redistributions of source code must retain the copyright 2798944Sobrien * notice, this list of conditions and the following disclaimer. 2819370Spst * 2. Redistributions in binary form must reproduce the above copyright 2998944Sobrien * notice, this list of conditions and the following disclaimer in the 3098944Sobrien * documentation and/or other materials provided with the distribution. 3198944Sobrien * 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#include <openssl/ossl_typ.h> 126 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 137#ifdef OPENSSL_SYS_WIN32 138#define rename(from,to) WIN32_rename((from),(to)) 139int WIN32_rename(const char *oldname,const char *newname); 140#endif 141 142#ifndef MONOLITH 143 144#define MAIN(a,v) main(a,v) 145 146#ifndef NON_MAIN 147CONF *config=NULL; 148BIO *bio_err=NULL; 149#else 150extern CONF *config; 151extern BIO *bio_err; 152#endif 153 154#else 155 156#define MAIN(a,v) PROG(a,v) 157extern CONF *config; 158extern char *default_config_file; 159extern BIO *bio_err; 160 161#endif 162 163#ifndef OPENSSL_SYS_NETWARE 164#include <signal.h> 165#endif 166 167#ifdef SIGPIPE 168#define do_pipe_sig() signal(SIGPIPE,SIG_IGN) 169#else 170#define do_pipe_sig() 171#endif 172 173#if defined(MONOLITH) && !defined(OPENSSL_C) 174# define apps_startup() \ 175 do_pipe_sig() 176# define apps_shutdown() 177#else 178# ifndef OPENSSL_NO_ENGINE 179# if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \ 180 defined(OPENSSL_SYS_WIN32) 181# ifdef _O_BINARY 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# else 187# define apps_startup() \ 188 do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \ 189 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \ 190 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0) 191# endif 192# else 193# define apps_startup() \ 194 do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \ 195 ERR_load_crypto_strings(); ENGINE_load_builtin_engines(); \ 196 setup_ui_method(); } while(0) 197# endif 198# define apps_shutdown() \ 199 do { CONF_modules_unload(1); destroy_ui_method(); \ 200 EVP_cleanup(); ENGINE_cleanup(); \ 201 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \ 202 ERR_free_strings(); } while(0) 203# else 204# if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \ 205 defined(OPENSSL_SYS_WIN32) 206# ifdef _O_BINARY 207# define apps_startup() \ 208 do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \ 209 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \ 210 setup_ui_method(); } while(0) 211# else 212# define apps_startup() \ 213 do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \ 214 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \ 215 setup_ui_method(); } while(0) 216# endif 217# else 218# define apps_startup() \ 219 do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \ 220 ERR_load_crypto_strings(); \ 221 setup_ui_method(); } while(0) 222# endif 223# define apps_shutdown() \ 224 do { CONF_modules_unload(1); destroy_ui_method(); \ 225 EVP_cleanup(); \ 226 CRYPTO_cleanup_all_ex_data(); ERR_remove_state(0); \ 227 ERR_free_strings(); } while(0) 228# endif 229#endif 230 231typedef struct args_st 232 { 233 char **data; 234 int count; 235 } ARGS; 236 237#define PW_MIN_LENGTH 4 238typedef struct pw_cb_data 239 { 240 const void *password; 241 const char *prompt_info; 242 } PW_CB_DATA; 243 244int password_callback(char *buf, int bufsiz, int verify, 245 PW_CB_DATA *cb_data); 246 247int setup_ui_method(void); 248void destroy_ui_method(void); 249 250int should_retry(int i); 251int args_from_file(char *file, int *argc, char **argv[]); 252int str2fmt(char *s); 253void program_name(char *in,char *out,int size); 254int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]); 255#ifdef HEADER_X509_H 256int dump_cert_text(BIO *out, X509 *x); 257void print_name(BIO *out, const char *title, X509_NAME *nm, unsigned long lflags); 258#endif 259int set_cert_ex(unsigned long *flags, const char *arg); 260int set_name_ex(unsigned long *flags, const char *arg); 261int set_ext_copy(int *copy_type, const char *arg); 262int copy_extensions(X509 *x, X509_REQ *req, int copy_type); 263int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2); 264int add_oid_section(BIO *err, CONF *conf); 265X509 *load_cert(BIO *err, const char *file, int format, 266 const char *pass, ENGINE *e, const char *cert_descrip); 267EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin, 268 const char *pass, ENGINE *e, const char *key_descrip); 269EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin, 270 const char *pass, ENGINE *e, const char *key_descrip); 271STACK_OF(X509) *load_certs(BIO *err, const char *file, int format, 272 const char *pass, ENGINE *e, const char *cert_descrip); 273X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath); 274#ifndef OPENSSL_NO_ENGINE 275ENGINE *setup_engine(BIO *err, const char *engine, int debug); 276#endif 277 278int load_config(BIO *err, CONF *cnf); 279char *make_config_name(void); 280 281/* Functions defined in ca.c and also used in ocsp.c */ 282int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold, 283 ASN1_GENERALIZEDTIME **pinvtm, const char *str); 284 285#define DB_type 0 286#define DB_exp_date 1 287#define DB_rev_date 2 288#define DB_serial 3 /* index - unique */ 289#define DB_file 4 290#define DB_name 5 /* index - unique when active and not disabled */ 291#define DB_NUMBER 6 292 293#define DB_TYPE_REV 'R' 294#define DB_TYPE_EXP 'E' 295#define DB_TYPE_VAL 'V' 296 297typedef struct db_attr_st 298 { 299 int unique_subject; 300 } DB_ATTR; 301typedef struct ca_db_st 302 { 303 DB_ATTR attributes; 304 TXT_DB *db; 305 } CA_DB; 306 307BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai); 308int save_serial(char *serialfile, char *suffix, BIGNUM *serial, ASN1_INTEGER **retai); 309int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix); 310int rand_serial(BIGNUM *b, ASN1_INTEGER *ai); 311CA_DB *load_index(char *dbfile, DB_ATTR *dbattr); 312int index_index(CA_DB *db); 313int save_index(const char *dbfile, const char *suffix, CA_DB *db); 314int rotate_index(const char *dbfile, const char *new_suffix, const char *old_suffix); 315void free_index(CA_DB *db); 316int index_name_cmp(const char **a, const char **b); 317int parse_yesno(const char *str, int def); 318 319X509_NAME *parse_name(char *str, long chtype, int multirdn); 320int args_verify(char ***pargs, int *pargc, 321 int *badarg, BIO *err, X509_VERIFY_PARAM **pm); 322void policies_print(BIO *out, X509_STORE_CTX *ctx); 323 324#define FORMAT_UNDEF 0 325#define FORMAT_ASN1 1 326#define FORMAT_TEXT 2 327#define FORMAT_PEM 3 328#define FORMAT_NETSCAPE 4 329#define FORMAT_PKCS12 5 330#define FORMAT_SMIME 6 331#define FORMAT_ENGINE 7 332#define FORMAT_IISSGC 8 /* XXX this stupid macro helps us to avoid 333 * adding yet another param to load_*key() */ 334 335#define EXT_COPY_NONE 0 336#define EXT_COPY_ADD 1 337#define EXT_COPY_ALL 2 338 339#define NETSCAPE_CERT_HDR "certificate" 340 341#define APP_PASS_LEN 1024 342 343#define SERIAL_RAND_BITS 64 344 345#endif 346