Edit File: X509_LOOKUP_by_alias.html
<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>X509_LOOKUP</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:root@localhost" /> </head> <body> <ul id="index"> <li><a href="#NAME">NAME</a></li> <li><a href="#SYNOPSIS">SYNOPSIS</a></li> <li><a href="#DESCRIPTION">DESCRIPTION</a> <ul> <li><a href="#File-Types">File Types</a></li> <li><a href="#Control-Commands">Control Commands</a></li> </ul> </li> <li><a href="#RETURN-VALUES">RETURN VALUES</a></li> <li><a href="#SEE-ALSO">SEE ALSO</a></li> <li><a href="#COPYRIGHT">COPYRIGHT</a></li> </ul> <h1 id="NAME">NAME</h1> <p>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</p> <h1 id="SYNOPSIS">SYNOPSIS</h1> <pre><code> #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);</code></pre> <h1 id="DESCRIPTION">DESCRIPTION</h1> <p>The <b>X509_LOOKUP</b> structure holds the information needed to look up certificates and CRLs according to an associated <a href="../man3/X509_LOOKUP_METHOD.html">X509_LOOKUP_METHOD(3)</a>. Multiple <b>X509_LOOKUP</b> instances can be added to an <a href="../man3/X509_STORE.html">X509_STORE(3)</a> to enable lookup in that store.</p> <p>X509_LOOKUP_new() creates a new <b>X509_LOOKUP</b> using the given lookup <i>method</i>. It can also be created by calling <a href="../man3/X509_STORE_add_lookup.html">X509_STORE_add_lookup(3)</a>, which will associate an <b>X509_STORE</b> with the lookup mechanism.</p> <p>X509_LOOKUP_init() initializes the internal state and resources as needed by the given <b>X509_LOOKUP</b> to do its work.</p> <p>X509_LOOKUP_shutdown() tears down the internal state and resources of the given <b>X509_LOOKUP</b>.</p> <p>X509_LOOKUP_free() destructs the given <b>X509_LOOKUP</b>.</p> <p>X509_LOOKUP_set_method_data() associates a pointer to application data to the given <b>X509_LOOKUP</b>.</p> <p>X509_LOOKUP_get_method_data() retrieves a pointer to application data from the given <b>X509_LOOKUP</b>.</p> <p>X509_LOOKUP_ctrl() is used to set or get additional data to or from an <b>X509_LOOKUP</b> structure or its associated <a href="../man3/X509_LOOKUP_METHOD.html">X509_LOOKUP_METHOD(3)</a>. The arguments of the control command are passed via <i>argc</i> and <i>argl</i>, its return value via <i>*ret</i>. The meaning of the arguments depends on the <i>cmd</i> number of the control command. In general, this function is not called directly, but wrapped by a macro call, see below. The control <i>cmd</i>s known to OpenSSL are discussed in more depth in <a href="#Control-Commands">"Control Commands"</a>.</p> <p>X509_LOOKUP_load_file() passes a filename to be loaded immediately into the associated <b>X509_STORE</b>. <i>type</i> indicates what type of object is expected. This can only be used with a lookup using the implementation <a href="../man3/X509_LOOKUP_file.html">X509_LOOKUP_file(3)</a>.</p> <p>X509_LOOKUP_add_dir() passes a directory specification from which certificates and CRLs are loaded on demand into the associated <b>X509_STORE</b>. <i>type</i> indicates what type of object is expected. This can only be used with a lookup using the implementation <a href="../man3/X509_LOOKUP_hash_dir.html">X509_LOOKUP_hash_dir(3)</a>.</p> <p>X509_LOOKUP_load_file(), X509_LOOKUP_add_dir(), X509_LOOKUP_add_store(), and X509_LOOKUP_load_store() are implemented as macros that use X509_LOOKUP_ctrl().</p> <p>X509_LOOKUP_by_subject(), X509_LOOKUP_by_issuer_serial(), X509_LOOKUP_by_fingerprint(), and X509_LOOKUP_by_alias() look up certificates and CRLs in the <a href="../man3/X509_STORE.html">X509_STORE(3)</a> associated with the <b>X509_LOOKUP</b> using different criteria, where the looked up object is stored in <i>ret</i>. Some of the underlying <b>X509_LOOKUP_METHOD</b>s will also cache objects matching the criteria in the associated <b>X509_STORE</b>, which makes it possible to handle cases where the criteria have more than one hit.</p> <h2 id="File-Types">File Types</h2> <p>X509_LOOKUP_load_file() and X509_LOOKUP_add_dir() take a <i>type</i>, which can be one of the following:</p> <dl> <dt id="X509_FILETYPE_PEM"><b>X509_FILETYPE_PEM</b></dt> <dd> <p>The file or files that are loaded are expected to be in PEM format.</p> </dd> <dt id="X509_FILETYPE_ASN1"><b>X509_FILETYPE_ASN1</b></dt> <dd> <p>The file or files that are loaded are expected to be in raw DER format.</p> </dd> <dt id="X509_FILETYPE_DEFAULT"><b>X509_FILETYPE_DEFAULT</b></dt> <dd> <p>The default certificate file or directory is used. In this case, <i>name</i> is ignored.</p> </dd> </dl> <h2 id="Control-Commands">Control Commands</h2> <p>The <b>X509_LOOKUP_METHOD</b>s built into OpenSSL recognise the following X509_LOOKUP_ctrl() <i>cmd</i>s:</p> <dl> <dt id="X509_L_FILE_LOAD"><b>X509_L_FILE_LOAD</b></dt> <dd> <p>This is the command that X509_LOOKUP_load_file() uses. The filename is passed in <i>argc</i>, and the type in <i>argl</i>.</p> </dd> <dt id="X509_L_ADD_DIR"><b>X509_L_ADD_DIR</b></dt> <dd> <p>This is the command that X509_LOOKUP_add_dir() uses. The directory specification is passed in <i>argc</i>, and the type in <i>argl</i>.</p> </dd> <dt id="X509_L_ADD_STORE"><b>X509_L_ADD_STORE</b></dt> <dd> <p>This is the command that X509_LOOKUP_add_store() uses. The URI is passed in <i>argc</i>.</p> </dd> <dt id="X509_L_LOAD_STORE"><b>X509_L_LOAD_STORE</b></dt> <dd> <p>This is the command that X509_LOOKUP_load_store() uses. The URI is passed in <i>argc</i>.</p> </dd> </dl> <h1 id="RETURN-VALUES">RETURN VALUES</h1> <p>X509_LOOKUP_new() returns an <b>X509_LOOKUP</b> pointer when successful, or NULL on error.</p> <p>X509_LOOKUP_init() and X509_LOOKUP_shutdown() return 1 on success, or 0 on error.</p> <p>X509_LOOKUP_ctrl() returns -1 if the <b>X509_LOOKUP</b> doesn't have an associated <b>X509_LOOKUP_METHOD</b>, or 1 if the doesn't have a control function. Otherwise, it returns what the control function in the <b>X509_LOOKUP_METHOD</b> returns, which is usually 1 on success and 0 in error.</p> <p>X509_LOOKUP_get_store() returns an <b>X509_STORE</b> pointer if there is one, otherwise NULL.</p> <p>X509_LOOKUP_by_subject(), X509_LOOKUP_by_issuer_serial(), X509_LOOKUP_by_fingerprint(), and X509_LOOKUP_by_alias() all return 0 if there is no <b>X509_LOOKUP_METHOD</b> or that method doesn't implement the corresponding function. Otherwise, it returns what the corresponding function in the <b>X509_LOOKUP_METHOD</b> returns, which is usually 1 on success and 0 in error.</p> <h1 id="SEE-ALSO">SEE ALSO</h1> <p><a href="../man3/X509_LOOKUP_METHOD.html">X509_LOOKUP_METHOD(3)</a>, <a href="../man3/X509_STORE.html">X509_STORE(3)</a></p> <h1 id="COPYRIGHT">COPYRIGHT</h1> <p>Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.</p> <p>Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <a href="https://www.openssl.org/source/license.html">https://www.openssl.org/source/license.html</a>.</p> </body> </html>