doc/man3/X509_STORE_CTX_new.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 X509_STORE_CTX_new_ex, X509_STORE_CTX_new, X509_STORE_CTX_cleanup,
   6 X509_STORE_CTX_free, X509_STORE_CTX_init, X509_STORE_CTX_set0_trusted_stack,
   7 X509_STORE_CTX_set_cert, X509_STORE_CTX_set0_crls,
   8 X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain,
   9 X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param,
  10 X509_STORE_CTX_get0_untrusted, X509_STORE_CTX_set0_untrusted,
  11 X509_STORE_CTX_get_num_untrusted,
  12 X509_STORE_CTX_set_default,
  13 X509_STORE_CTX_set_verify,
  14 X509_STORE_CTX_verify_fn
  15 - X509_STORE_CTX initialisation
  16
  17 =head1 SYNOPSIS
  18
  19  #include <openssl/x509_vfy.h>
  20
  21  X509_STORE_CTX *X509_STORE_CTX_new_ex(OSSL_LIB_CTX *libctx, const char *propq);
  22  X509_STORE_CTX *X509_STORE_CTX_new(void);
  23  void X509_STORE_CTX_cleanup(X509_STORE_CTX *ctx);
  24  void X509_STORE_CTX_free(X509_STORE_CTX *ctx);
  25
  26  int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store,
  27                          X509 *x509, STACK_OF(X509) *chain);
  28
  29  void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
  30
  31  void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx, X509 *x);
  32  STACK_OF(X509) *X509_STORE_CTX_get0_chain(const X509_STORE_CTX *ctx);
  33  void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain);
  34  void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk);
  35
  36  X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(const X509_STORE_CTX *ctx);
  37  void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param);
  38  int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name);
  39
  40  STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(const X509_STORE_CTX *ctx);
  41  void X509_STORE_CTX_set0_untrusted(X509_STORE_CTX *ctx, STACK_OF(X509) *sk);
  42
  43  int X509_STORE_CTX_get_num_untrusted(const X509_STORE_CTX *ctx);
  44
  45  typedef int (*X509_STORE_CTX_verify_fn)(X509_STORE_CTX *);
  46  void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify_fn verify);
  47
  48 =head1 DESCRIPTION
  49
  50 These functions initialise an B<X509_STORE_CTX> structure for subsequent use
  51 by X509_verify_cert().
  52
  53 X509_STORE_CTX_new_ex() returns a newly initialised B<X509_STORE_CTX>
  54 structure associated with the specified library context I<libctx> and property
  55 query string I<propq>. Any cryptographic algorithms fetched while performing
  56 processing with the X509_STORE_CTX will use that library context and property
  57 query string.
  58
  59 X509_STORE_CTX_new() is the same as X509_STORE_CTX_new_ex() except that
  60 the default library context and a NULL property query string are used.
  61
  62 X509_STORE_CTX_cleanup() internally cleans up an B<X509_STORE_CTX> structure.
  63 The context can then be reused with a new call to X509_STORE_CTX_init().
  64
  65 X509_STORE_CTX_free() completely frees up I<ctx>. After this call I<ctx>
  66 is no longer valid.
  67 If I<ctx> is NULL nothing is done.
  68
  69 X509_STORE_CTX_init() sets up I<ctx> for a subsequent verification operation.
  70 It must be called before each call to X509_verify_cert(), i.e. a I<ctx> is only
  71 good for one call to X509_verify_cert(); if you want to verify a second
  72 certificate with the same I<ctx> then you must call X509_STORE_CTX_cleanup()
  73 and then X509_STORE_CTX_init() again before the second call to
  74 X509_verify_cert(). The trusted certificate store is set to I<store>, the end
  75 entity certificate to be verified is set to I<x509> and a set of additional
  76 certificates (which will be untrusted but may be used to build the chain) in
  77 I<chain>. Any or all of the I<store>, I<x509> and I<chain> parameters can be
  78 B<NULL>.
  79
  80 X509_STORE_CTX_set0_trusted_stack() sets the set of trusted certificates of
  81 I<ctx> to I<sk>. This is an alternative way of specifying trusted certificates
  82 instead of using an B<X509_STORE>.
  83
  84 X509_STORE_CTX_set_cert() sets the certificate to be verified in I<ctx> to
  85 I<x>.
  86
  87 X509_STORE_CTX_set0_verified_chain() sets the validated chain used
  88 by I<ctx> to be I<chain>.
  89 Ownership of the chain is transferred to I<ctx> and should not be
  90 free'd by the caller.
  91 X509_STORE_CTX_get0_chain() returns the internal pointer used by the
  92 I<ctx> that contains the validated chain.
  93
  94 X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
  95 verification to I<sk>. These CRLs will only be used if CRL verification is
  96 enabled in the associated B<X509_VERIFY_PARAM> structure. This might be
  97 used where additional "useful" CRLs are supplied as part of a protocol,
  98 for example in a PKCS#7 structure.
  99
 100 X509_STORE_CTX_get0_param() retrieves an internal pointer
 101 to the verification parameters associated with I<ctx>.
 102
 103 X509_STORE_CTX_get0_untrusted() retrieves an internal pointer to the
 104 stack of untrusted certificates associated with I<ctx>.
 105
 106 X509_STORE_CTX_set0_untrusted() sets the internal point to the stack
 107 of untrusted certificates associated with I<ctx> to I<sk>.
 108
 109 X509_STORE_CTX_set0_param() sets the internal verification parameter pointer
 110 to I<param>. After this call B<param> should not be used.
 111
 112 X509_STORE_CTX_set_default() looks up and sets the default verification
 113 method to I<name>. This uses the function X509_VERIFY_PARAM_lookup() to
 114 find an appropriate set of parameters from I<name>.
 115
 116 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
 117 that were used in building the chain following a call to X509_verify_cert().
 118
 119 X509_STORE_CTX_set_verify() provides the capability for overriding the default
 120 verify function. This function is responsible for verifying chain signatures and
 121 expiration times.
 122
 123 A verify function is defined as an X509_STORE_CTX_verify type which has the
 124 following signature:
 125
 126  int (*verify)(X509_STORE_CTX *);
 127
 128 This function should receive the current X509_STORE_CTX as a parameter and
 129 return 1 on success or 0 on failure.
 130
 131 =head1 NOTES
 132
 133 The certificates and CRLs in a store are used internally and should B<not>
 134 be freed up until after the associated B<X509_STORE_CTX> is freed.
 135
 136 =head1 BUGS
 137
 138 The certificates and CRLs in a context are used internally and should B<not>
 139 be freed up until after the associated B<X509_STORE_CTX> is freed. Copies
 140 should be made or reference counts increased instead.
 141
 142 =head1 RETURN VALUES
 143
 144 X509_STORE_CTX_new() returns a newly allocates context or B<NULL> is an
 145 error occurred.
 146
 147 X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
 148
 149 X509_STORE_CTX_get0_param() returns a pointer to an B<X509_VERIFY_PARAM>
 150 structure or B<NULL> if an error occurred.
 151
 152 X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(),
 153 X509_STORE_CTX_set0_trusted_stack(),
 154 X509_STORE_CTX_set_cert(),
 155 X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return
 156 values.
 157
 158 X509_STORE_CTX_set_default() returns 1 for success or 0 if an error occurred.
 159
 160 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
 161 used.
 162
 163 =head1 SEE ALSO
 164
 165 L<X509_verify_cert(3)>
 166 L<X509_VERIFY_PARAM_set_flags(3)>
 167
 168 =head1 HISTORY
 169
 170 The X509_STORE_CTX_set0_crls() function was added in OpenSSL 1.0.0.
 171 The X509_STORE_CTX_get_num_untrusted() function was added in OpenSSL 1.1.0.
 172 The X509_STORE_CTX_new_ex() function was added in OpenSSL 3.0.
 173
 174 =head1 COPYRIGHT
 175
 176 Copyright 2009-2020 The OpenSSL Project Authors. All Rights Reserved.
 177
 178 Licensed under the Apache License 2.0 (the "License").  You may not use
 179 this file except in compliance with the License.  You can obtain a copy
 180 in the file LICENSE in the source distribution or at
 181 L<https://www.openssl.org/source/license.html>.
 182
 183 =cut