|
| 1 | +/* |
| 2 | + * Copyright (c) 2025 Nordic Semiconductor ASA |
| 3 | + * |
| 4 | + * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause |
| 5 | + */ |
| 6 | + |
| 7 | +/** |
| 8 | + * @defgroup nrf_security_api_structures Nordic-specific PSA API structures |
| 9 | + * @brief Platform Security Architecture (PSA) API structures for nRF Security |
| 10 | + * |
| 11 | + * The nRF Security subsystem provides integration between Mbed TLS and |
| 12 | + * hardware-accelerated cryptographic libraries through PSA drivers. These structures |
| 13 | + * define the implementation-specific context types used in the PSA Crypto API. |
| 14 | + * |
| 15 | + * The `crypto_driver_contexts_*` files are Nordic-specific implementations |
| 16 | + * for the corresponding `crypto_driver_contexts_*` files in the Oberon API. This API is defined |
| 17 | + * in sdk-nrf at https://github.com/nrfconnect/sdk-nrf/tree/main/subsys/nrf_security/include/psa and |
| 18 | + * should be consulted together with the three Nordic-specific files. |
| 19 | + * |
| 20 | + * Nordic-specific implementations are designed to extend available cryptographic features |
| 21 | + * with hardware acceleration or alternative implementations. The supported drivers include: |
| 22 | + * - Arm CryptoCell cc3xx (hardware acceleration for nRF52840, nRF91 Series, and nRF5340) |
| 23 | + * - nrf_oberon (optimized cryptographic algorithms) |
| 24 | + * - CRACEN (hardware acceleration for nRF54L Series) |
| 25 | + * |
| 26 | + * For detailed documentation on these drivers, see the nRF Connect SDK documentation: |
| 27 | + * https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/libraries/security/nrf_security/index.html |
| 28 | + * |
| 29 | + * The Nordic-specific implementation also uses files located at: |
| 30 | + * - https://github.com/nrfconnect/sdk-nrf/blob/main/subsys/nrf_security/src/drivers/cracen/cracenpsa/include/cracen_psa_primitives.h |
| 31 | + * |
| 32 | + * @{ |
| 33 | + */ |
| 34 | + |
| 35 | +/** |
| 36 | + * @defgroup psa_crypto_drivers PSA Crypto Drivers |
| 37 | + * @brief PSA Crypto driver context structures |
| 38 | + * |
| 39 | + * @{ |
| 40 | + */ |
| 41 | + |
| 42 | +/** |
| 43 | + * @defgroup psa_crypto_driver_primitives Primitive Crypto Drivers |
| 44 | + * @brief Driver context structures for primitive cryptographic operations |
| 45 | + * |
| 46 | + * These structures define the contexts for primitive cryptographic operations, |
| 47 | + * which do not rely on other contexts. They include contexts for hash operations |
| 48 | + * and cipher operations implemented by various drivers such as cc3xx, Oberon, |
| 49 | + * and CRACEN. |
| 50 | + * |
| 51 | + * @file crypto_driver_contexts_primitives.h |
| 52 | + */ |
| 53 | + |
| 54 | +/** |
| 55 | + * @defgroup psa_crypto_driver_composites Composite Crypto Drivers |
| 56 | + * @brief Driver context structures for composite cryptographic operations |
| 57 | + * |
| 58 | + * These structures define the contexts for composite operations, |
| 59 | + * which make use of other primitive operations. They include contexts for MAC |
| 60 | + * and AEAD operations implemented by various drivers such as cc3xx, Oberon, |
| 61 | + * and CRACEN. |
| 62 | + * |
| 63 | + * @file crypto_driver_contexts_composites.h |
| 64 | + */ |
| 65 | + |
| 66 | +/** |
| 67 | + * @defgroup psa_crypto_driver_key_derivation Key Derivation Crypto Drivers |
| 68 | + * @brief Driver context structures for key derivation operations |
| 69 | + * |
| 70 | + * These structures define the contexts for key derivation, PAKE, and random |
| 71 | + * generation operations implemented by various drivers such as Oberon and CRACEN. |
| 72 | + * |
| 73 | + * @file crypto_driver_contexts_key_derivation.h |
| 74 | + */ |
| 75 | + |
| 76 | +/** @} */ |
| 77 | + |
| 78 | +/** @} */ |
0 commit comments