5 ossl_method_store_new, ossl_method_store_free, ossl_method_store_init,
6 ossl_method_store_cleanup, ossl_method_store_add, ossl_method_store_remove,
7 ossl_method_store_fetch, ossl_method_store_set_global_properties,
8 ossl_method_store_cache_get, ossl_method_store_cache_set
9 - implementation method store and query
13 #include "internal/property.h"
15 typedef struct ossl_method_store_st OSSL_METHOD_STORE;
17 OSSL_METHOD_STORE *ossl_method_store_new(void);
18 void ossl_method_store_free(OSSL_METHOD_STORE *store);
19 int ossl_method_store_init(void);
20 void ossl_method_store_cleanup(void);
21 int ossl_method_store_add(OSSL_METHOD_STORE *store,
22 int nid, const char *properties,
23 void *method, void (*method_destruct)(void *));
24 int ossl_method_store_remove(OSSL_METHOD_STORE *store,
25 int nid, const void *method);
26 int ossl_method_store_fetch(OSSL_METHOD_STORE *store,
27 int nid, const char *properties,
29 int ossl_method_store_set_global_properties(OSSL_METHOD_STORE *store,
30 const char *prop_query);
31 int ossl_method_store_cache_get(OSSL_METHOD_STORE *store, int nid,
32 const char *prop_query, void **method);
33 int ossl_method_store_cache_set(OSSL_METHOD_STORE *store, int nid,
34 const char *prop_query, void *method);
38 OSSL_METHOD_STORE stores methods that can be queried using properties and a
39 numeric identity (nid).
41 Methods are expected to be library internal structures.
42 It's left to the caller to define the exact contents.
44 Numeric identities are expected to be an algorithm identity for the methods.
45 It's left to the caller to define exactly what an algorithm is, and to allocate
46 these numeric identities accordingly.
48 The B<OSSL_METHOD_STORE> also holds an internal query cache, which is accessed
49 separately (see L</Cache Functions> below).
51 =head2 Store Functions
53 ossl_method_store_init() initialises the method store subsystem.
55 ossl_method_store_cleanup() cleans up and shuts down the implementation method
58 ossl_method_store_new() create a new empty method store.
60 ossl_method_store_free() frees resources allocated to B<store>.
62 ossl_method_store_add() adds the B<method> to the B<store> as an instance of an
63 algorithm indicated by B<nid> and the property definition B<properties>.
64 The optional B<method_destruct> function is called when B<method> is being
65 released from B<store>.
67 ossl_method_store_remove() removes the B<method> identified by B<nid> from the
70 ossl_method_store_fetch() queries B<store> for an method identified by B<nid>
71 that matches the property query B<prop_query>.
72 The result, if any, is returned in B<method>.
74 ossl_method_store_set_global_properties() sets method B<store> wide query
75 properties to B<prop_query>.
76 All subsequent fetches will need to meet both these global query properties
77 and the ones passed to the ossl_method_store_free().
79 =head2 Cache Functions
81 ossl_method_store_cache_get() queries the cache associated with the B<store>
82 for an method identified by B<nid> that matches the property query
84 The result, if any, is returned in B<method>.
86 ossl_method_store_cache_set() sets a cache entry identified by B<nid> with the
87 property query B<prop_query> in the B<store>.
88 Future cache gets will return the specified B<method>.
92 ossl_method_store_new() a new method store object or B<NULL> on failure.
94 ossl_method_store_free(), ossl_method_store_add(),
95 ossl_method_store_remove(), ossl_method_store_fetch(),
96 ossl_method_store_set_global_properties(), ossl_method_store_cache_get()
97 and ossl_method_store_cache_set() return B<1> on success and B<0> on error.
99 ossl_method_store_free() and ossl_method_store_cleanup() do not return values.
103 This functionality was added to OpenSSL 3.0.0.
107 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
108 Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
110 Licensed under the Apache License 2.0 (the "License"). You may not use this
111 file except in compliance with the License. You can obtain a copy in the file
112 LICENSE in the source distribution or at
113 L<https://www.openssl.org/source/license.html>.