aboutsummaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/man3/SSL_export_keying_material.3
diff options
context:
space:
mode:
authorJung-uk Kim <jkim@FreeBSD.org>2020-02-21 00:33:21 +0000
committerJung-uk Kim <jkim@FreeBSD.org>2020-02-21 00:33:21 +0000
commit6b4382c4054d7c169c6140feaa144ca360a90ead (patch)
tree176bf7fdbae226099058e11e9a429805b6e0af42 /secure/lib/libcrypto/man/man3/SSL_export_keying_material.3
parent24722aacdb06a5ac6780beef7db856a0f99095c3 (diff)
downloadsrc-6b4382c4054d7c169c6140feaa144ca360a90ead.tar.gz
src-6b4382c4054d7c169c6140feaa144ca360a90ead.zip
MFC: r356963
Install man5 and man7 for OpenSSL.
Notes
Notes: svn path=/stable/12/; revision=358188
Diffstat (limited to 'secure/lib/libcrypto/man/man3/SSL_export_keying_material.3')
-rw-r--r--secure/lib/libcrypto/man/man3/SSL_export_keying_material.3217
1 files changed, 217 insertions, 0 deletions
diff --git a/secure/lib/libcrypto/man/man3/SSL_export_keying_material.3 b/secure/lib/libcrypto/man/man3/SSL_export_keying_material.3
new file mode 100644
index 000000000000..fa4cdfdb179e
--- /dev/null
+++ b/secure/lib/libcrypto/man/man3/SSL_export_keying_material.3
@@ -0,0 +1,217 @@
+.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" Set up some character translations and predefined strings. \*(-- will
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
+.\" double quote, and \*(R" will give a right double quote. \*(C+ will
+.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
+.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
+.\" nothing in troff, for use with C<>.
+.tr \(*W-
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
+.ie n \{\
+. ds -- \(*W-
+. ds PI pi
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
+. ds L" ""
+. ds R" ""
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds -- \|\(em\|
+. ds PI \(*p
+. ds L" ``
+. ds R" ''
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "SSL_EXPORT_KEYING_MATERIAL 3"
+.TH SSL_EXPORT_KEYING_MATERIAL 3 "2019-09-10" "1.1.1d" "OpenSSL"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH "NAME"
+SSL_export_keying_material, SSL_export_keying_material_early \&\- obtain keying material for application use
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& #include <openssl/ssl.h>
+\&
+\& int SSL_export_keying_material(SSL *s, unsigned char *out, size_t olen,
+\& const char *label, size_t llen,
+\& const unsigned char *context,
+\& size_t contextlen, int use_context);
+\&
+\& int SSL_export_keying_material_early(SSL *s, unsigned char *out, size_t olen,
+\& const char *label, size_t llen,
+\& const unsigned char *context,
+\& size_t contextlen);
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+During the creation of a \s-1TLS\s0 or \s-1DTLS\s0 connection shared keying material is
+established between the two endpoints. The functions
+\&\fBSSL_export_keying_material()\fR and \fBSSL_export_keying_material_early()\fR enable an
+application to use some of this keying material for its own purposes in
+accordance with \s-1RFC5705\s0 (for TLSv1.2 and below) or \s-1RFC8446\s0 (for TLSv1.3).
+.PP
+\&\fBSSL_export_keying_material()\fR derives keying material using
+the \fIexporter_master_secret\fR established in the handshake.
+.PP
+\&\fBSSL_export_keying_material_early()\fR is only usable with TLSv1.3, and derives
+keying material using the \fIearly_exporter_master_secret\fR (as defined in the
+\&\s-1TLS 1.3 RFC\s0). For the client, the \fIearly_exporter_master_secret\fR is only
+available when the client attempts to send 0\-RTT data. For the server, it is
+only available when the server accepts 0\-RTT data.
+.PP
+An application may need to securely establish the context within which this
+keying material will be used. For example this may include identifiers for the
+application session, application algorithms or parameters, or the lifetime of
+the context. The context value is left to the application but must be the same
+on both sides of the communication.
+.PP
+For a given \s-1SSL\s0 connection \fBs\fR, \fBolen\fR bytes of data will be written to
+\&\fBout\fR. The application specific context should be supplied in the location
+pointed to by \fBcontext\fR and should be \fBcontextlen\fR bytes long. Provision of
+a context is optional. If the context should be omitted entirely then
+\&\fBuse_context\fR should be set to 0. Otherwise it should be any other value. If
+\&\fBuse_context\fR is 0 then the values of \fBcontext\fR and \fBcontextlen\fR are ignored.
+Note that in TLSv1.2 and below a zero length context is treated differently from
+no context at all, and will result in different keying material being returned.
+In TLSv1.3 a zero length context is that same as no context at all and will
+result in the same keying material being returned.
+.PP
+An application specific label should be provided in the location pointed to by
+\&\fBlabel\fR and should be \fBllen\fR bytes long. Typically this will be a value from
+the \s-1IANA\s0 Exporter Label Registry
+(<https://www.iana.org/assignments/tls\-parameters/tls\-parameters.xhtml#exporter\-labels>).
+Alternatively labels beginning with \*(L"\s-1EXPERIMENTAL\*(R"\s0 are permitted by the standard
+to be used without registration. TLSv1.3 imposes a maximum label length of
+249 bytes.
+.PP
+Note that this function is only defined for TLSv1.0 and above, and DTLSv1.0 and
+above. Attempting to use it in SSLv3 will result in an error.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+\&\fBSSL_export_keying_material()\fR returns 0 or \-1 on failure or 1 on success.
+.PP
+\&\fBSSL_export_keying_material_early()\fR returns 0 on failure or 1 on success.
+.SH "HISTORY"
+.IX Header "HISTORY"
+The \fBSSL_export_keying_material_early()\fR function was added in OpenSSL 1.1.1.
+.SH "COPYRIGHT"
+.IX Header "COPYRIGHT"
+Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the OpenSSL license (the \*(L"License\*(R"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file \s-1LICENSE\s0 in the source distribution or at
+<https://www.openssl.org/source/license.html>.