]> git.sur5r.net Git - freertos/blobdiff - FreeRTOS-Labs/Source/mbedtls/library/nist_kw.c
Add the Labs projects provided in the V10.2.1_191129 zip file.
[freertos] / FreeRTOS-Labs / Source / mbedtls / library / nist_kw.c
diff --git a/FreeRTOS-Labs/Source/mbedtls/library/nist_kw.c b/FreeRTOS-Labs/Source/mbedtls/library/nist_kw.c
new file mode 100644 (file)
index 0000000..6f4bbea
--- /dev/null
@@ -0,0 +1,755 @@
+/*\r
+ *  Implementation of NIST SP 800-38F key wrapping, supporting KW and KWP modes\r
+ *  only\r
+ *\r
+ *  Copyright (C) 2018, Arm Limited (or its affiliates), All Rights Reserved\r
+ *  SPDX-License-Identifier: Apache-2.0\r
+ *\r
+ *  Licensed under the Apache License, Version 2.0 (the "License"); you may\r
+ *  not use this file except in compliance with the License.\r
+ *  You may obtain a copy of the License at\r
+ *\r
+ *  http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ *  Unless required by applicable law or agreed to in writing, software\r
+ *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT\r
+ *  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ *  See the License for the specific language governing permissions and\r
+ *  limitations under the License.\r
+ *\r
+ *  This file is part of Mbed TLS (https://tls.mbed.org)\r
+ */\r
+/*\r
+ * Definition of Key Wrapping:\r
+ * https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-38F.pdf\r
+ * RFC 3394 "Advanced Encryption Standard (AES) Key Wrap Algorithm"\r
+ * RFC 5649 "Advanced Encryption Standard (AES) Key Wrap with Padding Algorithm"\r
+ *\r
+ * Note: RFC 3394 defines different methodology for intermediate operations for\r
+ * the wrapping and unwrapping operation than the definition in NIST SP 800-38F.\r
+ */\r
+\r
+#if !defined(MBEDTLS_CONFIG_FILE)\r
+#include "mbedtls/config.h"\r
+#else\r
+#include MBEDTLS_CONFIG_FILE\r
+#endif\r
+\r
+#if defined(MBEDTLS_NIST_KW_C)\r
+\r
+#include "mbedtls/nist_kw.h"\r
+#include "mbedtls/platform_util.h"\r
+\r
+#include <stdint.h>\r
+#include <string.h>\r
+\r
+#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)\r
+#if defined(MBEDTLS_PLATFORM_C)\r
+#include "mbedtls/platform.h"\r
+#else\r
+#include <stdio.h>\r
+#define mbedtls_printf printf\r
+#endif /* MBEDTLS_PLATFORM_C */\r
+#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */\r
+\r
+#if !defined(MBEDTLS_NIST_KW_ALT)\r
+\r
+#define KW_SEMIBLOCK_LENGTH    8\r
+#define MIN_SEMIBLOCKS_COUNT   3\r
+\r
+/* constant-time buffer comparison */\r
+static inline unsigned char mbedtls_nist_kw_safer_memcmp( const void *a, const void *b, size_t n )\r
+{\r
+    size_t i;\r
+    volatile const unsigned char *A = (volatile const unsigned char *) a;\r
+    volatile const unsigned char *B = (volatile const unsigned char *) b;\r
+    volatile unsigned char diff = 0;\r
+\r
+    for( i = 0; i < n; i++ )\r
+    {\r
+        /* Read volatile data in order before computing diff.\r
+         * This avoids IAR compiler warning:\r
+         * 'the order of volatile accesses is undefined ..' */\r
+        unsigned char x = A[i], y = B[i];\r
+        diff |= x ^ y;\r
+    }\r
+\r
+    return( diff );\r
+}\r
+\r
+/*! The 64-bit default integrity check value (ICV) for KW mode. */\r
+static const unsigned char NIST_KW_ICV1[] = {0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6, 0xA6};\r
+/*! The 32-bit default integrity check value (ICV) for KWP mode. */\r
+static const  unsigned char NIST_KW_ICV2[] = {0xA6, 0x59, 0x59, 0xA6};\r
+\r
+#ifndef GET_UINT32_BE\r
+#define GET_UINT32_BE(n,b,i)                            \\r
+do {                                                    \\r
+    (n) = ( (uint32_t) (b)[(i)    ] << 24 )             \\r
+        | ( (uint32_t) (b)[(i) + 1] << 16 )             \\r
+        | ( (uint32_t) (b)[(i) + 2] <<  8 )             \\r
+        | ( (uint32_t) (b)[(i) + 3]       );            \\r
+} while( 0 )\r
+#endif\r
+\r
+#ifndef PUT_UINT32_BE\r
+#define PUT_UINT32_BE(n,b,i)                            \\r
+do {                                                    \\r
+    (b)[(i)    ] = (unsigned char) ( (n) >> 24 );       \\r
+    (b)[(i) + 1] = (unsigned char) ( (n) >> 16 );       \\r
+    (b)[(i) + 2] = (unsigned char) ( (n) >>  8 );       \\r
+    (b)[(i) + 3] = (unsigned char) ( (n)       );       \\r
+} while( 0 )\r
+#endif\r
+\r
+/*\r
+ * Initialize context\r
+ */\r
+void mbedtls_nist_kw_init( mbedtls_nist_kw_context *ctx )\r
+{\r
+    memset( ctx, 0, sizeof( mbedtls_nist_kw_context ) );\r
+}\r
+\r
+int mbedtls_nist_kw_setkey( mbedtls_nist_kw_context *ctx,\r
+                            mbedtls_cipher_id_t cipher,\r
+                            const unsigned char *key,\r
+                            unsigned int keybits,\r
+                            const int is_wrap )\r
+{\r
+    int ret;\r
+    const mbedtls_cipher_info_t *cipher_info;\r
+\r
+    cipher_info = mbedtls_cipher_info_from_values( cipher,\r
+                                                   keybits,\r
+                                                   MBEDTLS_MODE_ECB );\r
+    if( cipher_info == NULL )\r
+        return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+\r
+    if( cipher_info->block_size != 16 )\r
+        return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+\r
+    /*\r
+     * SP 800-38F currently defines AES cipher as the only block cipher allowed:\r
+     * "For KW and KWP, the underlying block cipher shall be approved, and the\r
+     *  block size shall be 128 bits. Currently, the AES block cipher, with key\r
+     *  lengths of 128, 192, or 256 bits, is the only block cipher that fits\r
+     *  this profile."\r
+     *  Currently we don't support other 128 bit block ciphers for key wrapping,\r
+     *  such as Camellia and Aria.\r
+     */\r
+    if( cipher != MBEDTLS_CIPHER_ID_AES )\r
+        return( MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE );\r
+\r
+    mbedtls_cipher_free( &ctx->cipher_ctx );\r
+\r
+    if( ( ret = mbedtls_cipher_setup( &ctx->cipher_ctx, cipher_info ) ) != 0 )\r
+        return( ret );\r
+\r
+    if( ( ret = mbedtls_cipher_setkey( &ctx->cipher_ctx, key, keybits,\r
+                                       is_wrap ? MBEDTLS_ENCRYPT :\r
+                                                 MBEDTLS_DECRYPT )\r
+                                                                   ) != 0 )\r
+    {\r
+        return( ret );\r
+    }\r
+\r
+    return( 0 );\r
+}\r
+\r
+/*\r
+ * Free context\r
+ */\r
+void mbedtls_nist_kw_free( mbedtls_nist_kw_context *ctx )\r
+{\r
+    mbedtls_cipher_free( &ctx->cipher_ctx );\r
+    mbedtls_platform_zeroize( ctx, sizeof( mbedtls_nist_kw_context ) );\r
+}\r
+\r
+/*\r
+ * Helper function for Xoring the uint64_t "t" with the encrypted A.\r
+ * Defined in NIST SP 800-38F section 6.1\r
+ */\r
+static void calc_a_xor_t( unsigned char A[KW_SEMIBLOCK_LENGTH], uint64_t t )\r
+{\r
+    size_t i = 0;\r
+    for( i = 0; i < sizeof( t ); i++ )\r
+    {\r
+        A[i] ^= ( t >> ( ( sizeof( t ) - 1 - i ) * 8 ) ) & 0xff;\r
+    }\r
+}\r
+\r
+/*\r
+ * KW-AE as defined in SP 800-38F section 6.2\r
+ * KWP-AE as defined in SP 800-38F section 6.3\r
+ */\r
+int mbedtls_nist_kw_wrap( mbedtls_nist_kw_context *ctx,\r
+                          mbedtls_nist_kw_mode_t mode,\r
+                          const unsigned char *input, size_t in_len,\r
+                          unsigned char *output, size_t *out_len, size_t out_size )\r
+{\r
+    int ret = 0;\r
+    size_t semiblocks = 0;\r
+    size_t s;\r
+    size_t olen, padlen = 0;\r
+    uint64_t t = 0;\r
+    unsigned char outbuff[KW_SEMIBLOCK_LENGTH * 2];\r
+    unsigned char inbuff[KW_SEMIBLOCK_LENGTH * 2];\r
+    unsigned char *R2 = output + KW_SEMIBLOCK_LENGTH;\r
+    unsigned char *A = output;\r
+\r
+    *out_len = 0;\r
+    /*\r
+     * Generate the String to work on\r
+     */\r
+    if( mode == MBEDTLS_KW_MODE_KW )\r
+    {\r
+        if( out_size < in_len + KW_SEMIBLOCK_LENGTH )\r
+        {\r
+            return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+        }\r
+\r
+        /*\r
+         * According to SP 800-38F Table 1, the plaintext length for KW\r
+         * must be between 2 to 2^54-1 semiblocks inclusive.\r
+         */\r
+        if( in_len < 16 ||\r
+#if SIZE_MAX > 0x1FFFFFFFFFFFFF8\r
+            in_len > 0x1FFFFFFFFFFFFF8 ||\r
+#endif\r
+            in_len % KW_SEMIBLOCK_LENGTH != 0 )\r
+        {\r
+            return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+        }\r
+\r
+        memcpy( output, NIST_KW_ICV1, KW_SEMIBLOCK_LENGTH );\r
+        memmove( output + KW_SEMIBLOCK_LENGTH, input, in_len );\r
+    }\r
+    else\r
+    {\r
+        if( in_len % 8 != 0 )\r
+        {\r
+            padlen = ( 8 - ( in_len % 8 ) );\r
+        }\r
+\r
+        if( out_size < in_len + KW_SEMIBLOCK_LENGTH + padlen )\r
+        {\r
+            return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+        }\r
+\r
+        /*\r
+         * According to SP 800-38F Table 1, the plaintext length for KWP\r
+         * must be between 1 and 2^32-1 octets inclusive.\r
+         */\r
+        if( in_len < 1\r
+#if SIZE_MAX > 0xFFFFFFFF\r
+            || in_len > 0xFFFFFFFF\r
+#endif\r
+          )\r
+        {\r
+            return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+        }\r
+\r
+        memcpy( output, NIST_KW_ICV2, KW_SEMIBLOCK_LENGTH / 2 );\r
+        PUT_UINT32_BE( ( in_len & 0xffffffff ), output,\r
+                       KW_SEMIBLOCK_LENGTH / 2 );\r
+\r
+        memcpy( output + KW_SEMIBLOCK_LENGTH, input, in_len );\r
+        memset( output + KW_SEMIBLOCK_LENGTH + in_len, 0, padlen );\r
+    }\r
+    semiblocks = ( ( in_len + padlen ) / KW_SEMIBLOCK_LENGTH ) + 1;\r
+\r
+    s = 6 * ( semiblocks - 1 );\r
+\r
+    if( mode == MBEDTLS_KW_MODE_KWP\r
+        && in_len <= KW_SEMIBLOCK_LENGTH )\r
+    {\r
+        memcpy( inbuff, output, 16 );\r
+        ret = mbedtls_cipher_update( &ctx->cipher_ctx,\r
+                                     inbuff, 16, output, &olen );\r
+        if( ret != 0 )\r
+            goto cleanup;\r
+    }\r
+    else\r
+    {\r
+        /*\r
+         * Do the wrapping function W, as defined in RFC 3394 section 2.2.1\r
+         */\r
+        if( semiblocks < MIN_SEMIBLOCKS_COUNT )\r
+        {\r
+            ret = MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA;\r
+            goto cleanup;\r
+        }\r
+\r
+        /* Calculate intermediate values */\r
+        for( t = 1; t <= s; t++ )\r
+        {\r
+            memcpy( inbuff, A, KW_SEMIBLOCK_LENGTH );\r
+            memcpy( inbuff + KW_SEMIBLOCK_LENGTH, R2, KW_SEMIBLOCK_LENGTH );\r
+\r
+            ret = mbedtls_cipher_update( &ctx->cipher_ctx,\r
+                                         inbuff, 16, outbuff, &olen );\r
+            if( ret != 0 )\r
+                goto cleanup;\r
+\r
+            memcpy( A, outbuff, KW_SEMIBLOCK_LENGTH );\r
+            calc_a_xor_t( A, t );\r
+\r
+            memcpy( R2, outbuff + KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH );\r
+            R2 += KW_SEMIBLOCK_LENGTH;\r
+            if( R2 >= output + ( semiblocks * KW_SEMIBLOCK_LENGTH ) )\r
+                R2 = output + KW_SEMIBLOCK_LENGTH;\r
+        }\r
+    }\r
+\r
+    *out_len = semiblocks * KW_SEMIBLOCK_LENGTH;\r
+\r
+cleanup:\r
+\r
+    if( ret != 0)\r
+    {\r
+        memset( output, 0, semiblocks * KW_SEMIBLOCK_LENGTH );\r
+    }\r
+    mbedtls_platform_zeroize( inbuff, KW_SEMIBLOCK_LENGTH * 2 );\r
+    mbedtls_platform_zeroize( outbuff, KW_SEMIBLOCK_LENGTH * 2 );\r
+\r
+    return( ret );\r
+}\r
+\r
+/*\r
+ * W-1 function as defined in RFC 3394 section 2.2.2\r
+ * This function assumes the following:\r
+ * 1. Output buffer is at least of size ( semiblocks - 1 ) * KW_SEMIBLOCK_LENGTH.\r
+ * 2. The input buffer is of size semiblocks * KW_SEMIBLOCK_LENGTH.\r
+ * 3. Minimal number of semiblocks is 3.\r
+ * 4. A is a buffer to hold the first semiblock of the input buffer.\r
+ */\r
+static int unwrap( mbedtls_nist_kw_context *ctx,\r
+                   const unsigned char *input, size_t semiblocks,\r
+                   unsigned char A[KW_SEMIBLOCK_LENGTH],\r
+                   unsigned char *output, size_t* out_len )\r
+{\r
+    int ret = 0;\r
+    const size_t s = 6 * ( semiblocks - 1 );\r
+    size_t olen;\r
+    uint64_t t = 0;\r
+    unsigned char outbuff[KW_SEMIBLOCK_LENGTH * 2];\r
+    unsigned char inbuff[KW_SEMIBLOCK_LENGTH * 2];\r
+    unsigned char *R = output + ( semiblocks - 2 ) * KW_SEMIBLOCK_LENGTH;\r
+    *out_len = 0;\r
+\r
+    if( semiblocks < MIN_SEMIBLOCKS_COUNT )\r
+    {\r
+        return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+    }\r
+\r
+    memcpy( A, input, KW_SEMIBLOCK_LENGTH );\r
+    memmove( output, input + KW_SEMIBLOCK_LENGTH, ( semiblocks - 1 ) * KW_SEMIBLOCK_LENGTH );\r
+\r
+    /* Calculate intermediate values */\r
+    for( t = s; t >= 1; t-- )\r
+    {\r
+        calc_a_xor_t( A, t );\r
+\r
+        memcpy( inbuff, A, KW_SEMIBLOCK_LENGTH );\r
+        memcpy( inbuff + KW_SEMIBLOCK_LENGTH, R, KW_SEMIBLOCK_LENGTH );\r
+\r
+        ret = mbedtls_cipher_update( &ctx->cipher_ctx,\r
+                                     inbuff, 16, outbuff, &olen );\r
+        if( ret != 0 )\r
+            goto cleanup;\r
+\r
+        memcpy( A, outbuff, KW_SEMIBLOCK_LENGTH );\r
+\r
+        /* Set R as LSB64 of outbuff */\r
+        memcpy( R, outbuff + KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH );\r
+\r
+        if( R == output )\r
+            R = output + ( semiblocks - 2 ) * KW_SEMIBLOCK_LENGTH;\r
+        else\r
+            R -= KW_SEMIBLOCK_LENGTH;\r
+    }\r
+\r
+    *out_len = ( semiblocks - 1 ) * KW_SEMIBLOCK_LENGTH;\r
+\r
+cleanup:\r
+    if( ret != 0)\r
+        memset( output, 0, ( semiblocks - 1 ) * KW_SEMIBLOCK_LENGTH );\r
+    mbedtls_platform_zeroize( inbuff, sizeof( inbuff )  );\r
+    mbedtls_platform_zeroize( outbuff, sizeof( outbuff ) );\r
+\r
+    return( ret );\r
+}\r
+\r
+/*\r
+ * KW-AD as defined in SP 800-38F section 6.2\r
+ * KWP-AD as defined in SP 800-38F section 6.3\r
+ */\r
+int mbedtls_nist_kw_unwrap( mbedtls_nist_kw_context *ctx,\r
+                            mbedtls_nist_kw_mode_t mode,\r
+                            const unsigned char *input, size_t in_len,\r
+                            unsigned char *output, size_t *out_len, size_t out_size )\r
+{\r
+    int ret = 0;\r
+    size_t i, olen;\r
+    unsigned char A[KW_SEMIBLOCK_LENGTH];\r
+    unsigned char diff, bad_padding = 0;\r
+\r
+    *out_len = 0;\r
+    if( out_size < in_len - KW_SEMIBLOCK_LENGTH )\r
+    {\r
+        return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+    }\r
+\r
+    if( mode == MBEDTLS_KW_MODE_KW )\r
+    {\r
+        /*\r
+         * According to SP 800-38F Table 1, the ciphertext length for KW\r
+         * must be between 3 to 2^54 semiblocks inclusive.\r
+         */\r
+        if( in_len < 24 ||\r
+#if SIZE_MAX > 0x200000000000000\r
+            in_len > 0x200000000000000 ||\r
+#endif\r
+            in_len % KW_SEMIBLOCK_LENGTH != 0 )\r
+        {\r
+            return( MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+        }\r
+\r
+        ret = unwrap( ctx, input, in_len / KW_SEMIBLOCK_LENGTH,\r
+                      A, output, out_len );\r
+        if( ret != 0 )\r
+            goto cleanup;\r
+\r
+        /* Check ICV in "constant-time" */\r
+        diff = mbedtls_nist_kw_safer_memcmp( NIST_KW_ICV1, A, KW_SEMIBLOCK_LENGTH );\r
+\r
+        if( diff != 0 )\r
+        {\r
+            ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;\r
+            goto cleanup;\r
+        }\r
+\r
+    }\r
+    else if( mode == MBEDTLS_KW_MODE_KWP )\r
+    {\r
+        size_t padlen = 0;\r
+        uint32_t Plen;\r
+        /*\r
+         * According to SP 800-38F Table 1, the ciphertext length for KWP\r
+         * must be between 2 to 2^29 semiblocks inclusive.\r
+         */\r
+        if( in_len < KW_SEMIBLOCK_LENGTH * 2 ||\r
+#if SIZE_MAX > 0x100000000\r
+            in_len > 0x100000000 ||\r
+#endif\r
+            in_len % KW_SEMIBLOCK_LENGTH != 0 )\r
+        {\r
+            return(  MBEDTLS_ERR_CIPHER_BAD_INPUT_DATA );\r
+        }\r
+\r
+        if( in_len == KW_SEMIBLOCK_LENGTH * 2 )\r
+        {\r
+            unsigned char outbuff[KW_SEMIBLOCK_LENGTH * 2];\r
+            ret = mbedtls_cipher_update( &ctx->cipher_ctx,\r
+                                         input, 16, outbuff, &olen );\r
+            if( ret != 0 )\r
+                goto cleanup;\r
+\r
+            memcpy( A, outbuff, KW_SEMIBLOCK_LENGTH );\r
+            memcpy( output, outbuff + KW_SEMIBLOCK_LENGTH, KW_SEMIBLOCK_LENGTH );\r
+            mbedtls_platform_zeroize( outbuff, sizeof( outbuff ) );\r
+            *out_len = KW_SEMIBLOCK_LENGTH;\r
+        }\r
+        else\r
+        {\r
+            /* in_len >=  KW_SEMIBLOCK_LENGTH * 3 */\r
+            ret = unwrap( ctx, input, in_len / KW_SEMIBLOCK_LENGTH,\r
+                          A, output, out_len );\r
+            if( ret != 0 )\r
+                goto cleanup;\r
+        }\r
+\r
+        /* Check ICV in "constant-time" */\r
+        diff = mbedtls_nist_kw_safer_memcmp( NIST_KW_ICV2, A, KW_SEMIBLOCK_LENGTH / 2 );\r
+\r
+        if( diff != 0 )\r
+        {\r
+            ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;\r
+        }\r
+\r
+        GET_UINT32_BE( Plen, A, KW_SEMIBLOCK_LENGTH / 2 );\r
+\r
+        /*\r
+         * Plen is the length of the plaintext, when the input is valid.\r
+         * If Plen is larger than the plaintext and padding, padlen will be\r
+         * larger than 8, because of the type wrap around.\r
+         */\r
+        padlen = in_len - KW_SEMIBLOCK_LENGTH - Plen;\r
+        if ( padlen > 7 )\r
+        {\r
+            padlen &= 7;\r
+            ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;\r
+        }\r
+\r
+        /* Check padding in "constant-time" */\r
+        for( diff = 0, i = 0; i < KW_SEMIBLOCK_LENGTH; i++ )\r
+        {\r
+             if( i >= KW_SEMIBLOCK_LENGTH - padlen )\r
+                 diff |= output[*out_len - KW_SEMIBLOCK_LENGTH + i];\r
+             else\r
+                 bad_padding |= output[*out_len - KW_SEMIBLOCK_LENGTH + i];\r
+        }\r
+\r
+        if( diff != 0 )\r
+        {\r
+            ret = MBEDTLS_ERR_CIPHER_AUTH_FAILED;\r
+        }\r
+\r
+        if( ret != 0 )\r
+        {\r
+            goto cleanup;\r
+        }\r
+        memset( output + Plen, 0, padlen );\r
+        *out_len = Plen;\r
+    }\r
+    else\r
+    {\r
+        ret = MBEDTLS_ERR_CIPHER_FEATURE_UNAVAILABLE;\r
+        goto cleanup;\r
+    }\r
+\r
+cleanup:\r
+    if( ret != 0 )\r
+    {\r
+        memset( output, 0, *out_len );\r
+        *out_len = 0;\r
+    }\r
+\r
+    mbedtls_platform_zeroize( &bad_padding, sizeof( bad_padding) );\r
+    mbedtls_platform_zeroize( &diff, sizeof( diff ) );\r
+    mbedtls_platform_zeroize( A, sizeof( A ) );\r
+\r
+    return( ret );\r
+}\r
+\r
+#endif /* !MBEDTLS_NIST_KW_ALT */\r
+\r
+#if defined(MBEDTLS_SELF_TEST) && defined(MBEDTLS_AES_C)\r
+\r
+#define KW_TESTS 3\r
+\r
+/*\r
+ * Test vectors taken from NIST\r
+ * https://csrc.nist.gov/Projects/Cryptographic-Algorithm-Validation-Program/CAVP-TESTING-BLOCK-CIPHER-MODES#KW\r
+ */\r
+static const unsigned int key_len[KW_TESTS] = { 16, 24, 32 };\r
+\r
+static const unsigned char kw_key[KW_TESTS][32] = {\r
+    { 0x75, 0x75, 0xda, 0x3a, 0x93, 0x60, 0x7c, 0xc2,\r
+      0xbf, 0xd8, 0xce, 0xc7, 0xaa, 0xdf, 0xd9, 0xa6 },\r
+    { 0x2d, 0x85, 0x26, 0x08, 0x1d, 0x02, 0xfb, 0x5b,\r
+      0x85, 0xf6, 0x9a, 0xc2, 0x86, 0xec, 0xd5, 0x7d,\r
+      0x40, 0xdf, 0x5d, 0xf3, 0x49, 0x47, 0x44, 0xd3 },\r
+    { 0x11, 0x2a, 0xd4, 0x1b, 0x48, 0x56, 0xc7, 0x25,\r
+      0x4a, 0x98, 0x48, 0xd3, 0x0f, 0xdd, 0x78, 0x33,\r
+      0x5b, 0x03, 0x9a, 0x48, 0xa8, 0x96, 0x2c, 0x4d,\r
+      0x1c, 0xb7, 0x8e, 0xab, 0xd5, 0xda, 0xd7, 0x88 }\r
+};\r
+\r
+static const unsigned char kw_msg[KW_TESTS][40] = {\r
+    { 0x42, 0x13, 0x6d, 0x3c, 0x38, 0x4a, 0x3e, 0xea,\r
+      0xc9, 0x5a, 0x06, 0x6f, 0xd2, 0x8f, 0xed, 0x3f },\r
+    { 0x95, 0xc1, 0x1b, 0xf5, 0x35, 0x3a, 0xfe, 0xdb,\r
+      0x98, 0xfd, 0xd6, 0xc8, 0xca, 0x6f, 0xdb, 0x6d,\r
+      0xa5, 0x4b, 0x74, 0xb4, 0x99, 0x0f, 0xdc, 0x45,\r
+      0xc0, 0x9d, 0x15, 0x8f, 0x51, 0xce, 0x62, 0x9d,\r
+      0xe2, 0xaf, 0x26, 0xe3, 0x25, 0x0e, 0x6b, 0x4c },\r
+    { 0x1b, 0x20, 0xbf, 0x19, 0x90, 0xb0, 0x65, 0xd7,\r
+      0x98, 0xe1, 0xb3, 0x22, 0x64, 0xad, 0x50, 0xa8,\r
+      0x74, 0x74, 0x92, 0xba, 0x09, 0xa0, 0x4d, 0xd1 }\r
+};\r
+\r
+static const size_t kw_msg_len[KW_TESTS] = { 16, 40, 24 };\r
+static const size_t kw_out_len[KW_TESTS] = { 24, 48, 32 };\r
+static const unsigned char kw_res[KW_TESTS][48] = {\r
+    { 0x03, 0x1f, 0x6b, 0xd7, 0xe6, 0x1e, 0x64, 0x3d,\r
+      0xf6, 0x85, 0x94, 0x81, 0x6f, 0x64, 0xca, 0xa3,\r
+      0xf5, 0x6f, 0xab, 0xea, 0x25, 0x48, 0xf5, 0xfb },\r
+    { 0x44, 0x3c, 0x6f, 0x15, 0x09, 0x83, 0x71, 0x91,\r
+      0x3e, 0x5c, 0x81, 0x4c, 0xa1, 0xa0, 0x42, 0xec,\r
+      0x68, 0x2f, 0x7b, 0x13, 0x6d, 0x24, 0x3a, 0x4d,\r
+      0x6c, 0x42, 0x6f, 0xc6, 0x97, 0x15, 0x63, 0xe8,\r
+      0xa1, 0x4a, 0x55, 0x8e, 0x09, 0x64, 0x16, 0x19,\r
+      0xbf, 0x03, 0xfc, 0xaf, 0x90, 0xb1, 0xfc, 0x2d },\r
+    { 0xba, 0x8a, 0x25, 0x9a, 0x47, 0x1b, 0x78, 0x7d,\r
+      0xd5, 0xd5, 0x40, 0xec, 0x25, 0xd4, 0x3d, 0x87,\r
+      0x20, 0x0f, 0xda, 0xdc, 0x6d, 0x1f, 0x05, 0xd9,\r
+      0x16, 0x58, 0x4f, 0xa9, 0xf6, 0xcb, 0xf5, 0x12 }\r
+};\r
+\r
+static const unsigned char kwp_key[KW_TESTS][32] = {\r
+    { 0x78, 0x65, 0xe2, 0x0f, 0x3c, 0x21, 0x65, 0x9a,\r
+      0xb4, 0x69, 0x0b, 0x62, 0x9c, 0xdf, 0x3c, 0xc4 },\r
+    { 0xf5, 0xf8, 0x96, 0xa3, 0xbd, 0x2f, 0x4a, 0x98,\r
+      0x23, 0xef, 0x16, 0x2b, 0x00, 0xb8, 0x05, 0xd7,\r
+      0xde, 0x1e, 0xa4, 0x66, 0x26, 0x96, 0xa2, 0x58 },\r
+    { 0x95, 0xda, 0x27, 0x00, 0xca, 0x6f, 0xd9, 0xa5,\r
+      0x25, 0x54, 0xee, 0x2a, 0x8d, 0xf1, 0x38, 0x6f,\r
+      0x5b, 0x94, 0xa1, 0xa6, 0x0e, 0xd8, 0xa4, 0xae,\r
+      0xf6, 0x0a, 0x8d, 0x61, 0xab, 0x5f, 0x22, 0x5a }\r
+};\r
+\r
+static const unsigned char kwp_msg[KW_TESTS][31] = {\r
+    { 0xbd, 0x68, 0x43, 0xd4, 0x20, 0x37, 0x8d, 0xc8,\r
+      0x96 },\r
+    { 0x6c, 0xcd, 0xd5, 0x85, 0x18, 0x40, 0x97, 0xeb,\r
+      0xd5, 0xc3, 0xaf, 0x3e, 0x47, 0xd0, 0x2c, 0x19,\r
+      0x14, 0x7b, 0x4d, 0x99, 0x5f, 0x96, 0x43, 0x66,\r
+      0x91, 0x56, 0x75, 0x8c, 0x13, 0x16, 0x8f },\r
+    { 0xd1 }\r
+};\r
+static const size_t kwp_msg_len[KW_TESTS] = { 9, 31, 1 };\r
+\r
+static const unsigned char kwp_res[KW_TESTS][48] = {\r
+    { 0x41, 0xec, 0xa9, 0x56, 0xd4, 0xaa, 0x04, 0x7e,\r
+      0xb5, 0xcf, 0x4e, 0xfe, 0x65, 0x96, 0x61, 0xe7,\r
+      0x4d, 0xb6, 0xf8, 0xc5, 0x64, 0xe2, 0x35, 0x00 },\r
+    { 0x4e, 0x9b, 0xc2, 0xbc, 0xbc, 0x6c, 0x1e, 0x13,\r
+      0xd3, 0x35, 0xbc, 0xc0, 0xf7, 0x73, 0x6a, 0x88,\r
+      0xfa, 0x87, 0x53, 0x66, 0x15, 0xbb, 0x8e, 0x63,\r
+      0x8b, 0xcc, 0x81, 0x66, 0x84, 0x68, 0x17, 0x90,\r
+      0x67, 0xcf, 0xa9, 0x8a, 0x9d, 0x0e, 0x33, 0x26 },\r
+    { 0x06, 0xba, 0x7a, 0xe6, 0xf3, 0x24, 0x8c, 0xfd,\r
+      0xcf, 0x26, 0x75, 0x07, 0xfa, 0x00, 0x1b, 0xc4  }\r
+};\r
+static const size_t kwp_out_len[KW_TESTS] = { 24, 40, 16 };\r
+\r
+int mbedtls_nist_kw_self_test( int verbose )\r
+{\r
+    mbedtls_nist_kw_context ctx;\r
+    unsigned char out[48];\r
+    size_t olen;\r
+    int i;\r
+    int ret = 0;\r
+    mbedtls_nist_kw_init( &ctx );\r
+\r
+    for( i = 0; i < KW_TESTS; i++ )\r
+    {\r
+        if( verbose != 0 )\r
+            mbedtls_printf( "  KW-AES-%u ", (unsigned int) key_len[i] * 8 );\r
+\r
+        ret = mbedtls_nist_kw_setkey( &ctx, MBEDTLS_CIPHER_ID_AES,\r
+                                      kw_key[i], key_len[i] * 8, 1 );\r
+        if( ret != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "  KW: setup failed " );\r
+\r
+            goto end;\r
+        }\r
+\r
+        ret = mbedtls_nist_kw_wrap( &ctx, MBEDTLS_KW_MODE_KW, kw_msg[i],\r
+                                    kw_msg_len[i], out, &olen, sizeof( out ) );\r
+        if( ret != 0 || kw_out_len[i] != olen ||\r
+            memcmp( out, kw_res[i], kw_out_len[i] ) != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "failed. ");\r
+\r
+            ret = 1;\r
+            goto end;\r
+        }\r
+\r
+        if( ( ret = mbedtls_nist_kw_setkey( &ctx, MBEDTLS_CIPHER_ID_AES,\r
+                                            kw_key[i], key_len[i] * 8, 0 ) )\r
+              != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "  KW: setup failed ");\r
+\r
+            goto end;\r
+        }\r
+\r
+        ret = mbedtls_nist_kw_unwrap( &ctx, MBEDTLS_KW_MODE_KW,\r
+                                      out, olen, out, &olen, sizeof( out ) );\r
+\r
+        if( ret != 0 || olen != kw_msg_len[i] ||\r
+            memcmp( out, kw_msg[i], kw_msg_len[i] ) != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "failed\n" );\r
+\r
+            ret = 1;\r
+            goto end;\r
+        }\r
+\r
+        if( verbose != 0 )\r
+            mbedtls_printf( " passed\n" );\r
+    }\r
+\r
+    for( i = 0; i < KW_TESTS; i++ )\r
+    {\r
+        olen = sizeof( out );\r
+        if( verbose != 0 )\r
+            mbedtls_printf( "  KWP-AES-%u ", (unsigned int) key_len[i] * 8 );\r
+\r
+        ret = mbedtls_nist_kw_setkey( &ctx, MBEDTLS_CIPHER_ID_AES, kwp_key[i],\r
+                                      key_len[i] * 8, 1 );\r
+        if( ret  != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "  KWP: setup failed " );\r
+\r
+            goto end;\r
+        }\r
+        ret = mbedtls_nist_kw_wrap( &ctx, MBEDTLS_KW_MODE_KWP, kwp_msg[i],\r
+                                    kwp_msg_len[i], out, &olen, sizeof( out ) );\r
+\r
+        if( ret != 0 || kwp_out_len[i] != olen ||\r
+            memcmp( out, kwp_res[i], kwp_out_len[i] ) != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "failed. ");\r
+\r
+            ret = 1;\r
+            goto end;\r
+        }\r
+\r
+        if( ( ret = mbedtls_nist_kw_setkey( &ctx, MBEDTLS_CIPHER_ID_AES,\r
+                                            kwp_key[i], key_len[i] * 8, 0 ) )\r
+              != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "  KWP: setup failed ");\r
+\r
+            goto end;\r
+        }\r
+\r
+        ret = mbedtls_nist_kw_unwrap(  &ctx, MBEDTLS_KW_MODE_KWP, out,\r
+                                       olen, out, &olen, sizeof( out ) );\r
+\r
+        if( ret != 0 || olen != kwp_msg_len[i] ||\r
+            memcmp( out, kwp_msg[i], kwp_msg_len[i] ) != 0 )\r
+        {\r
+            if( verbose != 0 )\r
+                mbedtls_printf( "failed. ");\r
+\r
+            ret = 1;\r
+            goto end;\r
+        }\r
+\r
+        if( verbose != 0 )\r
+            mbedtls_printf( " passed\n" );\r
+    }\r
+end:\r
+    mbedtls_nist_kw_free( &ctx );\r
+\r
+    if( verbose != 0 )\r
+        mbedtls_printf( "\n" );\r
+\r
+    return( ret );\r
+}\r
+\r
+#endif /* MBEDTLS_SELF_TEST && MBEDTLS_AES_C */\r
+\r
+#endif /* MBEDTLS_NIST_KW_C */\r