Current Path :
/
opt
/
cpanel
/
ea-openssl11
/
share
/
man
/
man3
/
Or
Select Your Path :
Upload File :
New :
File
Dir
//opt/cpanel/ea-openssl11/share/man/man3/X509_LOOKUP_get_store.3
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28) .\" .\" 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" '' . ds C` . ds C' '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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" 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_LOOKUP 3" .TH X509_LOOKUP 3 "2023-09-11" "1.1.1w" "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_LOOKUP, X509_LOOKUP_TYPE, X509_LOOKUP_new, X509_LOOKUP_free, X509_LOOKUP_init, X509_LOOKUP_shutdown, X509_LOOKUP_set_method_data, X509_LOOKUP_get_method_data, X509_LOOKUP_ctrl, X509_LOOKUP_load_file, X509_LOOKUP_add_dir, X509_LOOKUP_get_store, X509_LOOKUP_by_subject, X509_LOOKUP_by_issuer_serial, X509_LOOKUP_by_fingerprint, X509_LOOKUP_by_alias \&\- OpenSSL certificate lookup mechanisms .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& #include <openssl/x509_vfy.h> \& \& typedef x509_lookup_st X509_LOOKUP; \& \& typedef enum X509_LOOKUP_TYPE; \& \& X509_LOOKUP *X509_LOOKUP_new(X509_LOOKUP_METHOD *method); \& int X509_LOOKUP_init(X509_LOOKUP *ctx); \& int X509_LOOKUP_shutdown(X509_LOOKUP *ctx); \& void X509_LOOKUP_free(X509_LOOKUP *ctx); \& \& int X509_LOOKUP_set_method_data(X509_LOOKUP *ctx, void *data); \& void *X509_LOOKUP_get_method_data(const X509_LOOKUP *ctx); \& \& int X509_LOOKUP_ctrl(X509_LOOKUP *ctx, int cmd, const char *argc, \& long argl, char **ret); \& int X509_LOOKUP_load_file(X509_LOOKUP *ctx, char *name, long type); \& int X509_LOOKUP_add_dir(X509_LOOKUP *ctx, char *name, long type); \& \& X509_STORE *X509_LOOKUP_get_store(const X509_LOOKUP *ctx); \& \& int X509_LOOKUP_by_subject(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, \& X509_NAME *name, X509_OBJECT *ret); \& int X509_LOOKUP_by_issuer_serial(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, \& X509_NAME *name, ASN1_INTEGER *serial, \& X509_OBJECT *ret); \& int X509_LOOKUP_by_fingerprint(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, \& const unsigned char *bytes, int len, \& X509_OBJECT *ret); \& int X509_LOOKUP_by_alias(X509_LOOKUP *ctx, X509_LOOKUP_TYPE type, \& const char *str, int len, X509_OBJECT *ret); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBX509_LOOKUP\fR structure holds the information needed to look up certificates and CRLs according to an associated \fIX509_LOOKUP_METHOD\fR\|(3). Multiple \fBX509_LOOKUP\fR instances can be added to an \fIX509_STORE\fR\|(3) to enable lookup in that store. .PP \&\fIX509_LOOKUP_new()\fR creates a new \fBX509_LOOKUP\fR using the given lookup \&\fImethod\fR. It can also be created by calling \fIX509_STORE_add_lookup\fR\|(3), which will associate an \fBX509_STORE\fR with the lookup mechanism. .PP \&\fIX509_LOOKUP_init()\fR initializes the internal state and resources as needed by the given \fBX509_LOOKUP\fR to do its work. .PP \&\fIX509_LOOKUP_shutdown()\fR tears down the internal state and resources of the given \fBX509_LOOKUP\fR. .PP \&\fIX509_LOOKUP_free()\fR destructs the given \fBX509_LOOKUP\fR. .PP \&\fIX509_LOOKUP_set_method_data()\fR associates a pointer to application data to the given \fBX509_LOOKUP\fR. .PP \&\fIX509_LOOKUP_get_method_data()\fR retrieves a pointer to application data from the given \fBX509_LOOKUP\fR. .PP \&\fIX509_LOOKUP_ctrl()\fR is used to set or get additional data to or from an \&\fBX509_LOOKUP\fR structure or its associated \fIX509_LOOKUP_METHOD\fR\|(3). The arguments of the control command are passed via \fIargc\fR and \fIargl\fR, its return value via \fI*ret\fR. The meaning of the arguments depends on the \fIcmd\fR number of the control command. In general, this function is not called directly, but wrapped by a macro call, see below. The control \fIcmd\fRs known to OpenSSL are discussed in more depth in \*(L"Control Commands\*(R". .PP \&\fIX509_LOOKUP_load_file()\fR passes a filename to be loaded immediately into the associated \fBX509_STORE\fR. \&\fItype\fR indicates what type of object is expected. This can only be used with a lookup using the implementation \&\fIX509_LOOKUP_file\fR\|(3). .PP \&\fIX509_LOOKUP_add_dir()\fR passes a directory specification from which certificates and CRLs are loaded on demand into the associated \&\fBX509_STORE\fR. \&\fItype\fR indicates what type of object is expected. This can only be used with a lookup using the implementation \&\fIX509_LOOKUP_hash_dir\fR\|(3). .PP \&\fIX509_LOOKUP_load_file()\fR, \fIX509_LOOKUP_add_dir()\fR, \&\fIX509_LOOKUP_add_store()\fR, and \fIX509_LOOKUP_load_store()\fR are implemented as macros that use \fIX509_LOOKUP_ctrl()\fR. .PP \&\fIX509_LOOKUP_by_subject()\fR, \fIX509_LOOKUP_by_issuer_serial()\fR, \&\fIX509_LOOKUP_by_fingerprint()\fR, and \fIX509_LOOKUP_by_alias()\fR look up certificates and CRLs in the \fIX509_STORE\fR\|(3) associated with the \&\fBX509_LOOKUP\fR using different criteria, where the looked up object is stored in \fIret\fR. Some of the underlying \fBX509_LOOKUP_METHOD\fRs will also cache objects matching the criteria in the associated \fBX509_STORE\fR, which makes it possible to handle cases where the criteria have more than one hit. .SS "File Types" .IX Subsection "File Types" \&\fIX509_LOOKUP_load_file()\fR and \fIX509_LOOKUP_add_dir()\fR take a \fItype\fR, which can be one of the following: .IP "\fBX509_FILETYPE_PEM\fR" 4 .IX Item "X509_FILETYPE_PEM" The file or files that are loaded are expected to be in \s-1PEM\s0 format. .IP "\fBX509_FILETYPE_ASN1\fR" 4 .IX Item "X509_FILETYPE_ASN1" The file or files that are loaded are expected to be in raw \s-1DER\s0 format. .IP "\fBX509_FILETYPE_DEFAULT\fR" 4 .IX Item "X509_FILETYPE_DEFAULT" The default certificate file or directory is used. In this case, \&\fIname\fR is ignored. .SS "Control Commands" .IX Subsection "Control Commands" The \fBX509_LOOKUP_METHOD\fRs built into OpenSSL recognise the following \&\fIX509_LOOKUP_ctrl()\fR \fIcmd\fRs: .IP "\fBX509_L_FILE_LOAD\fR" 4 .IX Item "X509_L_FILE_LOAD" This is the command that \fIX509_LOOKUP_load_file()\fR uses. The filename is passed in \fIargc\fR, and the type in \fIargl\fR. .IP "\fBX509_L_ADD_DIR\fR" 4 .IX Item "X509_L_ADD_DIR" This is the command that \fIX509_LOOKUP_add_dir()\fR uses. The directory specification is passed in \fIargc\fR, and the type in \&\fIargl\fR. .IP "\fBX509_L_ADD_STORE\fR" 4 .IX Item "X509_L_ADD_STORE" This is the command that \fIX509_LOOKUP_add_store()\fR uses. The \s-1URI\s0 is passed in \fIargc\fR. .IP "\fBX509_L_LOAD_STORE\fR" 4 .IX Item "X509_L_LOAD_STORE" This is the command that \fIX509_LOOKUP_load_store()\fR uses. The \s-1URI\s0 is passed in \fIargc\fR. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fIX509_LOOKUP_new()\fR returns an \fBX509_LOOKUP\fR pointer when successful, or \s-1NULL\s0 on error. .PP \&\fIX509_LOOKUP_init()\fR and \fIX509_LOOKUP_shutdown()\fR return 1 on success, or 0 on error. .PP \&\fIX509_LOOKUP_ctrl()\fR returns \-1 if the \fBX509_LOOKUP\fR doesn't have an associated \fBX509_LOOKUP_METHOD\fR, or 1 if the doesn't have a control function. Otherwise, it returns what the control function in the \&\fBX509_LOOKUP_METHOD\fR returns, which is usually 1 on success and 0 in error. .IX Xref "509_LOOKUP_METHOD" .PP \&\fIX509_LOOKUP_get_store()\fR returns an \fBX509_STORE\fR pointer if there is one, otherwise \s-1NULL.\s0 .PP \&\fIX509_LOOKUP_by_subject()\fR, \fIX509_LOOKUP_by_issuer_serial()\fR, \&\fIX509_LOOKUP_by_fingerprint()\fR, and \fIX509_LOOKUP_by_alias()\fR all return 0 if there is no \fBX509_LOOKUP_METHOD\fR or that method doesn't implement the corresponding function. Otherwise, it returns what the corresponding function in the \&\fBX509_LOOKUP_METHOD\fR returns, which is usually 1 on success and 0 in error. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fIX509_LOOKUP_METHOD\fR\|(3), \fIX509_STORE\fR\|(3) .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2020 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>.
