228 lines
8.5 KiB
Groff
Executable File
228 lines
8.5 KiB
Groff
Executable File
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
|
|
.\"
|
|
.\" 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" ''
|
|
'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 turned on, 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.
|
|
.ie \nF \{\
|
|
. de IX
|
|
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
..
|
|
. nr % 0
|
|
. rr F
|
|
.\}
|
|
.el \{\
|
|
. de IX
|
|
..
|
|
.\}
|
|
.\"
|
|
.\" 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_CTX_SET_TLSEXT_USE_SRTP 3"
|
|
.TH SSL_CTX_SET_TLSEXT_USE_SRTP 3 "2020-03-02" "3.0.0-dev" "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_CTX_set_tlsext_use_srtp,
|
|
SSL_set_tlsext_use_srtp,
|
|
SSL_get_srtp_profiles,
|
|
SSL_get_selected_srtp_profile
|
|
\&\- Configure and query SRTP support
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/srtp.h>
|
|
\&
|
|
\& int SSL_CTX_set_tlsext_use_srtp(SSL_CTX *ctx, const char *profiles);
|
|
\& int SSL_set_tlsext_use_srtp(SSL *ssl, const char *profiles);
|
|
\&
|
|
\& STACK_OF(SRTP_PROTECTION_PROFILE) *SSL_get_srtp_profiles(SSL *ssl);
|
|
\& SRTP_PROTECTION_PROFILE *SSL_get_selected_srtp_profile(SSL *s);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\s-1SRTP\s0 is the Secure Real-Time Transport Protocol. OpenSSL implements support for
|
|
the \*(L"use_srtp\*(R" \s-1DTLS\s0 extension defined in \s-1RFC5764\s0. This provides a mechanism for
|
|
establishing \s-1SRTP\s0 keying material, algorithms and parameters using \s-1DTLS\s0. This
|
|
capability may be used as part of an implementation that conforms to \s-1RFC5763\s0.
|
|
OpenSSL does not implement \s-1SRTP\s0 itself or \s-1RFC5763\s0. Note that OpenSSL does not
|
|
support the use of \s-1SRTP\s0 Master Key Identifiers (MKIs). Also note that this
|
|
extension is only supported in \s-1DTLS\s0. Any \s-1SRTP\s0 configuration will be ignored if a
|
|
\&\s-1TLS\s0 connection is attempted.
|
|
.PP
|
|
An OpenSSL client wishing to send the \*(L"use_srtp\*(R" extension should call
|
|
\&\fISSL_CTX_set_tlsext_use_srtp()\fR to set its use for all \s-1SSL\s0 objects subsequently
|
|
created from an \s-1SSL_CTX\s0. Alternatively a client may call
|
|
\&\fISSL_set_tlsext_use_srtp()\fR to set its use for an individual \s-1SSL\s0 object. The
|
|
\&\fBprofiles\fR parameters should point to a NUL-terminated, colon delimited list of
|
|
\&\s-1SRTP\s0 protection profile names.
|
|
.PP
|
|
The currently supported protection profile names are:
|
|
.IP "\s-1SRTP_AES128_CM_SHA1_80\s0" 4
|
|
.IX Item "SRTP_AES128_CM_SHA1_80"
|
|
This corresponds to \s-1SRTP_AES128_CM_HMAC_SHA1_80\s0 defined in \s-1RFC5764\s0.
|
|
.IP "\s-1SRTP_AES128_CM_SHA1_32\s0" 4
|
|
.IX Item "SRTP_AES128_CM_SHA1_32"
|
|
This corresponds to \s-1SRTP_AES128_CM_HMAC_SHA1_32\s0 defined in \s-1RFC5764\s0.
|
|
.IP "\s-1SRTP_AEAD_AES_128_GCM\s0" 4
|
|
.IX Item "SRTP_AEAD_AES_128_GCM"
|
|
This corresponds to the profile of the same name defined in \s-1RFC7714\s0.
|
|
.IP "\s-1SRTP_AEAD_AES_256_GCM\s0" 4
|
|
.IX Item "SRTP_AEAD_AES_256_GCM"
|
|
This corresponds to the profile of the same name defined in \s-1RFC7714\s0.
|
|
.PP
|
|
Supplying an unrecognised protection profile name will result in an error.
|
|
.PP
|
|
An OpenSSL server wishing to support the \*(L"use_srtp\*(R" extension should also call
|
|
\&\fISSL_CTX_set_tlsext_use_srtp()\fR or \fISSL_set_tlsext_use_srtp()\fR to indicate the
|
|
protection profiles that it is willing to negotiate.
|
|
.PP
|
|
The currently configured list of protection profiles for either a client or a
|
|
server can be obtained by calling \fISSL_get_srtp_profiles()\fR. This returns a stack
|
|
of \s-1SRTP_PROTECTION_PROFILE\s0 objects. The memory pointed to in the return value of
|
|
this function should not be freed by the caller.
|
|
.PP
|
|
After a handshake has been completed the negotiated \s-1SRTP\s0 protection profile (if
|
|
any) can be obtained (on the client or the server) by calling
|
|
\&\fISSL_get_selected_srtp_profile()\fR. This function will return \s-1NULL\s0 if no \s-1SRTP\s0
|
|
protection profile was negotiated. The memory returned from this function should
|
|
not be freed by the caller.
|
|
.PP
|
|
If an \s-1SRTP\s0 protection profile has been successfully negotiated then the \s-1SRTP\s0
|
|
keying material (on both the client and server) should be obtained via a call to
|
|
\&\fISSL_export_keying_material\fR\|(3). This call should provide a label value of
|
|
\&\*(L"EXTRACTOR\-dtls_srtp\*(R" and a \s-1NULL\s0 context value (use_context is 0). The total
|
|
length of keying material obtained should be equal to two times the sum of the
|
|
master key length and the salt length as defined for the protection profile in
|
|
use. This provides the client write master key, the server write master key, the
|
|
client write master salt and the server write master salt in that order.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fISSL_CTX_set_tlsext_use_srtp()\fR and \fISSL_set_tlsext_use_srtp()\fR return 0 on success
|
|
or 1 on error.
|
|
.PP
|
|
\&\fISSL_get_srtp_profiles()\fR returns a stack of \s-1SRTP_PROTECTION_PROFILE\s0 objects on
|
|
success or \s-1NULL\s0 on error or if no protection profiles have been configured.
|
|
.PP
|
|
\&\fISSL_get_selected_srtp_profile()\fR returns a pointer to an \s-1SRTP_PROTECTION_PROFILE\s0
|
|
object if one has been negotiated or \s-1NULL\s0 otherwise.
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7),
|
|
\&\fISSL_export_keying_material\fR\|(3)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
|
|
.PP
|
|
Licensed under the Apache License 2.0 (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>.
|