include/internal/property.h

   1 /*
   2  * Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved.
   3  * Copyright (c) 2019, Oracle and/or its affiliates.  All rights reserved.
   4  *
   5  * Licensed under the Apache License 2.0 (the "License").  You may not use
   6  * this file except in compliance with the License.  You can obtain a copy
   7  * in the file LICENSE in the source distribution or at
   8  * https://www.openssl.org/source/license.html
   9  */
  10
  11 #ifndef OSSL_INTERNAL_PROPERTY_H
  12 # define OSSL_INTERNAL_PROPERTY_H
  13
  14 #include "internal/cryptlib.h"
  15
  16 typedef struct ossl_method_store_st OSSL_METHOD_STORE;
  17 typedef struct ossl_property_list_st OSSL_PROPERTY_LIST;
  18
  19 /* Initialisation */
  20 int ossl_property_parse_init(OPENSSL_CTX *ctx);
  21
  22 /* Property definition parser */
  23 OSSL_PROPERTY_LIST *ossl_parse_property(OPENSSL_CTX *ctx, const char *defn);
  24 /* Property query parser */
  25 OSSL_PROPERTY_LIST *ossl_parse_query(OPENSSL_CTX *ctx, const char *s);
  26 /* Property checker of query vs definition */
  27 int ossl_property_match_count(const OSSL_PROPERTY_LIST *query,
  28                               const OSSL_PROPERTY_LIST *defn);
  29 int ossl_property_is_enabled(OPENSSL_CTX *ctx,  const char *property_name,
  30                              const OSSL_PROPERTY_LIST *prop_list);
  31 /* Free a parsed property list */
  32 void ossl_property_free(OSSL_PROPERTY_LIST *p);
  33
  34
  35 /* Implementation store functions */
  36 OSSL_METHOD_STORE *ossl_method_store_new(OPENSSL_CTX *ctx);
  37 void ossl_method_store_free(OSSL_METHOD_STORE *store);
  38 int ossl_method_store_add(OSSL_METHOD_STORE *store, const OSSL_PROVIDER *prov,
  39                           int nid, const char *properties, void *method,
  40                           int (*method_up_ref)(void *),
  41                           void (*method_destruct)(void *));
  42 int ossl_method_store_remove(OSSL_METHOD_STORE *store, int nid,
  43                              const void *method);
  44 int ossl_method_store_fetch(OSSL_METHOD_STORE *store, int nid,
  45                             const char *prop_query, void **method);
  46
  47 /* Get the global properties associate with the specified library context */
  48 OSSL_PROPERTY_LIST **ossl_ctx_global_properties(OPENSSL_CTX *ctx);
  49
  50 /* property query cache functions */
  51 int ossl_method_store_cache_get(OSSL_METHOD_STORE *store, int nid,
  52                                 const char *prop_query, void **result);
  53 int ossl_method_store_cache_set(OSSL_METHOD_STORE *store, int nid,
  54                                 const char *prop_query, void *result,
  55                                 int (*method_up_ref)(void *),
  56                                 void (*method_destruct)(void *));
  57 void ossl_method_store_flush_cache(OSSL_METHOD_STORE *store);
  58
  59 /* Merge two property queries together */
  60 OSSL_PROPERTY_LIST *ossl_property_merge(const OSSL_PROPERTY_LIST *a,
  61                                         const OSSL_PROPERTY_LIST *b);
  62
  63 #endif