secure/lib/libcrypto/man/man3/X509_LOOKUP_meth_new.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_LOOKUP_METH_NEW 3"
 136 .TH X509_LOOKUP_METH_NEW 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_LOOKUP_METHOD, X509_LOOKUP_meth_new, X509_LOOKUP_meth_free, X509_LOOKUP_meth_set_new_item, X509_LOOKUP_meth_get_new_item, X509_LOOKUP_meth_set_free, X509_LOOKUP_meth_get_free, X509_LOOKUP_meth_set_init, X509_LOOKUP_meth_get_init, X509_LOOKUP_meth_set_shutdown, X509_LOOKUP_meth_get_shutdown, X509_LOOKUP_ctrl_fn, X509_LOOKUP_meth_set_ctrl, X509_LOOKUP_meth_get_ctrl, X509_LOOKUP_get_by_subject_fn, X509_LOOKUP_meth_set_get_by_subject, X509_LOOKUP_meth_get_get_by_subject, X509_LOOKUP_get_by_issuer_serial_fn, X509_LOOKUP_meth_set_get_by_issuer_serial, X509_LOOKUP_meth_get_get_by_issuer_serial, X509_LOOKUP_get_by_fingerprint_fn, X509_LOOKUP_meth_set_get_by_fingerprint, X509_LOOKUP_meth_get_get_by_fingerprint, X509_LOOKUP_get_by_alias_fn, X509_LOOKUP_meth_set_get_by_alias, X509_LOOKUP_meth_get_get_by_alias, X509_OBJECT_set1_X509, X509_OBJECT_set1_X509_CRL \&\- Routines to build up X509_LOOKUP methods
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/x509_vfy.h>
 147 \&
 148 \& typedef x509_lookup_method_st X509_LOOKUP_METHOD;
 149 \&
 150 \& X509_LOOKUP_METHOD *X509_LOOKUP_meth_new(const char *name);
 151 \& void X509_LOOKUP_meth_free(X509_LOOKUP_METHOD *method);
 152 \&
 153 \& int X509_LOOKUP_meth_set_new_item(X509_LOOKUP_METHOD *method,
 154 \&                                   int (*new_item) (X509_LOOKUP *ctx));
 155 \& int (*X509_LOOKUP_meth_get_new_item(const X509_LOOKUP_METHOD* method))
 156 \&     (X509_LOOKUP *ctx);
 157 \&
 158 \& int X509_LOOKUP_meth_set_free(X509_LOOKUP_METHOD *method,
 159 \&                               void (*free) (X509_LOOKUP *ctx));
 160 \& void (*X509_LOOKUP_meth_get_free(const X509_LOOKUP_METHOD* method))
 161 \&     (X509_LOOKUP *ctx);
 162 \&
 163 \& int X509_LOOKUP_meth_set_init(X509_LOOKUP_METHOD *method,
 164 \&                               int (*init) (X509_LOOKUP *ctx));
 165 \& int (*X509_LOOKUP_meth_get_init(const X509_LOOKUP_METHOD* method))
 166 \&     (X509_LOOKUP *ctx);
 167 \&
 168 \& int X509_LOOKUP_meth_set_shutdown(X509_LOOKUP_METHOD *method,
 169 \&                                   int (*shutdown) (X509_LOOKUP *ctx));
 170 \& int (*X509_LOOKUP_meth_get_shutdown(const X509_LOOKUP_METHOD* method))
 171 \&     (X509_LOOKUP *ctx);
 172 \&
 173 \& typedef int (*X509_LOOKUP_ctrl_fn)(X509_LOOKUP *ctx, int cmd, const char *argc,
 174 \&                                    long argl, char **ret);
 175 \& int X509_LOOKUP_meth_set_ctrl(X509_LOOKUP_METHOD *method,
 176 \&     X509_LOOKUP_ctrl_fn ctrl_fn);
 177 \& X509_LOOKUP_ctrl_fn X509_LOOKUP_meth_get_ctrl(const X509_LOOKUP_METHOD *method);
 178 \&
 179 \& typedef int (*X509_LOOKUP_get_by_subject_fn)(X509_LOOKUP *ctx,
 180 \&                                              X509_LOOKUP_TYPE type,
 181 \&                                              X509_NAME *name,
 182 \&                                              X509_OBJECT *ret);
 183 \& int X509_LOOKUP_meth_set_get_by_subject(X509_LOOKUP_METHOD *method,
 184 \&     X509_LOOKUP_get_by_subject_fn fn);
 185 \& X509_LOOKUP_get_by_subject_fn X509_LOOKUP_meth_get_get_by_subject(
 186 \&     const X509_LOOKUP_METHOD *method);
 187 \&
 188 \& typedef int (*X509_LOOKUP_get_by_issuer_serial_fn)(X509_LOOKUP *ctx,
 189 \&                                                    X509_LOOKUP_TYPE type,
 190 \&                                                    X509_NAME *name,
 191 \&                                                    ASN1_INTEGER *serial,
 192 \&                                                    X509_OBJECT *ret);
 193 \& int X509_LOOKUP_meth_set_get_by_issuer_serial(
 194 \&     X509_LOOKUP_METHOD *method, X509_LOOKUP_get_by_issuer_serial_fn fn);
 195 \& X509_LOOKUP_get_by_issuer_serial_fn X509_LOOKUP_meth_get_get_by_issuer_serial(
 196 \&     const X509_LOOKUP_METHOD *method);
 197 \&
 198 \& typedef int (*X509_LOOKUP_get_by_fingerprint_fn)(X509_LOOKUP *ctx,
 199 \&                                                  X509_LOOKUP_TYPE type,
 200 \&                                                  const unsigned char* bytes,
 201 \&                                                  int len,
 202 \&                                                  X509_OBJECT *ret);
 203 \& int X509_LOOKUP_meth_set_get_by_fingerprint(X509_LOOKUP_METHOD *method,
 204 \&     X509_LOOKUP_get_by_fingerprint_fn fn);
 205 \& X509_LOOKUP_get_by_fingerprint_fn X509_LOOKUP_meth_get_get_by_fingerprint(
 206 \&     const X509_LOOKUP_METHOD *method);
 207 \&
 208 \& typedef int (*X509_LOOKUP_get_by_alias_fn)(X509_LOOKUP *ctx,
 209 \&                                            X509_LOOKUP_TYPE type,
 210 \&                                            const char *str,
 211 \&                                            int len,
 212 \&                                            X509_OBJECT *ret);
 213 \& int X509_LOOKUP_meth_set_get_by_alias(X509_LOOKUP_METHOD *method,
 214 \&     X509_LOOKUP_get_by_alias_fn fn);
 215 \& X509_LOOKUP_get_by_alias_fn X509_LOOKUP_meth_get_get_by_alias(
 216 \&     const X509_LOOKUP_METHOD *method);
 217 \&
 218 \& int X509_OBJECT_set1_X509(X509_OBJECT *a, X509 *obj);
 219 \& int X509_OBJECT_set1_X509_CRL(X509_OBJECT *a, X509_CRL *obj);
 220 .Ve
 221 .SH "DESCRIPTION"
 222 .IX Header "DESCRIPTION"
 223 The \fBX509_LOOKUP_METHOD\fR type is a structure used for the implementation of new
 224 X509_LOOKUP types. It provides a set of functions used by OpenSSL for the
 225 implementation of various X509 and X509_CRL lookup capabilities. One instance
 226 of an X509_LOOKUP_METHOD can be associated to many instantiations of an
 227 \&\fBX509_LOOKUP\fR structure.
 228 .PP
 229 \&\fBX509_LOOKUP_meth_new()\fR creates a new \fBX509_LOOKUP_METHOD\fR structure. It should
 230 be given a human-readable string containing a brief description of the lookup
 231 method.
 232 .PP
 233 \&\fBX509_LOOKUP_meth_free()\fR destroys a \fBX509_LOOKUP_METHOD\fR structure.
 234 .PP
 235 \&\fBX509_LOOKUP_get_new_item()\fR and \fBX509_LOOKUP_set_new_item()\fR get and set the
 236 function that is called when an \fBX509_LOOKUP\fR object is created with
 237 \&\fBX509_LOOKUP_new()\fR. If an X509_LOOKUP_METHOD requires any per\-X509_LOOKUP
 238 specific data, the supplied new_item function should allocate this data and
 239 invoke \fBX509_LOOKUP_set_method_data\fR\|(3).
 240 .PP
 241 \&\fBX509_LOOKUP_get_free()\fR and \fBX509_LOOKUP_set_free()\fR get and set the function
 242 that is used to free any method data that was allocated and set from within
 243 new_item function.
 244 .PP
 245 \&\fBX509_LOOKUP_meth_get_init()\fR and \fBX509_LOOKUP_meth_set_init()\fR get and set the
 246 function that is used to initialize the method data that was set with
 247 \&\fBX509_LOOKUP_set_method_data\fR\|(3) as part of the new_item routine.
 248 .PP
 249 \&\fBX509_LOOKUP_meth_get_shutdown()\fR and \fBX509_LOOKUP_meth_set_shutdown()\fR get and set
 250 the function that is used to shut down the method data whose state was
 251 previously initialized in the init function.
 252 .PP
 253 \&\fBX509_LOOKUP_meth_get_ctrl()\fR and \fBX509_LOOKUP_meth_set_ctrl()\fR get and set a
 254 function to be used to handle arbitrary control commands issued by
 255 \&\fBX509_LOOKUP_ctrl()\fR. The control function is given the X509_LOOKUP
 256 \&\fBctx\fR, along with the arguments passed by X509_LOOKUP_ctrl. \fBcmd\fR is
 257 an arbitrary integer that defines some operation. \fBargc\fR is a pointer
 258 to an array of characters. \fBargl\fR is an integer. \fBret\fR, if set,
 259 points to a location where any return data should be written to. How
 260 \&\fBargc\fR and \fBargl\fR are used depends entirely on the control function.
 261 .PP
 262 \&\fBX509_LOOKUP_set_get_by_subject()\fR, \fBX509_LOOKUP_set_get_by_issuer_serial()\fR,
 263 \&\fBX509_LOOKUP_set_get_by_fingerprint()\fR, \fBX509_LOOKUP_set_get_by_alias()\fR set
 264 the functions used to retrieve an X509 or X509_CRL object by the object's
 265 subject, issuer, fingerprint, and alias respectively. These functions are given
 266 the X509_LOOKUP context, the type of the X509_OBJECT being requested, parameters
 267 related to the lookup, and an X509_OBJECT that will receive the requested
 268 object.
 269 .PP
 270 Implementations must add objects they find to the \fBX509_STORE\fR object
 271 using \fBX509_STORE_add_cert()\fR or \fBX509_STORE_add_crl()\fR.  This increments
 272 its reference count.  However, the \fBX509_STORE_CTX_get_by_subject()\fR
 273 function also increases the reference count which leads to one too
 274 many references being held.  Therefore, applications should
 275 additionally call \fBX509_free()\fR or \fBX509_CRL_free()\fR to decrement the
 276 reference count again.
 277 .PP
 278 Implementations should also use either \fBX509_OBJECT_set1_X509()\fR or
 279 \&\fBX509_OBJECT_set1_X509_CRL()\fR to set the result.  Note that this also
 280 increments the result's reference count.
 281 .PP
 282 Any method data that was created as a result of the new_item function
 283 set by \fBX509_LOOKUP_meth_set_new_item()\fR can be accessed with
 284 \&\fBX509_LOOKUP_get_method_data\fR\|(3). The \fBX509_STORE\fR object that owns the
 285 X509_LOOKUP may be accessed with \fBX509_LOOKUP_get_store\fR\|(3). Successful
 286 lookups should return 1, and unsuccessful lookups should return 0.
 287 .PP
 288 \&\fBX509_LOOKUP_get_get_by_subject()\fR, \fBX509_LOOKUP_get_get_by_issuer_serial()\fR,
 289 \&\fBX509_LOOKUP_get_get_by_fingerprint()\fR, \fBX509_LOOKUP_get_get_by_alias()\fR retrieve
 290 the function set by the corresponding setter.
 291 .SH "RETURN VALUES"
 292 .IX Header "RETURN VALUES"
 293 The \fBX509_LOOKUP_meth_set\fR functions return 1 on success or 0 on error.
 294 .PP
 295 The \fBX509_LOOKUP_meth_get\fR functions return the corresponding function
 296 pointers.
 297 .SH "SEE ALSO"
 298 .IX Header "SEE ALSO"
 299 \&\fBX509_STORE_new\fR\|(3), \fBSSL_CTX_set_cert_store\fR\|(3)
 300 .SH "HISTORY"
 301 .IX Header "HISTORY"
 302 The functions described here were added in OpenSSL 1.1.0i.
 303 .SH "COPYRIGHT"
 304 .IX Header "COPYRIGHT"
 305 Copyright 2018\-2020 The OpenSSL Project Authors. All Rights Reserved.
 306 .PP
 307 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 308 this file except in compliance with the License.  You can obtain a copy
 309 in the file \s-1LICENSE\s0 in the source distribution or at
 310 <https://www.openssl.org/source/license.html>.