secure/lib/libcrypto/man/X509_CRL_get0_by_serial.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.39)
   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_CRL_GET0_BY_SERIAL 3"
 136 .TH X509_CRL_GET0_BY_SERIAL 3 "2019-09-10" "1.1.1d" "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_CRL_get0_by_serial, X509_CRL_get0_by_cert, X509_CRL_get_REVOKED, X509_REVOKED_get0_serialNumber, X509_REVOKED_get0_revocationDate, X509_REVOKED_set_serialNumber, X509_REVOKED_set_revocationDate, X509_CRL_add0_revoked, X509_CRL_sort \- CRL revoked entry utility functions
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/x509.h>
 147 \&
 148 \& int X509_CRL_get0_by_serial(X509_CRL *crl,
 149 \&                             X509_REVOKED **ret, ASN1_INTEGER *serial);
 150 \& int X509_CRL_get0_by_cert(X509_CRL *crl, X509_REVOKED **ret, X509 *x);
 151 \&
 152 \& STACK_OF(X509_REVOKED) *X509_CRL_get_REVOKED(X509_CRL *crl);
 153 \&
 154 \& const ASN1_INTEGER *X509_REVOKED_get0_serialNumber(const X509_REVOKED *r);
 155 \& const ASN1_TIME *X509_REVOKED_get0_revocationDate(const X509_REVOKED *r);
 156 \&
 157 \& int X509_REVOKED_set_serialNumber(X509_REVOKED *r, ASN1_INTEGER *serial);
 158 \& int X509_REVOKED_set_revocationDate(X509_REVOKED *r, ASN1_TIME *tm);
 159 \&
 160 \& int X509_CRL_add0_revoked(X509_CRL *crl, X509_REVOKED *rev);
 161 \&
 162 \& int X509_CRL_sort(X509_CRL *crl);
 163 .Ve
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 \&\fBX509_CRL_get0_by_serial()\fR attempts to find a revoked entry in \fBcrl\fR for
 167 serial number \fBserial\fR. If it is successful it sets \fB*ret\fR to the internal
 168 pointer of the matching entry, as a result \fB*ret\fR must not be freed up
 169 after the call.
 170 .PP
 171 \&\fBX509_CRL_get0_by_cert()\fR is similar to \fBX509_get0_by_serial()\fR except it
 172 looks for a revoked entry using the serial number of certificate \fBx\fR.
 173 .PP
 174 \&\fBX509_CRL_get_REVOKED()\fR returns an internal pointer to a stack of all
 175 revoked entries for \fBcrl\fR.
 176 .PP
 177 \&\fBX509_REVOKED_get0_serialNumber()\fR returns an internal pointer to the
 178 serial number of \fBr\fR.
 179 .PP
 180 \&\fBX509_REVOKED_get0_revocationDate()\fR returns an internal pointer to the
 181 revocation date of \fBr\fR.
 182 .PP
 183 \&\fBX509_REVOKED_set_serialNumber()\fR sets the serial number of \fBr\fR to \fBserial\fR.
 184 The supplied \fBserial\fR pointer is not used internally so it should be
 185 freed up after use.
 186 .PP
 187 \&\fBX509_REVOKED_set_revocationDate()\fR sets the revocation date of \fBr\fR to
 188 \&\fBtm\fR. The supplied \fBtm\fR pointer is not used internally so it should be
 189 freed up after use.
 190 .PP
 191 \&\fBX509_CRL_add0_revoked()\fR appends revoked entry \fBrev\fR to \s-1CRL\s0 \fBcrl\fR. The
 192 pointer \fBrev\fR is used internally so it must not be freed up after the call:
 193 it is freed when the parent \s-1CRL\s0 is freed.
 194 .PP
 195 \&\fBX509_CRL_sort()\fR sorts the revoked entries of \fBcrl\fR into ascending serial
 196 number order.
 197 .SH "NOTES"
 198 .IX Header "NOTES"
 199 Applications can determine the number of revoked entries returned by
 200 \&\fBX509_CRL_get_revoked()\fR using \fBsk_X509_REVOKED_num()\fR and examine each one
 201 in turn using \fBsk_X509_REVOKED_value()\fR.
 202 .SH "RETURN VALUES"
 203 .IX Header "RETURN VALUES"
 204 \&\fBX509_CRL_get0_by_serial()\fR and \fBX509_CRL_get0_by_cert()\fR return 0 for failure,
 205 1 on success except if the revoked entry has the reason \f(CW\*(C`removeFromCRL\*(C'\fR (8),
 206 in which case 2 is returned.
 207 .PP
 208 \&\fBX509_REVOKED_set_serialNumber()\fR, \fBX509_REVOKED_set_revocationDate()\fR,
 209 \&\fBX509_CRL_add0_revoked()\fR and \fBX509_CRL_sort()\fR return 1 for success and 0 for
 210 failure.
 211 .PP
 212 \&\fBX509_REVOKED_get0_serialNumber()\fR returns an \fB\s-1ASN1_INTEGER\s0\fR pointer.
 213 .PP
 214 \&\fBX509_REVOKED_get0_revocationDate()\fR returns an \fB\s-1ASN1_TIME\s0\fR value.
 215 .PP
 216 \&\fBX509_CRL_get_REVOKED()\fR returns a \s-1STACK\s0 of revoked entries.
 217 .SH "SEE ALSO"
 218 .IX Header "SEE ALSO"
 219 \&\fBd2i_X509\fR\|(3),
 220 \&\fBERR_get_error\fR\|(3),
 221 \&\fBX509_get0_signature\fR\|(3),
 222 \&\fBX509_get_ext_d2i\fR\|(3),
 223 \&\fBX509_get_extension_flags\fR\|(3),
 224 \&\fBX509_get_pubkey\fR\|(3),
 225 \&\fBX509_get_subject_name\fR\|(3),
 226 \&\fBX509_get_version\fR\|(3),
 227 \&\fBX509_NAME_add_entry_by_txt\fR\|(3),
 228 \&\fBX509_NAME_ENTRY_get_object\fR\|(3),
 229 \&\fBX509_NAME_get_index_by_NID\fR\|(3),
 230 \&\fBX509_NAME_print_ex\fR\|(3),
 231 \&\fBX509_new\fR\|(3),
 232 \&\fBX509_sign\fR\|(3),
 233 \&\fBX509V3_get_d2i\fR\|(3),
 234 \&\fBX509_verify_cert\fR\|(3)
 235 .SH "COPYRIGHT"
 236 .IX Header "COPYRIGHT"
 237 Copyright 2015\-2016 The OpenSSL Project Authors. All Rights Reserved.
 238 .PP
 239 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 240 this file except in compliance with the License.  You can obtain a copy
 241 in the file \s-1LICENSE\s0 in the source distribution or at
 242 <https://www.openssl.org/source/license.html>.