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
  79 typedef struct args_st {
  80     int size;
  81     int argc;
  82     char **argv;
  83 } ARGS;
  84
  85 /* We need both wrap and the "real" function because libcrypto uses both. */
  86 int wrap_password_callback(char *buf, int bufsiz, int verify, void *cb_data);
  87
  88 int chopup_args(ARGS *arg, char *buf);
  89 int dump_cert_text(BIO *out, X509 *x);
  90 void print_name(BIO *out, const char *title, const X509_NAME *nm,
  91                 unsigned long lflags);
  92 void print_bignum_var(BIO *, const BIGNUM *, const char*,
  93                       int, unsigned char *);
  94 void print_array(BIO *, const char *, int, const unsigned char *);
  95 int set_nameopt(const char *arg);
  96 unsigned long get_nameopt(void);
  97 int set_cert_ex(unsigned long *flags, const char *arg);
  98 int set_name_ex(unsigned long *flags, const char *arg);
  99 int set_ext_copy(int *copy_type, const char *arg);
 100 int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
 101 char *get_passwd(const char *pass, const char *desc);
 102 int app_passwd(const char *arg1, const char *arg2, char **pass1, char **pass2);
 103 int add_oid_section(CONF *conf);
 104 X509_REQ *load_csr(const char *file, int format, const char *desc);
 105 X509 *load_cert_pass(const char *uri, int maybe_stdin,
 106                      const char *pass, const char *desc);
 107 /* the format parameter is meanwhile not needed anymore and thus ignored */
 108 X509 *load_cert(const char *uri, int format, const char *desc);
 109 X509_CRL *load_crl(const char *uri, int format, const char *desc);
 110 void cleanse(char *str);
 111 void clear_free(char *str);
 112 EVP_PKEY *load_key(const char *uri, int format, int maybe_stdin,
 113                    const char *pass, ENGINE *e, const char *desc);
 114 EVP_PKEY *load_pubkey(const char *uri, int format, int maybe_stdin,
 115                       const char *pass, ENGINE *e, const char *desc);
 116 int load_certs(const char *uri, STACK_OF(X509) **certs,
 117                const char *pass, const char *desc);
 118 int load_crls(const char *uri, STACK_OF(X509_CRL) **crls,
 119               const char *pass, const char *desc);
 120 int load_key_certs_crls(const char *uri, int maybe_stdin,
 121                         const char *pass, const char *desc,
 122                         EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
 123                         X509 **pcert, STACK_OF(X509) **pcerts,
 124                         X509_CRL **pcrl, STACK_OF(X509_CRL) **pcrls);
 125 int load_key_cert_crl(const char *uri, int maybe_stdin,
 126                       const char *pass, const char *desc,
 127                       EVP_PKEY **ppkey, EVP_PKEY **ppubkey,
 128                       X509 **pcert, X509_CRL **pcrl);
 129 X509_STORE *setup_verify(const char *CAfile, int noCAfile,
 130                          const char *CApath, int noCApath,
 131                          const char *CAstore, int noCAstore);
 132 __owur int ctx_set_verify_locations(SSL_CTX *ctx,
 133                                     const char *CAfile, int noCAfile,
 134                                     const char *CApath, int noCApath,
 135                                     const char *CAstore, int noCAstore);
 136
 137 # ifndef OPENSSL_NO_CT
 138
 139 /*
 140  * Sets the file to load the Certificate Transparency log list from.
 141  * If path is NULL, loads from the default file path.
 142  * Returns 1 on success, 0 otherwise.
 143  */
 144 __owur int ctx_set_ctlog_list_file(SSL_CTX *ctx, const char *path);
 145
 146 # endif
 147
 148 ENGINE *setup_engine_methods(const char *id, unsigned int methods, int debug);
 149 # define setup_engine(e, debug) setup_engine_methods(e, (unsigned int)-1, debug)
 150 void release_engine(ENGINE *e);
 151
 152 # ifndef OPENSSL_NO_OCSP
 153 OCSP_RESPONSE *process_responder(OCSP_REQUEST *req,
 154                                  const char *host, const char *path,
 155                                  const char *port, int use_ssl,
 156                                  STACK_OF(CONF_VALUE) *headers,
 157                                  int req_timeout);
 158 # endif
 159
 160 /* Functions defined in ca.c and also used in ocsp.c */
 161 int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
 162                    ASN1_GENERALIZEDTIME **pinvtm, const char *str);
 163
 164 # define DB_type         0
 165 # define DB_exp_date     1
 166 # define DB_rev_date     2
 167 # define DB_serial       3      /* index - unique */
 168 # define DB_file         4
 169 # define DB_name         5      /* index - unique when active and not
 170                                  * disabled */
 171 # define DB_NUMBER       6
 172
 173 # define DB_TYPE_REV     'R'    /* Revoked  */
 174 # define DB_TYPE_EXP     'E'    /* Expired  */
 175 # define DB_TYPE_VAL     'V'    /* Valid ; inserted with: ca ... -valid */
 176 # define DB_TYPE_SUSP    'S'    /* Suspended  */
 177
 178 typedef struct db_attr_st {
 179     int unique_subject;
 180 } DB_ATTR;
 181 typedef struct ca_db_st {
 182     DB_ATTR attributes;
 183     TXT_DB *db;
 184     char *dbfname;
 185 # ifndef OPENSSL_NO_POSIX_IO
 186     struct stat dbst;
 187 # endif
 188 } CA_DB;
 189
 190 void app_bail_out(char *fmt, ...);
 191 void* app_malloc(int sz, const char *what);
 192 BIGNUM *load_serial(const char *serialfile, int create, ASN1_INTEGER **retai);
 193 int save_serial(const char *serialfile, const char *suffix, const BIGNUM *serial,
 194                 ASN1_INTEGER **retai);
 195 int rotate_serial(const char *serialfile, const char *new_suffix,
 196                   const char *old_suffix);
 197 int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
 198 CA_DB *load_index(const char *dbfile, DB_ATTR *dbattr);
 199 int index_index(CA_DB *db);
 200 int save_index(const char *dbfile, const char *suffix, CA_DB *db);
 201 int rotate_index(const char *dbfile, const char *new_suffix,
 202                  const char *old_suffix);
 203 void free_index(CA_DB *db);
 204 # define index_name_cmp_noconst(a, b) \
 205         index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
 206         (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
 207 int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
 208 int parse_yesno(const char *str, int def);
 209
 210 X509_NAME *parse_name(const char *str, int chtype, int multirdn,
 211                       const char *desc);
 212 void policies_print(X509_STORE_CTX *ctx);
 213 int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
 214 int pkey_ctrl_string(EVP_PKEY_CTX *ctx, const char *value);
 215 int x509_ctrl_string(X509 *x, const char *value);
 216 int x509_req_ctrl_string(X509_REQ *x, const char *value);
 217 int init_gen_str(EVP_PKEY_CTX **pctx,
 218                  const char *algname, ENGINE *e, int do_param,
 219                  OPENSSL_CTX *libctx, const char *propq);
 220 int do_X509_sign(X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
 221                  STACK_OF(OPENSSL_STRING) *sigopts);
 222 int do_X509_verify(X509 *x, EVP_PKEY *pkey, STACK_OF(OPENSSL_STRING) *vfyopts);
 223 int do_X509_REQ_sign(X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
 224                      STACK_OF(OPENSSL_STRING) *sigopts);
 225 int do_X509_REQ_verify(X509_REQ *x, EVP_PKEY *pkey,
 226                        STACK_OF(OPENSSL_STRING) *vfyopts);
 227 int do_X509_CRL_sign(X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
 228                      STACK_OF(OPENSSL_STRING) *sigopts);
 229
 230 extern char *psk_key;
 231
 232
 233 unsigned char *next_protos_parse(size_t *outlen, const char *in);
 234
 235 void print_cert_checks(BIO *bio, X509 *x,
 236                        const char *checkhost,
 237                        const char *checkemail, const char *checkip);
 238
 239 void store_setup_crl_download(X509_STORE *st);
 240
 241 typedef struct app_http_tls_info_st {
 242     const char *server;
 243     const char *port;
 244     int use_proxy;
 245     long timeout;
 246     SSL_CTX *ssl_ctx;
 247 } APP_HTTP_TLS_INFO;
 248 BIO *app_http_tls_cb(BIO *hbio, /* APP_HTTP_TLS_INFO */ void *arg,
 249                      int connect, int detail);
 250 # ifndef OPENSSL_NO_SOCK
 251 ASN1_VALUE *app_http_get_asn1(const char *url, const char *proxy,
 252                               const char *no_proxy, SSL_CTX *ssl_ctx,
 253                               const STACK_OF(CONF_VALUE) *headers,
 254                               long timeout, const char *expected_content_type,
 255                               const ASN1_ITEM *it);
 256 ASN1_VALUE *app_http_post_asn1(const char *host, const char *port,
 257                                const char *path, const char *proxy,
 258                                const char *no_proxy, SSL_CTX *ctx,
 259                                const STACK_OF(CONF_VALUE) *headers,
 260                                const char *content_type,
 261                                ASN1_VALUE *req, const ASN1_ITEM *req_it,
 262                                long timeout, const ASN1_ITEM *rsp_it);
 263 # endif
 264
 265 # define EXT_COPY_NONE   0
 266 # define EXT_COPY_ADD    1
 267 # define EXT_COPY_ALL    2
 268
 269 # define NETSCAPE_CERT_HDR       "certificate"
 270
 271 # define APP_PASS_LEN    1024
 272
 273 /*
 274  * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
 275  * so that the first bit will never be one, so that the DER encoding
 276  * rules won't force a leading octet.
 277  */
 278 # define SERIAL_RAND_BITS        159
 279
 280 int app_isdir(const char *);
 281 int app_access(const char *, int flag);
 282 int fileno_stdin(void);
 283 int fileno_stdout(void);
 284 int raw_read_stdin(void *, int);
 285 int raw_write_stdout(const void *, int);
 286
 287 # define TM_START        0
 288 # define TM_STOP         1
 289 double app_tminterval(int stop, int usertime);
 290
 291 void make_uppercase(char *string);
 292
 293 typedef struct verify_options_st {
 294     int depth;
 295     int quiet;
 296     int error;
 297     int return_error;
 298 } VERIFY_CB_ARGS;
 299
 300 extern VERIFY_CB_ARGS verify_args;
 301
 302 OPENSSL_CTX *app_create_libctx(void);
 303 OPENSSL_CTX *app_get0_libctx(void);
 304 OSSL_PARAM *app_params_new_from_opts(STACK_OF(OPENSSL_STRING) *opts,
 305                                      const OSSL_PARAM *paramdefs);
 306 void app_params_free(OSSL_PARAM *params);
 307 int app_provider_load(OPENSSL_CTX *libctx, const char *provider_name);
 308 void app_providers_cleanup(void);
 309
 310 OPENSSL_CTX *app_get0_libctx(void);
 311 const char *app_get0_propq(void);
 312
 313 #endif