Reduce optimization in hppa builds
[openssl.git] / doc / man3 / X509_STORE_set_verify_cb_func.pod
index 5a2a52fe5d5f64724b56eaaed449cd42d0c9e199..57fc6c9f6435d33dfff3bcdd91e169f7dc2d82c2 100644 (file)
@@ -22,6 +22,7 @@ X509_STORE_get_check_revocation,
 X509_STORE_set_check_revocation,
 X509_STORE_get_check_issued,
 X509_STORE_set_check_issued,
+X509_STORE_CTX_get1_issuer,
 X509_STORE_get_get_issuer,
 X509_STORE_set_get_issuer,
 X509_STORE_CTX_get_verify,
@@ -57,78 +58,78 @@ X509_STORE_CTX_lookup_certs_fn, X509_STORE_CTX_lookup_crls_fn
                                                               const X509_NAME *nm);
  typedef int (*X509_STORE_CTX_cleanup_fn)(X509_STORE_CTX *ctx);
 
- void X509_STORE_set_verify_cb(X509_STORE *ctx,
+ void X509_STORE_set_verify_cb(X509_STORE *xs,
                                X509_STORE_CTX_verify_cb verify_cb);
  X509_STORE_CTX_verify_cb X509_STORE_get_verify_cb(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_verify(X509_STORE *ctx, X509_STORE_CTX_verify_fn verify);
+ void X509_STORE_set_verify(X509_STORE *xs, X509_STORE_CTX_verify_fn verify);
  X509_STORE_CTX_verify_fn X509_STORE_CTX_get_verify(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_get_issuer(X509_STORE *ctx,
+ int X509_STORE_CTX_get1_issuer(X509 **issuer, X509_STORE_CTX *ctx, X509 *x);
+ X509_STORE_CTX_get_issuer_fn X509_STORE_get_get_issuer(const X509_STORE_CTX *ctx);
+ void X509_STORE_set_get_issuer(X509_STORE *xs,
                                 X509_STORE_CTX_get_issuer_fn get_issuer);
- X509_STORE_CTX_get_issuer_fn
-     X509_STORE_get_get_issuer(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_check_issued(X509_STORE *ctx,
+ void X509_STORE_set_check_issued(X509_STORE *xs,
                                   X509_STORE_CTX_check_issued_fn check_issued);
  X509_STORE_CTX_check_issued_fn
      X509_STORE_get_check_issued(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_check_revocation(X509_STORE *ctx,
+ void X509_STORE_set_check_revocation(X509_STORE *xs,
                                       X509_STORE_CTX_check_revocation_fn check_revocation);
  X509_STORE_CTX_check_revocation_fn
      X509_STORE_get_check_revocation(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_get_crl(X509_STORE *ctx,
+ void X509_STORE_set_get_crl(X509_STORE *xs,
                              X509_STORE_CTX_get_crl_fn get_crl);
  X509_STORE_CTX_get_crl_fn X509_STORE_get_get_crl(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_check_crl(X509_STORE *ctx,
+ void X509_STORE_set_check_crl(X509_STORE *xs,
                                X509_STORE_CTX_check_crl_fn check_crl);
  X509_STORE_CTX_check_crl_fn
      X509_STORE_get_check_crl(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_cert_crl(X509_STORE *ctx,
+ void X509_STORE_set_cert_crl(X509_STORE *xs,
                               X509_STORE_CTX_cert_crl_fn cert_crl);
  X509_STORE_CTX_cert_crl_fn X509_STORE_get_cert_crl(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_check_policy(X509_STORE *ctx,
+ void X509_STORE_set_check_policy(X509_STORE *xs,
                                   X509_STORE_CTX_check_policy_fn check_policy);
  X509_STORE_CTX_check_policy_fn
      X509_STORE_get_check_policy(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_lookup_certs(X509_STORE *ctx,
+ void X509_STORE_set_lookup_certs(X509_STORE *xs,
                                   X509_STORE_CTX_lookup_certs_fn lookup_certs);
  X509_STORE_CTX_lookup_certs_fn
      X509_STORE_get_lookup_certs(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_lookup_crls(X509_STORE *ctx,
+ void X509_STORE_set_lookup_crls(X509_STORE *xs,
                                  X509_STORE_CTX_lookup_crls_fn lookup_crls);
  X509_STORE_CTX_lookup_crls_fn
      X509_STORE_get_lookup_crls(const X509_STORE_CTX *ctx);
 
- void X509_STORE_set_cleanup(X509_STORE *ctx,
+ void X509_STORE_set_cleanup(X509_STORE *xs,
                              X509_STORE_CTX_cleanup_fn cleanup);
  X509_STORE_CTX_cleanup_fn X509_STORE_get_cleanup(const X509_STORE_CTX *ctx);
 
  /* Aliases */
  void X509_STORE_set_verify_cb_func(X509_STORE *st,
                                     X509_STORE_CTX_verify_cb verify_cb);
- void X509_STORE_set_verify_func(X509_STORE *ctx,
+ void X509_STORE_set_verify_func(X509_STORE *xs,
                                  X509_STORE_CTX_verify_fn verify);
- void X509_STORE_set_lookup_crls_cb(X509_STORE *ctx,
+ void X509_STORE_set_lookup_crls_cb(X509_STORE *xs,
                                     X509_STORE_CTX_lookup_crls_fn lookup_crls);
 
 =head1 DESCRIPTION
 
-X509_STORE_set_verify_cb() sets the verification callback of B<ctx> to
-B<verify_cb> overwriting the previous callback.
+X509_STORE_set_verify_cb() sets the verification callback of I<xs> to
+I<verify_cb> overwriting the previous callback.
 The callback assigned with this function becomes a default for the one
 that can be assigned directly to the corresponding B<X509_STORE_CTX>,
 please see L<X509_STORE_CTX_set_verify_cb(3)> for further information.
 
 X509_STORE_set_verify() sets the final chain verification function for
-B<ctx> to B<verify>.
+I<xs> to I<verify>.
 Its purpose is to go through the chain of certificates and check that
 all signatures are valid and that the current time is within the
 limits of each certificate's first and last validity time.
@@ -137,17 +138,26 @@ on success.
 I<If no chain verification function is provided, the internal default
 function will be used instead.>
 
-X509_STORE_set_get_issuer() sets the function to get the issuer
-certificate that verifies the given certificate B<x>.
-When found, the issuer certificate must be assigned to B<*issuer>.
-This function must return 0 on failure and 1 on success.
-I<If no function to get the issuer is provided, the internal default
-function will be used instead.>
+X509_STORE_CTX_get1_issuer() tries to find a certificate from the I<store>
+component of I<ctx> that has a subject name matching the issuer name of I<x>
+and is accepted by the I<check_issued> function in I<ctx>.
+On success it assigns to I<*issuer> the first match that has a suitable validity
+period or otherwise has the latest expiration date of all matching certificates.
+If the function returns 1 the caller is responsible for freeing I<*issuer>.
+Note that this search does not support backtracking.
+
+X509_STORE_set_get_issuer() sets the function I<get_issuer> that is used
+to get the "best" candidate issuer certificate of the given certificate I<x>.
+When such a certificate is found, I<get_issuer> must up-ref and assign it
+to I<*issuer> and then return 1.
+Otherwise I<get_issuer> must return 0 if not found and -1 (or 0) on failure.
+If X509_STORE_set_get_issuer() is not used or I<get_issuer> is NULL
+then X509_STORE_CTX_get1_issuer() is used as the default implementation.
 
 X509_STORE_set_check_issued() sets the function to check that a given
-certificate B<x> is issued with the issuer certificate B<issuer>.
-This function must return 0 on failure (among others if B<x> hasn't
-been issued with B<issuer>) and 1 on success.
+certificate I<x> is issued by the issuer certificate I<issuer>.
+This function must return 0 on failure (among others if I<x> hasn't
+been issued with I<issuer>) and 1 on success.
 I<If no function to get the issuer is provided, the internal default
 function will be used instead.>
 
@@ -160,20 +170,20 @@ I<If no function to get the issuer is provided, the internal default
 function will be used instead.>
 
 X509_STORE_set_get_crl() sets the function to get the crl for a given
-certificate B<x>.
-When found, the crl must be assigned to B<*crl>.
+certificate I<x>.
+When found, the crl must be assigned to I<*crl>.
 This function must return 0 on failure and 1 on success.
 I<If no function to get the issuer is provided, the internal default
 function will be used instead.>
 
 X509_STORE_set_check_crl() sets the function to check the validity of
-the given B<crl>.
+the given I<crl>.
 This function must return 0 on failure and 1 on success.
 I<If no function to get the issuer is provided, the internal default
 function will be used instead.>
 
 X509_STORE_set_cert_crl() sets the function to check the revocation
-status of the given certificate B<x> against the given B<crl>.
+status of the given certificate I<x> against the given I<crl>.
 This function must return 0 on failure and 1 on success.
 I<If no function to get the issuer is provided, the internal default
 function will be used instead.>
@@ -186,7 +196,7 @@ function will be used instead.>
 
 X509_STORE_set_lookup_certs() and X509_STORE_set_lookup_crls() set the
 functions to look up all the certs or all the CRLs that match the
-given name B<nm>.
+given name I<nm>.
 These functions return NULL on failure and a pointer to a stack of
 certificates (B<X509>) or to a stack of CRLs (B<X509_CRL>) on
 success.
@@ -237,6 +247,9 @@ The X509_STORE_set_*() functions do not return a value.
 The X509_STORE_get_*() functions return a pointer of the appropriate
 function type.
 
+X509_STORE_CTX_get1_issuer() returns
+1 if a suitable certificate is found, 0 if not found, -1 on other error.
+
 =head1 SEE ALSO
 
 L<X509_STORE_CTX_set_verify_cb(3)>, L<X509_STORE_CTX_get0_chain(3)>,
@@ -264,7 +277,7 @@ were added in OpenSSL 1.1.0.
 
 =head1 COPYRIGHT
 
-Copyright 2009-2016 The OpenSSL Project Authors. All Rights Reserved.
+Copyright 2009-2021 The OpenSSL Project Authors. All Rights Reserved.
 
 Licensed under the Apache License 2.0 (the "License").  You may not use
 this file except in compliance with the License.  You can obtain a copy