1 /* $OpenBSD: apps.h,v 1.42 2025/01/02 13:11:26 tb 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 <openssl/ssl.h> 130 131 #include <unistd.h> 132 133 /* numbers in us */ 134 #define DGRAM_RCV_TIMEOUT 250000 135 #define DGRAM_SND_TIMEOUT 250000 136 137 extern CONF *config; 138 extern char *default_config_file; 139 extern BIO *bio_err; 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(void); 150 void destroy_ui(void); 151 152 extern UI_METHOD *ui_method; 153 int ui_open(UI *ui); 154 int ui_read(UI *ui, UI_STRING *uis); 155 int ui_write(UI *ui, UI_STRING *uis); 156 int ui_close(UI *ui); 157 158 int str2fmt(char *s); 159 void program_name(char *in, char *out, int size); 160 #ifdef HEADER_X509_H 161 int dump_cert_text(BIO *out, X509 *x); 162 void print_name(BIO *out, const char *title, X509_NAME *nm, 163 unsigned long lflags); 164 #endif 165 int set_cert_ex(unsigned long *flags, const char *arg); 166 int set_name_ex(unsigned long *flags, const char *arg); 167 int set_ext_copy(int *copy_type, const char *arg); 168 int copy_extensions(X509 *x, X509_REQ *req, int copy_type); 169 int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2); 170 int add_oid_section(BIO *err, CONF *conf); 171 X509 *load_cert(BIO *err, const char *file, int format, 172 const char *pass, const char *cert_descrip); 173 EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin, 174 const char *pass, const char *key_descrip); 175 EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin, 176 const char *pass, const char *key_descrip); 177 STACK_OF(X509) *load_certs(BIO *err, const char *file, int format, 178 const char *pass, const char *cert_descrip); 179 STACK_OF(X509_CRL) *load_crls(BIO *err, const char *file, int format, 180 const char *pass, const char *cert_descrip); 181 X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath); 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 #define DB_TYPE_SUSP 'S' 208 209 typedef struct db_attr_st { 210 int unique_subject; 211 } DB_ATTR; 212 typedef struct ca_db_st { 213 DB_ATTR attributes; 214 TXT_DB *db; 215 } CA_DB; 216 217 BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai); 218 int save_serial(char *serialfile, char *suffix, BIGNUM *serial, 219 ASN1_INTEGER **retai); 220 int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix); 221 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai); 222 CA_DB *load_index(char *dbfile, DB_ATTR *dbattr); 223 int index_index(CA_DB *db); 224 int save_index(const char *dbfile, const char *suffix, CA_DB *db); 225 int rotate_index(const char *dbfile, const char *new_suffix, 226 const char *old_suffix); 227 void free_index(CA_DB *db); 228 #define index_name_cmp_noconst(a, b) \ 229 index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \ 230 (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b)) 231 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b); 232 int parse_yesno(const char *str, int def); 233 234 X509_NAME *parse_name(char *str, long chtype, int multirdn); 235 int args_verify(char ***pargs, int *pargc, int *badarg, BIO *err, 236 X509_VERIFY_PARAM **pm); 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, 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 unsigned char *next_protos_parse(unsigned short *outlen, const char *in); 249 250 #define FORMAT_UNDEF 0 251 #define FORMAT_ASN1 1 252 #define FORMAT_TEXT 2 253 #define FORMAT_PEM 3 254 255 #define FORMAT_PKCS12 5 256 #define FORMAT_SMIME 6 257 258 #define FORMAT_PEMRSA 9 /* PEM RSAPublicKey format */ 259 #define FORMAT_ASN1RSA 10 /* DER RSAPublicKey format */ 260 #define FORMAT_MSBLOB 11 /* MS Key blob format */ 261 #define FORMAT_PVK 12 /* MS PVK file format */ 262 263 #define EXT_COPY_NONE 0 264 #define EXT_COPY_ADD 1 265 #define EXT_COPY_ALL 2 266 267 #define APP_PASS_LEN 1024 268 269 #define SERIAL_RAND_BITS 64 270 271 int app_isdir(const char *); 272 273 #define TM_RESET 0 274 #define TM_GET 1 275 double app_timer_real(int); 276 double app_timer_user(int); 277 278 #define OPENSSL_NO_SSL_INTERN 279 280 struct option { 281 const char *name; 282 const char *argname; 283 const char *desc; 284 enum { 285 OPTION_ARG, 286 OPTION_ARGV_FUNC, 287 OPTION_ARG_FORMAT, 288 OPTION_ARG_FUNC, 289 OPTION_ARG_INT, 290 OPTION_ARG_LONG, 291 OPTION_ARG_TIME, 292 OPTION_DISCARD, 293 OPTION_FUNC, 294 OPTION_FLAG, 295 OPTION_FLAG_ORD, 296 OPTION_VALUE, 297 OPTION_VALUE_AND, 298 OPTION_VALUE_OR, 299 OPTION_UL_VALUE_OR, 300 OPTION_ORDER, 301 } type; 302 union { 303 char **arg; 304 int (*argfunc)(char *arg); 305 int (*argvfunc)(int argc, char **argv, int *argsused); 306 int *flag; 307 int (*func)(void); 308 long *lvalue; 309 int *value; 310 unsigned long *ulvalue; 311 time_t *tvalue; 312 int *order; 313 } opt; 314 const int value; 315 const unsigned long ulvalue; 316 int *order; 317 }; 318 319 void options_usage(const struct option *opts); 320 int options_parse(int argc, char **argv, const struct option *opts, 321 char **unnamed, int *argsused); 322 323 void show_cipher(const OBJ_NAME *name, void *arg); 324 325 int asn1parse_main(int argc, char **argv); 326 int ca_main(int argc, char **argv); 327 int certhash_main(int argc, char **argv); 328 int ciphers_main(int argc, char **argv); 329 int cms_main(int argc, char **argv); 330 int crl2pkcs7_main(int argc, char **argv); 331 int crl_main(int argc, char **argv); 332 int dgst_main(int argc, char **argv); 333 int dh_main(int argc, char **argv); 334 int dhparam_main(int argc, char **argv); 335 int dsa_main(int argc, char **argv); 336 int dsaparam_main(int argc, char **argv); 337 int ec_main(int argc, char **argv); 338 int ecparam_main(int argc, char **argv); 339 int enc_main(int argc, char **argv); 340 int errstr_main(int argc, char **argv); 341 int gendh_main(int argc, char **argv); 342 int gendsa_main(int argc, char **argv); 343 int genpkey_main(int argc, char **argv); 344 int genrsa_main(int argc, char **argv); 345 int ocsp_main(int argc, char **argv); 346 int passwd_main(int argc, char **argv); 347 int pkcs7_main(int argc, char **argv); 348 int pkcs8_main(int argc, char **argv); 349 int pkcs12_main(int argc, char **argv); 350 int pkey_main(int argc, char **argv); 351 int pkeyparam_main(int argc, char **argv); 352 int pkeyutl_main(int argc, char **argv); 353 int prime_main(int argc, char **argv); 354 int rand_main(int argc, char **argv); 355 int req_main(int argc, char **argv); 356 int rsa_main(int argc, char **argv); 357 int rsautl_main(int argc, char **argv); 358 int s_client_main(int argc, char **argv); 359 int s_server_main(int argc, char **argv); 360 int s_time_main(int argc, char **argv); 361 int sess_id_main(int argc, char **argv); 362 int smime_main(int argc, char **argv); 363 int speed_main(int argc, char **argv); 364 int ts_main(int argc, char **argv); 365 int verify_main(int argc, char **argv); 366 int version_main(int argc, char **argv); 367 int x509_main(int argc, char **argv); 368 369 #define PORT 4433 370 #define PORT_STR "4433" 371 #define PROTOCOL "tcp" 372 373 extern int verify_depth; 374 extern int verify_return_error; 375 376 int do_server(int port, int type, int *ret, 377 int (*cb)(int s, unsigned char *context), 378 unsigned char *context, int naccept); 379 int verify_callback(int ok, X509_STORE_CTX *ctx); 380 int set_cert_stuff(SSL_CTX *ctx, char *cert_file, char *key_file); 381 int set_cert_key_stuff(SSL_CTX *ctx, X509 *cert, EVP_PKEY *key); 382 int ssl_print_tmp_key(BIO *out, SSL *s); 383 int init_client(int *sock, char *server, char *port, int type, int af); 384 int extract_port(char *str, short *port_ptr); 385 int extract_host_port(char *str, char **host_ptr, unsigned char *ip, char **p); 386 387 long bio_dump_callback(BIO *bio, int cmd, const char *argp, int argi, 388 long argl, long ret); 389 390 void apps_ssl_info_callback(const SSL *s, int where, int ret); 391 void msg_cb(int write_p, int version, int content_type, const void *buf, 392 size_t len, SSL *ssl, void *arg); 393 void tlsext_cb(SSL *s, int client_server, int type, unsigned char *data, 394 int len, void *arg); 395 396 int generate_cookie_callback(SSL *ssl, unsigned char *cookie, 397 unsigned int *cookie_len); 398 int verify_cookie_callback(SSL *ssl, const unsigned char *cookie, 399 unsigned int cookie_len); 400 401 #endif 402