2 * Copyright 1995-2018 The OpenSSL Project Authors. All Rights Reserved.
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
11 # define HEADER_APPS_H
13 # include "e_os.h" /* struct timeval for DTLS */
14 # include "internal/nelem.h"
17 # include <sys/types.h>
18 # ifndef OPENSSL_NO_POSIX_IO
19 # include <sys/stat.h>
23 # include <openssl/e_os2.h>
24 # include <openssl/ossl_typ.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>
35 # include "platform.h"
37 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINCE)
38 # define openssl_fdset(a,b) FD_SET((unsigned int)a, b)
40 # define openssl_fdset(a,b) FD_SET(a, b)
44 * quick macro when you need to pass an unsigned char instead of a char.
45 * this is true for some implementations of the is*() functions, for
48 #define _UC(c) ((unsigned char)(c))
50 void app_RAND_load_conf(CONF
*c
, const char *section
);
51 void app_RAND_write(void);
53 extern char *default_config_file
;
57 extern const unsigned char tls13_aes128gcmsha256_id
[];
58 extern const unsigned char tls13_aes256gcmsha384_id
[];
59 extern BIO_ADDR
*ourpeer
;
61 BIO_METHOD
*apps_bf_prefix(void);
63 * The control used to set the prefix with BIO_ctrl()
64 * We make it high enough so the chance of ever clashing with the BIO library
65 * remains unlikely for the foreseeable future and beyond.
67 #define PREFIX_CTRL_SET_PREFIX (1 << 15)
69 * apps_bf_prefix() returns a dynamically created BIO_METHOD, which we
70 * need to destroy at some point. When created internally, it's stored
71 * in an internal pointer which can be freed with the following function
73 void destroy_prefix_method(void);
75 BIO
*dup_bio_in(int format
);
76 BIO
*dup_bio_out(int format
);
77 BIO
*dup_bio_err(int format
);
78 BIO
*bio_open_owner(const char *filename
, int format
, int private);
79 BIO
*bio_open_default(const char *filename
, char mode
, int format
);
80 BIO
*bio_open_default_quiet(const char *filename
, char mode
, int format
);
81 CONF
*app_load_config_bio(BIO
*in
, const char *filename
);
82 CONF
*app_load_config(const char *filename
);
83 CONF
*app_load_config_quiet(const char *filename
);
84 int app_load_modules(const CONF
*config
);
85 void unbuffer(FILE *fp
);
86 void wait_for_async(SSL
*s
);
87 # if defined(OPENSSL_SYS_MSDOS)
88 int has_stdin_waiting(void);
91 void corrupt_signature(const ASN1_STRING
*signature
);
92 int set_cert_times(X509
*x
, const char *startdate
, const char *enddate
,
95 typedef struct args_st
{
101 /* We need both wrap and the "real" function because libcrypto uses both. */
102 int wrap_password_callback(char *buf
, int bufsiz
, int verify
, void *cb_data
);
104 int chopup_args(ARGS
*arg
, char *buf
);
105 int dump_cert_text(BIO
*out
, X509
*x
);
106 void print_name(BIO
*out
, const char *title
, X509_NAME
*nm
,
107 unsigned long lflags
);
108 void print_bignum_var(BIO
*, const BIGNUM
*, const char*,
109 int, unsigned char *);
110 void print_array(BIO
*, const char *, int, const unsigned char *);
111 int set_nameopt(const char *arg
);
112 unsigned long get_nameopt(void);
113 int set_cert_ex(unsigned long *flags
, const char *arg
);
114 int set_name_ex(unsigned long *flags
, const char *arg
);
115 int set_ext_copy(int *copy_type
, const char *arg
);
116 int copy_extensions(X509
*x
, X509_REQ
*req
, int copy_type
);
117 int app_passwd(const char *arg1
, const char *arg2
, char **pass1
, char **pass2
);
118 int add_oid_section(CONF
*conf
);
119 X509
*load_cert(const char *file
, int format
, const char *cert_descrip
);
120 X509_CRL
*load_crl(const char *infile
, int format
);
121 EVP_PKEY
*load_key(const char *file
, int format
, int maybe_stdin
,
122 const char *pass
, ENGINE
*e
, const char *key_descrip
);
123 EVP_PKEY
*load_pubkey(const char *file
, int format
, int maybe_stdin
,
124 const char *pass
, ENGINE
*e
, const char *key_descrip
);
125 int load_certs(const char *file
, STACK_OF(X509
) **certs
, int format
,
126 const char *pass
, const char *cert_descrip
);
127 int load_crls(const char *file
, STACK_OF(X509_CRL
) **crls
, int format
,
128 const char *pass
, const char *cert_descrip
);
129 X509_STORE
*setup_verify(const char *CAfile
, const char *CApath
,
130 int noCAfile
, int noCApath
);
131 __owur
int ctx_set_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
132 const char *CApath
, int noCAfile
,
135 #ifndef OPENSSL_NO_CT
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.
142 __owur
int ctx_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
);
146 ENGINE
*setup_engine(const char *engine
, int debug
);
147 void release_engine(ENGINE
*e
);
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
,
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
);
162 # define DB_exp_date 1
163 # define DB_rev_date 2
164 # define DB_serial 3 /* index - unique */
166 # define DB_name 5 /* index - unique when active and not
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 */
175 typedef struct db_attr_st
{
178 typedef struct ca_db_st
{
182 # ifndef OPENSSL_NO_POSIX_IO
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
);
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 init_gen_str(EVP_PKEY_CTX
**pctx
,
211 const char *algname
, ENGINE
*e
, int do_param
);
212 int do_X509_sign(X509
*x
, EVP_PKEY
*pkey
, const EVP_MD
*md
,
213 STACK_OF(OPENSSL_STRING
) *sigopts
);
214 int do_X509_REQ_sign(X509_REQ
*x
, EVP_PKEY
*pkey
, const EVP_MD
*md
,
215 STACK_OF(OPENSSL_STRING
) *sigopts
);
216 int do_X509_CRL_sign(X509_CRL
*x
, EVP_PKEY
*pkey
, const EVP_MD
*md
,
217 STACK_OF(OPENSSL_STRING
) *sigopts
);
219 extern char *psk_key
;
222 unsigned char *next_protos_parse(size_t *outlen
, const char *in
);
224 void print_cert_checks(BIO
*bio
, X509
*x
,
225 const char *checkhost
,
226 const char *checkemail
, const char *checkip
);
228 void store_setup_crl_download(X509_STORE
*st
);
230 # define EXT_COPY_NONE 0
231 # define EXT_COPY_ADD 1
232 # define EXT_COPY_ALL 2
234 # define NETSCAPE_CERT_HDR "certificate"
236 # define APP_PASS_LEN 1024
239 * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
240 * so that the first bit will never be one, so that the DER encoding
241 * rules won't force a leading octet.
243 # define SERIAL_RAND_BITS 159
245 int app_isdir(const char *);
246 int app_access(const char *, int flag
);
247 int fileno_stdin(void);
248 int fileno_stdout(void);
249 int raw_read_stdin(void *, int);
250 int raw_write_stdout(const void *, int);
254 double app_tminterval(int stop
, int usertime
);
256 void make_uppercase(char *string
);
258 typedef struct verify_options_st
{
265 extern VERIFY_CB_ARGS verify_args
;
267 OSSL_PARAM
*app_params_new_from_opts(STACK_OF(OPENSSL_STRING
) *opts
,
268 const OSSL_PARAM
*paramdefs
);
269 void app_params_free(OSSL_PARAM
*params
);