2768524e0c5b6d15560dcf4f5b378197003b060e
[openssl.git] / doc / internal / man3 / OSSL_METHOD_STORE.pod
1 =pod
2
3 =head1 NAME
4
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,
8 ossl_method_store_set_global_properties,
9 ossl_method_store_cache_get, ossl_method_store_cache_set
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
18  OSSL_METHOD_STORE *ossl_method_store_new(OPENSSL_CTX *ctx);
19  void ossl_method_store_free(OSSL_METHOD_STORE *store);
20  int ossl_method_store_init(OPENSSL_CTX *ctx);
21  void ossl_method_store_cleanup(OPENSSL_CTX *ctx);
22  int ossl_method_store_add(OSSL_METHOD_STORE *store, const OSSL_PROVIDER *prov,
23                            int nid, const char *properties, void *method,
24                            int (*method_up_ref)(void *),
25                            void (*method_destruct)(void *));
26  int ossl_method_store_remove(OSSL_METHOD_STORE *store,
27                               int nid, const void *method);
28  int ossl_method_store_fetch(OSSL_METHOD_STORE *store,
29                              int nid, const char *properties,
30                              void **method);
31  int ossl_method_store_set_global_properties(OSSL_METHOD_STORE *store,
32                                             const char *prop_query);
33  int ossl_method_store_cache_get(OSSL_METHOD_STORE *store, int nid,
34                                  const char *prop_query, void **method);
35  int ossl_method_store_cache_set(OSSL_METHOD_STORE *store, int nid,
36                                  const char *prop_query, void *method,
37                                  int (*method_up_ref)(void *),
38                                  void (*method_destruct)(void *));
39
40 =head1 DESCRIPTION
41
42 OSSL_METHOD_STORE stores methods that can be queried using properties and a
43 numeric identity (nid).
44
45 Methods are expected to be library internal structures.
46 It's left to the caller to define the exact contents.
47
48 Numeric identities are expected to be an algorithm identity for the methods.
49 It's left to the caller to define exactly what an algorithm is, and to allocate
50 these numeric identities accordingly.
51
52 The B<OSSL_METHOD_STORE> also holds an internal query cache, which is accessed
53 separately (see L</Cache Functions> below).
54
55 =head2 Store Functions
56
57 ossl_method_store_init() initialises the method store subsystem in the scope of
58 the library context I<ctx>.
59
60 ossl_method_store_cleanup() cleans up and shuts down the implementation method
61 store subsystem in the scope of the library context I<ctx>.
62
63 ossl_method_store_new() create a new empty method store using the supplied
64 I<ctx> to allow access to the required underlying property data.
65
66 ossl_method_store_free() frees resources allocated to I<store>.
67
68 ossl_method_store_add() adds the I<method> constructed from an implementation in
69 the provider I<prov> to the I<store> as an instance of an algorithm indicated by
70 I<nid> and the property definition I<properties>, unless the I<store> already
71 has a method from the same provider with the same I<nid> and I<properties>.
72 If the I<method_up_ref> function is given, it's called to increment the
73 reference count of the method.
74 If the I<method_destruct> function is given, it's called when this function
75 fails to add the method to the store, or later on when it is being released from
76 the I<store>.
77
78 ossl_method_store_remove() removes the I<method> identified by I<nid> from the
79 I<store>.
80
81 ossl_method_store_fetch() queries I<store> for a method identified by I<nid>
82 that matches the property query I<prop_query>.
83 The result, if any, is returned in I<method>.
84
85 ossl_method_store_set_global_properties() sets method I<store> wide query
86 properties to I<prop_query>.
87 All subsequent fetches will need to meet both these global query properties
88 and the ones passed to the ossl_method_store_free().
89
90 =head2 Cache Functions
91
92 ossl_method_store_cache_get() queries the cache associated with the I<store>
93 for a method identified by I<nid> that matches the property query
94 I<prop_query>.
95 The result, if any, is returned in I<method>.
96
97 ossl_method_store_cache_set() sets a cache entry identified by I<nid> with the
98 property query I<prop_query> in the I<store>.
99 Future calls to ossl_method_store_cache_get() will return the specified I<method>.
100 The I<method_up_ref> function is called to increment the
101 reference count of the method and the I<method_destruct> function is called
102 to decrement it.
103
104 =head1 RETURN VALUES
105
106 ossl_method_store_new() returns a new method store object or NULL on failure.
107
108 ossl_method_store_free(), ossl_method_store_add(),
109 ossl_method_store_remove(), ossl_method_store_fetch(),
110 ossl_method_store_set_global_properties(), ossl_method_store_cache_get()
111 and ossl_method_store_cache_set() return B<1> on success and B<0> on error.
112
113 ossl_method_store_free() and ossl_method_store_cleanup() do not return any value.
114
115 =head1 HISTORY
116
117 This functionality was added to OpenSSL 3.0.
118
119 =head1 COPYRIGHT
120
121 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
122 Copyright (c) 2019, Oracle and/or its affiliates.  All rights reserved.
123
124 Licensed under the Apache License 2.0 (the "License").  You may not use this
125 file except in compliance with the License.  You can obtain a copy in the file
126 LICENSE in the source distribution or at
127 L<https://www.openssl.org/source/license.html>.
128
129 =cut