1=pod
2
3=head1 NAME
4
5OSSL_STORE_expect,
6OSSL_STORE_supports_search,
7OSSL_STORE_find
8- Specify what object type is expected
9
10=head1 SYNOPSIS
11
12 #include <openssl/store.h>
13
14 int OSSL_STORE_expect(OSSL_STORE_CTX *ctx, int expected_type);
15
16 int OSSL_STORE_supports_search(OSSL_STORE_CTX *ctx, int criterion_type);
17
18 int OSSL_STORE_find(OSSL_STORE_CTX *ctx, OSSL_STORE_SEARCH *search);
19
20=head1 DESCRIPTION
21
22OSSL_STORE_expect() helps applications filter what OSSL_STORE_load() returns
23by specifying a B<OSSL_STORE_INFO> type.
24For example, if C<file:/foo/bar/store.pem> contains several different objects
25and only the certificates are interesting, the application can simply say
26that it expects the type B<OSSL_STORE_INFO_CERT>.
27All known object types (see L<OSSL_STORE_INFO(3)/SUPPORTED OBJECTS>)
28except for B<OSSL_STORE_INFO_NAME> are supported.
29
30OSSL_STORE_find() helps applications specify a criterion for a more fine
31grained search of objects.
32
33OSSL_STORE_supports_search() checks if the loader of the given OSSL_STORE
34context supports the given search type.
35See L<OSSL_STORE_SEARCH/SUPPORED CRITERION TYPES> for information on the
36supported search criterion types.
37
38OSSL_STORE_expect() and OSSL_STORE_find I<must> be called before the first
39OSSL_STORE_load() of a given session, or they will fail.
40
41=head1 NOTES
42
43If a more elaborate filter is required by the application, a better choice
44would be to use a post-processing function.
45See L<OSSL_STORE_open(3)> for more information.
46
47However, some loaders may take advantage of the knowledge of an expected type
48to make object retrieval more efficient, so if a single type is expected, this
49method is usually preferable.
50
51=head1 RETURN VALUES
52
53OSSL_STORE_expect() returns 1 on success, or 0 on failure.
54
55OSSL_STORE_supports_search() returns 1 if the criterion is supported, or 0
56otherwise.
57
58OSSL_STORE_find() returns 1 on success, or 0 on failure.
59
60=head1 SEE ALSO
61
62L<ossl_store(7)>, L<OSSL_STORE_INFO(3)>, L<OSSL_STORE_SEARCH(3)>,
63L<OSSL_STORE_load(3)>
64
65=head1 HISTORY
66
67OSSL_STORE_expect(), OSSL_STORE_supports_search() and OSSL_STORE_find()
68were added in OpenSSL 1.1.1.
69
70=head1 COPYRIGHT
71
72Copyright 2018 The OpenSSL Project Authors. All Rights Reserved.
73
74Licensed under the OpenSSL license (the "License").  You may not use
75this file except in compliance with the License.  You can obtain a copy
76in the file LICENSE in the source distribution or at
77L<https://www.openssl.org/source/license.html>.
78
79=cut
80