doc/crypto/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_cert,
  11 X509_STORE_CTX_get0_untrusted,
  12 X509_STORE_CTX_get_num_untrusted,
  13 X509_STORE_CTX_set_default,
  14 X509_STORE_CTX_get_verify_cb,
  15 X509_STORE_CTX_set_verify,
  16 X509_STORE_CTX_get_verify - X509_STORE_CTX initialisation
  17
  18 =head1 SYNOPSIS
  19
  20  #include <openssl/x509_vfy.h>
  21
  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(X609_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(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  X509 *X509_STORE_CTX_get0_cert(X509_STORE_CTX *ctx);
  41  STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx);
  42
  43  int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx);
  44
  45  typedef int (*X509_STORE_CTX_verify)(X509_STORE_CTX *);
  46  X509_STORE_CTX_verify X509_STORE_CTX_get_verify(X509_STORE_CTX *ctx);
  47  void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify verify);
  48
  49
  50 =head1 DESCRIPTION
  51
  52 These functions initialise an B<X509_STORE_CTX> structure for subsequent use
  53 by X509_verify_cert().
  54
  55 X509_STORE_CTX_new() returns a newly initialised B<X509_STORE_CTX> structure.
  56
  57 X509_STORE_CTX_cleanup() internally cleans up an B<X509_STORE_CTX> structure.
  58 The context can then be reused with an new call to X509_STORE_CTX_init().
  59
  60 X509_STORE_CTX_free() completely frees up B<ctx>. After this call B<ctx>
  61 is no longer valid.
  62 If B<ctx> is NULL nothing is done.
  63
  64 X509_STORE_CTX_init() sets up B<ctx> for a subsequent verification operation.
  65 It must be called before each call to X509_verify_cert(), i.e. a B<ctx> is only
  66 good for one call to X509_verify_cert(); if you want to verify a second
  67 certificate with the same B<ctx> then you must call X509_XTORE_CTX_cleanup()
  68 and then X509_STORE_CTX_init() again before the second call to
  69 X509_verify_cert(). The trusted certificate store is set to B<store>, the end
  70 entity certificate to be verified is set to B<x509> and a set of additional
  71 certificates (which will be untrusted but may be used to build the chain) in
  72 B<chain>. Any or all of the B<store>, B<x509> and B<chain> parameters can be
  73 B<NULL>.
  74
  75 X509_STORE_CTX_set0_trusted_stack() sets the set of trusted certificates of
  76 B<ctx> to B<sk>. This is an alternative way of specifying trusted certificates
  77 instead of using an B<X509_STORE>.
  78
  79 X509_STORE_CTX_set_cert() sets the certificate to be verified in B<ctx> to
  80 B<x>.
  81
  82 X509_STORE_CTX_set0_verified_chain() sets the validated chain used
  83 by B<ctx> to be B<chain>.
  84 Ownership of the chain is transferred to B<ctx> and should not be
  85 free'd by the caller.
  86 X509_STORE_CTX_get0_chain() returns a the internal pointer used by the
  87 B<ctx> that contains the validated chain.
  88
  89 X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate
  90 verification to B<sk>. These CRLs will only be used if CRL verification is
  91 enabled in the associated B<X509_VERIFY_PARAM> structure. This might be
  92 used where additional "useful" CRLs are supplied as part of a protocol,
  93 for example in a PKCS#7 structure.
  94
  95 X509_STORE_CTX_get0_param() retrieves an internal pointer
  96 to the verification parameters associated with B<ctx>.
  97
  98 X509_STORE_CTX_get0_cert() retrieves an internal pointer to the
  99 certificate being verified by the B<ctx>.
 100
 101 X509_STORE_CTX_get0_untrusted() retrieves an internal pointer to the
 102 stack of untrusted certifieds associated with B<ctx>.
 103
 104 X509_STORE_CTX_set0_param() sets the internal verification parameter pointer
 105 to B<param>. After this call B<param> should not be used.
 106
 107 X509_STORE_CTX_set_default() looks up and sets the default verification
 108 method to B<name>. This uses the function X509_VERIFY_PARAM_lookup() to
 109 find an appropriate set of parameters from B<name>.
 110
 111 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
 112 that were used in building the chain following a call to X509_verify_cert().
 113
 114 =head1 NOTES
 115
 116 The certificates and CRLs in a store are used internally and should B<not>
 117 be freed up until after the associated B<X509_STORE_CTX> is freed.
 118
 119 =head1 BUGS
 120
 121 The certificates and CRLs in a context are used internally and should B<not>
 122 be freed up until after the associated B<X509_STORE_CTX> is freed. Copies
 123 should be made or reference counts increased instead.
 124
 125 =head1 RETURN VALUES
 126
 127 X509_STORE_CTX_new() returns an newly allocates context or B<NULL> is an
 128 error occurred.
 129
 130 X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred.
 131
 132 X509_STORE_CTX_get0_param() returns a pointer to an B<X509_VERIFY_PARAM>
 133 structure or B<NULL> if an error occurred.
 134
 135 X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(),
 136 X509_STORE_CTX_set0_trusted_stack(),
 137 X509_STORE_CTX_set_cert(),
 138 X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return
 139 values.
 140
 141 X509_STORE_CTX_set_default() returns 1 for success or 0 if an error occurred.
 142
 143 X509_STORE_CTX_get_num_untrusted() returns the number of untrusted certificates
 144 used.
 145
 146 =head1 SEE ALSO
 147
 148 L<X509_verify_cert(3)>
 149 L<X509_VERIFY_PARAM_set_flags(3)>
 150
 151 =head1 HISTORY
 152
 153 X509_STORE_CTX_set0_crls() was first added to OpenSSL 1.0.0
 154 X509_STORE_CTX_get_num_untrusted() was first added to OpenSSL 1.1.0
 155
 156 =cut