Annotation of src/usr.bin/openssl/apps.h, Revision 1.28
1.28 ! inoguchi 1: /* $OpenBSD: apps.h,v 1.27 2021/03/31 17:13:54 tb Exp $ */
1.1 jsing 2: /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3: * All rights reserved.
4: *
5: * This package is an SSL implementation written
6: * by Eric Young (eay@cryptsoft.com).
7: * The implementation was written so as to conform with Netscapes SSL.
8: *
9: * This library is free for commercial and non-commercial use as long as
10: * the following conditions are aheared to. The following conditions
11: * apply to all code found in this distribution, be it the RC4, RSA,
12: * lhash, DES, etc., code; not just the SSL code. The SSL documentation
13: * included with this distribution is covered by the same copyright terms
14: * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15: *
16: * Copyright remains Eric Young's, and as such any Copyright notices in
17: * the code are not to be removed.
18: * If this package is used in a product, Eric Young should be given attribution
19: * as the author of the parts of the library used.
20: * This can be in the form of a textual message at program startup or
21: * in documentation (online or textual) provided with the package.
22: *
23: * Redistribution and use in source and binary forms, with or without
24: * modification, are permitted provided that the following conditions
25: * are met:
26: * 1. Redistributions of source code must retain the copyright
27: * notice, this list of conditions and the following disclaimer.
28: * 2. Redistributions in binary form must reproduce the above copyright
29: * notice, this list of conditions and the following disclaimer in the
30: * documentation and/or other materials provided with the distribution.
31: * 3. All advertising materials mentioning features or use of this software
32: * must display the following acknowledgement:
33: * "This product includes cryptographic software written by
34: * Eric Young (eay@cryptsoft.com)"
35: * The word 'cryptographic' can be left out if the rouines from the library
36: * being used are not cryptographic related :-).
37: * 4. If you include any Windows specific code (or a derivative thereof) from
38: * the apps directory (application code) you must include an acknowledgement:
39: * "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40: *
41: * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44: * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51: * SUCH DAMAGE.
52: *
53: * The licence and distribution terms for any publically available version or
54: * derivative of this code cannot be changed. i.e. this code cannot simply be
55: * copied and put under another distribution licence
56: * [including the GNU Public Licence.]
57: */
58: /* ====================================================================
59: * Copyright (c) 1998-2001 The OpenSSL Project. All rights reserved.
60: *
61: * Redistribution and use in source and binary forms, with or without
62: * modification, are permitted provided that the following conditions
63: * are met:
64: *
65: * 1. Redistributions of source code must retain the above copyright
66: * notice, this list of conditions and the following disclaimer.
67: *
68: * 2. Redistributions in binary form must reproduce the above copyright
69: * notice, this list of conditions and the following disclaimer in
70: * the documentation and/or other materials provided with the
71: * distribution.
72: *
73: * 3. All advertising materials mentioning features or use of this
74: * software must display the following acknowledgment:
75: * "This product includes software developed by the OpenSSL Project
76: * for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77: *
78: * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79: * endorse or promote products derived from this software without
80: * prior written permission. For written permission, please contact
81: * openssl-core@openssl.org.
82: *
83: * 5. Products derived from this software may not be called "OpenSSL"
84: * nor may "OpenSSL" appear in their names without prior written
85: * permission of the OpenSSL Project.
86: *
87: * 6. Redistributions of any form whatsoever must retain the following
88: * acknowledgment:
89: * "This product includes software developed by the OpenSSL Project
90: * for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91: *
92: * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93: * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95: * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR
96: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98: * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101: * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103: * OF THE POSSIBILITY OF SUCH DAMAGE.
104: * ====================================================================
105: *
106: * This product includes cryptographic software written by Eric Young
107: * (eay@cryptsoft.com). This product includes software written by Tim
108: * Hudson (tjh@cryptsoft.com).
109: *
110: */
111:
112: #ifndef HEADER_APPS_H
113: #define HEADER_APPS_H
114:
115: #include <openssl/opensslconf.h>
116:
117: #include <openssl/bio.h>
118: #include <openssl/conf.h>
119: #include <openssl/lhash.h>
120: #include <openssl/ossl_typ.h>
121: #include <openssl/txt_db.h>
122: #include <openssl/x509.h>
1.16 bcook 123: #include <openssl/ui.h>
1.1 jsing 124:
125: #ifndef OPENSSL_NO_OCSP
126: #include <openssl/ocsp.h>
127: #endif
1.17 doug 128:
129: #include <unistd.h>
130: extern int single_execution;
1.1 jsing 131:
132: extern CONF *config;
133: extern char *default_config_file;
134: extern BIO *bio_err;
135:
136: typedef struct args_st {
137: char **data;
138: int count;
139: } ARGS;
140:
141: #define PW_MIN_LENGTH 4
142: typedef struct pw_cb_data {
143: const void *password;
144: const char *prompt_info;
145: } PW_CB_DATA;
146:
147: int password_callback(char *buf, int bufsiz, int verify, void *cb_data);
148:
1.16 bcook 149: int setup_ui(void);
150: void destroy_ui(void);
151:
152: extern UI_METHOD *ui_method;
153: int ui_open(UI *ui);
154: int ui_read(UI *ui, UI_STRING *uis);
155: int ui_write(UI *ui, UI_STRING *uis);
156: int ui_close(UI *ui);
1.1 jsing 157:
158: int should_retry(int i);
159: int args_from_file(char *file, int *argc, char **argv[]);
160: int str2fmt(char *s);
161: void program_name(char *in, char *out, int size);
162: int chopup_args(ARGS *arg, char *buf, int *argc, char **argv[]);
163: #ifdef HEADER_X509_H
164: int dump_cert_text(BIO *out, X509 *x);
165: void print_name(BIO *out, const char *title, X509_NAME *nm,
166: unsigned long lflags);
167: #endif
168: int set_cert_ex(unsigned long *flags, const char *arg);
169: int set_name_ex(unsigned long *flags, const char *arg);
170: int set_ext_copy(int *copy_type, const char *arg);
171: int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
172: int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
173: int add_oid_section(BIO *err, CONF *conf);
174: X509 *load_cert(BIO *err, const char *file, int format,
1.15 bcook 175: const char *pass, const char *cert_descrip);
1.1 jsing 176: EVP_PKEY *load_key(BIO *err, const char *file, int format, int maybe_stdin,
1.15 bcook 177: const char *pass, const char *key_descrip);
1.1 jsing 178: EVP_PKEY *load_pubkey(BIO *err, const char *file, int format, int maybe_stdin,
1.15 bcook 179: const char *pass, const char *key_descrip);
1.1 jsing 180: STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
1.15 bcook 181: const char *pass, const char *cert_descrip);
1.1 jsing 182: STACK_OF(X509_CRL) *load_crls(BIO *err, const char *file, int format,
1.15 bcook 183: const char *pass, const char *cert_descrip);
1.1 jsing 184: X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
185:
186: #ifndef OPENSSL_NO_OCSP
187: OCSP_RESPONSE *process_responder(BIO *err, OCSP_REQUEST *req,
188: char *host, char *path, char *port, int use_ssl,
189: STACK_OF(CONF_VALUE) *headers, int req_timeout);
190: #endif
191:
192: int load_config(BIO *err, CONF *cnf);
193: char *make_config_name(void);
194:
195: /* Functions defined in ca.c and also used in ocsp.c */
196: int unpack_revinfo(ASN1_TIME **prevtm, int *preason, ASN1_OBJECT **phold,
197: ASN1_GENERALIZEDTIME **pinvtm, const char *str);
198:
199: #define DB_type 0
200: #define DB_exp_date 1
201: #define DB_rev_date 2
202: #define DB_serial 3 /* index - unique */
203: #define DB_file 4
204: #define DB_name 5 /* index - unique when active and not disabled */
205: #define DB_NUMBER 6
206:
207: #define DB_TYPE_REV 'R'
208: #define DB_TYPE_EXP 'E'
209: #define DB_TYPE_VAL 'V'
1.28 ! inoguchi 210: #define DB_TYPE_SUSP 'S'
1.1 jsing 211:
212: typedef struct db_attr_st {
213: int unique_subject;
214: } DB_ATTR;
215: typedef struct ca_db_st {
216: DB_ATTR attributes;
217: TXT_DB *db;
218: } CA_DB;
219:
220: BIGNUM *load_serial(char *serialfile, int create, ASN1_INTEGER **retai);
221: int save_serial(char *serialfile, char *suffix, BIGNUM *serial,
222: ASN1_INTEGER **retai);
223: int rotate_serial(char *serialfile, char *new_suffix, char *old_suffix);
224: int rand_serial(BIGNUM *b, ASN1_INTEGER *ai);
225: CA_DB *load_index(char *dbfile, DB_ATTR *dbattr);
226: int index_index(CA_DB *db);
227: int save_index(const char *dbfile, const char *suffix, CA_DB *db);
228: int rotate_index(const char *dbfile, const char *new_suffix,
229: const char *old_suffix);
230: void free_index(CA_DB *db);
231: #define index_name_cmp_noconst(a, b) \
232: index_name_cmp((const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, a), \
233: (const OPENSSL_CSTRING *)CHECKED_PTR_OF(OPENSSL_STRING, b))
234: int index_name_cmp(const OPENSSL_CSTRING *a, const OPENSSL_CSTRING *b);
235: int parse_yesno(const char *str, int def);
236:
237: X509_NAME *parse_name(char *str, long chtype, int multirdn);
238: int args_verify(char ***pargs, int *pargc, int *badarg, BIO *err,
239: X509_VERIFY_PARAM **pm);
240: void policies_print(BIO *out, X509_STORE_CTX *ctx);
241: int bio_to_mem(unsigned char **out, int maxlen, BIO *in);
242: int pkey_ctrl_string(EVP_PKEY_CTX *ctx, char *value);
1.15 bcook 243: int init_gen_str(BIO *err, EVP_PKEY_CTX **pctx, const char *algname,
1.1 jsing 244: int do_param);
245: int do_X509_sign(BIO *err, X509 *x, EVP_PKEY *pkey, const EVP_MD *md,
246: STACK_OF(OPENSSL_STRING) *sigopts);
247: int do_X509_REQ_sign(BIO *err, X509_REQ *x, EVP_PKEY *pkey, const EVP_MD *md,
248: STACK_OF(OPENSSL_STRING) *sigopts);
249: int do_X509_CRL_sign(BIO *err, X509_CRL *x, EVP_PKEY *pkey, const EVP_MD *md,
250: STACK_OF(OPENSSL_STRING) *sigopts);
251:
252: unsigned char *next_protos_parse(unsigned short *outlen, const char *in);
253:
254: #define FORMAT_UNDEF 0
255: #define FORMAT_ASN1 1
256: #define FORMAT_TEXT 2
257: #define FORMAT_PEM 3
258: #define FORMAT_NETSCAPE 4
259: #define FORMAT_PKCS12 5
260: #define FORMAT_SMIME 6
1.15 bcook 261:
1.1 jsing 262: #define FORMAT_IISSGC 8 /* XXX this stupid macro helps us to avoid
263: * adding yet another param to load_*key() */
264: #define FORMAT_PEMRSA 9 /* PEM RSAPubicKey format */
265: #define FORMAT_ASN1RSA 10 /* DER RSAPubicKey format */
266: #define FORMAT_MSBLOB 11 /* MS Key blob format */
267: #define FORMAT_PVK 12 /* MS PVK file format */
268:
269: #define EXT_COPY_NONE 0
270: #define EXT_COPY_ADD 1
271: #define EXT_COPY_ALL 2
272:
273: #define NETSCAPE_CERT_HDR "certificate"
274:
275: #define APP_PASS_LEN 1024
276:
277: #define SERIAL_RAND_BITS 64
278:
279: int app_isdir(const char *);
280:
1.21 cheloha 281: #define TM_RESET 0
282: #define TM_GET 1
283: double app_timer_real(int);
284: double app_timer_user(int);
1.1 jsing 285:
286: #define OPENSSL_NO_SSL_INTERN
1.2 jsing 287:
288: struct option {
289: const char *name;
290: const char *argname;
291: const char *desc;
292: enum {
293: OPTION_ARG,
1.12 jsing 294: OPTION_ARGV_FUNC,
1.4 jsing 295: OPTION_ARG_FORMAT,
1.6 jsing 296: OPTION_ARG_FUNC,
1.3 jsing 297: OPTION_ARG_INT,
1.14 jsing 298: OPTION_ARG_LONG,
1.19 deraadt 299: OPTION_ARG_TIME,
1.13 jsing 300: OPTION_DISCARD,
1.7 jsing 301: OPTION_FUNC,
1.2 jsing 302: OPTION_FLAG,
1.5 jsing 303: OPTION_FLAG_ORD,
1.2 jsing 304: OPTION_VALUE,
1.13 jsing 305: OPTION_VALUE_AND,
306: OPTION_VALUE_OR,
1.24 inoguchi 307: OPTION_UL_VALUE_OR,
1.25 inoguchi 308: OPTION_ORDER,
1.2 jsing 309: } type;
310: union {
311: char **arg;
1.10 jsing 312: int (*argfunc)(char *arg);
1.12 jsing 313: int (*argvfunc)(int argc, char **argv, int *argsused);
1.2 jsing 314: int *flag;
1.10 jsing 315: int (*func)(void);
1.14 jsing 316: long *lvalue;
1.2 jsing 317: int *value;
1.24 inoguchi 318: unsigned long *ulvalue;
1.18 deraadt 319: time_t *tvalue;
1.25 inoguchi 320: int *order;
1.2 jsing 321: } opt;
322: const int value;
1.24 inoguchi 323: const unsigned long ulvalue;
1.25 inoguchi 324: int *order;
1.2 jsing 325: };
326:
1.23 guenther 327: void options_usage(const struct option *opts);
328: int options_parse(int argc, char **argv, const struct option *opts,
329: char **unnamed, int *argsused);
1.22 inoguchi 330:
331: void show_cipher(const OBJ_NAME *name, void *arg);
1.1 jsing 332:
333: #endif
![[BACK]](/icons/back.gif){kind=icon}
Return to apps.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / openssl