Annotation of src/usr.bin/openssl/apps.h, Revision 1.1
1.1 ! jsing 1: /* $OpenBSD: apps.h,v 1.35 2014/07/11 09:24:44 beck Exp $ */
! 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 <openssl/opensslconf.h>
! 116:
! 117: #include <openssl/bio.h>
! 118: #include <openssl/conf.h>
! 119: #include <openssl/lhash.h>
! 120: #include <openssl/ossl_typ.h>
! 121: #include <openssl/txt_db.h>
! 122: #include <openssl/x509.h>
! 123:
! 124: #ifndef OPENSSL_NO_ENGINE
! 125: #include <openssl/engine.h>
! 126: #endif
! 127:
! 128: #ifndef OPENSSL_NO_OCSP
! 129: #include <openssl/ocsp.h>
! 130: #endif
! 131:
! 132: extern CONF *config;
! 133: extern char *default_config_file;
! 134: extern BIO *bio_err;
! 135:
! 136: typedef struct args_st {
! 137: char **data;
! 138: int count;
! 139: } ARGS;
! 140:
! 141: #define PW_MIN_LENGTH 4
! 142: typedef struct pw_cb_data {
! 143: const void *password;
! 144: const char *prompt_info;
! 145: } PW_CB_DATA;
! 146:
! 147: int password_callback(char *buf, int bufsiz, int verify, void *cb_data);
! 148:
! 149: int setup_ui_method(void);
! 150: void destroy_ui_method(void);
! 151:
! 152: int should_retry(int i);
! 153: int args_from_file(char *file, int *argc, char **argv[]);
! 154: int str2fmt(char *s);
! 155: void program_name(char *in, char *out, int size);
! 156: int chopup_args(ARGS *arg, char *buf, int *argc, char **argv[]);
! 157: #ifdef HEADER_X509_H
! 158: int dump_cert_text(BIO *out, X509 *x);
! 159: void print_name(BIO *out, const char *title, X509_NAME *nm,
! 160: unsigned long lflags);
! 161: #endif
! 162: int set_cert_ex(unsigned long *flags, const char *arg);
! 163: int set_name_ex(unsigned long *flags, const char *arg);
! 164: int set_ext_copy(int *copy_type, const char *arg);
! 165: int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
! 166: int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
! 167: int add_oid_section(BIO *err, CONF *conf);
! 168: X509 *load_cert(BIO *err, const char *file, int format,
! 169: const char *pass, ENGINE *e, const char *cert_descrip);
! 170: EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin,
! 171: const char *pass, ENGINE *e, const char *key_descrip);
! 172: EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin,
! 173: const char *pass, ENGINE *e, const char *key_descrip);
! 174: STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
! 175: const char *pass, ENGINE *e, const char *cert_descrip);
! 176: STACK_OF(X509_CRL) *load_crls(BIO *err, const char *file, int format,
! 177: const char *pass, ENGINE *e, const char *cert_descrip);
! 178: X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
! 179: #ifndef OPENSSL_NO_ENGINE
! 180: ENGINE *setup_engine(BIO *err, const char *engine, int debug);
! 181: #endif
! 182:
! 183: #ifndef OPENSSL_NO_OCSP
! 184: OCSP_RESPONSE *process_responder(BIO *err, OCSP_REQUEST *req,
! 185: char *host, char *path, char *port, int use_ssl,
! 186: STACK_OF(CONF_VALUE) *headers, int req_timeout);
! 187: #endif
! 188:
! 189: int load_config(BIO *err, CONF *cnf);
! 190: char *make_config_name(void);
! 191:
! 192: /* Functions defined in ca.c and also used in ocsp.c */
! 193: int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
! 194: ASN1_GENERALIZEDTIME **pinvtm, const char *str);
! 195:
! 196: #define DB_type 0
! 197: #define DB_exp_date 1
! 198: #define DB_rev_date 2
! 199: #define DB_serial 3 /* index - unique */
! 200: #define DB_file 4
! 201: #define DB_name 5 /* index - unique when active and not disabled */
! 202: #define DB_NUMBER 6
! 203:
! 204: #define DB_TYPE_REV 'R'
! 205: #define DB_TYPE_EXP 'E'
! 206: #define DB_TYPE_VAL 'V'
! 207:
! 208: typedef struct db_attr_st {
! 209: int unique_subject;
! 210: } DB_ATTR;
! 211: typedef struct ca_db_st {
! 212: DB_ATTR attributes;
! 213: TXT_DB *db;
! 214: } CA_DB;
! 215:
! 216: BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
! 217: int save_serial(char *serialfile, char *suffix, BIGNUM *serial,
! 218: ASN1_INTEGER **retai);
! 219: int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
! 220: int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
! 221: CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
! 222: int index_index(CA_DB *db);
! 223: int save_index(const char *dbfile, const char *suffix, CA_DB *db);
! 224: int rotate_index(const char *dbfile, const char *new_suffix,
! 225: const char *old_suffix);
! 226: void free_index(CA_DB *db);
! 227: #define index_name_cmp_noconst(a, b) \
! 228: index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
! 229: (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
! 230: int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
! 231: int parse_yesno(const char *str, int def);
! 232:
! 233: X509_NAME *parse_name(char *str, long chtype, int multirdn);
! 234: int args_verify(char ***pargs, int *pargc, int *badarg, BIO *err,
! 235: X509_VERIFY_PARAM **pm);
! 236: void policies_print(BIO *out, X509_STORE_CTX *ctx);
! 237: int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
! 238: int pkey_ctrl_string(EVP_PKEY_CTX *ctx, char *value);
! 239: int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx, const char *algname, ENGINE *e,
! 240: int do_param);
! 241: int do_X509_sign(BIO *err, X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
! 242: STACK_OF(OPENSSL_STRING) *sigopts);
! 243: int do_X509_REQ_sign(BIO *err, X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
! 244: STACK_OF(OPENSSL_STRING) *sigopts);
! 245: int do_X509_CRL_sign(BIO *err, X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
! 246: STACK_OF(OPENSSL_STRING) *sigopts);
! 247:
! 248: #if !defined(OPENSSL_NO_TLSEXT) && !defined(OPENSSL_NO_NEXTPROTONEG)
! 249: unsigned char *next_protos_parse(unsigned short *outlen, const char *in);
! 250: #endif /* !OPENSSL_NO_TLSEXT && !OPENSSL_NO_NEXTPROTONEG */
! 251:
! 252: #define FORMAT_UNDEF 0
! 253: #define FORMAT_ASN1 1
! 254: #define FORMAT_TEXT 2
! 255: #define FORMAT_PEM 3
! 256: #define FORMAT_NETSCAPE 4
! 257: #define FORMAT_PKCS12 5
! 258: #define FORMAT_SMIME 6
! 259: #define FORMAT_ENGINE 7
! 260: #define FORMAT_IISSGC 8 /* XXX this stupid macro helps us to avoid
! 261: * adding yet another param to load_*key() */
! 262: #define FORMAT_PEMRSA 9 /* PEM RSAPubicKey format */
! 263: #define FORMAT_ASN1RSA 10 /* DER RSAPubicKey format */
! 264: #define FORMAT_MSBLOB 11 /* MS Key blob format */
! 265: #define FORMAT_PVK 12 /* MS PVK file format */
! 266:
! 267: #define EXT_COPY_NONE 0
! 268: #define EXT_COPY_ADD 1
! 269: #define EXT_COPY_ALL 2
! 270:
! 271: #define NETSCAPE_CERT_HDR "certificate"
! 272:
! 273: #define APP_PASS_LEN 1024
! 274:
! 275: #define SERIAL_RAND_BITS 64
! 276:
! 277: int app_isdir(const char *);
! 278:
! 279: #define TM_START 0
! 280: #define TM_STOP 1
! 281: double app_tminterval (int stop, int usertime);
! 282:
! 283: #define OPENSSL_NO_SSL_INTERN
! 284:
! 285: #endif