OSSL_STORE_attach.pod 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. =pod
  2. =head1 NAME
  3. OSSL_STORE_attach - Functions to read objects from a BIO
  4. =head1 SYNOPSIS
  5. #include <openssl/store.h>
  6. OSSL_STORE_CTX *OSSL_STORE_attach(BIO *bio, const char *scheme,
  7. OSSL_LIB_CTX *libctx, const char *propq,
  8. const UI_METHOD *ui_method, void *ui_data,
  9. const OSSL_PARAM params[],
  10. OSSL_STORE_post_process_info_fn post_process,
  11. void *post_process_data);
  12. =head1 DESCRIPTION
  13. OSSL_STORE_attach() works like L<OSSL_STORE_open(3)>, except it takes a B<BIO>
  14. I<bio> instead of a I<uri>, along with a I<scheme> to determine what loader
  15. should be used to process the data. The reference count of the B<BIO> object
  16. is increased by 1 if the call is successful.
  17. =head1 RETURN VALUES
  18. OSSL_STORE_attach() returns a pointer to a B<OSSL_STORE_CTX> on success, or
  19. NULL on failure.
  20. =head1 SEE ALSO
  21. L<ossl_store(7)>, L<OSSL_STORE_open(3)>
  22. =head1 HISTORY
  23. OSSL_STORE_attach() was added in OpenSSL 3.0.
  24. =head1 COPYRIGHT
  25. Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
  26. Licensed under the Apache License 2.0 (the "License"). You may not use
  27. this file except in compliance with the License. You can obtain a copy
  28. in the file LICENSE in the source distribution or at
  29. L<https://www.openssl.org/source/license.html>.
  30. =cut