Rename new BIO_set_shutdown_wr macro to just BIO_shutdown_wr
[openssl.git] / crypto / bio / bio.h
index b2871c7235c912e995926cab0f5a58c312c76b77..b7ab20677766f2a45a93afe8d8f16db29eb1b9ed 100644 (file)
 #ifndef HEADER_BIO_H
 #define HEADER_BIO_H
 
-#ifdef  __cplusplus
-extern "C" {
+#ifndef NO_FP_API
+# include <stdio.h>
 #endif
+#include <stdarg.h>
 
-#include <stdio.h>
 #include <openssl/crypto.h>
 
+#ifdef  __cplusplus
+extern "C" {
+#endif
+
 /* These are the 'types' of BIOs */
 #define BIO_TYPE_NONE          0
 #define BIO_TYPE_MEM           (1|0x0400)
@@ -75,7 +79,7 @@ extern "C" {
 #define BIO_TYPE_SOCKET                (5|0x0400|0x0100)
 #define BIO_TYPE_NULL          (6|0x0400)
 #define BIO_TYPE_SSL           (7|0x0200)
-#define BIO_TYPE_MD            (8|0x0200)              /* pasive filter */
+#define BIO_TYPE_MD            (8|0x0200)              /* passive filter */
 #define BIO_TYPE_BUFFER                (9|0x0200)              /* filter */
 #define BIO_TYPE_CIPHER                (10|0x0200)             /* filter */
 #define BIO_TYPE_BASE64                (11|0x0200)             /* filter */
@@ -86,6 +90,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
@@ -145,6 +150,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) \
@@ -161,7 +171,7 @@ extern "C" {
 #define BIO_get_retry_flags(b) \
                ((b)->flags&(BIO_FLAGS_RWS|BIO_FLAGS_SHOULD_RETRY))
 
-/* These shouldbe used by the application to tell why we should retry */
+/* These should be used by the application to tell why we should retry */
 #define BIO_should_read(a)             ((a)->flags & BIO_FLAGS_READ)
 #define BIO_should_write(a)            ((a)->flags & BIO_FLAGS_WRITE)
 #define BIO_should_io_special(a)       ((a)->flags & BIO_FLAGS_IO_SPECIAL)
@@ -200,18 +210,23 @@ extern "C" {
 #define BIO_method_name(b)             ((b)->method->name)
 #define BIO_method_type(b)             ((b)->method->type)
 
+typedef struct bio_st BIO;
+
+typedef void bio_info_cb(struct bio_st *, int, const char *, int, long, long);
+
 #ifndef WIN16
 typedef struct bio_method_st
        {
        int type;
        const char *name;
-       int (*bwrite)();
-       int (*bread)();
-       int (*bputs)();
-       int (*bgets)();
-       long (*ctrl)();
-       int (*create)();
-       int (*destroy)();
+       int (*bwrite)(BIO *, const char *, int);
+       int (*bread)(BIO *, char *, int);
+       int (*bputs)(BIO *, const char *);
+       int (*bgets)(BIO *, char *, int);
+       long (*ctrl)(BIO *, int, long, void *);
+       int (*create)(BIO *);
+       int (*destroy)(BIO *);
+        long (*callback_ctrl)(BIO *, int, bio_info_cb *);
        } BIO_METHOD;
 #else
 typedef struct bio_method_st
@@ -225,10 +240,11 @@ typedef struct bio_method_st
        long (_far *ctrl)();
        int (_far *create)();
        int (_far *destroy)();
+       long (_fat *callback_ctrl)();
        } BIO_METHOD;
 #endif
 
-typedef struct bio_st
+struct bio_st
        {
        BIO_METHOD *method;
        /* bio, mode, argp, argi, argl, ret */
@@ -240,7 +256,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;
@@ -248,7 +264,9 @@ typedef struct bio_st
        unsigned long num_write;
 
        CRYPTO_EX_DATA ex_data;
-       } BIO;
+       };
+
+DECLARE_STACK_OF(BIO)
 
 typedef struct bio_f_buffer_ctx_struct
        {
@@ -276,9 +294,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
@@ -316,7 +331,21 @@ typedef struct bio_f_buffer_ctx_struct
 #define BIO_C_GET_SOCKS                                134
 #define BIO_C_SET_SOCKS                                135
 
-#define BIO_set_app_data(s,arg)                BIO_set_ex_data(s,0,(char *)arg)
+#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,arg)
 #define BIO_get_app_data(s)            BIO_get_ex_data(s,0)
 
 /* BIO_s_connect() and BIO_s_socks4a_connect() */
@@ -355,7 +384,7 @@ typedef struct bio_f_buffer_ctx_struct
 /* BIO_set_nbio(b,n) */
 #define BIO_set_filter_bio(b,s) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,2,(char *)(s))
 /* BIO *BIO_get_filter_bio(BIO *bio); */
-#define BIO_set_proxy_cb(b,cb) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(char *)(cb))
+#define BIO_set_proxy_cb(b,cb) BIO_callback_ctrl(b,BIO_C_SET_PROXY_PARAM,3,(void *(*cb)()))
 #define BIO_set_proxy_header(b,sk) BIO_ctrl(b,BIO_C_SET_PROXY_PARAM,4,(char *)sk)
 #define BIO_set_no_connect_return(b,bool) BIO_int_ctrl(b,BIO_C_SET_PROXY_PARAM,5,bool)
 
@@ -430,26 +459,40 @@ int BIO_read_filename(BIO *b,const char *name);
 #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)
+#define BIO_get_info_callback(b,cbp) (int)BIO_ctrl(b,BIO_CTRL_GET_CALLBACK,0,(bio_info_cb **)(cbp))
+#define BIO_set_info_callback(b,cb) (int)BIO_callback_ctrl(b,BIO_CTRL_SET_CALLBACK,(bio_info_cb *)(cb))
 
 /* For the BIO_f_buffer() type */
 #define BIO_buffer_get_num_lines(b) BIO_ctrl(b,BIO_CTRL_GET,0,NULL)
 
-#ifdef NO_STDIO
-#define NO_FP_API
-#endif
-
+/* 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)
+#define BIO_shutdown_wr(b) (int)BIO_ctrl(b, BIO_C_SHUTDOWN_WR, 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);
 
 /* 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)());
-
+int BIO_set_ex_data(BIO *bio,int idx,void *data);
+void *BIO_get_ex_data(BIO *bio,int idx);
+int BIO_get_ex_new_index(long argl, void *argp, CRYPTO_EX_new *new_func,
+       CRYPTO_EX_dup *dup_func, CRYPTO_EX_free *free_func);
+unsigned long BIO_number_read(BIO *bio);
+unsigned long BIO_number_written(BIO *bio);
+
+# ifndef NO_FP_API
 #  if defined(WIN16) && defined(_WINDLL)
 BIO_METHOD *BIO_s_file_internal(void);
 BIO *BIO_new_file_internal(char *filename, char *mode);
@@ -459,30 +502,39 @@ 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 */
+# endif
 BIO *  BIO_new(BIO_METHOD *type);
 int    BIO_set(BIO *a,BIO_METHOD *type);
 int    BIO_free(BIO *a);
+void   BIO_vfree(BIO *a);
 int    BIO_read(BIO *b, void *data, int len);
 int    BIO_gets(BIO *bp,char *buf, int size);
-int    BIO_write(BIO *b, const char *data, int len);
+int    BIO_write(BIO *b, const void *data, int len);
 int    BIO_puts(BIO *bp,const char *buf);
-long   BIO_ctrl(BIO *bp,int cmd,long larg,char *parg);
+long   BIO_ctrl(BIO *bp,int cmd,long larg,void *parg);
+long BIO_callback_ctrl(BIO *b, int cmd, void (*fp)(struct bio_st *, int, const char *, int, long, long));
 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);
 BIO *  BIO_pop(BIO *b);
 void   BIO_free_all(BIO *a);
 BIO *  BIO_find_type(BIO *b,int bio_type);
+BIO *  BIO_next(BIO *b);
 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,const char *argp,int argi,
        long argl,long ret);
@@ -492,11 +544,13 @@ long _far _loadds BIO_debug_callback(BIO *bio,int cmd,const char *argp,int argi,
 #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);
@@ -508,8 +562,17 @@ 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,const char *bytes,int len);
+int BIO_dump_indent(BIO *b,const char *bytes,int len,int indent);
 
 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);
