]>
Commit | Line | Data |
---|---|---|
1bdbdaff P |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
4ce738d0 RL |
5 | OSSL_METHOD_STORE, ossl_method_store_new, ossl_method_store_free, |
6 | ossl_method_store_init, ossl_method_store_cleanup, | |
7 | ossl_method_store_add, ossl_method_store_remove, ossl_method_store_fetch, | |
f9e504e8 P |
8 | ossl_method_store_cache_get, ossl_method_store_cache_set, |
9 | ossl_method_store_flush_cache | |
1bdbdaff P |
10 | - implementation method store and query |
11 | ||
12 | =head1 SYNOPSIS | |
13 | ||
14 | #include "internal/property.h" | |
15 | ||
16 | typedef struct ossl_method_store_st OSSL_METHOD_STORE; | |
17 | ||
b4250010 | 18 | OSSL_METHOD_STORE *ossl_method_store_new(OSSL_LIB_CTX *ctx); |
1bdbdaff | 19 | void ossl_method_store_free(OSSL_METHOD_STORE *store); |
b4250010 DMSP |
20 | int ossl_method_store_init(OSSL_LIB_CTX *ctx); |
21 | void ossl_method_store_cleanup(OSSL_LIB_CTX *ctx); | |
c1d56231 | 22 | int ossl_method_store_add(OSSL_METHOD_STORE *store, const OSSL_PROVIDER *prov, |
b1d40ddf RL |
23 | int nid, const char *properties, void *method, |
24 | int (*method_up_ref)(void *), | |
25 | void (*method_destruct)(void *)); | |
1bdbdaff | 26 | int ossl_method_store_remove(OSSL_METHOD_STORE *store, |
0a79572a | 27 | int nid, const void *method); |
1bdbdaff P |
28 | int ossl_method_store_fetch(OSSL_METHOD_STORE *store, |
29 | int nid, const char *properties, | |
dc010ca6 RL |
30 | void **method, const OSSL_PROVIDER **prov_rw); |
31 | int ossl_method_store_cache_get(OSSL_METHOD_STORE *store, OSSL_PROVIDER *prov, | |
32 | int nid, const char *prop_query, void **method); | |
33 | int ossl_method_store_cache_set(OSSL_METHOD_STORE *store, OSSL_PROVIDER *prov, | |
34 | int nid, const char *prop_query, void *method, | |
bdbf2df2 P |
35 | int (*method_up_ref)(void *), |
36 | void (*method_destruct)(void *)); | |
60640d79 | 37 | void ossl_method_store_cache_flush_all(OSSL_METHOD_STORE *store); |
1bdbdaff P |
38 | |
39 | =head1 DESCRIPTION | |
40 | ||
0a79572a RL |
41 | OSSL_METHOD_STORE stores methods that can be queried using properties and a |
42 | numeric identity (nid). | |
1bdbdaff | 43 | |
0a79572a RL |
44 | Methods are expected to be library internal structures. |
45 | It's left to the caller to define the exact contents. | |
46 | ||
47 | Numeric identities are expected to be an algorithm identity for the methods. | |
48 | It's left to the caller to define exactly what an algorithm is, and to allocate | |
49 | these numeric identities accordingly. | |
50 | ||
51 | The B<OSSL_METHOD_STORE> also holds an internal query cache, which is accessed | |
52 | separately (see L</Cache Functions> below). | |
53 | ||
54 | =head2 Store Functions | |
55 | ||
25b25b0f | 56 | ossl_method_store_init() initialises the method store subsystem in the scope of |
dfabee82 | 57 | the library context I<ctx>. |
1bdbdaff P |
58 | |
59 | ossl_method_store_cleanup() cleans up and shuts down the implementation method | |
dfabee82 | 60 | store subsystem in the scope of the library context I<ctx>. |
1bdbdaff | 61 | |
25b25b0f | 62 | ossl_method_store_new() create a new empty method store using the supplied |
dfabee82 | 63 | I<ctx> to allow access to the required underlying property data. |
1bdbdaff | 64 | |
dfabee82 | 65 | ossl_method_store_free() frees resources allocated to I<store>. |
1bdbdaff | 66 | |
dfabee82 RL |
67 | ossl_method_store_add() adds the I<method> constructed from an implementation in |
68 | the provider I<prov> to the I<store> as an instance of an algorithm indicated by | |
69 | I<nid> and the property definition I<properties>, unless the I<store> already | |
70 | has a method from the same provider with the same I<nid> and I<properties>. | |
71 | If the I<method_up_ref> function is given, it's called to increment the | |
b1d40ddf | 72 | reference count of the method. |
dfabee82 | 73 | If the I<method_destruct> function is given, it's called when this function |
b1d40ddf | 74 | fails to add the method to the store, or later on when it is being released from |
dfabee82 | 75 | the I<store>. |
1bdbdaff | 76 | |
dfabee82 RL |
77 | ossl_method_store_remove() removes the I<method> identified by I<nid> from the |
78 | I<store>. | |
1bdbdaff | 79 | |
dfabee82 RL |
80 | ossl_method_store_fetch() queries I<store> for a method identified by I<nid> |
81 | that matches the property query I<prop_query>. | |
dc010ca6 RL |
82 | I<*prop> may be a pointer to a provider, which will narrow the search |
83 | to methods from that provider. | |
84 | The result, if any, is returned in I<*method>, and its provider in I<*prov>. | |
1bdbdaff | 85 | |
0a79572a | 86 | =head2 Cache Functions |
1bdbdaff | 87 | |
dfabee82 RL |
88 | ossl_method_store_cache_get() queries the cache associated with the I<store> |
89 | for a method identified by I<nid> that matches the property query | |
90 | I<prop_query>. | |
dc010ca6 RL |
91 | Additionally, if I<prov> isn't NULL, it will be used to narrow the search |
92 | to only include methods from that provider. | |
dfabee82 | 93 | The result, if any, is returned in I<method>. |
1bdbdaff | 94 | |
dc010ca6 RL |
95 | ossl_method_store_cache_set() sets a cache entry identified by I<nid> from the |
96 | provider I<prov>, with the property query I<prop_query> in the I<store>. | |
dfabee82 | 97 | Future calls to ossl_method_store_cache_get() will return the specified I<method>. |
bdbf2df2 P |
98 | The I<method_up_ref> function is called to increment the |
99 | reference count of the method and the I<method_destruct> function is called | |
100 | to decrement it. | |
1bdbdaff | 101 | |
60640d79 RL |
102 | ossl_method_store_cache_flush_all() flushes all cached entries associated with |
103 | I<store>. | |
104 | ||
af788ad6 P |
105 | =head1 NOTES |
106 | ||
107 | The I<prop_query> argument to ossl_method_store_cache_get() and | |
108 | ossl_method_store_cache_set() is not allowed to be NULL. Use "" for an | |
109 | empty property definition or query. | |
110 | ||
1bdbdaff P |
111 | =head1 RETURN VALUES |
112 | ||
dfabee82 | 113 | ossl_method_store_new() returns a new method store object or NULL on failure. |
1bdbdaff P |
114 | |
115 | ossl_method_store_free(), ossl_method_store_add(), | |
116 | ossl_method_store_remove(), ossl_method_store_fetch(), | |
860ecfd7 P |
117 | ossl_method_store_cache_get(), ossl_method_store_cache_set() and |
118 | ossl_method_store_flush_cache() return B<1> on success and B<0> on error. | |
1bdbdaff | 119 | |
3f37050e | 120 | ossl_method_store_free() and ossl_method_store_cleanup() do not return any value. |
1bdbdaff P |
121 | |
122 | =head1 HISTORY | |
123 | ||
4674aaf4 | 124 | This functionality was added to OpenSSL 3.0. |
1bdbdaff P |
125 | |
126 | =head1 COPYRIGHT | |
127 | ||
fecb3aae | 128 | Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved. |
1bdbdaff P |
129 | Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved. |
130 | ||
131 | Licensed under the Apache License 2.0 (the "License"). You may not use this | |
132 | file except in compliance with the License. You can obtain a copy in the file | |
133 | LICENSE in the source distribution or at | |
134 | L<https://www.openssl.org/source/license.html>. | |
135 | ||
136 | =cut |