doc/man3/X509_STORE_CTX_new.pod

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