880576d741f53372d9dbae013777babde6cf7df7
[openssl.git] / doc / man3 / SSL_CTX_set_early_cb.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_CTX_set_early_cb, SSL_early_cb_fn, SSL_early_isv2, SSL_early_get0_legacy_version, SSL_early_get0_random, SSL_early_get0_session_id, SSL_early_get0_ciphers, SSL_early_get0_compression_methods, SSL_early_get0_ext - callback functions for early server-side ClientHello processing
6
7 =head1 SYNOPSIS
8
9  typedef int (*SSL_early_cb_fn)(SSL *s, int *al, void *arg);
10  void SSL_CTX_set_early_cb(SSL_CTX *c, SSL_early_cb_fn *f, void *arg);
11  int SSL_early_isv2(SSL *s);
12  unsigned int SSL_early_get0_legacy_version(SSL *s);
13  size_t SSL_early_get0_random(SSL *s, const unsigned char **out);
14  size_t SSL_early_get0_session_id(SSL *s, const unsigned char **out);
15  size_t SSL_early_get0_ciphers(SSL *s, const unsigned char **out);
16  size_t SSL_early_get0_compression_methods(SSL *s, const unsigned char **out);
17  int SSL_early_get0_ext(SSL *s, int type, const unsigned char **out,
18                         size_t *outlen);
19
20 =head1 DESCRIPTION
21
22 SSL_CTX_set_early_cb() sets the callback function, which is automatically
23 called during the early stages of ClientHello processing on the server.
24 The argument supplied when setting the callback is passed back to the
25 callback at runtime.  A callback that returns failure (0) will cause the
26 connection to terminate, and callbacks returning failure should indicate
27 what alert value is to be sent in the B<al> parameter.  A callback may
28 also return a negative value to suspend the handshake, and the handshake
29 function will return immediately.  L<SSL_get_error(3)> will return
30 SSL_ERROR_WANT_EARLY to indicate that the handshake was suspended.
31 It is the job of the early callback to store information about the state
32 of the last call if needed to continue.  On the next call into the handshake
33 function, the early callback will be called again, and, if it returns
34 success, normal handshake processing will continue from that point.
35
36 SSL_early_isv2() indicates whether the ClientHello was carried in a
37 SSLv2 record and is in the SSLv2 format.  The SSLv2 format has substantial
38 differences from the normal SSLv3 format, including using three bytes per
39 cipher suite, and not allowing extensions.  Additionally, the SSLv2 format
40 'challenge' field is exposed via SSL_early_get0_random(), padded to
41 SSL3_RANDOM_SIZE bytes with zeros if needed.  For SSLv2 format ClientHellos,
42 SSL_early_get0_compression_methods() returns a dummy list that only includes
43 the null compression method, since the SSLv2 format does not include a
44 mechanism by which to negotiate compression.
45
46 SSL_early_get0_random(), SSL_early_get0_session_id(), SSL_early_get0_ciphers(),
47 and SSL_early_get0_compression_methods() provide access to the corresponding
48 ClientHello fields, returning the field length and optionally setting an
49 out pointer to the octets of that field.
50
51 Similarly, SSL_early_get0_ext() provides access to individual extensions
52 from the ClientHello on a per-extension basis.  For the provided wire
53 protocol extension type value, the extension value and length are returned
54 in the output parameters (if present).
55
56 =head1 NOTES
57
58 The early callback provides a vast window of possibilities for application
59 code to affect the TLS handshake.  A primary use of the callback is to
60 allow the server to examine the server name indication extension provided
61 by the client in order to select an appropriate certificate to present,
62 and make other configuration adjustments relevant to that server name
63 and its configuration.  Such configuration changes can include swapping out
64 the associated SSL_CTX pointer, modifying the server's list of permitted TLS
65 versions, changing the server's cipher list in response to the client's
66 cipher list, etc.
67
68 It is also recommended that applications utilize an early callback and
69 not use a servername callback, in order to avoid unexpected behavior that
70 occurs due to the relative order of processing between things like session
71 resumption and the historical servername callback.
72
73 The SSL_early_* family of functions may only be called from code executing
74 within an early callback.
75
76 =head1 RETURN VALUES
77
78 The application's supplied early callback returns 1 on success, 0 on failure,
79 and a negative value to suspend processing.
80
81 SSL_early_isv2() returns 1 for SSLv2-format ClientHellos and 0 otherwise.
82
83 SSL_early_get0_random(), SSL_early_get0_session_id(), SSL_early_get0_ciphers(),
84 and SSL_early_get0_compression_methods() return the length of the corresponding
85 ClientHello fields.  If zero is returned, the ouput pointer should not be
86 assumed to be valid.
87
88 SSL_early_get0_ext() returns 1 if the extension of type 'type' is present, and
89 0 otherwise.
90
91 =head1 SEE ALSO
92
93 L<ssl(7)>, L<SSL_CTX_set_tlsext_servername_callback(3)>,
94 L<SSL_bytes_to_cipher_list>
95
96 =head1 HISTORY
97
98 The SSL early callback, SSL_early_isv2(), SSL_early_get0_random(),
99 SSL_early_get0_session_id(), SSL_early_get0_ciphers(),
100 SSL_early_get0_compression_methods(), and SSL_early_get0_ext() were
101 added in OpenSSL 1.1.1.
102
103 =head1 COPYRIGHT
104
105 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
106
107 Licensed under the OpenSSL license (the "License").  You may not use
108 this file except in compliance with the License.  You can obtain a copy
109 in the file LICENSE in the source distribution or at
110 L<https://www.openssl.org/source/license.html>.
111
112 =cut