TLSv1.3: additional checks in SSL_set_record_padding_callback
[openssl.git] / doc / man3 / SSL_CTX_set_record_padding_callback.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_set_record_padding_callback,
6 SSL_set_record_padding_callback,
7 SSL_CTX_set_record_padding_callback_arg,
8 SSL_set_record_padding_callback_arg,
9 SSL_CTX_get_record_padding_callback_arg,
10 SSL_get_record_padding_callback_arg,
11 SSL_CTX_set_block_padding,
12 SSL_set_block_padding - install callback to specify TLS 1.3 record padding
13
14 =head1 SYNOPSIS
15
16  #include <openssl/ssl.h>
17
18  void SSL_CTX_set_record_padding_callback(SSL_CTX *ctx, size_t (*cb)(SSL *s, int type, size_t len, void *arg));
19  int SSL_set_record_padding_callback(SSL *ssl, size_t (*cb)(SSL *s, int type, size_t len, void *arg));
20
21  void SSL_CTX_set_record_padding_callback_arg(SSL_CTX *ctx, void *arg);
22  void *SSL_CTX_get_record_padding_callback_arg(const SSL_CTX *ctx);
23
24  void SSL_set_record_padding_callback_arg(SSL *ssl, void *arg);
25  void *SSL_get_record_padding_callback_arg(const SSL *ssl);
26
27  int SSL_CTX_set_block_padding(SSL_CTX *ctx, size_t block_size);
28  int SSL_set_block_padding(SSL *ssl, size_t block_size);
29
30 =head1 DESCRIPTION
31
32 SSL_CTX_set_record_padding_callback() or SSL_set_record_padding_callback()
33 can be used to assign a callback function I<cb> to specify the padding
34 for TLS 1.3 records. The value set in B<ctx> is copied to a new SSL by SSL_new().
35 Kernel TLS is not possible if the record padding callback is set, and the callback
36 function cannot be set if Kernel TLS is already configured for the current SSL object.
37
38 SSL_CTX_set_record_padding_callback_arg() and SSL_set_record_padding_callback_arg()
39 assign a value B<arg> that is passed to the callback when it is invoked. The value
40 set in B<ctx> is copied to a new SSL by SSL_new().
41
42 SSL_CTX_get_record_padding_callback_arg() and SSL_get_record_padding_callback_arg()
43 retrieve the B<arg> value that is passed to the callback.
44
45 SSL_CTX_set_block_padding() and SSL_set_block_padding() pads the record to a multiple
46 of the B<block_size>. A B<block_size> of 0 or 1 disables block padding. The limit of
47 B<block_size> is SSL3_RT_MAX_PLAIN_LENGTH.
48
49 The callback is invoked for every record before encryption.
50 The B<type> parameter is the TLS record type that is being processed; may be
51 one of SSL3_RT_APPLICATION_DATA, SSL3_RT_HANDSHAKE, or SSL3_RT_ALERT.
52 The B<len> parameter is the current plaintext length of the record before encryption.
53 The B<arg> parameter is the value set via SSL_CTX_set_record_padding_callback_arg()
54 or SSL_set_record_padding_callback_arg().
55
56 =head1 RETURN VALUES
57
58 The SSL_CTX_get_record_padding_callback_arg() and SSL_get_record_padding_callback_arg()
59 functions return the B<arg> value assigned in the corresponding set functions.
60
61 The SSL_CTX_set_block_padding() and SSL_set_block_padding() functions return 1 on success
62 or 0 if B<block_size> is too large.
63
64 The B<cb> returns the number of padding bytes to add to the record. A return of 0
65 indicates no padding will be added. A return value that causes the record to
66 exceed the maximum record size (SSL3_RT_MAX_PLAIN_LENGTH) will pad out to the
67 maximum record size.
68
69 The SSL_CTX_get_record_padding_callback_arg() function returns 1 on success or 0 if
70 the callback function is not set because Kernel TLS is configured for the SSL object.
71
72 =head1 NOTES
73
74 The default behavior is to add no padding to the record.
75
76 A user-supplied padding callback function will override the behavior set by
77 SSL_set_block_padding() or SSL_CTX_set_block_padding(). Setting the user-supplied
78 callback to NULL will restore the configured block padding behavior.
79
80 These functions only apply to TLS 1.3 records being written.
81
82 Padding bytes are not added in constant-time.
83
84 =head1 SEE ALSO
85
86 L<ssl(7)>, L<SSL_new(3)>
87
88 =head1 HISTORY
89
90 The record padding API was added for TLS 1.3 support in OpenSSL 1.1.1.
91
92 The return type of SSL_CTX_set_record_padding_callback() function was
93 changed to int in OpenSSL 3.0.
94
95 =head1 COPYRIGHT
96
97 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
98
99 Licensed under the Apache License 2.0 (the "License").  You may not use
100 this file except in compliance with the License.  You can obtain a copy
101 in the file LICENSE in the source distribution or at
102 L<https://www.openssl.org/source/license.html>.
103
104 =cut