Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 1 | /* |
julhal01 | c3f4e9a | 2020-12-15 13:39:01 +0000 | [diff] [blame] | 2 | * Copyright (c) 2020-2021, Arm Limited and Contributors. All rights reserved. |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: BSD-3-Clause |
| 5 | */ |
| 6 | |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 7 | #ifndef CRYPTO_PROVIDER_H |
| 8 | #define CRYPTO_PROVIDER_H |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 9 | |
julhal01 | c3f4e9a | 2020-12-15 13:39:01 +0000 | [diff] [blame] | 10 | #include <rpc/common/endpoint/rpc_interface.h> |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 11 | #include <service/common/provider/service_provider.h> |
julhal01 | c3f4e9a | 2020-12-15 13:39:01 +0000 | [diff] [blame] | 12 | #include <service/crypto/provider/serializer/crypto_provider_serializer.h> |
Julian Hall | 3e61454 | 2021-07-29 11:47:47 +0100 | [diff] [blame] | 13 | #include <service/discovery/provider/discovery_provider.h> |
julhal01 | c3f4e9a | 2020-12-15 13:39:01 +0000 | [diff] [blame] | 14 | #include <protocols/rpc/common/packed-c/encoding.h> |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 15 | |
| 16 | #ifdef __cplusplus |
| 17 | extern "C" { |
| 18 | #endif |
| 19 | |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 20 | struct crypto_provider |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 21 | { |
Julian Hall | 3e61454 | 2021-07-29 11:47:47 +0100 | [diff] [blame] | 22 | struct service_provider base_provider; |
| 23 | const struct crypto_provider_serializer *serializers[TS_RPC_ENCODING_LIMIT]; |
| 24 | struct discovery_provider discovery_provider; |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 25 | }; |
| 26 | |
| 27 | /* |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 28 | * Initializes an instance of the crypto service provider. A suitable |
| 29 | * backend that realizes the PSA Crypto API should have been initialized |
| 30 | * prior to initializing the crypto provider. |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 31 | */ |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 32 | struct rpc_interface *crypto_provider_init(struct crypto_provider *context); |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 33 | |
| 34 | /* |
| 35 | * When operation of the provider is no longer required, this function |
| 36 | * frees any resource used by the previously initialized provider instance. |
| 37 | */ |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 38 | void crypto_provider_deinit(struct crypto_provider *context); |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 39 | |
julhal01 | c3f4e9a | 2020-12-15 13:39:01 +0000 | [diff] [blame] | 40 | /* |
| 41 | * Register a serializer for supportng a particular parameter encoding. At |
| 42 | * least one serializer must be registered but additional ones may be registered |
| 43 | * to allow alternative parameter serialization schemes to be used to allow |
| 44 | * for compatibility with different types of client. |
| 45 | */ |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 46 | void crypto_provider_register_serializer(struct crypto_provider *context, |
Julian Hall | 3e61454 | 2021-07-29 11:47:47 +0100 | [diff] [blame] | 47 | unsigned int encoding, |
| 48 | const struct crypto_provider_serializer *serializer); |
julhal01 | c3f4e9a | 2020-12-15 13:39:01 +0000 | [diff] [blame] | 49 | |
Julian Hall | 13e7695 | 2021-07-13 12:17:09 +0100 | [diff] [blame] | 50 | /* |
| 51 | * Extend the core set of operations provided by the crypto provider. |
| 52 | */ |
| 53 | void crypto_provider_extend(struct crypto_provider *context, |
Julian Hall | 3e61454 | 2021-07-29 11:47:47 +0100 | [diff] [blame] | 54 | struct service_provider *sub_provider); |
Julian Hall | 13e7695 | 2021-07-13 12:17:09 +0100 | [diff] [blame] | 55 | |
Julian Hall | c02fffb | 2020-11-23 18:22:06 +0100 | [diff] [blame] | 56 | #ifdef __cplusplus |
| 57 | } /* extern "C" */ |
| 58 | #endif |
| 59 | |
Julian Hall | 9061e6c | 2021-06-29 14:24:20 +0100 | [diff] [blame] | 60 | #endif /* CRYPTO_PROVIDER_H */ |