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/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#ifndef OPENSSL_NO_OCSP 126#include <openssl/ocsp.h> 127#endif 128#include <openssl/ossl_typ.h> 129 130int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn); 131int app_RAND_write_file(const char *file, BIO *bio_e); 132/* When `file' is NULL, use defaults. 133 * `bio_e' is for error messages. */ 134void app_RAND_allow_write_file(void); 135long app_RAND_load_files(char *file); /* `file' is a list of files to read, 136 * separated by LIST_SEPARATOR_CHAR 137 * (see e_os.h). The string is 138 * destroyed! */ 139 140#ifndef MONOLITH 141 142#define MAIN(a,v) main(a,v) 143 144#ifndef NON_MAIN 145CONF *config=NULL; 146BIO *bio_err=NULL; 147#else 148extern CONF *config; 149extern BIO *bio_err; 150#endif 151 152#else 153 154#define MAIN(a,v) PROG(a,v) 155extern CONF *config; 156extern char *default_config_file; 157extern BIO *bio_err; 158 159#endif 160 161#ifndef OPENSSL_SYS_NETWARE 162#include <signal.h> 163#endif 164 165#ifdef SIGPIPE 166#define do_pipe_sig() signal(SIGPIPE,SIG_IGN) 167#else 168#define do_pipe_sig() 169#endif 170 171#ifdef OPENSSL_NO_COMP 172#define zlib_cleanup() 173#else 174#define zlib_cleanup() COMP_zlib_cleanup() 175#endif 176 177#if defined(MONOLITH) && !defined(OPENSSL_C) 178# define apps_startup() \ 179 do_pipe_sig() 180# define apps_shutdown() 181#else 182# ifndef OPENSSL_NO_ENGINE 183# define apps_startup() \ 184 do { do_pipe_sig(); CRYPTO_malloc_init(); \ 185 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \ 186 ENGINE_load_builtin_engines(); setup_ui_method(); } while(0) 187# define apps_shutdown() \ 188 do { CONF_modules_unload(1); destroy_ui_method(); \ 189 OBJ_cleanup(); EVP_cleanup(); ENGINE_cleanup(); \ 190 CRYPTO_cleanup_all_ex_data(); ERR_remove_thread_state(NULL); \ 191 RAND_cleanup(); \ 192 ERR_free_strings(); zlib_cleanup();} while(0) 193# else 194# define apps_startup() \ 195 do { do_pipe_sig(); CRYPTO_malloc_init(); \ 196 ERR_load_crypto_strings(); OpenSSL_add_all_algorithms(); \ 197 setup_ui_method(); } while(0) 198# define apps_shutdown() \ 199 do { CONF_modules_unload(1); destroy_ui_method(); \ 200 OBJ_cleanup(); EVP_cleanup(); \ 201 CRYPTO_cleanup_all_ex_data(); ERR_remove_thread_state(NULL); \ 202 RAND_cleanup(); \ 203 ERR_free_strings(); zlib_cleanup(); } while(0) 204# endif 205#endif 206 207#ifdef OPENSSL_SYSNAME_WIN32 208# define openssl_fdset(a,b) FD_SET((unsigned int)a, b) 209#else 210# define openssl_fdset(a,b) FD_SET(a, b) 211#endif 212 213 214typedef struct args_st 215 { 216 char **data; 217 int count; 218 } ARGS; 219 220#define PW_MIN_LENGTH 4 221typedef struct pw_cb_data 222 { 223 const void *password; 224 const char *prompt_info; 225 } PW_CB_DATA; 226 227int password_callback(char *buf, int bufsiz, int verify, 228 PW_CB_DATA *cb_data); 229 230int setup_ui_method(void); 231void destroy_ui_method(void); 232 233int should_retry(int i); 234int args_from_file(char *file, int *argc, char **argv[]); 235int str2fmt(char *s); 236void program_name(char *in,char *out,int size); 237int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]); 238#ifdef HEADER_X509_H 239int dump_cert_text(BIO *out, X509 *x); 240void print_name(BIO *out, const char *title, X509_NAME *nm, unsigned long lflags); 241#endif 242int set_cert_ex(unsigned long *flags, const char *arg); 243int set_name_ex(unsigned long *flags, const char *arg); 244int set_ext_copy(int *copy_type, const char *arg); 245int copy_extensions(X509 *x, X509_REQ *req, int copy_type); 246int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2); 247int add_oid_section(BIO *err, CONF *conf); 248X509 *load_cert(BIO *err, const char *file, int format, 249 const char *pass, ENGINE *e, const char *cert_descrip); 250EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin, 251 const char *pass, ENGINE *e, const char *key_descrip); 252EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin, 253 const char *pass, ENGINE *e, const char *key_descrip); 254STACK_OF(X509) *load_certs(BIO *err, const char *file, int format, 255 const char *pass, ENGINE *e, const char *cert_descrip); 256STACK_OF(X509_CRL) *load_crls(BIO *err, const char *file, int format, 257 const char *pass, ENGINE *e, const char *cert_descrip); 258X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath); 259#ifndef OPENSSL_NO_ENGINE 260ENGINE *setup_engine(BIO *err, const char *engine, int debug); 261#endif 262 263#ifndef OPENSSL_NO_OCSP 264OCSP_RESPONSE *process_responder(BIO *err, OCSP_REQUEST *req, 265 char *host, char *path, char *port, int use_ssl, 266 STACK_OF(CONF_VALUE) *headers, 267 int req_timeout); 268#endif 269 270int load_config(BIO *err, CONF *cnf); 271char *make_config_name(void); 272 273/* Functions defined in ca.c and also used in ocsp.c */ 274int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold, 275 ASN1_GENERALIZEDTIME **pinvtm, const char *str); 276 277#define DB_type 0 278#define DB_exp_date 1 279#define DB_rev_date 2 280#define DB_serial 3 /* index - unique */ 281#define DB_file 4 282#define DB_name 5 /* index - unique when active and not disabled */ 283#define DB_NUMBER 6 284 285#define DB_TYPE_REV 'R' 286#define DB_TYPE_EXP 'E' 287#define DB_TYPE_VAL 'V' 288 289typedef struct db_attr_st 290 { 291 int unique_subject; 292 } DB_ATTR; 293typedef struct ca_db_st 294 { 295 DB_ATTR attributes; 296 TXT_DB *db; 297 } CA_DB; 298 299BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai); 300int save_serial(char *serialfile, char *suffix, BIGNUM *serial, ASN1_INTEGER **retai); 301int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix); 302int rand_serial(BIGNUM *b, ASN1_INTEGER *ai); 303CA_DB *load_index(char *dbfile, DB_ATTR *dbattr); 304int index_index(CA_DB *db); 305int save_index(const char *dbfile, const char *suffix, CA_DB *db); 306int rotate_index(const char *dbfile, const char *new_suffix, const char *old_suffix); 307void free_index(CA_DB *db); 308#define index_name_cmp_noconst(a, b) \ 309 index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \ 310 (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b)) 311int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b); 312int parse_yesno(const char *str, int def); 313 314X509_NAME *parse_name(char *str, long chtype, int multirdn); 315int args_verify(char ***pargs, int *pargc, 316 int *badarg, BIO *err, X509_VERIFY_PARAM **pm); 317void policies_print(BIO *out, X509_STORE_CTX *ctx); 318int bio_to_mem(unsigned char **out, int maxlen, BIO *in); 319int pkey_ctrl_string(EVP_PKEY_CTX *ctx, char *value); 320int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx, 321 const char *algname, ENGINE *e, int do_param); 322int do_X509_sign(BIO *err, X509 *x, EVP_PKEY *pkey, const EVP_MD *md, 323 STACK_OF(OPENSSL_STRING) *sigopts); 324int do_X509_REQ_sign(BIO *err, X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md, 325 STACK_OF(OPENSSL_STRING) *sigopts); 326int do_X509_CRL_sign(BIO *err, X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md, 327 STACK_OF(OPENSSL_STRING) *sigopts); 328#ifndef OPENSSL_NO_PSK 329extern char *psk_key; 330#endif 331#ifndef OPENSSL_NO_JPAKE 332void jpake_client_auth(BIO *out, BIO *conn, const char *secret); 333void jpake_server_auth(BIO *out, BIO *conn, const char *secret); 334#endif 335 336#if !defined(OPENSSL_NO_TLSEXT) && !defined(OPENSSL_NO_NEXTPROTONEG) 337unsigned char *next_protos_parse(unsigned short *outlen, const char *in); 338#endif /* !OPENSSL_NO_TLSEXT && !OPENSSL_NO_NEXTPROTONEG */ 339 340#define FORMAT_UNDEF 0 341#define FORMAT_ASN1 1 342#define FORMAT_TEXT 2 343#define FORMAT_PEM 3 344#define FORMAT_NETSCAPE 4 345#define FORMAT_PKCS12 5 346#define FORMAT_SMIME 6 347#define FORMAT_ENGINE 7 348#define FORMAT_IISSGC 8 /* XXX this stupid macro helps us to avoid 349 * adding yet another param to load_*key() */ 350#define FORMAT_PEMRSA 9 /* PEM RSAPubicKey format */ 351#define FORMAT_ASN1RSA 10 /* DER RSAPubicKey format */ 352#define FORMAT_MSBLOB 11 /* MS Key blob format */ 353#define FORMAT_PVK 12 /* MS PVK file format */ 354 355#define EXT_COPY_NONE 0 356#define EXT_COPY_ADD 1 357#define EXT_COPY_ALL 2 358 359#define NETSCAPE_CERT_HDR "certificate" 360 361#define APP_PASS_LEN 1024 362 363#define SERIAL_RAND_BITS 64 364 365int app_isdir(const char *); 366int raw_read_stdin(void *,int); 367int raw_write_stdout(const void *,int); 368 369#define TM_START 0 370#define TM_STOP 1 371double app_tminterval (int stop,int usertime); 372 373#define OPENSSL_NO_SSL_INTERN 374 375#endif 376