Add -prexit command to s_client and patch some BIO
[openssl.git] / crypto / bio / bio.h
index 82aaf31719ac289a3744e5767d29bffab4f6652e..31264598d36440018921b781ea1183457079f611 100644 (file)
@@ -63,7 +63,9 @@
 extern "C" {
 #endif
 
-#include "crypto.h"
+#include <stdio.h>
+#include <stdlib.h>
+#include <openssl/crypto.h>
 
 /* These are the 'types' of BIOs */
 #define BIO_TYPE_NONE          0
@@ -85,6 +87,7 @@ extern "C" {
 #define BIO_TYPE_NBIO_TEST     (16|0x0200)             /* server proxy BIO */
 #define BIO_TYPE_NULL_FILTER   (17|0x0200)
 #define BIO_TYPE_BER           (18|0x0200)             /* BER -> bin filter */
+#define BIO_TYPE_BIO           (19|0x0400)             /* (half a) BIO pair */
 
 #define BIO_TYPE_DESCRIPTOR    0x0100  /* socket, fd, connect or accept */
 #define BIO_TYPE_FILTER                0x0200
@@ -144,6 +147,11 @@ extern "C" {
 
 #define BIO_FLAGS_BASE64_NO_NL 0x100
 
+/* This is used with memory BIOs: it means we shouldn't free up or change the
+ * data in any way.
+ */
+#define BIO_FLAGS_MEM_RDONLY   0x200
+
 #define BIO_set_flags(b,f) ((b)->flags|=(f))
 #define BIO_get_flags(b) ((b)->flags)
 #define BIO_set_retry_special(b) \
@@ -203,7 +211,7 @@ extern "C" {
 typedef struct bio_method_st
        {
        int type;
-       char *name;
+       const char *name;
        int (*bwrite)();
        int (*bread)();
        int (*bputs)();
@@ -216,7 +224,7 @@ typedef struct bio_method_st
 typedef struct bio_method_st
        {
        int type;
-       char *name;
+       const char *name;
        int (_far *bwrite)();
        int (_far *bread)();
        int (_far *bputs)();
@@ -230,12 +238,8 @@ typedef struct bio_method_st
 typedef struct bio_st
        {
        BIO_METHOD *method;
-#ifndef NOPROTO
        /* bio, mode, argp, argi, argl, ret */
-       long (*callback)(struct bio_st *,int,char *,int, long,long);
-#else
-       long (*callback)();
-#endif
+       long (*callback)(struct bio_st *,int,const char *,int, long,long);
        char *cb_arg; /* first argument for the callback */
 
        int init;
@@ -243,7 +247,7 @@ typedef struct bio_st
        int flags;      /* extra storage */
        int retry_reason;
        int num;
-       char *ptr;
+       void *ptr;
        struct bio_st *next_bio;        /* used by filter BIOs */
        struct bio_st *prev_bio;        /* used by filter BIOs */
        int references;
@@ -279,9 +283,6 @@ typedef struct bio_f_buffer_ctx_struct
 #define BIO_CONN_S_NBIO                        8
 /*#define BIO_CONN_get_param_hostname  BIO_ctrl */
 
-#define BIO_number_read(b)     ((b)->num_read)
-#define BIO_number_written(b)  ((b)->num_write)
-
 #define BIO_C_SET_CONNECT                      100
 #define BIO_C_DO_STATE_MACHINE                 101
 #define BIO_C_SET_NBIO                         102
@@ -319,16 +320,23 @@ typedef struct bio_f_buffer_ctx_struct
 #define BIO_C_GET_SOCKS                                134
 #define BIO_C_SET_SOCKS                                135
 
+#define BIO_C_SET_WRITE_BUF_SIZE               136/* for BIO_s_bio */
+#define BIO_C_GET_WRITE_BUF_SIZE               137
+#define BIO_C_MAKE_BIO_PAIR                    138
+#define BIO_C_DESTROY_BIO_PAIR                 139
+#define BIO_C_GET_WRITE_GUARANTEE              140
+#define BIO_C_GET_READ_REQUEST                 141
+#define BIO_C_SHUTDOWN_WR                      142
+#define BIO_C_NREAD0                           143
+#define BIO_C_NREAD                            144
+#define BIO_C_NWRITE0                          145
+#define BIO_C_NWRITE                           146
+#define BIO_C_RESET_READ_REQUEST               147
+
+
 #define BIO_set_app_data(s,arg)                BIO_set_ex_data(s,0,(char *)arg)
 #define BIO_get_app_data(s)            BIO_get_ex_data(s,0)
 
-int BIO_get_ex_num(BIO *bio);
-int BIO_set_ex_data(BIO *bio,int idx,char *data);
-char *BIO_get_ex_data(BIO *bio,int idx);
-void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)());
-int BIO_get_ex_new_index(long argl, char *argp, int (*new_func)(),
-       int (*dup_func)(), void (*free_func)());
-
 /* BIO_s_connect() and BIO_s_socks4a_connect() */
 #define BIO_set_conn_hostname(b,name) BIO_ctrl(b,BIO_C_SET_CONNECT,0,(char *)name)
 #define BIO_set_conn_port(b,port) BIO_ctrl(b,BIO_C_SET_CONNECT,1,(char *)port)
@@ -383,8 +391,17 @@ int BIO_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 #define BIO_seek(b,ofs)        (int)BIO_ctrl(b,BIO_C_FILE_SEEK,ofs,NULL)
 #define BIO_tell(b)    (int)BIO_ctrl(b,BIO_C_FILE_TELL,0,NULL)
 
+/* name is cast to lose const, but might be better to route through a function
+   so we can do it safely */
+#ifdef CONST_STRICT
+/* If you are wondering why this isn't defined, its because CONST_STRICT is
+ * purely a compile-time kludge to allow const to be checked.
+ */
+int BIO_read_filename(BIO *b,const char *name);
+#else
 #define BIO_read_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
-               BIO_CLOSE|BIO_FP_READ,name)
+               BIO_CLOSE|BIO_FP_READ,(char *)name)
+#endif
 #define BIO_write_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
                BIO_CLOSE|BIO_FP_WRITE,name)
 #define BIO_append_filename(b,name) BIO_ctrl(b,BIO_C_SET_FILENAME, \
@@ -431,6 +448,9 @@ int BIO_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 #define BIO_get_close(b)       (int)BIO_ctrl(b,BIO_CTRL_GET_CLOSE,0,NULL)
 #define BIO_pending(b)         (int)BIO_ctrl(b,BIO_CTRL_PENDING,0,NULL)
 #define BIO_wpending(b)                (int)BIO_ctrl(b,BIO_CTRL_WPENDING,0,NULL)
+/* ...pending macros have inappropriate return type */
+size_t BIO_ctrl_pending(BIO *b);
+size_t BIO_ctrl_wpending(BIO *b);
 #define BIO_flush(b)           (int)BIO_ctrl(b,BIO_CTRL_FLUSH,0,NULL)
 #define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0,(char *)cbp)
 #define BIO_set_info_callback(b,cb) (int)BIO_ctrl(b,BIO_CTRL_SET_CALLBACK,0,(char *)cb)
@@ -438,11 +458,33 @@ int BIO_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 /* For the BIO_f_buffer() type */
 #define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
 
+/* For BIO_s_bio() */
+#define BIO_set_write_buf_size(b,size) (int)BIO_ctrl(b,BIO_C_SET_WRITE_BUF_SIZE,size,NULL)
+#define BIO_get_write_buf_size(b,size) (size_t)BIO_ctrl(b,BIO_C_GET_WRITE_BUF_SIZE,size,NULL)
+#define BIO_make_bio_pair(b1,b2)   (int)BIO_ctrl(b1,BIO_C_MAKE_BIO_PAIR,0,b2)
+#define BIO_destroy_bio_pair(b)    (int)BIO_ctrl(b,BIO_C_DESTROY_BIO_PAIR,0,NULL)
+/* macros with inappropriate type -- but ...pending macros use int too: */
+#define BIO_get_write_guarantee(b) (int)BIO_ctrl(b,BIO_C_GET_WRITE_GUARANTEE,0,NULL)
+#define BIO_get_read_request(b)    (int)BIO_ctrl(b,BIO_C_GET_READ_REQUEST,0,NULL)
+size_t BIO_ctrl_get_write_guarantee(BIO *b);
+size_t BIO_ctrl_get_read_request(BIO *b);
+int BIO_ctrl_reset_read_request(BIO *b);
+
 #ifdef NO_STDIO
 #define NO_FP_API
 #endif
 
-#ifndef NOPROTO
+
+/* These two aren't currently implemented */
+/* int BIO_get_ex_num(BIO *bio); */
+/* void BIO_set_ex_free_func(BIO *bio,int idx,void (*cb)()); */
+int BIO_set_ex_data(BIO *bio,int idx,char *data);
+char *BIO_get_ex_data(BIO *bio,int idx);
+int BIO_get_ex_new_index(long argl, char *argp, int (*new_func)(),
+       int (*dup_func)(), void (*free_func)());
+unsigned long BIO_number_read(BIO *bio);
+unsigned long BIO_number_written(BIO *bio);
+
 #  if defined(WIN16) && defined(_WINDLL)
 BIO_METHOD *BIO_s_file_internal(void);
 BIO *BIO_new_file_internal(char *filename, char *mode);
@@ -452,39 +494,20 @@ BIO *BIO_new_fp_internal(FILE *stream, int close_flag);
 #    define BIO_new_fp BIO_new_fp_internal
 #  else /* FP_API */
 BIO_METHOD *BIO_s_file(void );
-BIO *BIO_new_file(char *filename, char *mode);
+BIO *BIO_new_file(const char *filename, const char *mode);
 BIO *BIO_new_fp(FILE *stream, int close_flag);
 #    define BIO_s_file_internal                BIO_s_file
 #    define BIO_new_file_internal      BIO_new_file
 #    define BIO_new_fp_internal                BIO_s_file
 #  endif /* FP_API */
-#else
-#  if defined(WIN16) && defined(_WINDLL)
-BIO_METHOD *BIO_s_file_internal();
-BIO *BIO_new_file_internal();
-BIO *BIO_new_fp_internal();
-#    define BIO_s_file BIO_s_file_internal
-#    define BIO_new_file       BIO_new_file_internal
-#    define BIO_new_fp BIO_new_fp_internal
-#  else /* FP_API */
-BIO_METHOD *BIO_s_file();
-BIO *BIO_new_file();
-BIO *BIO_new_fp();
-#    define BIO_s_file_internal                BIO_s_file
-#    define BIO_new_file_internal      BIO_new_file
-#    define BIO_new_fp_internal                BIO_s_file
-#  endif /* FP_API */
-#endif
-
-#ifndef NOPROTO
 BIO *  BIO_new(BIO_METHOD *type);
 int    BIO_set(BIO *a,BIO_METHOD *type);
 int    BIO_free(BIO *a);
-int    BIO_read(BIO *b, char *data, int len);
+int    BIO_read(BIO *b, void *data, int len);
 int    BIO_gets(BIO *bp,char *buf, int size);
-int    BIO_write(BIO *b, char *data, int len);
-int    BIO_puts(BIO *bp,char *buf);
-long   BIO_ctrl(BIO *bp,int cmd,long larg,char *parg);
+int    BIO_write(BIO *b, const char *data, int len);
+int    BIO_puts(BIO *bp,const char *buf);
+long   BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
 char * BIO_ptr_ctrl(BIO *bp,int cmd,long larg);
 long   BIO_int_ctrl(BIO *bp,int cmd,long larg,int iarg);
 BIO *  BIO_push(BIO *b,BIO *append);
@@ -495,20 +518,27 @@ BIO *     BIO_get_retry_BIO(BIO *bio, int *reason);
 int    BIO_get_retry_reason(BIO *bio);
 BIO *  BIO_dup_chain(BIO *in);
 
+int BIO_nread0(BIO *bio, char **buf);
+int BIO_nread(BIO *bio, char **buf, int num);
+int BIO_nwrite0(BIO *bio, char **buf);
+int BIO_nwrite(BIO *bio, char **buf, int num);
+
 #ifndef WIN16
-long BIO_debug_callback(BIO *bio,int cmd,char *argp,int argi,
+long BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
        long argl,long ret);
 #else
-long _far _loadds BIO_debug_callback(BIO *bio,int cmd,char *argp,int argi,
+long _far _loadds BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
        long argl,long ret);
 #endif
 
 BIO_METHOD *BIO_s_mem(void);
+BIO *BIO_new_mem_buf(void *buf, int len);
 BIO_METHOD *BIO_s_socket(void);
 BIO_METHOD *BIO_s_connect(void);
 BIO_METHOD *BIO_s_accept(void);
 BIO_METHOD *BIO_s_fd(void);
 BIO_METHOD *BIO_s_log(void);
+BIO_METHOD *BIO_s_bio(void);
 BIO_METHOD *BIO_s_null(void);
 BIO_METHOD *BIO_f_null(void);
 BIO_METHOD *BIO_f_buffer(void);
@@ -519,14 +549,22 @@ int BIO_sock_should_retry(int i);
 int BIO_sock_non_fatal_error(int error);
 int BIO_fd_should_retry(int i);
 int BIO_fd_non_fatal_error(int error);
-int BIO_dump(BIO *b,char *bytes,int len);
-
-struct hostent *BIO_gethostbyname(char *name);
+int BIO_dump(BIO *b,const char *bytes,int len);
+
+struct hostent *BIO_gethostbyname(const char *name);
+/* We might want a thread-safe interface too:
+ * struct hostent *BIO_gethostbyname_r(const char *name,
+ *     struct hostent *result, void *buffer, size_t buflen);
+ * or something similar (caller allocates a struct hostent,
+ * pointed to by "result", and additional buffer space for the various
+ * substructures; if the buffer does not suffice, NULL is returned
+ * and an appropriate error code is set).
+ */
 int BIO_sock_error(int sock);
 int BIO_socket_ioctl(int fd, long type, unsigned long *arg);
 int BIO_socket_nbio(int fd,int mode);
-int BIO_get_port(char *str, unsigned short *port_ptr);
-int BIO_get_host_ip(char *str, unsigned char *ip);
+int BIO_get_port(const char *str, unsigned short *port_ptr);
+int BIO_get_host_ip(const char *str, unsigned char *ip);
 int BIO_get_accept_socket(char *host_port,int mode);
 int BIO_accept(int sock,char **ip_port);
 int BIO_sock_init(void );
@@ -540,130 +578,24 @@ BIO *BIO_new_fd(int fd, int close_flag);
 BIO *BIO_new_connect(char *host_port);
 BIO *BIO_new_accept(char *host_port);
 
+int BIO_new_bio_pair(BIO **bio1, size_t writebuf1,
+       BIO **bio2, size_t writebuf2);
+/* If successful, returns 1 and in *bio1, *bio2 two BIO pair endpoints.
+ * Otherwise returns 0 and sets *bio1 and *bio2 to NULL.
+ * Size 0 uses default value.
+ */
+
 void BIO_copy_next_retry(BIO *b);
 
 long BIO_ghbn_ctrl(int cmd,int iarg,char *parg);
 
-#else
-
-BIO *  BIO_new();
-int    BIO_set();
-int    BIO_free();
-int    BIO_read();
-int    BIO_gets();
-int    BIO_write();
-int    BIO_puts();
-char * BIO_ptr_ctrl();
-long   BIO_ctrl();
-long   BIO_int_ctrl();
-BIO *  BIO_push();
-BIO *  BIO_pop();
-void   BIO_free_all();
-BIO *  BIO_find_type();
-BIO *  BIO_get_retry_BIO();
-int    BIO_get_retry_reason();
-BIO *  BIO_dup_chain();
-
-#ifndef WIN16
-long BIO_debug_callback();
-#else
-long _far _loadds BIO_debug_callback();
-#endif
-
-BIO_METHOD *BIO_s_mem();
-BIO_METHOD *BIO_s_socket();
-BIO_METHOD *BIO_s_connect();
-BIO_METHOD *BIO_s_accept();
-BIO_METHOD *BIO_s_fd();
-BIO_METHOD *BIO_s_log();
-BIO_METHOD *BIO_s_null();
-BIO_METHOD *BIO_f_null();
-BIO_METHOD *BIO_f_buffer();
-BIO_METHOD *BIO_f_nbio_test();
-/* BIO_METHOD *BIO_f_ber(); */
-
-int BIO_sock_should_retry();
-int BIO_sock_non_fatal_error();
-int BIO_fd_should_retry();
-int BIO_fd_non_fatal_error();
-int BIO_dump();
-
-struct hostent *BIO_gethostbyname();
-int BIO_sock_error();
-int BIO_socket_ioctl();
-int BIO_socket_nbio();
-int BIO_get_port();
-int BIO_get_host_ip();
-int BIO_get_accept_socket();
-int BIO_accept();
-int BIO_sock_init();
-void BIO_sock_cleanup();
-int BIO_set_tcp_ndelay();
-
-void ERR_load_BIO_strings();
-
-BIO *BIO_new_socket();
-BIO *BIO_new_fd();
-BIO *BIO_new_connect();
-BIO *BIO_new_accept();
-
-void BIO_copy_next_retry();
-
-long BIO_ghbn_ctrl();
-
-#endif
-
-/* Tim Hudson's portable varargs stuff */
-
-#ifndef NOPROTO
-#define VAR_ANSI       /* select ANSI version by default */
-#endif
-
-#ifdef VAR_ANSI
-/* ANSI version of a "portable" macro set for variable length args */
-#ifndef __STDARG_H__ /**/
-#include <stdarg.h>
-#endif /**/
-
-#define VAR_PLIST(arg1type,arg1)    arg1type arg1, ...
-#define VAR_PLIST2(arg1type,arg1,arg2type,arg2) arg1type arg1,arg2type arg2,...
-#define VAR_ALIST
-#define VAR_BDEFN(args,arg1type,arg1)   va_list args
-#define VAR_BDEFN2(args,arg1type,arg1,arg2type,arg2)    va_list args
-#define VAR_INIT(args,arg1type,arg1)    va_start(args,arg1);
-#define VAR_INIT2(args,arg1type,arg1,arg2type,arg2) va_start(args,arg2);
-#define VAR_ARG(args,type,arg) arg=va_arg(args,type)
-#define VAR_END(args)          va_end(args);
-
-#else
-
-/* K&R version of a "portable" macro set for variable length args */
-#ifndef __VARARGS_H__
-#include <varargs.h>
-#endif
-
-#define VAR_PLIST(arg1type,arg1)       va_alist
-#define VAR_PLIST2(arg1type,arg1,arg2type,arg2) va_alist
-#define VAR_ALIST              va_dcl
-#define VAR_BDEFN(args,arg1type,arg1)  va_list args; arg1type arg1
-#define VAR_BDEFN2(args,arg1type,arg1,arg2type,arg2)    va_list args; \
-       arg1type arg1; arg2type arg2
-#define VAR_INIT(args,arg1type,arg1)   va_start(args); \
-       arg1=va_arg(args,arg1type);
-#define VAR_INIT2(args,arg1type,arg1,arg2type,arg2) va_start(args); \
-       arg1=va_arg(args,arg1type);     arg2=va_arg(args,arg2type);
-#define VAR_ARG(args,type,arg)         arg=va_arg(args,type)
-#define VAR_END(args)                  va_end(args);
-
-#endif
-
-#ifndef NOPROTO
-int BIO_printf( VAR_PLIST( BIO *, bio ) );
-#else
-int BIO_printf();
-#endif
+int BIO_printf(BIO *bio, ...);
 
 /* BEGIN ERROR CODES */
+/* The following lines are auto generated by the script mkerr.pl. Any changes
+ * made after this point may be overwritten when the script is next run.
+ */
+
 /* Error codes for the BIO functions. */
 
 /* Function codes. */
@@ -671,12 +603,19 @@ int BIO_printf();
 #define BIO_F_BIO_ACCEPT                                101
 #define BIO_F_BIO_BER_GET_HEADER                        102
 #define BIO_F_BIO_CTRL                                  103
+#define BIO_F_BIO_GETHOSTBYNAME                                 120
 #define BIO_F_BIO_GETS                                  104
 #define BIO_F_BIO_GET_ACCEPT_SOCKET                     105
 #define BIO_F_BIO_GET_HOST_IP                           106
 #define BIO_F_BIO_GET_PORT                              107
+#define BIO_F_BIO_MAKE_PAIR                             121
 #define BIO_F_BIO_NEW                                   108
 #define BIO_F_BIO_NEW_FILE                              109
+#define BIO_F_BIO_NEW_MEM_BUF                           126
+#define BIO_F_BIO_NREAD                                         123
+#define BIO_F_BIO_NREAD0                                124
+#define BIO_F_BIO_NWRITE                                125
+#define BIO_F_BIO_NWRITE0                               122
 #define BIO_F_BIO_PUTS                                  110
 #define BIO_F_BIO_READ                                  111
 #define BIO_F_BIO_SOCK_INIT                             112
@@ -692,16 +631,19 @@ int BIO_printf();
 #define BIO_R_ACCEPT_ERROR                              100
 #define BIO_R_BAD_FOPEN_MODE                            101
 #define BIO_R_BAD_HOSTNAME_LOOKUP                       102
+#define BIO_R_BROKEN_PIPE                               124
 #define BIO_R_CONNECT_ERROR                             103
 #define BIO_R_ERROR_SETTING_NBIO                        104
 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPTED_SOCKET     105
 #define BIO_R_ERROR_SETTING_NBIO_ON_ACCEPT_SOCKET       106
 #define BIO_R_GETHOSTBYNAME_ADDR_IS_NOT_AF_INET                 107
+#define BIO_R_INVALID_ARGUMENT                          125
 #define BIO_R_INVALID_IP_ADDRESS                        108
+#define BIO_R_IN_USE                                    123
 #define BIO_R_KEEPALIVE                                         109
 #define BIO_R_NBIO_CONNECT_ERROR                        110
 #define BIO_R_NO_ACCEPT_PORT_SPECIFIED                  111
-#define BIO_R_NO_HOSTHNAME_SPECIFIED                    112
+#define BIO_R_NO_HOSTNAME_SPECIFIED                     112
 #define BIO_R_NO_PORT_DEFINED                           113
 #define BIO_R_NO_PORT_SPECIFIED                                 114
 #define BIO_R_NULL_PARAMETER                            115
@@ -709,10 +651,11 @@ int BIO_printf();
 #define BIO_R_UNABLE_TO_BIND_SOCKET                     117
 #define BIO_R_UNABLE_TO_CREATE_SOCKET                   118
 #define BIO_R_UNABLE_TO_LISTEN_SOCKET                   119
-#define BIO_R_UNINITALISED                              120
+#define BIO_R_UNINITIALIZED                             120
 #define BIO_R_UNSUPPORTED_METHOD                        121
+#define BIO_R_WRITE_TO_READ_ONLY_BIO                    126
 #define BIO_R_WSASTARTUP                                122
+
 #ifdef  __cplusplus
 }
 #endif