OSSL_STORE: Make it possible to attach an OSSL_STORE to an opened BIO
[openssl.git] / doc / man3 / OSSL_STORE_attach.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_STORE_attach - Functions to read objects from a BIO
6
7 =head1 SYNOPSIS
8
9  #include <openssl/store.h>
10
11  OSSL_STORE_CTX *OSSL_STORE_attach(BIO *bio, OPENSSL_CTX *libctx,
12                                    const char *scheme, const char *propq,
13                                    const UI_METHOD *ui_method, void *ui_data,
14                                    OSSL_STORE_post_process_info_fn post_process,
15                                    void *post_process_data);
16
17 =head1 DESCRIPTION
18
19 OSSL_STORE_attach() works like L<OSSL_STORE_open(3)>, except it takes a B<BIO>
20 I<bio> instead of a I<uri>, along with a I<scheme> to determine what loader
21 should be used to process the data.
22
23 =head1 RETURN VALUES
24
25 OSSL_STORE_attach() returns a pointer to a B<OSSL_STORE_CTX> on success, or
26 NULL on failure.
27
28 =head1 SEE ALSO
29
30 L<ossl_store(7)>, L<OSSL_STORE_open(3)>
31
32 =head1 HISTORY
33
34 OSSL_STORE_attach() was added in OpenSSL 3.0.
35
36 =head1 COPYRIGHT
37
38 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
39
40 Licensed under the Apache License 2.0 (the "License").  You may not use
41 this file except in compliance with the License.  You can obtain a copy
42 in the file LICENSE in the source distribution or at
43 L<https://www.openssl.org/source/license.html>.
44
45 =cut