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