252 lines
8.8 KiB
Groff
Executable File
252 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 "X509_GET0_SIGNATURE 3"
|
|
.TH X509_GET0_SIGNATURE 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"
|
|
X509_get0_signature, X509_get_signature_nid, X509_get0_tbs_sigalg,
|
|
X509_REQ_get0_signature, X509_REQ_get_signature_nid, X509_CRL_get0_signature,
|
|
X509_CRL_get_signature_nid, X509_get_signature_info, X509_SIG_INFO_get,
|
|
X509_SIG_INFO_set \- signature information
|
|
.SH "SYNOPSIS"
|
|
.IX Header "SYNOPSIS"
|
|
.Vb 1
|
|
\& #include <openssl/x509.h>
|
|
\&
|
|
\& void X509_get0_signature(const ASN1_BIT_STRING **psig,
|
|
\& const X509_ALGOR **palg,
|
|
\& const X509 *x);
|
|
\& int X509_get_signature_nid(const X509 *x);
|
|
\& const X509_ALGOR *X509_get0_tbs_sigalg(const X509 *x);
|
|
\&
|
|
\& void X509_REQ_get0_signature(const X509_REQ *crl,
|
|
\& const ASN1_BIT_STRING **psig,
|
|
\& const X509_ALGOR **palg);
|
|
\& int X509_REQ_get_signature_nid(const X509_REQ *crl);
|
|
\&
|
|
\& void X509_CRL_get0_signature(const X509_CRL *crl,
|
|
\& const ASN1_BIT_STRING **psig,
|
|
\& const X509_ALGOR **palg);
|
|
\& int X509_CRL_get_signature_nid(const X509_CRL *crl);
|
|
\&
|
|
\& int X509_get_signature_info(X509 *x, int *mdnid, int *pknid, int *secbits,
|
|
\& uint32_t *flags);
|
|
\&
|
|
\& int X509_SIG_INFO_get(const X509_SIG_INFO *siginf, int *mdnid, int *pknid,
|
|
\& int *secbits, uint32_t *flags);
|
|
\& void X509_SIG_INFO_set(X509_SIG_INFO *siginf, int mdnid, int pknid,
|
|
\& int secbits, uint32_t flags);
|
|
.Ve
|
|
.SH "DESCRIPTION"
|
|
.IX Header "DESCRIPTION"
|
|
\&\fIX509_get0_signature()\fR sets \fB*psig\fR to the signature of \fBx\fR and \fB*palg\fR
|
|
to the signature algorithm of \fBx\fR. The values returned are internal
|
|
pointers which \fB\s-1MUST\s0 \s-1NOT\s0\fR be freed up after the call.
|
|
.PP
|
|
\&\fIX509_get0_tbs_sigalg()\fR returns the signature algorithm in the signed
|
|
portion of \fBx\fR.
|
|
.PP
|
|
\&\fIX509_get_signature_nid()\fR returns the \s-1NID\s0 corresponding to the signature
|
|
algorithm of \fBx\fR.
|
|
.PP
|
|
\&\fIX509_REQ_get0_signature()\fR, \fIX509_REQ_get_signature_nid()\fR
|
|
\&\fIX509_CRL_get0_signature()\fR and \fIX509_CRL_get_signature_nid()\fR perform the
|
|
same function for certificate requests and CRLs.
|
|
.PP
|
|
\&\fIX509_get_signature_info()\fR retrieves information about the signature of
|
|
certificate \fBx\fR. The \s-1NID\s0 of the signing digest is written to \fB*mdnid\fR,
|
|
the public key algorithm to \fB*pknid\fR, the effective security bits to
|
|
\&\fB*secbits\fR and flag details to \fB*flags\fR. Any of the parameters can
|
|
be set to \fB\s-1NULL\s0\fR if the information is not required.
|
|
.PP
|
|
\&\fIX509_SIG_INFO_get()\fR and \fIX509_SIG_INFO_set()\fR get and set information
|
|
about a signature in an \fBX509_SIG_INFO\fR structure. They are only
|
|
used by implementations of algorithms which need to set custom
|
|
signature information: most applications will never need to call
|
|
them.
|
|
.SH "NOTES"
|
|
.IX Header "NOTES"
|
|
These functions provide lower level access to signatures in certificates
|
|
where an application wishes to analyse or generate a signature in a form
|
|
where \fIX509_sign()\fR et al is not appropriate (for example a non standard
|
|
or unsupported format).
|
|
.PP
|
|
The security bits returned by \fIX509_get_signature_info()\fR refers to information
|
|
available from the certificate signature (such as the signing digest). In some
|
|
cases the actual security of the signature is less because the signing
|
|
key is less secure: for example a certificate signed using \s-1SHA\-512\s0 and a
|
|
1024 bit \s-1RSA\s0 key.
|
|
.SH "RETURN VALUES"
|
|
.IX Header "RETURN VALUES"
|
|
\&\fIX509_get_signature_nid()\fR, \fIX509_REQ_get_signature_nid()\fR and
|
|
\&\fIX509_CRL_get_signature_nid()\fR return a \s-1NID\s0.
|
|
.PP
|
|
\&\fIX509_get0_signature()\fR, \fIX509_REQ_get0_signature()\fR and
|
|
\&\fIX509_CRL_get0_signature()\fR do not return values.
|
|
.PP
|
|
\&\fIX509_get_signature_info()\fR returns 1 if the signature information
|
|
returned is valid or 0 if the information is not available (e.g.
|
|
unknown algorithms or malformed parameters).
|
|
.SH "SEE ALSO"
|
|
.IX Header "SEE ALSO"
|
|
\&\fId2i_X509\fR\|(3),
|
|
\&\fIERR_get_error\fR\|(3),
|
|
\&\fIX509_CRL_get0_by_serial\fR\|(3),
|
|
\&\fIX509_get_ext_d2i\fR\|(3),
|
|
\&\fIX509_get_extension_flags\fR\|(3),
|
|
\&\fIX509_get_pubkey\fR\|(3),
|
|
\&\fIX509_get_subject_name\fR\|(3),
|
|
\&\fIX509_get_version\fR\|(3),
|
|
\&\fIX509_NAME_add_entry_by_txt\fR\|(3),
|
|
\&\fIX509_NAME_ENTRY_get_object\fR\|(3),
|
|
\&\fIX509_NAME_get_index_by_NID\fR\|(3),
|
|
\&\fIX509_NAME_print_ex\fR\|(3),
|
|
\&\fIX509_new\fR\|(3),
|
|
\&\fIX509_sign\fR\|(3),
|
|
\&\fIX509V3_get_d2i\fR\|(3),
|
|
\&\fIX509_verify_cert\fR\|(3)
|
|
.SH "HISTORY"
|
|
.IX Header "HISTORY"
|
|
The
|
|
\&\fIX509_get0_signature()\fR and \fIX509_get_signature_nid()\fR functions were
|
|
added in OpenSSL 1.0.2.
|
|
.PP
|
|
The
|
|
\&\fIX509_REQ_get0_signature()\fR, \fIX509_REQ_get_signature_nid()\fR,
|
|
\&\fIX509_CRL_get0_signature()\fR and \fIX509_CRL_get_signature_nid()\fR were
|
|
added in OpenSSL 1.1.0.
|
|
.SH "COPYRIGHT"
|
|
.IX Header "COPYRIGHT"
|
|
Copyright 2015\-2016 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>.
|