1 /******************************************************************************
2 *  Filename:       aes_doc.h
3 *  Revised:        2020-02-14 11:30:20 +0100 (Fri, 14 Feb 2020)
4 *  Revision:       56760
5 *
6 *  Copyright (c) 2015 - 2020, Texas Instruments Incorporated
7 *  All rights reserved.
8 *
9 *  Redistribution and use in source and binary forms, with or without
10 *  modification, are permitted provided that the following conditions are met:
11 *
12 *  1) Redistributions of source code must retain the above copyright notice,
13 *     this list of conditions and the following disclaimer.
14 *
15 *  2) Redistributions in binary form must reproduce the above copyright notice,
16 *     this list of conditions and the following disclaimer in the documentation
17 *     and/or other materials provided with the distribution.
18 *
19 *  3) Neither the name of the ORGANIZATION nor the names of its contributors may
20 *     be used to endorse or promote products derived from this software without
21 *     specific prior written permission.
22 *
23 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
27 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 *  POSSIBILITY OF SUCH DAMAGE.
34 *
35 ******************************************************************************/
36 //! \addtogroup aes_api
37 //! @{
38 //! \section sec_aes Introduction
39 //!
40 //! The AES (advanced encryption standard) API provides access to the AES and key
41 //! store functionality of the crypto core. The SHA2 accelerator is also
42 //! contained within the crypto core. Hence, only one of SHA2 and AES may be
43 //! used at the same time.
44 //! This module offers hardware acceleration for several protocols using the
45 //! AES block cypher. The protocols below are supported by the hardware. The
46 //! driverlib documentation only explicitly references the most commonly used ones.
47 //! - ECB
48 //! - CBC
49 //! - CCM
50 //! - CBC-MAC
51 //! - GCM
52 //!
53 //! The key store is a section of crypto memory that is only accessible to the crypto module
54 //! and may be written to by the application via the crypto DMA. It is not possible to
55 //! read from the key store to main memory. Thereby, it is not possible to
56 //! compromise the key should the application be hacked if the original key in main
57 //! memory was overwritten already.
58 //!
59 //! The crypto core does not have retention and all configuration settings and
60 //! keys in the keystore are lost when going into standby or shutdown.
61 //! The typical security advantages a key store offers are not available in these
62 //! low power modes as the key must be saved in regular memory to reload
63 //! it after going into standby or shutdown.
64 //! Consequently, the keystore primarily serves as an interface to the AES accelerator.
65 //!
66 //! @}
67