[thirdparty/openssl.git] / apps / apps.h

/* apps/apps.h */
/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
 * All rights reserved.
 *
 * This package is an SSL implementation written
 * by Eric Young (eay@cryptsoft.com).
 * The implementation was written so as to conform with Netscapes SSL.
 * 
 * This library is free for commercial and non-commercial use as long as
 * the following conditions are aheared to.  The following conditions
 * apply to all code found in this distribution, be it the RC4, RSA,
 * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
 * included with this distribution is covered by the same copyright terms
 * except that the holder is Tim Hudson (tjh@cryptsoft.com).
 * 
 * Copyright remains Eric Young's, and as such any Copyright notices in
 * the code are not to be removed.
 * If this package is used in a product, Eric Young should be given attribution
 * as the author of the parts of the library used.
 * This can be in the form of a textual message at program startup or
 * in documentation (online or textual) provided with the package.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *    "This product includes cryptographic software written by
 *     Eric Young (eay@cryptsoft.com)"
 *    The word 'cryptographic' can be left out if the rouines from the library
 *    being used are not cryptographic related :-).
 * 4. If you include any Windows specific code (or a derivative thereof) from 
 *    the apps directory (application code) you must include an acknowledgement:
 *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
 * 
 * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * 
 * The licence and distribution terms for any publically available version or
 * derivative of this code cannot be changed.  i.e. this code cannot simply be
 * copied and put under another distribution licence
 * [including the GNU Public Licence.]
 */

#ifndef HEADER_APPS_H
#define HEADER_APPS_H

#include "e_os.h"

#include <openssl/buffer.h>
#include <openssl/bio.h>
#include <openssl/crypto.h>
#include <openssl/x509.h>
#include <openssl/lhash.h>
#include <openssl/conf.h>
#include <openssl/engine.h>

int app_RAND_load_file(const char *file, BIO *bio_e, int dont_warn);
int app_RAND_write_file(const char *file, BIO *bio_e);
/* When `file' is NULL, use defaults.
 * `bio_e' is for error messages. */
void app_RAND_allow_write_file(void);
long app_RAND_load_files(char *file); /* `file' is a list of files to read,
                                       * separated by LIST_SEPARATOR_CHAR
                                       * (see e_os.h).  The string is
                                       * destroyed! */

#ifdef OPENSSL_NO_STDIO
BIO_METHOD *BIO_s_file();
#endif

#ifdef OPENSSL_SYS_WIN32
#define rename(from,to) WIN32_rename((from),(to))
int WIN32_rename(char *oldname,char *newname);
#endif

#ifndef MONOLITH

#define MAIN(a,v)	main(a,v)

#ifndef NON_MAIN
BIO *bio_err=NULL;
#else
extern BIO *bio_err;
#endif

#else

#define MAIN(a,v)	PROG(a,v)
extern CONF *config;
extern char *default_config_file;
extern BIO *bio_err;

#endif

#include <signal.h>

#ifdef SIGPIPE
#define do_pipe_sig()	signal(SIGPIPE,SIG_IGN)
#else
#define do_pipe_sig()
#endif

#if defined(MONOLITH) && !defined(OPENSSL_C)
#  define apps_startup() \
		do_pipe_sig()
#  define apps_shutdown()
#else
#  if defined(OPENSSL_SYS_MSDOS) || defined(OPENSSL_SYS_WIN16) || \
   defined(OPENSSL_SYS_WIN32)
#    ifdef _O_BINARY
#      define apps_startup() \
		do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
		OpenSSL_add_all_algorithms(); ENGINE_load_builtin_engines(); \
                setup_ui_method(); } while(0)
#    else
#      define apps_startup() \
		do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
		OpenSSL_add_all_algorithms(); ENGINE_load_builtin_engines(); \
                setup_ui_method(); } while(0)
#    endif
#  else
#    define apps_startup() \
		do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
		ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
#  endif
#  define apps_shutdown() \
		destroy_ui_method()
#endif

typedef struct args_st
	{
	char **data;
	int count;
	} ARGS;

#define PW_MIN_LENGTH 4
typedef struct pw_cb_data
	{
	const void *password;
	const char *prompt_info;
	} PW_CB_DATA;

int password_callback(char *buf, int bufsiz, int verify,
	PW_CB_DATA *cb_data);

int setup_ui_method();
void destroy_ui_method();

