diff options
Diffstat (limited to 'secure/lib/libcrypto/man/BIO_f_ssl.3')
| -rw-r--r-- | secure/lib/libcrypto/man/BIO_f_ssl.3 | 239 |
1 files changed, 108 insertions, 131 deletions
diff --git a/secure/lib/libcrypto/man/BIO_f_ssl.3 b/secure/lib/libcrypto/man/BIO_f_ssl.3 index bc8580b6cfb4..0713da633b63 100644 --- a/secure/lib/libcrypto/man/BIO_f_ssl.3 +++ b/secure/lib/libcrypto/man/BIO_f_ssl.3 @@ -128,42 +128,36 @@ .rm #[ #] #H #V #F C .\" ======================================================================== .\" -.IX Title "BIO_f_ssl 3" -.TH BIO_f_ssl 3 "2018-08-14" "1.0.2p" "OpenSSL" +.IX Title "BIO_F_SSL 3" +.TH BIO_F_SSL 3 "2018-09-11" "1.1.1" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" -BIO_f_ssl, BIO_set_ssl, BIO_get_ssl, BIO_set_ssl_mode, BIO_set_ssl_renegotiate_bytes, -BIO_get_num_renegotiates, BIO_set_ssl_renegotiate_timeout, BIO_new_ssl, -BIO_new_ssl_connect, BIO_new_buffer_ssl_connect, BIO_ssl_copy_session_id, -BIO_ssl_shutdown \- SSL BIO +BIO_do_handshake, BIO_f_ssl, BIO_set_ssl, BIO_get_ssl, BIO_set_ssl_mode, BIO_set_ssl_renegotiate_bytes, BIO_get_num_renegotiates, BIO_set_ssl_renegotiate_timeout, BIO_new_ssl, BIO_new_ssl_connect, BIO_new_buffer_ssl_connect, BIO_ssl_copy_session_id, BIO_ssl_shutdown \- SSL BIO .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& #include <openssl/bio.h> \& #include <openssl/ssl.h> \& -\& BIO_METHOD *BIO_f_ssl(void); +\& const BIO_METHOD *BIO_f_ssl(void); \& -\& #define BIO_set_ssl(b,ssl,c) BIO_ctrl(b,BIO_C_SET_SSL,c,(char *)ssl) -\& #define BIO_get_ssl(b,sslp) BIO_ctrl(b,BIO_C_GET_SSL,0,(char *)sslp) -\& #define BIO_set_ssl_mode(b,client) BIO_ctrl(b,BIO_C_SSL_MODE,client,NULL) -\& #define BIO_set_ssl_renegotiate_bytes(b,num) \e -\& BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_BYTES,num,NULL); -\& #define BIO_set_ssl_renegotiate_timeout(b,seconds) \e -\& BIO_ctrl(b,BIO_C_SET_SSL_RENEGOTIATE_TIMEOUT,seconds,NULL); -\& #define BIO_get_num_renegotiates(b) \e -\& BIO_ctrl(b,BIO_C_SET_SSL_NUM_RENEGOTIATES,0,NULL); +\& long BIO_set_ssl(BIO *b, SSL *ssl, long c); +\& long BIO_get_ssl(BIO *b, SSL **sslp); +\& long BIO_set_ssl_mode(BIO *b, long client); +\& long BIO_set_ssl_renegotiate_bytes(BIO *b, long num); +\& long BIO_set_ssl_renegotiate_timeout(BIO *b, long seconds); +\& long BIO_get_num_renegotiates(BIO *b); \& -\& BIO *BIO_new_ssl(SSL_CTX *ctx,int client); +\& BIO *BIO_new_ssl(SSL_CTX *ctx, int client); \& BIO *BIO_new_ssl_connect(SSL_CTX *ctx); \& BIO *BIO_new_buffer_ssl_connect(SSL_CTX *ctx); -\& int BIO_ssl_copy_session_id(BIO *to,BIO *from); +\& int BIO_ssl_copy_session_id(BIO *to, BIO *from); \& void BIO_ssl_shutdown(BIO *bio); \& -\& #define BIO_do_handshake(b) BIO_ctrl(b,BIO_C_DO_STATE_MACHINE,0,NULL) +\& long BIO_do_handshake(BIO *b); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" @@ -196,7 +190,7 @@ manipulated using the standard \s-1SSL\s0 library functions. is 1 client mode is set. If \fBclient\fR is 0 server mode is set. .PP \&\fIBIO_set_ssl_renegotiate_bytes()\fR sets the renegotiate byte count -to \fBnum\fR. When set after every \fBnum\fR bytes of I/O (read and write) +to \fBnum\fR. When set after every \fBnum\fR bytes of I/O (read and write) the \s-1SSL\s0 session is automatically renegotiated. \fBnum\fR must be at least 512 bytes. .PP @@ -217,7 +211,7 @@ client mode if \fBclient\fR is non zero. of a buffering \s-1BIO,\s0 an \s-1SSL BIO\s0 (using \fBctx\fR) and a connect \&\s-1BIO.\s0 .PP -\&\fIBIO_ssl_copy_session_id()\fR copies an \s-1SSL\s0 session id between +\&\fIBIO_ssl_copy_session_id()\fR copies an \s-1SSL\s0 session id between \&\s-1BIO\s0 chains \fBfrom\fR and \fBto\fR. It does this by locating the \&\s-1SSL\s0 BIOs in each chain and calling \fISSL_copy_session_id()\fR on the internal \s-1SSL\s0 pointer. @@ -239,10 +233,10 @@ already been established this call has no effect. \&\s-1SSL\s0 BIOs are exceptional in that if the underlying transport is non blocking they can still request a retry in exceptional circumstances. Specifically this will happen if a session -renegotiation takes place during a \fIBIO_read()\fR operation, one +renegotiation takes place during a \fIBIO_read_ex()\fR operation, one case where this happens is when step up occurs. .PP -In OpenSSL 0.9.6 and later the \s-1SSL\s0 flag \s-1SSL_AUTO_RETRY\s0 can be +The \s-1SSL\s0 flag \s-1SSL_AUTO_RETRY\s0 can be set to disable this behaviour. That is when this flag is set an \s-1SSL BIO\s0 using a blocking transport will never request a retry. @@ -255,9 +249,10 @@ to locate the connect \s-1BIO\s0 first. Applications do not have to call \fIBIO_do_handshake()\fR but may wish to do so to separate the handshake process from other I/O processing. -.SH "RETURN VALUES" -.IX Header "RETURN VALUES" -\&\s-1TBA\s0 +.PP +\&\fIBIO_set_ssl()\fR, \fIBIO_get_ssl()\fR, \fIBIO_set_ssl_mode()\fR, +\&\fIBIO_set_ssl_renegotiate_bytes()\fR, \fIBIO_set_ssl_renegotiate_timeout()\fR, +\&\fIBIO_get_num_renegotiates()\fR, and \fIBIO_do_handshake()\fR are implemented as macros. .SH "EXAMPLE" .IX Header "EXAMPLE" This \s-1SSL/TLS\s0 client example, attempts to retrieve a page from an @@ -271,57 +266,48 @@ unencrypted example in \fIBIO_s_connect\fR\|(3). \& SSL_CTX *ctx; \& SSL *ssl; \& -\& ERR_load_crypto_strings(); -\& ERR_load_SSL_strings(); -\& OpenSSL_add_all_algorithms(); +\& /* XXX Seed the PRNG if needed. */ \& -\& /* We would seed the PRNG here if the platform didn\*(Aqt -\& * do it automatically -\& */ +\& ctx = SSL_CTX_new(TLS_client_method()); \& -\& ctx = SSL_CTX_new(SSLv23_client_method()); -\& -\& /* We\*(Aqd normally set some stuff like the verify paths and -\& * mode here because as things stand this will connect to -\& * any server whose certificate is signed by any CA. -\& */ +\& /* XXX Set verify paths and mode here. */ \& \& sbio = BIO_new_ssl_connect(ctx); -\& \& BIO_get_ssl(sbio, &ssl); -\& -\& if(!ssl) { -\& fprintf(stderr, "Can\*(Aqt locate SSL pointer\en"); -\& /* whatever ... */ +\& if (ssl == NULL) { +\& fprintf(stderr, "Can\*(Aqt locate SSL pointer\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } \& \& /* Don\*(Aqt want any retries */ \& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY); \& -\& /* We might want to do other things with ssl here */ +\& /* XXX We might want to do other things with ssl here */ \& -\& BIO_set_conn_hostname(sbio, "localhost:https"); +\& /* An empty host part means the loopback address */ +\& BIO_set_conn_hostname(sbio, ":https"); \& \& out = BIO_new_fp(stdout, BIO_NOCLOSE); -\& if(BIO_do_connect(sbio) <= 0) { -\& fprintf(stderr, "Error connecting to server\en"); -\& ERR_print_errors_fp(stderr); -\& /* whatever ... */ +\& if (BIO_do_connect(sbio) <= 0) { +\& fprintf(stderr, "Error connecting to server\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } -\& -\& if(BIO_do_handshake(sbio) <= 0) { -\& fprintf(stderr, "Error establishing SSL connection\en"); -\& ERR_print_errors_fp(stderr); -\& /* whatever ... */ +\& if (BIO_do_handshake(sbio) <= 0) { +\& fprintf(stderr, "Error establishing SSL connection\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } \& -\& /* Could examine ssl here to get connection info */ +\& /* XXX Could examine ssl here to get connection info */ \& \& BIO_puts(sbio, "GET / HTTP/1.0\en\en"); -\& for(;;) { -\& len = BIO_read(sbio, tmpbuf, 1024); -\& if(len <= 0) break; -\& BIO_write(out, tmpbuf, len); +\& for (;;) { +\& len = BIO_read(sbio, tmpbuf, 1024); +\& if (len <= 0) +\& break; +\& BIO_write(out, tmpbuf, len); \& } \& BIO_free_all(sbio); \& BIO_free(out); @@ -339,116 +325,107 @@ a client and also echoes the request to standard output. \& SSL_CTX *ctx; \& SSL *ssl; \& -\& ERR_load_crypto_strings(); -\& ERR_load_SSL_strings(); -\& OpenSSL_add_all_algorithms(); +\& /* XXX Seed the PRNG if needed. */ \& -\& /* Might seed PRNG here */ -\& -\& ctx = SSL_CTX_new(SSLv23_server_method()); -\& -\& if (!SSL_CTX_use_certificate_file(ctx,"server.pem",SSL_FILETYPE_PEM) -\& || !SSL_CTX_use_PrivateKey_file(ctx,"server.pem",SSL_FILETYPE_PEM) -\& || !SSL_CTX_check_private_key(ctx)) { -\& -\& fprintf(stderr, "Error setting up SSL_CTX\en"); -\& ERR_print_errors_fp(stderr); -\& return 0; +\& ctx = SSL_CTX_new(TLS_server_method()); +\& if (!SSL_CTX_use_certificate_file(ctx, "server.pem", SSL_FILETYPE_PEM) +\& || !SSL_CTX_use_PrivateKey_file(ctx, "server.pem", SSL_FILETYPE_PEM) +\& || !SSL_CTX_check_private_key(ctx)) { +\& fprintf(stderr, "Error setting up SSL_CTX\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } \& -\& /* Might do other things here like setting verify locations and -\& * DH and/or RSA temporary key callbacks -\& */ +\& /* XXX Other things like set verify locations, EDH temp callbacks. */ \& \& /* New SSL BIO setup as server */ -\& sbio=BIO_new_ssl(ctx,0); -\& +\& sbio = BIO_new_ssl(ctx, 0); \& BIO_get_ssl(sbio, &ssl); -\& -\& if(!ssl) { -\& fprintf(stderr, "Can\*(Aqt locate SSL pointer\en"); -\& /* whatever ... */ +\& if (ssl == NULL) { +\& fprintf(stderr, "Can\*(Aqt locate SSL pointer\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } \& -\& /* Don\*(Aqt want any retries */ \& SSL_set_mode(ssl, SSL_MODE_AUTO_RETRY); -\& -\& /* Create the buffering BIO */ -\& \& bbio = BIO_new(BIO_f_buffer()); -\& -\& /* Add to chain */ \& sbio = BIO_push(bbio, sbio); +\& acpt = BIO_new_accept("4433"); \& -\& acpt=BIO_new_accept("4433"); -\& -\& /* By doing this when a new connection is established +\& /* +\& * By doing this when a new connection is established \& * we automatically have sbio inserted into it. The \& * BIO chain is now \*(Aqswallowed\*(Aq by the accept BIO and -\& * will be freed when the accept BIO is freed. +\& * will be freed when the accept BIO is freed. \& */ -\& -\& BIO_set_accept_bios(acpt,sbio); -\& +\& BIO_set_accept_bios(acpt, sbio); \& out = BIO_new_fp(stdout, BIO_NOCLOSE); \& \& /* Setup accept BIO */ -\& if(BIO_do_accept(acpt) <= 0) { -\& fprintf(stderr, "Error setting up accept BIO\en"); -\& ERR_print_errors_fp(stderr); -\& return 0; -\& } -\& -\& /* Now wait for incoming connection */ -\& if(BIO_do_accept(acpt) <= 0) { -\& fprintf(stderr, "Error in connection\en"); -\& ERR_print_errors_fp(stderr); -\& return 0; +\& if (BIO_do_accept(acpt) <= 0) { +\& fprintf(stderr, "Error setting up accept BIO\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } \& -\& /* We only want one connection so remove and free -\& * accept BIO -\& */ -\& +\& /* We only want one connection so remove and free accept BIO */ \& sbio = BIO_pop(acpt); -\& \& BIO_free_all(acpt); \& -\& if(BIO_do_handshake(sbio) <= 0) { -\& fprintf(stderr, "Error in SSL handshake\en"); -\& ERR_print_errors_fp(stderr); -\& return 0; +\& if (BIO_do_handshake(sbio) <= 0) { +\& fprintf(stderr, "Error in SSL handshake\en"); +\& ERR_print_errors_fp(stderr); +\& exit(1); \& } \& \& BIO_puts(sbio, "HTTP/1.0 200 OK\er\enContent\-type: text/plain\er\en\er\en"); \& BIO_puts(sbio, "\er\enConnection Established\er\enRequest headers:\er\en"); \& BIO_puts(sbio, "\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\er\en"); \& -\& for(;;) { -\& len = BIO_gets(sbio, tmpbuf, 1024); -\& if(len <= 0) break; -\& BIO_write(sbio, tmpbuf, len); -\& BIO_write(out, tmpbuf, len); -\& /* Look for blank line signifying end of headers*/ -\& if((tmpbuf[0] == \*(Aq\er\*(Aq) || (tmpbuf[0] == \*(Aq\en\*(Aq)) break; +\& for (;;) { +\& len = BIO_gets(sbio, tmpbuf, 1024); +\& if (len <= 0) +\& break; +\& BIO_write(sbio, tmpbuf, len); +\& BIO_write(out, tmpbuf, len); +\& /* Look for blank line signifying end of headers*/ +\& if (tmpbuf[0] == \*(Aq\er\*(Aq || tmpbuf[0] == \*(Aq\en\*(Aq) +\& break; \& } \& \& BIO_puts(sbio, "\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\er\en"); \& BIO_puts(sbio, "\er\en"); -\& -\& /* Since there is a buffering BIO present we had better flush it */ \& BIO_flush(sbio); -\& \& BIO_free_all(sbio); .Ve -.SH "BUGS" -.IX Header "BUGS" -In OpenSSL versions before 1.0.0 the \fIBIO_pop()\fR call was handled incorrectly, +.SH "RETURN VALUES" +.IX Header "RETURN VALUES" +\&\fIBIO_f_ssl()\fR returns the \s-1SSL\s0 \fB\s-1BIO_METHOD\s0\fR structure. +.PP +\&\fIBIO_set_ssl()\fR, \fIBIO_get_ssl()\fR, \fIBIO_set_ssl_mode()\fR, \fIBIO_set_ssl_renegotiate_bytes()\fR, +\&\fIBIO_set_ssl_renegotiate_timeout()\fR and \fIBIO_get_num_renegotiates()\fR return 1 on +success or a value which is less than or equal to 0 if an error occurred. +.PP +\&\fIBIO_new_ssl()\fR, \fIBIO_new_ssl_connect()\fR and \fIBIO_new_buffer_ssl_connect()\fR return +a valid \fB\s-1BIO\s0\fR structure on success or \fB\s-1NULL\s0\fR if an error occurred. +.PP +\&\fIBIO_ssl_copy_session_id()\fR returns 1 on success or 0 on error. +.PP +\&\fIBIO_do_handshake()\fR returns 1 if the connection was established successfully. +A zero or negative value is returned if the connection could not be established. +.SH "HISTORY" +.IX Header "HISTORY" +In OpenSSL before 1.0.0 the \fIBIO_pop()\fR call was handled incorrectly, the I/O \s-1BIO\s0 reference count was incorrectly incremented (instead of decremented) and dissociated with the \s-1SSL BIO\s0 even if the \s-1SSL BIO\s0 was not explicitly being popped (e.g. a pop higher up the chain). Applications which included workarounds for this bug (e.g. freeing BIOs more than once) should be modified to handle this fix or they may free up an already freed \s-1BIO.\s0 -.SH "SEE ALSO" -.IX Header "SEE ALSO" -\&\s-1TBA\s0 +.SH "COPYRIGHT" +.IX Header "COPYRIGHT" +Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved. +.PP +Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file \s-1LICENSE\s0 in the source distribution or at +<https://www.openssl.org/source/license.html>. |