secure/lib/libcrypto/man/man3/X509_get0_signature.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "X509_GET0_SIGNATURE 3"
 136 .TH X509_GET0_SIGNATURE 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 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
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/x509.h>
 147 \&
 148 \& void X509_get0_signature(const ASN1_BIT_STRING **psig,
 149 \&                          const X509_ALGOR **palg,
 150 \&                          const X509 *x);
 151 \& int X509_get_signature_nid(const X509 *x);
 152 \& const X509_ALGOR *X509_get0_tbs_sigalg(const X509 *x);
 153 \&
 154 \& void X509_REQ_get0_signature(const X509_REQ *crl,
 155 \&                              const ASN1_BIT_STRING **psig,
 156 \&                              const X509_ALGOR **palg);
 157 \& int X509_REQ_get_signature_nid(const X509_REQ *crl);
 158 \&
 159 \& void X509_CRL_get0_signature(const X509_CRL *crl,
 160 \&                              const ASN1_BIT_STRING **psig,
 161 \&                              const X509_ALGOR **palg);
 162 \& int X509_CRL_get_signature_nid(const X509_CRL *crl);
 163 \&
 164 \& int X509_get_signature_info(X509 *x, int *mdnid, int *pknid, int *secbits,
 165 \&                             uint32_t *flags);
 166 \&
 167 \& int X509_SIG_INFO_get(const X509_SIG_INFO *siginf, int *mdnid, int *pknid,
 168 \&                      int *secbits, uint32_t *flags);
 169 \& void X509_SIG_INFO_set(X509_SIG_INFO *siginf, int mdnid, int pknid,
 170 \&                        int secbits, uint32_t flags);
 171 .Ve
 172 .SH "DESCRIPTION"
 173 .IX Header "DESCRIPTION"
 174 \&\fBX509_get0_signature()\fR sets \fB*psig\fR to the signature of \fBx\fR and \fB*palg\fR
 175 to the signature algorithm of \fBx\fR. The values returned are internal
 176 pointers which \fB\s-1MUST NOT\s0\fR be freed up after the call.
 177 .PP
 178 \&\fBX509_get0_tbs_sigalg()\fR returns the signature algorithm in the signed
 179 portion of \fBx\fR.
 180 .PP
 181 \&\fBX509_get_signature_nid()\fR returns the \s-1NID\s0 corresponding to the signature
 182 algorithm of \fBx\fR.
 183 .PP
 184 \&\fBX509_REQ_get0_signature()\fR, \fBX509_REQ_get_signature_nid()\fR
 185 \&\fBX509_CRL_get0_signature()\fR and \fBX509_CRL_get_signature_nid()\fR perform the
 186 same function for certificate requests and CRLs.
 187 .PP
 188 \&\fBX509_get_signature_info()\fR retrieves information about the signature of
 189 certificate \fBx\fR. The \s-1NID\s0 of the signing digest is written to \fB*mdnid\fR,
 190 the public key algorithm to \fB*pknid\fR, the effective security bits to
 191 \&\fB*secbits\fR and flag details to \fB*flags\fR. Any of the parameters can
 192 be set to \fB\s-1NULL\s0\fR if the information is not required.
 193 .PP
 194 \&\fBX509_SIG_INFO_get()\fR and \fBX509_SIG_INFO_set()\fR get and set information
 195 about a signature in an \fBX509_SIG_INFO\fR structure. They are only
 196 used by implementations of algorithms which need to set custom
 197 signature information: most applications will never need to call
 198 them.
 199 .SH "NOTES"
 200 .IX Header "NOTES"
 201 These functions provide lower level access to signatures in certificates
 202 where an application wishes to analyse or generate a signature in a form
 203 where \fBX509_sign()\fR et al is not appropriate (for example a non standard
 204 or unsupported format).
 205 .PP
 206 The security bits returned by \fBX509_get_signature_info()\fR refers to information
 207 available from the certificate signature (such as the signing digest). In some
 208 cases the actual security of the signature is less because the signing
 209 key is less secure: for example a certificate signed using \s-1SHA\-512\s0 and a
 210 1024 bit \s-1RSA\s0 key.
 211 .SH "RETURN VALUES"
 212 .IX Header "RETURN VALUES"
 213 \&\fBX509_get_signature_nid()\fR, \fBX509_REQ_get_signature_nid()\fR and
 214 \&\fBX509_CRL_get_signature_nid()\fR return a \s-1NID.\s0
 215 .PP
 216 \&\fBX509_get0_signature()\fR, \fBX509_REQ_get0_signature()\fR and
 217 \&\fBX509_CRL_get0_signature()\fR do not return values.
 218 .PP
 219 \&\fBX509_get_signature_info()\fR returns 1 if the signature information
 220 returned is valid or 0 if the information is not available (e.g.
 221 unknown algorithms or malformed parameters).
 222 .SH "SEE ALSO"
 223 .IX Header "SEE ALSO"
 224 \&\fBd2i_X509\fR\|(3),
 225 \&\fBERR_get_error\fR\|(3),
 226 \&\fBX509_CRL_get0_by_serial\fR\|(3),
 227 \&\fBX509_get_ext_d2i\fR\|(3),
 228 \&\fBX509_get_extension_flags\fR\|(3),
 229 \&\fBX509_get_pubkey\fR\|(3),
 230 \&\fBX509_get_subject_name\fR\|(3),
 231 \&\fBX509_get_version\fR\|(3),
 232 \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
 233 \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
 234 \&\fBX509_NAME_get_index_by_NID\fR\|(3),
 235 \&\fBX509_NAME_print_ex\fR\|(3),
 236 \&\fBX509_new\fR\|(3),
 237 \&\fBX509_sign\fR\|(3),
 238 \&\fBX509V3_get_d2i\fR\|(3),
 239 \&\fBX509_verify_cert\fR\|(3)
 240 .SH "HISTORY"
 241 .IX Header "HISTORY"
 242 The
 243 \&\fBX509_get0_signature()\fR and \fBX509_get_signature_nid()\fR functions were
 244 added in OpenSSL 1.0.2.
 245 .PP
 246 The
 247 \&\fBX509_REQ_get0_signature()\fR, \fBX509_REQ_get_signature_nid()\fR,
 248 \&\fBX509_CRL_get0_signature()\fR and \fBX509_CRL_get_signature_nid()\fR were
 249 added in OpenSSL 1.1.0.
 250 .SH "COPYRIGHT"
 251 .IX Header "COPYRIGHT"
 252 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 253 .PP
 254 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 255 this file except in compliance with the License.  You can obtain a copy
 256 in the file \s-1LICENSE\s0 in the source distribution or at
 257 <https://www.openssl.org/source/license.html>.