int should_retry(int i);
int args_from_file(char *file, int *argc, char **argv[]);
int str2fmt(char *s);
void program_name(char *in,char *out,int size);
int chopup_args(ARGS *arg,char *buf, int *argc, char **argv[]);
#ifdef HEADER_X509_H
int dump_cert_text(BIO *out, X509 *x);
void print_name(BIO *out, char *title, X509_NAME *nm, unsigned long lflags);
#endif
int set_cert_ex(unsigned long *flags, const char *arg);
int set_name_ex(unsigned long *flags, const char *arg);
int set_ext_copy(int *copy_type, const char *arg);
int copy_extensions(X509 *x, X509_REQ *req, int copy_type);
int app_passwd(BIO *err, char *arg1, char *arg2, char **pass1, char **pass2);
int add_oid_section(BIO *err, CONF *conf);
X509 *load_cert(BIO *err, const char *file, int format,
	const char *pass, ENGINE *e, const char *cert_descrip);
EVP_PKEY *load_key(BIO *err, const char *file, int format,
	const char *pass, ENGINE *e, const char *key_descrip);
EVP_PKEY *load_pubkey(BIO *err, const char *file, int format,
	const char *pass, ENGINE *e, const char *key_descrip);
STACK_OF(X509) *load_certs(BIO *err, const char *file, int format,
	const char *pass, ENGINE *e, const char *cert_descrip);
X509_STORE *setup_verify(BIO *bp, char *CAfile, char *CApath);
ENGINE *setup_engine(BIO *err, const char *engine, int debug);

#define FORMAT_UNDEF    0
#define FORMAT_ASN1     1
#define FORMAT_TEXT     2
#define FORMAT_PEM      3
#define FORMAT_NETSCAPE 4
#define FORMAT_PKCS12   5
#define FORMAT_SMIME    6
#define FORMAT_ENGINE   7

#define EXT_COPY_NONE	0
#define EXT_COPY_ADD	1
#define EXT_COPY_ALL	2

#define NETSCAPE_CERT_HDR	"certificate"

#define APP_PASS_LEN	1024

#endif
Commit	Line	Data
d02b48c6	1	/* apps/apps.h */
58964a49	2	/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
d02b48c6 RE	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	#ifndef HEADER_APPS_H
	60	#define HEADER_APPS_H
	61
41d2a336	62	#include "e_os.h"
d02b48c6	63
ec577822 BM	64	#include <openssl/buffer.h>
	65	#include <openssl/bio.h>
	66	#include <openssl/crypto.h>
