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>
36 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINCE)
37 # define openssl_fdset(a,b) FD_SET((unsigned int)a, b)
39 # define openssl_fdset(a,b) FD_SET(a, b)
43 * quick macro when you need to pass an unsigned char instead of a char.
44 * this is true for some implementations of the is*() functions, for
47 #define _UC(c) ((unsigned char)(c))
49 void app_RAND_load_conf(CONF
*c
, const char *section
);
50 void app_RAND_write(void);
52 extern char *default_config_file
;
56 extern const unsigned char tls13_aes128gcmsha256_id
[];
57 extern const unsigned char tls13_aes256gcmsha384_id
[];
58 extern BIO_ADDR
*ourpeer
;
60 BIO_METHOD
*apps_bf_prefix(void);
62 * The control used to set the prefix with BIO_ctrl()
63 * We make it high enough so the chance of ever clashing with the BIO library
64 * remains unlikely for the foreseeable future and beyond.
66 #define PREFIX_CTRL_SET_PREFIX (1 << 15)
68 * apps_bf_prefix() returns a dynamically created BIO_METHOD, which we
69 * need to destroy at some point. When created internally, it's stored
70 * in an internal pointer which can be freed with the following function
72 void destroy_prefix_method(void);
74 BIO
*dup_bio_in(int format
);
75 BIO
*dup_bio_out(int format
);
76 BIO
*dup_bio_err(int format
);
77 BIO
*bio_open_owner(const char *filename
, int format
, int private);
78 BIO
*bio_open_default(const char *filename
, char mode
, int format
);
79 BIO
*bio_open_default_quiet(const char *filename
, char mode
, int format
);
80 CONF
*app_load_config_bio(BIO
*in
, const char *filename
);
81 CONF
*app_load_config(const char *filename
);
82 CONF
*app_load_config_quiet(const char *filename
);
83 int app_load_modules(const CONF
*config
);
84 void unbuffer(FILE *fp
);
85 void wait_for_async(SSL
*s
);
86 # if defined(OPENSSL_SYS_MSDOS)
87 int has_stdin_waiting(void);
90 void corrupt_signature(const ASN1_STRING
*signature
);
91 int set_cert_times(X509
*x
, const char *startdate
, const char *enddate
,
94 typedef struct args_st
{
101 * VMS C only for now, implemented in vms_decc_init.c
102 * If other C compilers forget to terminate argv with NULL, this function
105 char **copy_argv(int *argc
, char *argv
[]);
107 * Win32-specific argv initialization that splits OS-supplied UNICODE
108 * command line string to array of UTF8-encoded strings.
110 void win32_utf8argv(int *argc
, char **argv
[]);
112 /* We need both wrap and the "real" function because libcrypto uses both. */
113 int wrap_password_callback(char *buf
, int bufsiz
, int verify
, void *cb_data
);
115 int chopup_args(ARGS
*arg
, char *buf
);
116 # ifdef HEADER_X509_H
117 int dump_cert_text(BIO
*out
, X509
*x
);
118 void print_name(BIO
*out
, const char *title
, X509_NAME
*nm
,
119 unsigned long lflags
);
121 void print_bignum_var(BIO
*, const BIGNUM
*, const char*,
122 int, unsigned char *);
123 void print_array(BIO
*, const char *, int, const unsigned char *);
124 int set_nameopt(const char *arg
);
125 unsigned long get_nameopt(void);
126 int set_cert_ex(unsigned long *flags
, const char *arg
);
127 int set_name_ex(unsigned long *flags
, const char *arg
);
128 int set_ext_copy(int *copy_type
, const char *arg
);
129 int copy_extensions(X509
*x
, X509_REQ
*req
, int copy_type
);
130 int app_passwd(const char *arg1
, const char *arg2
, char **pass1
, char **pass2
);
131 int add_oid_section(CONF
*conf
);
132 X509
*load_cert(const char *file
, int format
, const char *cert_descrip
);
133 X509_CRL
*load_crl(const char *infile
, int format
);
134 EVP_PKEY
*load_key(const char *file
, int format
, int maybe_stdin
,
135 const char *pass
, ENGINE
*e
, const char *key_descrip
);
136 EVP_PKEY
*load_pubkey(const char *file
, int format
, int maybe_stdin
,
137 const char *pass
, ENGINE
*e
, const char *key_descrip
);
138 int load_certs(const char *file
, STACK_OF(X509
) **certs
, int format
,
139 const char *pass
, const char *cert_descrip
);
140 int load_crls(const char *file
, STACK_OF(X509_CRL
) **crls
, int format
,
141 const char *pass
, const char *cert_descrip
);
142 X509_STORE
*setup_verify(const char *CAfile
, const char *CApath
,
143 int noCAfile
, int noCApath
);
144 __owur
int ctx_set_verify_locations(SSL_CTX
*ctx
, const char *CAfile
,
145 const char *CApath
, int noCAfile
,
148 #ifndef OPENSSL_NO_CT
151 * Sets the file to load the Certificate Transparency log list from.
152 * If path is NULL, loads from the default file path.
153 * Returns 1 on success, 0 otherwise.
155 __owur
int ctx_set_ctlog_list_file(SSL_CTX
*ctx
, const char *path
);
159 ENGINE
*setup_engine(const char *engine
, int debug
);
160 void release_engine(ENGINE
*e
);
162 # ifndef OPENSSL_NO_OCSP
163 OCSP_RESPONSE
*process_responder(OCSP_REQUEST
*req
,
164 const char *host
, const char *path
,
165 const char *port
, int use_ssl
,
166 STACK_OF(CONF_VALUE
) *headers
,
170 /* Functions defined in ca.c and also used in ocsp.c */
171 int unpack_revinfo(ASN1_TIME
**prevtm
, int *preason
, ASN1_OBJECT
**phold
,
172 ASN1_GENERALIZEDTIME
**pinvtm
, const char *str
);
175 # define DB_exp_date 1
176 # define DB_rev_date 2
177 # define DB_serial 3 /* index - unique */
179 # define DB_name 5 /* index - unique when active and not
183 # define DB_TYPE_REV 'R' /* Revoked */
184 # define DB_TYPE_EXP 'E' /* Expired */
185 # define DB_TYPE_VAL 'V' /* Valid ; inserted with: ca ... -valid */
186 # define DB_TYPE_SUSP 'S' /* Suspended */
188 typedef struct db_attr_st
{
191 typedef struct ca_db_st
{
195 # ifndef OPENSSL_NO_POSIX_IO
200 void* app_malloc(int sz
, const char *what
);
201 BIGNUM
*load_serial(const char *serialfile
, int create
, ASN1_INTEGER
**retai
);
202 int save_serial(const char *serialfile
, const char *suffix
, const BIGNUM
*serial
,
203 ASN1_INTEGER
**retai
);
204 int rotate_serial(const char *serialfile
, const char *new_suffix
,
205 const char *old_suffix
);
206 int rand_serial(BIGNUM
*b
, ASN1_INTEGER
*ai
);
207 CA_DB
*load_index(const char *dbfile
, DB_ATTR
*dbattr
);
208 int index_index(CA_DB
*db
);
209 int save_index(const char *dbfile
, const char *suffix
, CA_DB
*db
);
210 int rotate_index(const char *dbfile
, const char *new_suffix
,
211 const char *old_suffix
);
212 void free_index(CA_DB
*db
);
213 # define index_name_cmp_noconst(a, b) \
214 index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
215 (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
216 int index_name_cmp(const OPENSSL_CSTRING
*a
, const OPENSSL_CSTRING
*b
);
217 int parse_yesno(const char *str
, int def
);
219 X509_NAME
*parse_name(const char *str
, long chtype
, int multirdn
);
220 void policies_print(X509_STORE_CTX
*ctx
);
221 int bio_to_mem(unsigned char **out
, int maxlen
, BIO
*in
);
222 int pkey_ctrl_string(EVP_PKEY_CTX
*ctx
, const char *value
);
223 int init_gen_str(EVP_PKEY_CTX
**pctx
,
224 const char *algname
, ENGINE
*e
, int do_param
);
225 int do_X509_sign(X509
*x
, EVP_PKEY
*pkey
, const EVP_MD
*md
,
226 STACK_OF(OPENSSL_STRING
) *sigopts
);
227 int do_X509_REQ_sign(X509_REQ
*x
, EVP_PKEY
*pkey
, const EVP_MD
*md
,
228 STACK_OF(OPENSSL_STRING
) *sigopts
);
229 int do_X509_CRL_sign(X509_CRL
*x
, EVP_PKEY
*pkey
, const EVP_MD
*md
,
230 STACK_OF(OPENSSL_STRING
) *sigopts
);
232 extern char *psk_key
;
235 unsigned char *next_protos_parse(size_t *outlen
, const char *in
);
237 void print_cert_checks(BIO
*bio
, X509
*x
,
238 const char *checkhost
,
239 const char *checkemail
, const char *checkip
);
241 void store_setup_crl_download(X509_STORE
*st
);
243 # define EXT_COPY_NONE 0
244 # define EXT_COPY_ADD 1
245 # define EXT_COPY_ALL 2
247 # define NETSCAPE_CERT_HDR "certificate"
249 # define APP_PASS_LEN 1024
252 * IETF RFC 5280 says serial number must be <= 20 bytes. Use 159 bits
253 * so that the first bit will never be one, so that the DER encoding
254 * rules won't force a leading octet.
256 # define SERIAL_RAND_BITS 159
258 int app_isdir(const char *);
259 int app_access(const char *, int flag
);
260 int fileno_stdin(void);
261 int fileno_stdout(void);
262 int raw_read_stdin(void *, int);
263 int raw_write_stdout(const void *, int);
267 double app_tminterval(int stop
, int usertime
);
269 void make_uppercase(char *string
);
271 typedef struct verify_options_st
{
278 extern VERIFY_CB_ARGS verify_args
;