244 lines
8.8 KiB
Groff
Executable File
244 lines
8.8 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_SET1_SIGALGS 3"
|
|
.TH SSL_CTX_SET1_SIGALGS 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_set1_sigalgs, SSL_set1_sigalgs, SSL_CTX_set1_sigalgs_list,
|
|
SSL_set1_sigalgs_list, SSL_CTX_set1_client_sigalgs,
|
|
SSL_set1_client_sigalgs, SSL_CTX_set1_client_sigalgs_list,
|
|
SSL_set1_client_sigalgs_list \- set supported signature algorithms
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/ssl.h>
|
|
\&
|
|
\& long SSL_CTX_set1_sigalgs(SSL_CTX *ctx, const int *slist, long slistlen);
|
|
\& long SSL_set1_sigalgs(SSL *ssl, const int *slist, long slistlen);
|
|
\& long SSL_CTX_set1_sigalgs_list(SSL_CTX *ctx, const char *str);
|
|
\& long SSL_set1_sigalgs_list(SSL *ssl, const char *str);
|
|
\&
|
|
\& long SSL_CTX_set1_client_sigalgs(SSL_CTX *ctx, const int *slist, long slistlen);
|
|
\& long SSL_set1_client_sigalgs(SSL *ssl, const int *slist, long slistlen);
|
|
\& long SSL_CTX_set1_client_sigalgs_list(SSL_CTX *ctx, const char *str);
|
|
\& long SSL_set1_client_sigalgs_list(SSL *ssl, const char *str);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fISSL_CTX_set1_sigalgs()\fR and \fISSL_set1_sigalgs()\fR set the supported signature
|
|
algorithms for \fBctx\fR or \fBssl\fR. The array \fBslist\fR of length \fBslistlen\fR
|
|
must consist of pairs of NIDs corresponding to digest and public key
|
|
algorithms.
|
|
.PP
|
|
\&\fISSL_CTX_set1_sigalgs_list()\fR and \fISSL_set1_sigalgs_list()\fR set the supported
|
|
signature algorithms for \fBctx\fR or \fBssl\fR. The \fBstr\fR parameter
|
|
must be a null terminated string consisting of a colon separated list of
|
|
elements, where each element is either a combination of a public key
|
|
algorithm and a digest separated by \fB+\fR, or a \s-1TLS\s0 1.3\-style named
|
|
SignatureScheme such as rsa_pss_pss_sha256.
|
|
.PP
|
|
\&\fISSL_CTX_set1_client_sigalgs()\fR, \fISSL_set1_client_sigalgs()\fR,
|
|
\&\fISSL_CTX_set1_client_sigalgs_list()\fR and \fISSL_set1_client_sigalgs_list()\fR set
|
|
signature algorithms related to client authentication, otherwise they are
|
|
identical to \fISSL_CTX_set1_sigalgs()\fR, \fISSL_set1_sigalgs()\fR,
|
|
\&\fISSL_CTX_set1_sigalgs_list()\fR and \fISSL_set1_sigalgs_list()\fR.
|
|
.PP
|
|
All these functions are implemented as macros. The signature algorithm
|
|
parameter (integer array or string) is not freed: the application should
|
|
free it, if necessary.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
If an application wishes to allow the setting of signature algorithms
|
|
as one of many user configurable options it should consider using the more
|
|
flexible \s-1SSL_CONF\s0 \s-1API\s0 instead.
|
|
.PP
|
|
The signature algorithms set by a client are used directly in the supported
|
|
signature algorithm in the client hello message.
|
|
.PP
|
|
The supported signature algorithms set by a server are not sent to the
|
|
client but are used to determine the set of shared signature algorithms
|
|
and (if server preferences are set with \s-1SSL_OP_CIPHER_SERVER_PREFERENCE\s0)
|
|
their order.
|
|
.PP
|
|
The client authentication signature algorithms set by a server are sent
|
|
in a certificate request message if client authentication is enabled,
|
|
otherwise they are unused.
|
|
.PP
|
|
Similarly client authentication signature algorithms set by a client are
|
|
used to determined the set of client authentication shared signature
|
|
algorithms.
|
|
.PP
|
|
Signature algorithms will neither be advertised nor used if the security level
|
|
prohibits them (for example \s-1SHA1\s0 if the security level is 4 or more).
|
|
.PP
|
|
Currently the NID_md5, NID_sha1, NID_sha224, NID_sha256, NID_sha384 and
|
|
NID_sha512 digest NIDs are supported and the public key algorithm NIDs
|
|
\&\s-1EVP_PKEY_RSA\s0, \s-1EVP_PKEY_RSA_PSS\s0, \s-1EVP_PKEY_DSA\s0 and \s-1EVP_PKEY_EC\s0.
|
|
.PP
|
|
The short or long name values for digests can be used in a string (for
|
|
example \*(L"\s-1MD5\s0\*(R", \*(L"\s-1SHA1\s0\*(R", \*(L"\s-1SHA224\s0\*(R", \*(L"\s-1SHA256\s0\*(R", \*(L"\s-1SHA384\s0\*(R", \*(L"\s-1SHA512\s0\*(R") and
|
|
the public key algorithm strings \*(L"\s-1RSA\s0\*(R", \*(L"RSA-PSS\*(R", \*(L"\s-1DSA\s0\*(R" or \*(L"\s-1ECDSA\s0\*(R".
|
|
.PP
|
|
The \s-1TLS\s0 1.3 signature scheme names (such as \*(L"rsa_pss_pss_sha256\*(R") can also
|
|
be used with the \fB_list\fR forms of the \s-1API\s0.
|
|
.PP
|
|
The use of \s-1MD5\s0 as a digest is strongly discouraged due to security weaknesses.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
All these functions return 1 for success and 0 for failure.
|
|
.SH "EXAMPLES"
|
|
.IX Header "EXAMPLES"
|
|
Set supported signature algorithms to \s-1SHA256\s0 with \s-1ECDSA\s0 and \s-1SHA256\s0 with \s-1RSA\s0
|
|
using an array:
|
|
.PP
|
|
.Vb 1
|
|
\& const int slist[] = {NID_sha256, EVP_PKEY_EC, NID_sha256, EVP_PKEY_RSA};
|
|
\&
|
|
\& SSL_CTX_set1_sigalgs(ctx, slist, 4);
|
|
.Ve
|
|
.PP
|
|
Set supported signature algorithms to \s-1SHA256\s0 with \s-1ECDSA\s0 and \s-1SHA256\s0 with \s-1RSA\s0
|
|
using a string:
|
|
.PP
|
|
.Vb 1
|
|
\& SSL_CTX_set1_sigalgs_list(ctx, "ECDSA+SHA256:RSA+SHA256");
|
|
.Ve
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fIssl\fR\|(7), \fISSL_get_shared_sigalgs\fR\|(3),
|
|
\&\fISSL_CONF_CTX_new\fR\|(3)
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-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>.
|