954ef7ef	67	#include <openssl/x509.h>
431b0cce	68	#include <openssl/lhash.h>
095aadc4	69	#include <openssl/conf.h>
32d862ed	70	#include <openssl/engine.h>
d02b48c6	71
a31011e8 BM	72	int app_RAND_load_file(const char file, BIO bio_e, int dont_warn);
	73	int app_RAND_write_file(const char file, BIO bio_e);
	74	/* When `file' is NULL, use defaults.
	75	* `bio_e' is for error messages. */
	76	void app_RAND_allow_write_file(void);
	77	long app_RAND_load_files(char file); / `file' is a list of files to read,
	78	* separated by LIST_SEPARATOR_CHAR
	79	* (see e_os.h). The string is
	80	* destroyed! */
	81
cf1b7d96	82	#ifdef OPENSSL_NO_STDIO
d02b48c6 RE	83	BIO_METHOD *BIO_s_file();
	84	#endif
	85
cf1b7d96	86	#ifdef OPENSSL_SYS_WIN32
d02b48c6 RE	87	#define rename(from,to) WIN32_rename((from),(to))
	88	int WIN32_rename(char oldname,char newname);
	89	#endif
	90
	91	#ifndef MONOLITH
	92
	93	#define MAIN(a,v) main(a,v)
	94
	95	#ifndef NON_MAIN
	96	BIO *bio_err=NULL;
	97	#else
	98	extern BIO *bio_err;
	99	#endif
	100
	101	#else
	102
	103	#define MAIN(a,v) PROG(a,v)
b7a26e6d	104	extern CONF *config;
d02b48c6 RE	105	extern char *default_config_file;
	106	extern BIO *bio_err;
	107
	108	#endif
	109
	110	#include <signal.h>
	111
	112	#ifdef SIGPIPE
	113	#define do_pipe_sig() signal(SIGPIPE,SIG_IGN)
	114	#else
	115	#define do_pipe_sig()
	116	#endif
	117
e290c7d4	118	#if defined(MONOLITH) && !defined(OPENSSL_C)
870d9861 RL	119	# define apps_startup() \
	120	do_pipe_sig()
	121	# define apps_shutdown()
d02b48c6	122	#else
cf1b7d96 RL	123	# if defined(OPENSSL_SYS_MSDOS) \|\| defined(OPENSSL_SYS_WIN16) \|\| \
cf1b7d96 RL	124	defined(OPENSSL_SYS_WIN32)
d02b48c6 RE	125	# ifdef _O_BINARY
d02b48c6 RE	126	# define apps_startup() \
870d9861	127	do { _fmode=_O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
2fe5adc3	128	OpenSSL_add_all_algorithms(); ENGINE_load_builtin_engines(); \
870d9861	129	setup_ui_method(); } while(0)
d02b48c6 RE	130	# else
d02b48c6 RE	131	# define apps_startup() \
870d9861	132	do { _fmode=O_BINARY; do_pipe_sig(); CRYPTO_malloc_init(); \
2fe5adc3	133	OpenSSL_add_all_algorithms(); ENGINE_load_builtin_engines(); \
870d9861	134	setup_ui_method(); } while(0)
d02b48c6 RE	135	# endif
d02b48c6 RE	136	# else
e7ef1a56	137	# define apps_startup() \
870d9861 RL	138	do { do_pipe_sig(); OpenSSL_add_all_algorithms(); \
870d9861 RL	139	ENGINE_load_builtin_engines(); setup_ui_method(); } while(0)
d02b48c6	140	# endif
870d9861 RL	141	# define apps_shutdown() \
870d9861 RL	142	destroy_ui_method()
d02b48c6 RE	143	#endif
	144
	145	typedef struct args_st
b1c4fe36 BM	146	{
b1c4fe36 BM	147	char **data;
d02b48c6	148	int count;
b1c4fe36	149	} ARGS;
d02b48c6	150
30b4c272 RL	151	#define PW_MIN_LENGTH 4
	152	typedef struct pw_cb_data
	153	{
	154	const void *password;
	155	const char *prompt_info;
	156	} PW_CB_DATA;
	157
	158	int password_callback(char *buf, int bufsiz, int verify,
	159	PW_CB_DATA *cb_data);
	160
2fe5adc3	161	int setup_ui_method();
2c7bc88d	162	void destroy_ui_method();
2fe5adc3	163
d02b48c6 RE	164	int should_retry(int i);
	165	int args_from_file(char file, int argc, char **argv[]);
	166	int str2fmt(char *s);
	167	void program_name(char in,char out,int size);
	168	int chopup_args(ARGS arg,char buf, int argc, char *argv[]);
954ef7ef DSH	169	#ifdef HEADER_X509_H
954ef7ef DSH	170	int dump_cert_text(BIO out, X509 x);
a657546f	171	void print_name(BIO out, char title, X509_NAME *nm, unsigned long lflags);
954ef7ef	172	#endif
8ca533e3	173	int set_cert_ex(unsigned long flags, const char arg);
a657546f	174	int set_name_ex(unsigned long flags, const char arg);
791bd0cd DSH	175	int set_ext_copy(int copy_type, const char arg);
791bd0cd DSH	176	int copy_extensions(X509 x, X509_REQ req, int copy_type);
a3fe382e	177	int app_passwd(BIO err, char arg1, char arg2, char pass1, char *pass2);
b7a26e6d	178	int add_oid_section(BIO err, CONF conf);
30b4c272 RL	179	X509 load_cert(BIO err, const char *file, int format,
	180	const char pass, ENGINE e, const char *cert_descrip);
	181	EVP_PKEY load_key(BIO err, const char *file, int format,
	182	const char pass, ENGINE e, const char *key_descrip);
	183	EVP_PKEY load_pubkey(BIO err, const char *file, int format,
	184	const char pass, ENGINE e, const char *key_descrip);
	185	STACK_OF(X509) load_certs(BIO err, const char *file, int format,
	186	const char pass, ENGINE e, const char *cert_descrip);
81f169e9	187	X509_STORE setup_verify(BIO bp, char CAfile, char CApath);
531d630b	188	ENGINE setup_engine(BIO err, const char *engine, int debug);
90ae4673	189
d02b48c6 RE	190	#define FORMAT_UNDEF 0
	191	#define FORMAT_ASN1 1
	192	#define FORMAT_TEXT 2
	193	#define FORMAT_PEM 3
	194	#define FORMAT_NETSCAPE 4
90ae4673	195	#define FORMAT_PKCS12 5
094fe66d	196	#define FORMAT_SMIME 6
5270e702	197	#define FORMAT_ENGINE 7
90ae4673	198
791bd0cd DSH	199	#define EXT_COPY_NONE 0
	200	#define EXT_COPY_ADD 1
	201	#define EXT_COPY_ALL 2
	202
90ae4673	203	#define NETSCAPE_CERT_HDR "certificate"
d02b48c6	204
a3fe382e DSH	205	#define APP_PASS_LEN 1024
a3fe382e DSH	206
d02b48c6	207	#endif