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