1 /* $OpenBSD: apps.h,v 1.37 2024/05/21 05:00:48 jsg 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 #include <openssl/ui.h> 124 125 #ifndef OPENSSL_NO_OCSP 126 #include <openssl/ocsp.h> 127 #endif 128 129 #include <unistd.h> 130 131 extern CONF *config; 132 extern char *default_config_file; 133 extern BIO *bio_err; 134 135 #define PW_MIN_LENGTH 4 136 typedef struct pw_cb_data { 137 const void *password; 138 const char *prompt_info; 139 } PW_CB_DATA; 140 141 int password_callback(char *buf, int bufsiz, int verify, void *cb_data); 142 143 int setup_ui(void); 144 void destroy_ui(void); 145 146 extern UI_METHOD *ui_method; 147 int ui_open(UI *ui); 148 int ui_read(UI *ui, UI_STRING *uis); 149 int ui_write(UI *ui, UI_STRING *uis); 150 int ui_close(UI *ui); 151 152 int str2fmt(char *s); 153 void program_name(char *in, char *out, int size); 154 #ifdef HEADER_X509_H 155 int dump_cert_text(BIO *out, X509 *x); 156 void print_name(BIO *out, const char *title, X509_NAME *nm, 157 unsigned long lflags); 158 #endif 159 int set_cert_ex(unsigned long *flags, const char *arg); 160 int set_name_ex(unsigned long *flags, const char *arg); 161 int set_ext_copy(int *copy_type, const char *arg); 162 int copy_extensions(X509 *x, X509_REQ *req, int copy_type); 163 int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2); 164 int add_oid_section(BIO *err, CONF *conf); 165 X509 *load_cert(BIO *err, const char *file, int format, 166 const char *pass, const char *cert_descrip); 167 EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin, 168 const char *pass, const char *key_descrip); 169 EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin, 170 const char *pass, const char *key_descrip); 171 STACK_OF(X509) *load_certs(BIO *err, const char *file, int format, 172 const char *pass, const char *cert_descrip); 173 STACK_OF(X509_CRL) *load_crls(BIO *err, const char *file, int format, 174 const char *pass, const char *cert_descrip); 175 X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath); 176 177 #ifndef OPENSSL_NO_OCSP 178 OCSP_RESPONSE *process_responder(BIO *err, OCSP_REQUEST *req, 179 char *host, char *path, char *port, int use_ssl, 180 STACK_OF(CONF_VALUE) *headers, int req_timeout); 181 #endif 182 183 int load_config(BIO *err, CONF *cnf); 184 char *make_config_name(void); 185 186 /* Functions defined in ca.c and also used in ocsp.c */ 187 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold, 188 ASN1_GENERALIZEDTIME **pinvtm, const char *str); 189 190 #define DB_type 0 191 #define DB_exp_date 1 192 #define DB_rev_date 2 193 #define DB_serial 3 /* index - unique */ 194 #define DB_file 4 195 #define DB_name 5 /* index - unique when active and not disabled */ 196 #define DB_NUMBER 6 197 198 #define DB_TYPE_REV 'R' 199 #define DB_TYPE_EXP 'E' 200 #define DB_TYPE_VAL 'V' 201 #define DB_TYPE_SUSP 'S' 202 203 typedef struct db_attr_st { 204 int unique_subject; 205 } DB_ATTR; 206 typedef struct ca_db_st { 207 DB_ATTR attributes; 208 TXT_DB *db; 209 } CA_DB; 210 211 BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai); 212 int save_serial(char *serialfile, char *suffix, BIGNUM *serial, 213 ASN1_INTEGER **retai); 214 int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix); 215 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai); 216 CA_DB *load_index(char *dbfile, DB_ATTR *dbattr); 217 int index_index(CA_DB *db); 218 int save_index(const char *dbfile, const char *suffix, CA_DB *db); 219 int rotate_index(const char *dbfile, const char *new_suffix, 220 const char *old_suffix); 221 void free_index(CA_DB *db); 222 #define index_name_cmp_noconst(a, b) \ 223 index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \ 224 (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b)) 225 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b); 226 int parse_yesno(const char *str, int def); 227 228 X509_NAME *parse_name(char *str, long chtype, int multirdn); 229 int args_verify(char ***pargs, int *pargc, int *badarg, BIO *err, 230 X509_VERIFY_PARAM **pm); 231 int bio_to_mem(unsigned char **out, int maxlen, BIO *in); 232 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, char *value); 233 int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx, const char *algname, 234 int do_param); 235 int do_X509_sign(BIO *err, X509 *x, EVP_PKEY *pkey, const EVP_MD *md, 236 STACK_OF(OPENSSL_STRING) *sigopts); 237 int do_X509_REQ_sign(BIO *err, X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md, 238 STACK_OF(OPENSSL_STRING) *sigopts); 239 int do_X509_CRL_sign(BIO *err, X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md, 240 STACK_OF(OPENSSL_STRING) *sigopts); 241 242 unsigned char *next_protos_parse(unsigned short *outlen, const char *in); 243 244 #define FORMAT_UNDEF 0 245 #define FORMAT_ASN1 1 246 #define FORMAT_TEXT 2 247 #define FORMAT_PEM 3 248 249 #define FORMAT_PKCS12 5 250 #define FORMAT_SMIME 6 251 252 #define FORMAT_PEMRSA 9 /* PEM RSAPublicKey format */ 253 #define FORMAT_ASN1RSA 10 /* DER RSAPublicKey format */ 254 #define FORMAT_MSBLOB 11 /* MS Key blob format */ 255 #define FORMAT_PVK 12 /* MS PVK file format */ 256 257 #define EXT_COPY_NONE 0 258 #define EXT_COPY_ADD 1 259 #define EXT_COPY_ALL 2 260 261 #define APP_PASS_LEN 1024 262 263 #define SERIAL_RAND_BITS 64 264 265 int app_isdir(const char *); 266 267 #define TM_RESET 0 268 #define TM_GET 1 269 double app_timer_real(int); 270 double app_timer_user(int); 271 272 #define OPENSSL_NO_SSL_INTERN 273 274 struct option { 275 const char *name; 276 const char *argname; 277 const char *desc; 278 enum { 279 OPTION_ARG, 280 OPTION_ARGV_FUNC, 281 OPTION_ARG_FORMAT, 282 OPTION_ARG_FUNC, 283 OPTION_ARG_INT, 284 OPTION_ARG_LONG, 285 OPTION_ARG_TIME, 286 OPTION_DISCARD, 287 OPTION_FUNC, 288 OPTION_FLAG, 289 OPTION_FLAG_ORD, 290 OPTION_VALUE, 291 OPTION_VALUE_AND, 292 OPTION_VALUE_OR, 293 OPTION_UL_VALUE_OR, 294 OPTION_ORDER, 295 } type; 296 union { 297 char **arg; 298 int (*argfunc)(char *arg); 299 int (*argvfunc)(int argc, char **argv, int *argsused); 300 int *flag; 301 int (*func)(void); 302 long *lvalue; 303 int *value; 304 unsigned long *ulvalue; 305 time_t *tvalue; 306 int *order; 307 } opt; 308 const int value; 309 const unsigned long ulvalue; 310 int *order; 311 }; 312 313 void options_usage(const struct option *opts); 314 int options_parse(int argc, char **argv, const struct option *opts, 315 char **unnamed, int *argsused); 316 317 void show_cipher(const OBJ_NAME *name, void *arg); 318 319 int pkey_check(BIO *out, EVP_PKEY *pkey, int (check_fn)(EVP_PKEY_CTX *), 320 const char *desc); 321 #endif 322