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