apps/include/apps.h

   1 /*
   2  * Copyright 1995-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  *
   4  * Licensed under the Apache License 2.0 (the "License").  You may not use
   5  * this file except in compliance with the License.  You can obtain a copy
   6  * in the file LICENSE in the source distribution or at
   7  * https://www.openssl.org/source/license.html
   8  */
   9
  10 #ifndef OSSL_APPS_H
  11 # define OSSL_APPS_H
  12
  13 # include "e_os.h" /* struct timeval for DTLS */
  14 # include "internal/nelem.h"
  15 # include "internal/sockets.h" /* for openssl_fdset() */
  16 # include <assert.h>
  17
  18 # include <stdarg.h>
  19 # include <sys/types.h>
  20 # ifndef OPENSSL_NO_POSIX_IO
  21 #  include <sys/stat.h>
  22 #  include <fcntl.h>
  23 # endif
  24
  25 # include <openssl/e_os2.h>
  26 # include <openssl/types.h>
  27 # include <openssl/bio.h>
  28 # include <openssl/x509.h>
  29 # include <openssl/conf.h>
  30 # include <openssl/txt_db.h>
  31 # include <openssl/engine.h>
  32 # include <openssl/ocsp.h>
  33 # include <openssl/http.h>
  34 # include <signal.h>
  35 # include "apps_ui.h"
  36 # include "opt.h"
  37 # include "fmt.h"
  38 # include "platform.h"
  39
  40 /*
  41  * quick macro when you need to pass an unsigned char instead of a char.
  42  * this is true for some implementations of the is*() functions, for
  43  * example.
  44  */
  45 # define _UC(c) ((unsigned char)(c))
  46
  47 void app_RAND_load_conf(CONF *c, const char *section);
  48 void app_RAND_write(void);
  49
  50 extern char *default_config_file;
  51 extern BIO *bio_in;
  52 extern BIO *bio_out;
  53 extern BIO *bio_err;
  54 extern const unsigned char tls13_aes128gcmsha256_id[];
  55 extern const unsigned char tls13_aes256gcmsha384_id[];
  56 extern BIO_ADDR *ourpeer;
  57
  58 BIO *dup_bio_in(int format);
  59 BIO *dup_bio_out(int format);
  60 BIO *dup_bio_err(int format);
  61 BIO *bio_open_owner(const char *filename, int format, int private);
  62 BIO *bio_open_default(const char *filename, char mode, int format);
  63 BIO *bio_open_default_quiet(const char *filename, char mode, int format);
  64 CONF *app_load_config_bio(BIO *in, const char *filename);
  65 CONF *app_load_config(const char *filename);
  66 CONF *app_load_config_quiet(const char *filename);
  67 int app_load_modules(const CONF *config);
  68 CONF *app_load_config_modules(const char *configfile);
  69 void unbuffer(FILE *fp);
  70 void wait_for_async(SSL *s);
  71 # if defined(OPENSSL_SYS_MSDOS)
  72 int has_stdin_waiting(void);
  73 # endif
  74
  75 void corrupt_signature(const ASN1_STRING *signature);
  76 int set_cert_times(X509 *x, const char *startdate, const char *enddate,
  77                    int days);
  78 int set_crl_lastupdate(X509_CRL *crl, const char *lastupdate);
  79 int set_crl_nextupdate(X509_CRL *crl, const char *nextupdate,
  80                        long days, long hours, long secs);
  81
  82 typedef struct args_st {
  83     int size;
  84     int argc;
  85     char **argv;
  86 } ARGS;
  87
  88 /* We need both wrap and the "real" function because libcrypto uses both. */
  89 int wrap_password_callback(char *buf, int bufsiz, int verify, void *cb_data);
  90
  91 int chopup_args(ARGS *arg, char *buf);
  92 int dump_cert_text(BIO *out, X509 *x);
  93 void print_name(BIO *out, const char *title, const X509_NAME *nm,
  94                 unsigned long lflags);
  95 void print_bignum_var(BIO *, const BIGNUM *, const char*,
  96                       int, unsigned char *);
  97 void print_array(BIO *, const char *, int, const unsigned char *);
  98 int set_nameopt(const char *arg);
  99 unsigned long get_nameopt(void);
 100 int set_cert_ex(unsigned long *flags, const char *arg);
 101 int set_name_ex(unsigned long *flags, const char *arg);
 102 int set_ext_copy(int *copy_type, const char *arg);
 103 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
 104 char *get_passwd(const char *pass, const char *desc);
 105 int app_passwd(const char *arg1, const char *arg2, char **pass1, char **pass2);
 106 int add_oid_section(CONF *conf);
 107 X509_REQ *load_csr(const char *file, int format, const char *desc);
 108 X509 *load_cert_pass(const char *uri, int maybe_stdin,
 109                      const char *pass, const char *desc);
 110 #define load_cert(uri, desc) load_cert_pass(uri, 1, NULL, desc)
 111 X509_CRL *load_crl(const char *uri, const char *desc);
 112 void cleanse(char *str);
 113 void clear_free(char *str);
 114 EVP_PKEY *load_key(const char *uri, int format, int maybe_stdin,
 115                    const char *pass, ENGINE *e, const char *desc);
 116 EVP_PKEY *load_pubkey(const char *uri, int format, int maybe_stdin,
 117                       const char *pass, ENGINE *e, const char *desc);
 118 EVP_PKEY *load_keyparams(const char *uri, int maybe_stdin, const char *keytype,
 119                          const char *desc);
 120 int load_certs(const char *uri, STACK_OF(X509) **certs,
 121                const char *pass, const char *desc);
 122 int load_crls(const char *uri, STACK_OF(X509_CRL) **crls,
 123               const char *pass, const char *desc);
 124 int load_key_certs_crls(const char *uri, int maybe_stdin,
 125                         const char *pass, const char *desc,
 126                         EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
 127                         EVP_PKEY **pparams,
 128                         X509 **pcert, STACK_OF(X509) **pcerts,
 129                         X509_CRL **pcrl, STACK_OF(X509_CRL) **pcrls);
 130 int load_key_cert_crl(const char *uri, int maybe_stdin,
 131                       const char *pass, const char *desc,
 132                       EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
 133                       X509 **pcert, X509_CRL **pcrl);
 134 X509_STORE *setup_verify(const char *CAfile, int noCAfile,
 135                          const char *CApath, int noCApath,
 136                          const char *CAstore, int noCAstore);
 137 __owur int ctx_set_verify_locations(SSL_CTX *ctx,
 138                                     const char *CAfile, int noCAfile,
 139                                     const char *CApath, int noCApath,
 140                                     const char *CAstore, int noCAstore);
 141
 142 # ifndef OPENSSL_NO_CT
 143
 144 /*
 145  * Sets the file to load the Certificate Transparency log list from.
 146  * If path is NULL, loads from the default file path.
 147  * Returns 1 on success, 0 otherwise.
 148  */
 149 __owur int ctx_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
 150
 151 # endif
 152
 153 ENGINE *setup_engine_methods(const char *id, unsigned int methods, int debug);
 154 # define setup_engine(e, debug) setup_engine_methods(e, (unsigned int)-1, debug)
 155 void release_engine(ENGINE *e);
 156 int init_engine(ENGINE *e);
 157 int finish_engine(ENGINE *e);
 158 EVP_PKEY *load_engine_private_key(ENGINE *e, const char *keyid,
 159                                   const char *pass, const char *desc);
 160 EVP_PKEY *load_engine_public_key(ENGINE *e, const char *keyid,
 161                                  const char *pass, const char *desc);
 162
 163 int get_legacy_pkey_id(OSSL_LIB_CTX *libctx, const char *algname, ENGINE *e);
 164
 165 # ifndef OPENSSL_NO_OCSP
 166 OCSP_RESPONSE *process_responder(OCSP_REQUEST *req,
 167                                  const char *host, const char *path,
 168                                  const char *port, int use_ssl,
 169                                  STACK_OF(CONF_VALUE) *headers,
 170                                  int req_timeout);
 171 # endif
 172
 173 /* Functions defined in ca.c and also used in ocsp.c */
 174 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
 175                    ASN1_GENERALIZEDTIME **pinvtm, const char *str);
 176
 177 # define DB_type         0
 178 # define DB_exp_date     1
 179 # define DB_rev_date     2
 180 # define DB_serial       3      /* index - unique */
 181 # define DB_file         4
 182 # define DB_name         5      /* index - unique when active and not
 183                                  * disabled */
 184 # define DB_NUMBER       6
 185
 186 # define DB_TYPE_REV     'R'    /* Revoked  */
 187 # define DB_TYPE_EXP     'E'    /* Expired  */
 188 # define DB_TYPE_VAL     'V'    /* Valid ; inserted with: ca ... -valid */
 189 # define DB_TYPE_SUSP    'S'    /* Suspended  */
 190
 191 typedef struct db_attr_st {
 192     int unique_subject;
 193 } DB_ATTR;
 194 typedef struct ca_db_st {
 195     DB_ATTR attributes;
 196     TXT_DB *db;
 197     char *dbfname;
 198 # ifndef OPENSSL_NO_POSIX_IO
 199     struct stat dbst;
 200 # endif
 201 } CA_DB;
 202
 203 void app_bail_out(char *fmt, ...);
 204 void* app_malloc(int sz, const char *what);
 205 BIGNUM *load_serial(const char *serialfile, int create, ASN1_INTEGER **retai);
 206 int save_serial(const char *serialfile, const char *suffix, const BIGNUM *serial,
 207                 ASN1_INTEGER **retai);
 208 int rotate_serial(const char *serialfile, const char *new_suffix,
 209                   const char *old_suffix);
 210 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
 211 CA_DB *load_index(const char *dbfile, DB_ATTR *dbattr);
 212 int index_index(CA_DB *db);
 213 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
 214 int rotate_index(const char *dbfile, const char *new_suffix,
 215                  const char *old_suffix);
 216 void free_index(CA_DB *db);
 217 # define index_name_cmp_noconst(a, b) \
 218         index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
 219         (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
 220 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
 221 int parse_yesno(const char *str, int def);
 222
 223 X509_NAME *parse_name(const char *str, int chtype, int multirdn,
 224                       const char *desc);
 225 void policies_print(X509_STORE_CTX *ctx);
 226 int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
 227 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value);
 228 int x509_ctrl_string(X509 *x, const char *value);
 229 int x509_req_ctrl_string(X509_REQ *x, const char *value);
 230 int init_gen_str(EVP_PKEY_CTX **pctx,
 231                  const char *algname, ENGINE *e, int do_param,
 232                  OSSL_LIB_CTX *libctx, const char *propq);
 233 int do_X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
 234                  STACK_OF(OPENSSL_STRING) *sigopts);
 235 int do_X509_verify(X509 *x, EVP_PKEY *pkey, STACK_OF(OPENSSL_STRING) *vfyopts);
 236 int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
 237                      STACK_OF(OPENSSL_STRING) *sigopts);
 238 int do_X509_REQ_verify(X509_REQ *x, EVP_PKEY *pkey,
 239                        STACK_OF(OPENSSL_STRING) *vfyopts);
 240 int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
 241                      STACK_OF(OPENSSL_STRING) *sigopts);
 242
 243 extern char *psk_key;
 244
 245
 246 unsigned char *next_protos_parse(size_t *outlen, const char *in);
 247
 248 void print_cert_checks(BIO *bio, X509 *x,
 249                        const char *checkhost,
 250                        const char *checkemail, const char *checkip);
 251
 252 void store_setup_crl_download(X509_STORE *st);
 253
 254 typedef struct app_http_tls_info_st {
 255     const char *server;
 256     const char *port;
 257     int use_proxy;
 258     long timeout;
 259     SSL_CTX *ssl_ctx;
 260 } APP_HTTP_TLS_INFO;
 261 BIO *app_http_tls_cb(BIO *hbio, /* APP_HTTP_TLS_INFO */ void *arg,
 262                      int connect, int detail);
 263 # ifndef OPENSSL_NO_SOCK
 264 ASN1_VALUE *app_http_get_asn1(const char *url, const char *proxy,
 265                               const char *no_proxy, SSL_CTX *ssl_ctx,
 266                               const STACK_OF(CONF_VALUE) *headers,
 267                               long timeout, const char *expected_content_type,
 268                               const ASN1_ITEM *it);
 269 ASN1_VALUE *app_http_post_asn1(const char *host, const char *port,
 270                                const char *path, const char *proxy,
 271                                const char *no_proxy, SSL_CTX *ctx,
 272                                const STACK_OF(CONF_VALUE) *headers,
 273                                const char *content_type,
 274                                ASN1_VALUE *req, const ASN1_ITEM *req_it,
 275                                long timeout, const ASN1_ITEM *rsp_it);
 276 # endif
 277
 278 # define EXT_COPY_NONE   0
 279 # define EXT_COPY_ADD    1
 280 # define EXT_COPY_ALL    2
 281
 282 # define NETSCAPE_CERT_HDR       "certificate"
 283
 284 # define APP_PASS_LEN    1024
 285
 286 /*
 287  * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
 288  * so that the first bit will never be one, so that the DER encoding
 289  * rules won't force a leading octet.
 290  */
 291 # define SERIAL_RAND_BITS        159
 292
 293 int app_isdir(const char *);
 294 int app_access(const char *, int flag);
 295 int fileno_stdin(void);
 296 int fileno_stdout(void);
 297 int raw_read_stdin(void *, int);
 298 int raw_write_stdout(const void *, int);
 299
 300 # define TM_START        0
 301 # define TM_STOP         1
 302 double app_tminterval(int stop, int usertime);
 303
 304 void make_uppercase(char *string);
 305
 306 typedef struct verify_options_st {
 307     int depth;
 308     int quiet;
 309     int error;
 310     int return_error;
 311 } VERIFY_CB_ARGS;
 312
 313 extern VERIFY_CB_ARGS verify_args;
 314
 315 OSSL_LIB_CTX *app_create_libctx(void);
 316 OSSL_LIB_CTX *app_get0_libctx(void);
 317 OSSL_PARAM *app_params_new_from_opts(STACK_OF(OPENSSL_STRING) *opts,
 318                                      const OSSL_PARAM *paramdefs);
 319 void app_params_free(OSSL_PARAM *params);
 320 int app_provider_load(OSSL_LIB_CTX *libctx, const char *provider_name);
 321 void app_providers_cleanup(void);
 322
 323 OSSL_LIB_CTX *app_get0_libctx(void);
 324 const char *app_get0_propq(void);
 325
 326 #endif