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