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

   1 .\" Automatically generated by Pod::Man 4.14 (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_CMP 3"
 136 .TH X509_CMP 3 "2020-09-22" "1.1.1h" "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_cmp, X509_NAME_cmp, X509_issuer_and_serial_cmp, X509_issuer_name_cmp, X509_subject_name_cmp, X509_CRL_cmp, X509_CRL_match \&\- compare X509 certificates and related values
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/x509.h>
 147 \&
 148 \& int X509_cmp(const X509 *a, const X509 *b);
 149 \& int X509_NAME_cmp(const X509_NAME *a, const X509_NAME *b);
 150 \& int X509_issuer_and_serial_cmp(const X509 *a, const X509 *b);
 151 \& int X509_issuer_name_cmp(const X509 *a, const X509 *b);
 152 \& int X509_subject_name_cmp(const X509 *a, const X509 *b);
 153 \& int X509_CRL_cmp(const X509_CRL *a, const X509_CRL *b);
 154 \& int X509_CRL_match(const X509_CRL *a, const X509_CRL *b);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 This set of functions are used to compare X509 objects, including X509
 159 certificates, X509 \s-1CRL\s0 objects and various values in an X509 certificate.
 160 .PP
 161 The \fBX509_cmp()\fR function compares two \fBX509\fR objects indicated by parameters
 162 \&\fBa\fR and \fBb\fR. The comparison is based on the \fBmemcmp\fR result of the hash
 163 values of two \fBX509\fR objects and the canonical (\s-1DER\s0) encoding values.
 164 .PP
 165 The \fBX509_NAME_cmp()\fR function compares two \fBX509_NAME\fR objects indicated by
 166 parameters \fBa\fR and \fBb\fR. The comparison is based on the \fBmemcmp\fR result of
 167 the canonical (\s-1DER\s0) encoding values of the two objects. \fBi2d_X509_NAME\fR\|(3)
 168 has a more detailed description of the \s-1DER\s0 encoding of the \fBX509_NAME\fR structure.
 169 .PP
 170 The \fBX509_issuer_and_serial_cmp()\fR function compares the serial number and issuer
 171 values in the given \fBX509\fR objects \fBa\fR and \fBb\fR.
 172 .PP
 173 The \fBX509_issuer_name_cmp()\fR, \fBX509_subject_name_cmp()\fR and \fBX509_CRL_cmp()\fR functions
 174 are effectively wrappers of the \fBX509_NAME_cmp()\fR function. These functions compare
 175 issuer names and subject names of the  objects, or issuers of \fBX509_CRL\fR
 176 objects, respectively.
 177 .IX Xref "509"
 178 .PP
 179 The \fBX509_CRL_match()\fR function compares two \fBX509_CRL\fR objects. Unlike the
 180 \&\fBX509_CRL_cmp()\fR function, this function compares the whole \s-1CRL\s0 content instead
 181 of just the issuer name.
 182 .SH "RETURN VALUES"
 183 .IX Header "RETURN VALUES"
 184 Like common memory comparison functions, the \fBX509\fR comparison functions return
 185 an integer less than, equal to, or greater than zero if object \fBa\fR is found to
 186 be less than, to match, or be greater than object \fBb\fR, respectively.
 187 .PP
 188 \&\fBX509_NAME_cmp()\fR, \fBX509_issuer_and_serial_cmp()\fR, \fBX509_issuer_name_cmp()\fR,
 189 \&\fBX509_subject_name_cmp()\fR and \fBX509_CRL_cmp()\fR may return \fB\-2\fR to indicate an error.
 190 .SH "NOTES"
 191 .IX Header "NOTES"
 192 These functions in fact utilize the underlying \fBmemcmp\fR of the C library to do
 193 the comparison job. Data to be compared varies from \s-1DER\s0 encoding data, hash
 194 value or \fB\s-1ASN1_STRING\s0\fR. The sign of the comparison can be used to order the
 195 objects but it does not have a special meaning in some cases.
 196 .PP
 197 \&\fBX509_NAME_cmp()\fR and wrappers utilize the value \fB\-2\fR to indicate errors in some
 198 circumstances, which could cause confusion for the applications.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fBi2d_X509_NAME\fR\|(3), \fBi2d_X509\fR\|(3)
 202 .SH "COPYRIGHT"
 203 .IX Header "COPYRIGHT"
 204 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
 205 .PP
 206 Licensed under the Apache License 2.0 (the \*(L"License\*(R").  You may not use
 207 this file except in compliance with the License.  You can obtain a copy
 208 in the file \s-1LICENSE\s0 in the source distribution or at
 209 <https://www.openssl.org/source/license.html>.