8ed91929bba214f6b474abd64795fb5267b9e230
[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 functio 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, except when a
38 renegotiation take place, in which case a SSL_ERROR_WANT_READ may occur.
39 This behaviour can be controlled with the SSL_MODE_AUTO_RETRY flag of the
40 L<SSL_CTX_set_mode(3)> call.
41
42 If the underlying BIO is B<non-blocking> the write functions will also return
43 when the underlying BIO could not satisfy the needs of the function to continue
44 the operation. In this case a call to L<SSL_get_error(3)> with the
45 return value of the write function will yield B<SSL_ERROR_WANT_READ>
46 or B<SSL_ERROR_WANT_WRITE>. As at any time a re-negotiation is possible, a
47 call to a write function can also cause read operations! The calling process
48 then must repeat the call after taking appropriate action to satisfy the needs
49 of the write function. The action depends on the underlying BIO. When using a
50 non-blocking socket, nothing is to be done, but select() can be used to check
51 for the required condition. When using a buffering BIO, like a BIO pair, data
52 must be written into or retrieved out of the BIO before being able to continue.
53
54 The write functions will only return with success when the complete contents of
55 B<buf> of length B<num> has been written. This default behaviour can be changed
56 with the SSL_MODE_ENABLE_PARTIAL_WRITE option of L<SSL_CTX_set_mode(3)>. When
57 this flag is set the write functions will also return with success when a
58 partial write has been successfully completed. In this case the write function
59 operation is considered completed. The bytes are sent and a new write call with
60 a new buffer (with the already sent bytes removed) must be started. A partial
61 write is performed with the size of a message block, which is 16kB.
62
63 =head1 WARNING
64
65 When a write function call has to be repeated because L<SSL_get_error(3)>
66 returned B<SSL_ERROR_WANT_READ> or B<SSL_ERROR_WANT_WRITE>, it must be repeated
67 with the same arguments.
68
69 When calling the write functions with num=0 bytes to be sent the behaviour is
70 undefined.
71
72 =head1 RETURN VALUES
73
74 SSL_write_ex() will return 1 for success or 0 for failure. Success means that
75 all requested application data bytes have been written to the SSL connection or,
76 if SSL_MODE_ENABLE_PARTIAL_WRITE is in use, at least 1 application data byte has
77 been written to the SSL connection. Failure means that not all the requested
78 bytes have been written yet (if SSL_MODE_ENABLE_PARTIAL_WRITE is not in use) or
79 no bytes could be written to the SSL connection (if
80 SSL_MODE_ENABLE_PARTIAL_WRITE is in use). Failures can be retryable (e.g. the
81 network write buffer has temporarily filled up) or non-retryable (e.g. a fatal
82 network error). In the event of a failure call L<SSL_get_error(3)> to find out
83 the reason which indicates whether the call is retryable or not.
84
85 For SSL_write() the following return values can occur:
86
87 =over 4
88
89 =item E<gt>0
90
91 The write operation was successful, the return value is the number of
92 bytes actually written to the TLS/SSL connection.
93
94 =item Z<>0
95
96 The write operation was not successful. Probably the underlying connection
97 was closed. Call SSL_get_error() with the return value B<ret> to find out,
98 whether an error occurred or the connection was shut down cleanly
99 (SSL_ERROR_ZERO_RETURN).
100
101 =item E<lt>0
102
103 The write operation was not successful, because either an error occurred
104 or action must be taken by the calling process. Call SSL_get_error() with the
105 return value B<ret> to find out the reason.
106
107 =back
108
109 =head1 SEE ALSO
110
111 L<SSL_get_error(3)>, L<SSL_read_ex(3)>, L<SSL_read(3)>
112 L<SSL_CTX_set_mode(3)>, L<SSL_CTX_new(3)>,
113 L<SSL_connect(3)>, L<SSL_accept(3)>
114 L<SSL_set_connect_state(3)>,
115 L<ssl(7)>, L<bio(7)>
116
117 =head1 COPYRIGHT
118
119 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
120
121 Licensed under the OpenSSL license (the "License").  You may not use
122 this file except in compliance with the License.  You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 L<https://www.openssl.org/source/license.html>.
125
126 =cut