root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/SSL_get_peer_signature_nid.pod

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

74 lines
2.7 KiB
Plaintext
Raw Normal View History

Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
=pod
=head1 NAME
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
SSL_get0_peer_signature_name, SSL_get_peer_signature_nid,
SSL_get_peer_signature_type_nid, SSL_get0_signature_name,
SSL_get_signature_nid, SSL_get_signature_type_nid -
get TLS message signing types
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
=head1 SYNOPSIS
#include <openssl/ssl.h>
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
int SSL_get0_peer_signature_name(const SSL *ssl, const char **sigalg);
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
int SSL_get_peer_signature_nid(SSL *ssl, int *psig_nid);
int SSL_get_peer_signature_type_nid(const SSL *ssl, int *psigtype_nid);
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
int SSL_get0_signature_name(SSL *ssl, const char **sigalg);
Added missing signature algorithm reflection functions SSL_get_signature_nid() -- local signature algorithm SSL_get_signature_type_nid() -- local signature algorithm key type SSL_get_peer_tmp_key() -- Peer key-exchange public key SSL_get_tmp_key -- local key exchange public key Aliased pre-existing SSL_get_server_tmp_key(), which was formerly just for clients, to SSL_get_peer_tmp_key(). Changed internal calls to use the new name. Reviewed-by: Matt Caswell <matt@openssl.org>
2018-11-10 14:53:56 +08:00
int SSL_get_signature_nid(SSL *ssl, int *psig_nid);
int SSL_get_signature_type_nid(const SSL *ssl, int *psigtype_nid);
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
=head1 DESCRIPTION
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
SSL_get0_peer_signature_name() sets I<*sigalg> to the IANA name of the
L<signature scheme|https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-signaturescheme>
used by the peer to sign the TLS handshake.
The caller must not free the returned pointer.
The returned string should be copied if it is to be retained beyond the
lifetime of the SSL connection.
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
SSL_get_peer_signature_nid() sets B<*psig_nid> to the NID of the digest used
by the peer to sign TLS messages. It is implemented as a macro.
SSL_get_peer_signature_type_nid() sets B<*psigtype_nid> to the signature
type used by the peer to sign TLS messages. Currently the signature type
is the NID of the public key type used for signing except for PSS signing
TLSv1.3 related changes to man pages Add or update the documentation of the different man pages in relation to TLSv1.3 behaviour. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Ben Kaduk <kaduk@mit.edu> Reviewed-by: Paul Yang <yang.yang@baishancloud.com> (Merged from https://github.com/openssl/openssl/pull/6939)
2018-09-01 08:40:51 +08:00
where it is B<EVP_PKEY_RSA_PSS>. To differentiate between
B<rsa_pss_rsae_*> and B<rsa_pss_pss_*> signatures, it's necessary to check
the type of public key in the peer's certificate.
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
SSL_get0_signature_name(), SSL_get_signature_nid() and
SSL_get_signature_type_nid() return the equivalent information for the local
end of the connection.
Added missing signature algorithm reflection functions SSL_get_signature_nid() -- local signature algorithm SSL_get_signature_type_nid() -- local signature algorithm key type SSL_get_peer_tmp_key() -- Peer key-exchange public key SSL_get_tmp_key -- local key exchange public key Aliased pre-existing SSL_get_server_tmp_key(), which was formerly just for clients, to SSL_get_peer_tmp_key(). Changed internal calls to use the new name. Reviewed-by: Matt Caswell <matt@openssl.org>
2018-11-10 14:53:56 +08:00
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
=head1 RETURN VALUES
These functions return 1 for success and 0 for failure. There are several
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
possible reasons for failure: the peer or local end is a client and did not
sign the handshake (did not use a client certificate), the cipher suite has no
signature (e.g. it uses RSA key exchange or is anonymous), the TLS version is
below 1.2 or the functions were called too early, e.g. before the peer signed a
message.
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
=head1 SEE ALSO
L<ssl(7)>, L<SSL_get_peer_certificate(3)>,
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
=head1 HISTORY
The SSL_get0_peer_signature_name() and SSL_get0_signature_name() functions were
added in OpenSSL 3.5.
doc/man3: Document missing macro function history By updating the `util/find-doc-nits` new missing history sections were discovered. This commit adds the missing. Signed-off-by: Norbert Pocs <norbertpocs0@gmail.com> Reviewed-by: Paul Dale <ppzgs1@gmail.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/27488)
2025-04-26 01:06:44 +08:00
SSL_get_signature_nid() was added in OpenSSL 1.1.1a.
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
=head1 COPYRIGHT
Accessors for the IANA signature scheme name This is the official name of the signature algorithm(s) used by the peer and/or local end of the connection, and should be available, e.g. for logging. Reviewed-by: Tim Hudson <tjh@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/26738)
2025-02-13 23:07:14 +08:00
Copyright 2017-2025 The OpenSSL Project Authors. All Rights Reserved.
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
Following the license change, modify the boilerplates in doc/man3/ [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
2018-12-06 21:04:44 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
Update documentation Add details of the use of PSS for signature algorithms. Document SSL_get_peer_signature_nid() and SSL_get_peer_signature_type_nid(). Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/2301)
2017-01-27 10:19:54 +08:00
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut