A local copy of OpenSSL from GitHub
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

136 lines
5.5 KiB

  1. =pod
  2. =head1 NAME
  3. X509_STORE,
  4. X509_STORE_add_cert, X509_STORE_add_crl, X509_STORE_set_depth,
  5. X509_STORE_set_flags, X509_STORE_set_purpose, X509_STORE_set_trust,
  6. X509_STORE_add_lookup,
  7. X509_STORE_load_file, X509_STORE_load_path, X509_STORE_load_store,
  8. X509_STORE_set_default_paths,
  9. X509_STORE_load_locations
  10. - X509_STORE manipulation
  11. =head1 SYNOPSIS
  12. #include <openssl/x509_vfy.h>
  13. typedef x509_store_st X509_STORE;
  14. int X509_STORE_add_cert(X509_STORE *ctx, X509 *x);
  15. int X509_STORE_add_crl(X509_STORE *ctx, X509_CRL *x);
  16. int X509_STORE_set_depth(X509_STORE *store, int depth);
  17. int X509_STORE_set_flags(X509_STORE *ctx, unsigned long flags);
  18. int X509_STORE_set_purpose(X509_STORE *ctx, int purpose);
  19. int X509_STORE_set_trust(X509_STORE *ctx, int trust);
  20. X509_LOOKUP *X509_STORE_add_lookup(X509_STORE *store,
  21. X509_LOOKUP_METHOD *meth);
  22. int X509_STORE_set_default_paths(X509_STORE *ctx);
  23. int X509_STORE_load_file(X509_STORE *ctx, const char *file);
  24. int X509_STORE_load_path(X509_STORE *ctx, const char *dir);
  25. int X509_STORE_load_store(X509_STORE *ctx, const char *uri);
  26. Deprecated:
  27. int X509_STORE_load_locations(X509_STORE *ctx,
  28. const char *file, const char *dir);
  29. =head1 DESCRIPTION
  30. The B<X509_STORE> structure is intended to be a consolidated mechanism for
  31. holding information about X.509 certificates and CRLs, and constructing
  32. and validating chains of certificates terminating in trusted roots.
  33. It admits multiple lookup mechanisms and efficient scaling performance
  34. with large numbers of certificates, and a great deal of flexibility in
  35. how validation and policy checks are performed.
  36. L<X509_STORE_new(3)> creates an empty B<X509_STORE> structure, which contains
  37. no information about trusted certificates or where such certificates
  38. are located on disk, and is generally not usable. Normally, trusted
  39. certificates will be added to the B<X509_STORE> to prepare it for use,
  40. via mechanisms such as X509_STORE_add_lookup() and X509_LOOKUP_file(), or
  41. PEM_read_bio_X509_AUX() and X509_STORE_add_cert(). CRLs can also be added,
  42. and many behaviors configured as desired.
  43. Once the B<X509_STORE> is suitably configured, X509_STORE_CTX_new() is
  44. used to instantiate a single-use B<X509_STORE_CTX> for each chain-building
  45. and verification operation. That process includes providing the end-entity
  46. certificate to be verified and an additional set of untrusted certificates
  47. that may be used in chain-building. As such, it is expected that the
  48. certificates included in the B<X509_STORE> are certificates that represent
  49. trusted entities such as root certificate authorities (CAs).
  50. OpenSSL represents these trusted certificates internally as B<X509> objects
  51. with an associated B<X509_CERT_AUX>, as are produced by
  52. PEM_read_bio_X509_AUX() and similar routines that refer to X509_AUX.
  53. The public interfaces that operate on such trusted certificates still
  54. operate on pointers to B<X509> objects, though.
  55. X509_STORE_add_cert() and X509_STORE_add_crl() add the respective object
  56. to the B<X509_STORE>'s local storage. Untrusted objects should not be
  57. added in this way. The added object's reference count is incremented by one,
  58. hence the caller retains ownership of the object and needs to free it when it
  59. is no longer needed.
  60. X509_STORE_set_depth(), X509_STORE_set_flags(), X509_STORE_set_purpose(),
  61. X509_STORE_set_trust(), and X509_STORE_set1_param() set the default values
  62. for the corresponding values used in certificate chain validation. Their
  63. behavior is documented in the corresponding B<X509_VERIFY_PARAM> manual
  64. pages, e.g., L<X509_VERIFY_PARAM_set_depth(3)>.
  65. X509_STORE_add_lookup() finds or creates a L<X509_LOOKUP(3)> with the
  66. L<X509_LOOKUP_METHOD(3)> I<meth> and adds it to the B<X509_STORE>
  67. I<store>. This also associates the B<X509_STORE> with the lookup, so
  68. B<X509_LOOKUP> functions can look up objects in that store.
  69. X509_STORE_load_file() loads trusted certificate(s) into an
  70. B<X509_STORE> from a given file.
  71. X509_STORE_load_path() loads trusted certificate(s) into an
  72. B<X509_STORE> from a given directory path.
  73. The certificates in the directory must be in hashed form, as
  74. documented in L<X509_LOOKUP_hash_dir(3)>.
  75. X509_STORE_load_store() loads trusted certificate(s) into an
  76. B<X509_STORE> from a store at a given URI.
  77. X509_STORE_load_locations() combines X509_STORE_load_file() and
  78. X509_STORE_load_dir() for a given file and/or directory path.
  79. It is permitted to specify just a file, just a directory, or both
  80. paths.
  81. X509_STORE_set_default_paths() is somewhat misnamed, in that it does not
  82. set what default paths should be used for loading certificates. Instead,
  83. it loads certificates into the B<X509_STORE> from the hardcoded default
  84. paths.
  85. =head1 RETURN VALUES
  86. X509_STORE_add_cert(), X509_STORE_add_crl(), X509_STORE_set_depth(),
  87. X509_STORE_set_flags(), X509_STORE_set_purpose(),
  88. X509_STORE_set_trust(), X509_STORE_load_file(),
  89. X509_STORE_load_path(), X509_STORE_load_store(),
  90. X509_STORE_load_locations(), and X509_STORE_set_default_paths() return
  91. 1 on success or 0 on failure.
  92. X509_STORE_add_lookup() returns the found or created
  93. L<X509_LOOKUP(3)>, or NULL on error.
  94. =head1 SEE ALSO
  95. L<X509_LOOKUP_hash_dir(3)>.
  96. L<X509_VERIFY_PARAM_set_depth(3)>.
  97. L<X509_STORE_new(3)>,
  98. L<X509_STORE_get0_param(3)>
  99. =head1 COPYRIGHT
  100. Copyright 2017-2019 The OpenSSL Project Authors. All Rights Reserved.
  101. Licensed under the Apache License 2.0 (the "License"). You may not use
  102. this file except in compliance with the License. You can obtain a copy
  103. in the file LICENSE in the source distribution or at
  104. L<https://www.openssl.org/source/license.html>.
  105. =cut