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