doc/man3/X509_STORE_add_cert.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_STORE,
   6 X509_STORE_add_cert, X509_STORE_add_crl, X509_STORE_set_depth,
   7 X509_STORE_set_flags, X509_STORE_set_purpose, X509_STORE_set_trust,
   8 X509_STORE_add_lookup,
   9 X509_STORE_load_file, X509_STORE_load_path, X509_STORE_load_store,
  10 X509_STORE_set_default_paths,
  11 X509_STORE_load_locations
  12 - X509_STORE manipulation
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/x509_vfy.h>
  17
  18  typedef x509_store_st X509_STORE;
  19
  20  int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
  21  int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
  22  int X509_STORE_set_depth(X509_STORE *store, int depth);
  23  int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags);
  24  int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
  25  int X509_STORE_set_trust(X509_STORE *ctx, int trust);
  26
  27  X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *store,
  28                                     X509_LOOKUP_METHOD *meth);
  29
  30  int X509_STORE_set_default_paths(X509_STORE *ctx);
  31  int X509_STORE_load_file(X509_STORE *ctx, const char *file);
  32  int X509_STORE_load_path(X509_STORE *ctx, const char *dir);
  33  int X509_STORE_load_store(X509_STORE *ctx, const char *uri);
  34
  35  int X509_STORE_load_locations(X509_STORE *ctx,
  36                                const char *file, const char *dir);
  37
  38 =head1 DESCRIPTION
  39
  40 The B<X509_STORE> structure is intended to be a consolidated mechanism for
  41 holding information about X.509 certificates and CRLs, and constructing
  42 and validating chains of certificates terminating in trusted roots.
  43 It admits multiple lookup mechanisms and efficient scaling performance
  44 with large numbers of certificates, and a great deal of flexibility in
  45 how validation and policy checks are performed.
  46
  47 L<X509_STORE_new(3)> creates an empty B<X509_STORE> structure, which contains
  48 no information about trusted certificates or where such certificates
  49 are located on disk, and is generally not usable.  Normally, trusted
  50 certificates will be added to the B<X509_STORE> to prepare it for use,
  51 via mechanisms such as X509_STORE_add_lookup() and X509_LOOKUP_file(), or
  52 PEM_read_bio_X509_AUX() and X509_STORE_add_cert().  CRLs can also be added,
  53 and many behaviors configured as desired.
  54
  55 Once the B<X509_STORE> is suitably configured, X509_STORE_CTX_new() is
  56 used to instantiate a single-use B<X509_STORE_CTX> for each chain-building
  57 and verification operation.  That process includes providing the end-entity
  58 certificate to be verified and an additional set of untrusted certificates
  59 that may be used in chain-building.  As such, it is expected that the
  60 certificates included in the B<X509_STORE> are certificates that represent
  61 trusted entities such as root certificate authorities (CAs).
  62 OpenSSL represents these trusted certificates internally as B<X509> objects
  63 with an associated B<X509_CERT_AUX>, as are produced by
  64 PEM_read_bio_X509_AUX() and similar routines that refer to X509_AUX.
  65 The public interfaces that operate on such trusted certificates still
  66 operate on pointers to B<X509> objects, though.
  67
  68 X509_STORE_add_cert() and X509_STORE_add_crl() add the respective object
  69 to the B<X509_STORE>'s local storage.  Untrusted objects should not be
  70 added in this way.  The added object's reference count is incremented by one,
  71 hence the caller retains ownership of the object and needs to free it when it
  72 is no longer needed.
  73
  74 X509_STORE_set_depth(), X509_STORE_set_flags(), X509_STORE_set_purpose(),
  75 X509_STORE_set_trust(), and X509_STORE_set1_param() set the default values
  76 for the corresponding values used in certificate chain validation.  Their
  77 behavior is documented in the corresponding B<X509_VERIFY_PARAM> manual
  78 pages, e.g., L<X509_VERIFY_PARAM_set_depth(3)>.
  79
  80 X509_STORE_add_lookup() finds or creates a L<X509_LOOKUP(3)> with the
  81 L<X509_LOOKUP_METHOD(3)> I<meth> and adds it to the B<X509_STORE>
  82 I<store>.  This also associates the B<X509_STORE> with the lookup, so
  83 B<X509_LOOKUP> functions can look up objects in that store.
  84
  85 X509_STORE_load_file() loads trusted certificate(s) into an
  86 B<X509_STORE> from a given file.
  87
  88 X509_STORE_load_path() loads trusted certificate(s) into an
  89 B<X509_STORE> from a given directory path.
  90 The certificates in the directory must be in hashed form, as
  91 documented in L<X509_LOOKUP_hash_dir(3)>.
  92
  93 X509_STORE_load_store() loads trusted certificate(s) into an
  94 B<X509_STORE> from a store at a given URI.
  95
  96 X509_STORE_load_locations() combines X509_STORE_load_file() and
  97 X509_STORE_load_dir() for a given file and/or directory path.
  98 It is permitted to specify just a file, just a directory, or both
  99 paths.
 100
 101 X509_STORE_set_default_paths() is somewhat misnamed, in that it does not
 102 set what default paths should be used for loading certificates.  Instead,
 103 it loads certificates into the B<X509_STORE> from the hardcoded default
 104 paths.
 105
 106 =head1 RETURN VALUES
 107
 108 X509_STORE_add_cert(), X509_STORE_add_crl(), X509_STORE_set_depth(),
 109 X509_STORE_set_flags(), X509_STORE_set_purpose(),
 110 X509_STORE_set_trust(), X509_STORE_load_file(),
 111 X509_STORE_load_path(), X509_STORE_load_store(),
 112 X509_STORE_load_locations(), and X509_STORE_set_default_paths() return
 113 1 on success or 0 on failure.
 114
 115 X509_STORE_add_lookup() returns the found or created
 116 L<X509_LOOKUP(3)>, or NULL on error.
 117
 118 =head1 SEE ALSO
 119
 120 L<X509_LOOKUP_hash_dir(3)>.
 121 L<X509_VERIFY_PARAM_set_depth(3)>.
 122 L<X509_STORE_new(3)>,
 123 L<X509_STORE_get0_param(3)>
 124
 125 =head1 COPYRIGHT
 126
 127 Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
 128
 129 Licensed under the Apache License 2.0 (the "License").  You may not use
 130 this file except in compliance with the License.  You can obtain a copy
 131 in the file LICENSE in the source distribution or at
 132 L<https://www.openssl.org/source/license.html>.
 133
 134 =cut