1 /* 2 * Copyright 2019-2021 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 #pragma once 14 15 #include "internal/cryptlib.h" 16 17 typedef struct ossl_method_store_st OSSL_METHOD_STORE; 18 typedef struct ossl_property_list_st OSSL_PROPERTY_LIST; 19 20 typedef enum { 21 OSSL_PROPERTY_TYPE_STRING, 22 OSSL_PROPERTY_TYPE_NUMBER, 23 OSSL_PROPERTY_TYPE_VALUE_UNDEFINED 24 } OSSL_PROPERTY_TYPE; 25 typedef struct ossl_property_definition_st OSSL_PROPERTY_DEFINITION; 26 27 /* Initialisation */ 28 int ossl_property_parse_init(OSSL_LIB_CTX *ctx); 29 30 /* Property definition parser */ 31 OSSL_PROPERTY_LIST *ossl_parse_property(OSSL_LIB_CTX *ctx, const char *defn); 32 /* Property query parser */ 33 OSSL_PROPERTY_LIST *ossl_parse_query(OSSL_LIB_CTX *ctx, const char *s, 34 int create_values); 35 /* Property checker of query vs definition */ 36 int ossl_property_match_count(const OSSL_PROPERTY_LIST *query, 37 const OSSL_PROPERTY_LIST *defn); 38 int ossl_property_is_enabled(OSSL_LIB_CTX *ctx, const char *property_name, 39 const OSSL_PROPERTY_LIST *prop_list); 40 /* Free a parsed property list */ 41 void ossl_property_free(OSSL_PROPERTY_LIST *p); 42 43 /* Get a property from a property list */ 44 const OSSL_PROPERTY_DEFINITION * 45 ossl_property_find_property(const OSSL_PROPERTY_LIST *list, 46 OSSL_LIB_CTX *libctx, const char *name); 47 OSSL_PROPERTY_TYPE ossl_property_get_type(const OSSL_PROPERTY_DEFINITION *prop); 48 const char *ossl_property_get_string_value(OSSL_LIB_CTX *libctx, 49 const OSSL_PROPERTY_DEFINITION *prop); 50 int64_t ossl_property_get_number_value(const OSSL_PROPERTY_DEFINITION *prop); 51 52 /* Implementation store functions */ 53 OSSL_METHOD_STORE *ossl_method_store_new(OSSL_LIB_CTX *ctx); 54 void ossl_method_store_free(OSSL_METHOD_STORE *store); 55 56 int ossl_method_lock_store(OSSL_METHOD_STORE *store); 57 int ossl_method_unlock_store(OSSL_METHOD_STORE *store); 58 59 int ossl_method_store_add(OSSL_METHOD_STORE *store, const OSSL_PROVIDER *prov, 60 int nid, const char *properties, void *method, 61 int (*method_up_ref)(void *), 62 void (*method_destruct)(void *)); 63 int ossl_method_store_remove(OSSL_METHOD_STORE *store, int nid, 64 const void *method); 65 void ossl_method_store_do_all(OSSL_METHOD_STORE *store, 66 void (*fn)(int id, void *method, void *fnarg), 67 void *fnarg); 68 int ossl_method_store_fetch(OSSL_METHOD_STORE *store, 69 int nid, const char *prop_query, 70 const OSSL_PROVIDER **prov, void **method); 71 int ossl_method_store_remove_all_provided(OSSL_METHOD_STORE *store, 72 const OSSL_PROVIDER *prov); 73 74 /* Get the global properties associate with the specified library context */ 75 OSSL_PROPERTY_LIST **ossl_ctx_global_properties(OSSL_LIB_CTX *ctx, 76 int loadconfig); 77 78 /* property query cache functions */ 79 int ossl_method_store_cache_get(OSSL_METHOD_STORE *store, OSSL_PROVIDER *prov, 80 int nid, const char *prop_query, void **result); 81 int ossl_method_store_cache_set(OSSL_METHOD_STORE *store, OSSL_PROVIDER *prov, 82 int nid, const char *prop_query, void *result, 83 int (*method_up_ref)(void *), 84 void (*method_destruct)(void *)); 85 86 __owur int ossl_method_store_cache_flush_all(OSSL_METHOD_STORE *store); 87 88 /* Merge two property queries together */ 89 OSSL_PROPERTY_LIST *ossl_property_merge(const OSSL_PROPERTY_LIST *a, 90 const OSSL_PROPERTY_LIST *b); 91 92 size_t ossl_property_list_to_string(OSSL_LIB_CTX *ctx, 93 const OSSL_PROPERTY_LIST *list, char *buf, 94 size_t bufsize); 95 96 int ossl_global_properties_no_mirrored(OSSL_LIB_CTX *libctx); 97 void ossl_global_properties_stop_mirroring(OSSL_LIB_CTX *libctx); 98 99 #endif 100