@@ -528,11 +591,21 @@ 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);
 
-int BIO_printf(BIO *bio, ...);
+int BIO_printf(BIO *bio, const char *format, ...);
+int BIO_vprintf(BIO *bio, const char *format, va_list args);
+int BIO_snprintf(char *buf, size_t n, const char *format, ...);
+int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args);
 
 /* BEGIN ERROR CODES */
 /* The following lines are auto generated by the script mkerr.pl. Any changes
@@ -546,19 +619,28 @@ int BIO_printf(BIO *bio, ...);
 #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
 #define BIO_F_BIO_WRITE                                         113
 #define BIO_F_BUFFER_CTRL                               114
+#define BIO_F_CONN_CTRL                                         127
 #define BIO_F_CONN_STATE                                115
 #define BIO_F_FILE_CTRL                                         116
+#define BIO_F_MEM_READ                                  128
 #define BIO_F_MEM_WRITE                                         117
 #define BIO_F_SSL_NEW                                   118
 #define BIO_F_WSASTARTUP                                119
@@ -567,12 +649,16 @@ int BIO_printf(BIO *bio, ...);
 #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_EOF_ON_MEMORY_BIO                                 127
 #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
@@ -586,6 +672,7 @@ int BIO_printf(BIO *bio, ...);
 #define BIO_R_UNABLE_TO_LISTEN_SOCKET                   119
 #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