| Gilles Peskine | 961849f | 2018-11-30 18:54:54 +0100 | [diff] [blame^] | 1 | /* |
| 2 | * PSA crypto layer on top of Mbed TLS crypto |
| 3 | */ |
| 4 | /* Copyright (C) 2018, ARM Limited, All Rights Reserved |
| 5 | * SPDX-License-Identifier: Apache-2.0 |
| 6 | * |
| 7 | * Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 8 | * not use this file except in compliance with the License. |
| 9 | * You may obtain a copy of the License at |
| 10 | * |
| 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | * |
| 13 | * Unless required by applicable law or agreed to in writing, software |
| 14 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 15 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | * See the License for the specific language governing permissions and |
| 17 | * limitations under the License. |
| 18 | * |
| 19 | * This file is part of mbed TLS (https://tls.mbed.org) |
| 20 | */ |
| 21 | |
| 22 | #ifndef PSA_CRYPTO_SLOT_MANAGEMENT_H |
| 23 | #define PSA_CRYPTO_SLOT_MANAGEMENT_H |
| 24 | |
| 25 | /* Number of key slots (plus one because 0 is not used). |
| 26 | * The value is a compile-time constant for now, for simplicity. */ |
| 27 | #define PSA_KEY_SLOT_COUNT 32 |
| 28 | |
| 29 | /* All dynamically allocated handles have this bit set. */ |
| 30 | #define PSA_KEY_HANDLE_ALLOCATED_FLAG ( (psa_key_handle_t) 0x8000 ) |
| 31 | |
| 32 | /** \defgroup core_slot_management Internal functions exposed by the core |
| 33 | * @{ |
| 34 | */ |
| 35 | |
| 36 | /** Find a free key slot and mark it as in use. |
| 37 | * |
| 38 | * \param[out] handle On success, a slot number that is not in use. |
| 39 | * |
| 40 | * \retval #PSA_SUCCESS |
| 41 | * \retval #PSA_ERROR_INSUFFICIENT_MEMORY |
| 42 | */ |
| 43 | psa_status_t psa_internal_allocate_key_slot( psa_key_handle_t *handle ); |
| 44 | |
| 45 | /** Wipe an a key slot and mark it as available. |
| 46 | * |
| 47 | * This does not affect persistent storage. |
| 48 | * |
| 49 | * \param handle The key slot number to release. |
| 50 | * |
| 51 | * \retval #PSA_SUCCESS |
| 52 | * \retval #PSA_ERROR_INVALID_ARGUMENT |
| 53 | * \retval #PSA_ERROR_TAMPERING_DETECTED |
| 54 | */ |
| 55 | psa_status_t psa_internal_release_key_slot( psa_key_handle_t handle ); |
| 56 | |
| 57 | /** Declare a slot as persistent and load it from storage. |
| 58 | * |
| 59 | * This function may only be called immediately after a successful call |
| 60 | * to psa_internal_allocate_key_slot(). |
| 61 | * |
| 62 | * \param handle A handle to a key slot freshly allocated with |
| 63 | * psa_internal_allocate_key_slot(). |
| 64 | * |
| 65 | * \retval #PSA_SUCCESS |
| 66 | * The slot content was loaded successfully. |
| 67 | * \retval #PSA_ERROR_EMPTY_SLOT |
| 68 | * There is no content for this slot in persistent storage. |
| 69 | * \retval #PSA_ERROR_INVALID_HANDLE |
| 70 | * \retval #PSA_ERROR_INVALID_ARGUMENT |
| 71 | * \p id is not acceptable. |
| 72 | * \retval #PSA_ERROR_INSUFFICIENT_MEMORY |
| 73 | * \retval #PSA_ERROR_STORAGE_FAILURE |
| 74 | */ |
| 75 | psa_status_t psa_internal_make_key_persistent( psa_key_handle_t handle, |
| 76 | psa_key_id_t id ); |
| 77 | |
| 78 | /**@}*/ |
| 79 | |
| 80 | #endif /* PSA_CRYPTO_SLOT_MANAGEMENT_H */ |