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