Export keying material using early exporter master secret
[openssl.git] / doc / man3 / SSL_export_keying_material.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_export_keying_material,
6 SSL_export_keying_material_early
7 - obtain keying material for application use
8
9 =head1 SYNOPSIS
10
11  #include <openssl/ssl.h>
12
13  int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
14                                 const char *label, size_t llen,
15                                 const unsigned char *context,
16                                 size_t contextlen, int use_context);
17
18  int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
19                                       const char *label, size_t llen,
20                                       const unsigned char *context,
21                                       size_t contextlen);
22
23 =head1 DESCRIPTION
24
25 During the creation of a TLS or DTLS connection shared keying material is
26 established between the two endpoints. The functions
27 SSL_export_keying_material() and SSL_export_keying_material_early() enable an
28 application to use some of this keying material for its own purposes in
29 accordance with RFC5705 (for TLSv1.2 and below) or RFCXXXX (for TLSv1.3).
30 TODO(TLS1.3): Update the RFC number when the RFC is published.
31
32 SSL_export_keying_material() derives keying material using
33 the F<exporter_master_secret> established in the handshake.
34
35 SSL_export_keying_material_early() is only usable with TLSv1.3, and derives
36 keying material using the F<early_exporter_master_secret> (as defined in the
37 TLS 1.3 RFC). For the client, the F<early_exporter_master_secret> is only
38 available when the client attempts to send 0-RTT data. For the server, it is
39 only available when the server accepts 0-RTT data.
40
41 An application may need to securely establish the context within which this
42 keying material will be used. For example this may include identifiers for the
43 application session, application algorithms or parameters, or the lifetime of
44 the context. The context value is left to the application but must be the same
45 on both sides of the communication.
46
47 For a given SSL connection B<s>, B<olen> bytes of data will be written to
48 B<out>. The application specific context should be supplied in the location
49 pointed to by B<context> and should be B<contextlen> bytes long. Provision of
50 a context is optional. If the context should be omitted entirely then
51 B<use_context> should be set to 0. Otherwise it should be any other value. If
52 B<use_context> is 0 then the values of B<context> and B<contextlen> are ignored.
53 Note that in TLSv1.2 and below a zero length context is treated differently from
54 no context at all, and will result in different keying material being returned.
55 In TLSv1.3 a zero length context is that same as no context at all and will
56 result in the same keying material being returned.
57
58 An application specific label should be provided in the location pointed to by
59 B<label> and should be B<llen> bytes long. Typically this will be a value from
60 the IANA Exporter Label Registry
61 (L<https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#exporter-labels>).
62 Alternatively labels beginning with "EXPERIMENTAL" are permitted by the standard
63 to be used without registration.
64
65 Note that this function is only defined for TLSv1.0 and above, and DTLSv1.0 and
66 above. Attempting to use it in SSLv3 will result in an error.
67
68 =head1 RETURN VALUES
69
70 SSL_export_keying_material() returns 0 or -1 on failure or 1 on success.
71
72 SSL_export_keying_material_early() returns 0 on failure or 1 on success.
73
74 =head1 HISTORY
75
76 SSL_export_keying_material_early() was first added in OpenSSL 1.1.1.
77
78 =head1 COPYRIGHT
79
80 Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
81
82 Licensed under the OpenSSL license (the "License").  You may not use
83 this file except in compliance with the License.  You can obtain a copy
84 in the file LICENSE in the source distribution or at
85 L<https://www.openssl.org/source/license.html>.
86
87 =cut