Update various man pages to place HISTORY section after SEE ALSO
[openssl.git] / doc / man3 / SSL_write.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_write_ex, SSL_write - write bytes to a TLS/SSL connection
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  int SSL_write_ex(SSL *s, const void *buf, size_t num, size_t *written);
12  int SSL_write(SSL *ssl, const void *buf, int num);
13
14 =head1 DESCRIPTION
15
16 SSL_write_ex() and SSL_write() write B<num> bytes from the buffer B<buf> into
17 the specified B<ssl> connection. On success SSL_write_ex() will store the number
18 of bytes written in B<*written>.
19
20 =head1 NOTES
21
22 In the paragraphs below a "write function" is defined as one of either
23 SSL_write_ex(), or SSL_write().
24
25 If necessary, a write function will negotiate a TLS/SSL session, if not already
26 explicitly performed by L<SSL_connect(3)> or L<SSL_accept(3)>. If the peer
27 requests a re-negotiation, it will be performed transparently during
28 the write function operation. The behaviour of the write functions depends on the
29 underlying BIO.
30
31 For the transparent negotiation to succeed, the B<ssl> must have been
32 initialized to client or server mode. This is being done by calling
33 L<SSL_set_connect_state(3)> or SSL_set_accept_state()
34 before the first call to a write function.
35
36 If the underlying BIO is B<blocking>, the write functions will only return, once
37 the write operation has been finished or an error occurred.
38
39 If the underlying BIO is B<non-blocking> the write functions will also return
40 when the underlying BIO could not satisfy the needs of the function to continue
41 the operation. In this case a call to L<SSL_get_error(3)> with the
42 return value of the write function will yield B<SSL_ERROR_WANT_READ>
43 or B<SSL_ERROR_WANT_WRITE>. As at any time a re-negotiation is possible, a
44 call to a write function can also cause read operations! The calling process
45 then must repeat the call after taking appropriate action to satisfy the needs
46 of the write function. The action depends on the underlying BIO. When using a
47 non-blocking socket, nothing is to be done, but select() can be used to check
48 for the required condition. When using a buffering BIO, like a BIO pair, data
49 must be written into or retrieved out of the BIO before being able to continue.
50
51 The write functions will only return with success when the complete contents of
52 B<buf> of length B<num> has been written. This default behaviour can be changed
53 with the SSL_MODE_ENABLE_PARTIAL_WRITE option of L<SSL_CTX_set_mode(3)>. When
54 this flag is set the write functions will also return with success when a
55 partial write has been successfully completed. In this case the write function
56 operation is considered completed. The bytes are sent and a new write call with
57 a new buffer (with the already sent bytes removed) must be started. A partial
58 write is performed with the size of a message block, which is 16kB.
59
60 =head1 WARNING
61
62 When a write function call has to be repeated because L<SSL_get_error(3)>
63 returned B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
64 with the same arguments.
65 The data that was passed might have been partially processed.
66 When B<SSL_MODE_ACCEPT_MOVING_WRITE_BUFFER> was set using L<SSL_CTX_set_mode(3)>
67 the pointer can be different, but the data and length should still be the same.
68
69 You should not call SSL_write() with num=0, it will return an error.
70 SSL_write_ex() can be called with num=0, but will not send application data to
71 the peer.
72
73 =head1 RETURN VALUES
74
75 SSL_write_ex() will return 1 for success or 0 for failure. Success means that
76 all requested application data bytes have been written to the SSL connection or,
77 if SSL_MODE_ENABLE_PARTIAL_WRITE is in use, at least 1 application data byte has
78 been written to the SSL connection. Failure means that not all the requested
79 bytes have been written yet (if SSL_MODE_ENABLE_PARTIAL_WRITE is not in use) or
80 no bytes could be written to the SSL connection (if
81 SSL_MODE_ENABLE_PARTIAL_WRITE is in use). Failures can be retryable (e.g. the
82 network write buffer has temporarily filled up) or non-retryable (e.g. a fatal
83 network error). In the event of a failure call L<SSL_get_error(3)> to find out
84 the reason which indicates whether the call is retryable or not.
85
86 For SSL_write() the following return values can occur:
87
88 =over 4
89
90 =item E<gt> 0
91
92 The write operation was successful, the return value is the number of
93 bytes actually written to the TLS/SSL connection.
94
95 =item Z<><= 0
96
97 The write operation was not successful, because either the connection was
98 closed, an error occurred or action must be taken by the calling process.
99 Call SSL_get_error() with the return value B<ret> to find out the reason.
100
101 Old documentation indicated a difference between 0 and -1, and that -1 was
102 retryable.
103 You should instead call SSL_get_error() to find out if it's retryable.
104
105 =back
106
107 =head1 SEE ALSO
108
109 L<SSL_get_error(3)>, L<SSL_read_ex(3)>, L<SSL_read(3)>
110 L<SSL_CTX_set_mode(3)>, L<SSL_CTX_new(3)>,
111 L<SSL_connect(3)>, L<SSL_accept(3)>
112 L<SSL_set_connect_state(3)>,
113 L<ssl(7)>, L<bio(7)>
114
115 =head1 HISTORY
116
117 The SSL_write_ex() function was added in OpenSSL 1.1.1.
118
119 =head1 COPYRIGHT
120
121 Copyright 2000-2019 The OpenSSL Project Authors. All Rights Reserved.
122
123 Licensed under the Apache License 2.0 (the "License").  You may not use
124 this file except in compliance with the License.  You can obtain a copy
125 in the file LICENSE in the source distribution or at
126 L<https://www.openssl.org/source/license.html>.
127
128 =cut