X-Git-Url: https://git.openssl.org/gitweb/?a=blobdiff_plain;f=doc%2Fcrypto%2FX509_STORE_CTX_new.pod;fp=doc%2Fcrypto%2FX509_STORE_CTX_new.pod;h=69ff7c453886e8bc3c21d7316261c5b4b74f7d1b;hb=f0e0fd51fd8307f6eae64862ad9aaea113f1177a;hp=1f3ded6d29d970ba93c720ccd0ff2845cc65bd21;hpb=34da11b39d2421f546ec568f355875eec353844c;p=openssl.git diff --git a/doc/crypto/X509_STORE_CTX_new.pod b/doc/crypto/X509_STORE_CTX_new.pod index 1f3ded6d29..69ff7c4538 100644 --- a/doc/crypto/X509_STORE_CTX_new.pod +++ b/doc/crypto/X509_STORE_CTX_new.pod @@ -2,7 +2,18 @@ =head1 NAME -X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, X509_STORE_CTX_init, X509_STORE_CTX_trusted_stack, X509_STORE_CTX_set_cert, X509_STORE_CTX_set_chain, X509_STORE_CTX_set0_crls, X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param, X509_STORE_CTX_set_default - X509_STORE_CTX initialisation +X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, +X509_STORE_CTX_init, X509_STORE_CTX_set0_trusted_stack, X509_STORE_CTX_set_cert, +X509_STORE_CTX_set0_crls, +X509_STORE_CTX_get0_chain, X509_STORE_CTX_set0_verified_chain, +X509_STORE_CTX_get0_param, X509_STORE_CTX_set0_param, +X509_STORE_CTX_get0_cert, +X509_STORE_CTX_get0_untrusted, +X509_STORE_CTX_get_num_untrusted, +X509_STORE_CTX_set_default, +X509_STORE_CTX_get_verify_cb, +X509_STORE_CTX_set_verify, +X509_STORE_CTX_get_verify - X509_STORE_CTX initialisation =head1 SYNOPSIS @@ -15,18 +26,27 @@ X509_STORE_CTX_new, X509_STORE_CTX_cleanup, X509_STORE_CTX_free, X509_STORE_CTX_ int X509_STORE_CTX_init(X509_STORE_CTX *ctx, X509_STORE *store, X509 *x509, STACK_OF(X509) *chain); - void X509_STORE_CTX_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk); + void X509_STORE_CTX_set0_trusted_stack(X509_STORE_CTX *ctx, STACK_OF(X509) *sk); - void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx,X509 *x); - void X509_STORE_CTX_set_chain(X509_STORE_CTX *ctx,STACK_OF(X509) *sk); - void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk); + void X509_STORE_CTX_set_cert(X509_STORE_CTX *ctx,X509 *x); + STACK_OF(X509) *X509_STORE_CTX_get0_chain(X609_STORE_CTX *ctx); + void X509_STORE_CTX_set0_verified_chain(X509_STORE_CTX *ctx, STACK_OF(X509) *chain); + void X509_STORE_CTX_set0_crls(X509_STORE_CTX *ctx, STACK_OF(X509_CRL) *sk); X509_VERIFY_PARAM *X509_STORE_CTX_get0_param(X509_STORE_CTX *ctx); void X509_STORE_CTX_set0_param(X509_STORE_CTX *ctx, X509_VERIFY_PARAM *param); int X509_STORE_CTX_set_default(X509_STORE_CTX *ctx, const char *name); + X509 *X509_STORE_CTX_get0_cert(X509_STORE_CTX *ctx); + STACK_OF(X509)* X509_STORE_CTX_get0_untrusted(X509_STORE_CTX *ctx); + int X509_STORE_CTX_get_num_untrusted(X509_STORE_CTX *ctx); + typedef int (*X509_STORE_CTX_verify)(X509_STORE_CTX *); + X509_STORE_CTX_verify X509_STORE_CTX_get_verify(X509_STORE_CTX *ctx); + void X509_STORE_CTX_set_verify(X509_STORE_CTX *ctx, X509_STORE_CTX_verify verify); + + =head1 DESCRIPTION These functions initialise an B structure for subsequent use @@ -52,15 +72,19 @@ certificates (which will be untrusted but may be used to build the chain) in B. Any or all of the B, B and B parameters can be B. -X509_STORE_CTX_trusted_stack() sets the set of trusted certificates of B -to B. This is an alternative way of specifying trusted certificates +X509_STORE_CTX_set0_trusted_stack() sets the set of trusted certificates of +B to B. This is an alternative way of specifying trusted certificates instead of using an B. X509_STORE_CTX_set_cert() sets the certificate to be verified in B to B. -X509_STORE_CTX_set_chain() sets the additional certificate chain used by B -to B. +X509_STORE_CTX_set0_verified_chain() sets the validated chain used +by B to be B. +Ownership of the chain is transferred to B and should not be +free'd by the caller. +X509_STORE_CTX_get0_chain() returns a the internal pointer used by the +B that contains the validated chain. X509_STORE_CTX_set0_crls() sets a set of CRLs to use to aid certificate verification to B. These CRLs will only be used if CRL verification is @@ -68,9 +92,15 @@ enabled in the associated B structure. This might be used where additional "useful" CRLs are supplied as part of a protocol, for example in a PKCS#7 structure. -X509_VERIFY_PARAM *X509_STORE_CTX_get0_param() retrieves an internal pointer +X509_STORE_CTX_get0_param() retrieves an internal pointer to the verification parameters associated with B. +X509_STORE_CTX_get0_cert() retrieves an internal pointer to the +certificate being verified by the B. + +X509_STORE_CTX_get0_untrusted() retrieves an internal pointer to the +stack of untrusted certifieds associated with B. + X509_STORE_CTX_set0_param() sets the internal verification parameter pointer to B. After this call B should not be used. @@ -84,19 +114,7 @@ that were used in building the chain following a call to X509_verify_cert(). =head1 NOTES The certificates and CRLs in a store are used internally and should B -be freed up until after the associated B is freed. Legacy -applications might implicitly use an B like this: - - X509_STORE_CTX ctx; - X509_STORE_CTX_init(&ctx, store, cert, chain); - -this is B recommended in new applications they should instead do: - - X509_STORE_CTX *ctx; - ctx = X509_STORE_CTX_new(); - if (ctx == NULL) - /* Bad error */ - X509_STORE_CTX_init(ctx, store, cert, chain); +be freed up until after the associated B is freed. =head1 BUGS @@ -114,8 +132,9 @@ X509_STORE_CTX_init() returns 1 for success or 0 if an error occurred. X509_STORE_CTX_get0_param() returns a pointer to an B structure or B if an error occurred. -X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(), X509_STORE_CTX_trusted_stack(), -X509_STORE_CTX_set_cert(), X509_STORE_CTX_set_chain(), +X509_STORE_CTX_cleanup(), X509_STORE_CTX_free(), +X509_STORE_CTX_set0_trusted_stack(), +X509_STORE_CTX_set_cert(), X509_STORE_CTX_set0_crls() and X509_STORE_CTX_set0_param() do not return values.