xref: /freebsd/crypto/openssl/doc/man3/OSSL_STORE_attach.pod (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1=pod
2
3=head1 NAME
4
5OSSL_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, const char *scheme,
12                                   OSSL_LIB_CTX *libctx, const char *propq,
13                                   const UI_METHOD *ui_method, void *ui_data,
14                                   const OSSL_PARAM params[],
15                                   OSSL_STORE_post_process_info_fn post_process,
16                                   void *post_process_data);
17
18=head1 DESCRIPTION
19
20OSSL_STORE_attach() works like L<OSSL_STORE_open(3)>, except it takes a B<BIO>
21I<bio> instead of a I<uri>, along with a I<scheme> to determine what loader
22should be used to process the data. The reference count of the B<BIO> object
23is increased by 1 if the call is successful.
24
25=head1 RETURN VALUES
26
27OSSL_STORE_attach() returns a pointer to a B<OSSL_STORE_CTX> on success, or
28NULL on failure.
29
30=head1 SEE ALSO
31
32L<ossl_store(7)>, L<OSSL_STORE_open(3)>
33
34=head1 HISTORY
35
36OSSL_STORE_attach() was added in OpenSSL 3.0.
37
38=head1 COPYRIGHT
39
40Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
41
42Licensed under the Apache License 2.0 (the "License").  You may not use
43this file except in compliance with the License.  You can obtain a copy
44in the file LICENSE in the source distribution or at
45L<https://www.openssl.org/source/license.html>.
46
47=cut
48