Initial commit se05x-aes-key

The app provides the functions to:
1. setkey: Read text file and inject a key at a specified address
2. getkey: Read out key from a specified address and write it to a file
3. erasekey: Erase a key at a specific address

At the moment, it is not possible to use all adresses of the SE. This is
due to failing get_handle requests on some adresses. It looks like
this is a problem of the build configuration, as the get_handle requests
work when using the yocto default configuration of the full package.

CMakeLists.txt

+CMAKE_MINIMUM_REQUIRED(VERSION 3.5.0)
+
+project(se05x-aes-key)
+
+add_executable(${PROJECT_NAME} src/se05x-aes-key.c)
+target_compile_definitions(${PROJECT_NAME} PRIVATE SSS_USE_FTR_FILE T1oI2C T1oI2C_UM11225)
+target_link_libraries(${PROJECT_NAME} PRIVATE ptmwmini)

LICENSE.txt

+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 SECO Northern Europe GmbH
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

src/se05x-aes-key.c

+/*
+ *
+ * Copyright 2018,2019 NXP
+ * Copyright 2023 SECO Northern Europe GmbH
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <ex_sss.h>
+#include <ex_sss_boot.h>
+#include <fsl_sss_se05x_apis.h>
+#include <nxEnsure.h>
+#include <nxLog_App.h>
+#include <string.h>
+#include <stdio.h>
+#include <stdlib.h>
+
+static ex_sss_boot_ctx_t gex_sss_symmetric_boot_ctx;
+
+#define EX_SSS_BOOT_PCONTEXT (&gex_sss_symmetric_boot_ctx)
+#define EX_SSS_BOOT_DO_ERASE 1
+#define EX_SSS_BOOT_EXPOSE_ARGC_ARGV 1
+
+#define MAX_FILE_NAME_SIZE 255
+#define MAX_BYTE_LENGTH 32
+
+/* ************************************************************************** */
+/* Include "main()" with the platform specific startup code for Plug & Trust  */
+/* MW examples which will call ex_sss_entry()                                 */
+/* ************************************************************************** */
+#include <ex_sss_main_inc.h>
+
+/*
+ * hex2uint
+ * Convert a char array and into byte array by using the ascii
+ * table indices.
+ */
+static int hex2uint(char *hexarr, uint8_t *bytearr, int lenchararr) {
+    uint8_t byte;
+    uint8_t val = 0;
+    int i;
+    for (i = 0; i < lenchararr; i++) {
+        byte = hexarr[i];
+        if (byte >= '0' && byte <= '9') byte = byte - '0';
+        else if (byte >= 'a' && byte <='f') byte = byte - 'a' + 10;
+        else if (byte >= 'A' && byte <='F') byte = byte - 'A' + 10;
+        else return 1;
+        /*
+         * Combine 2 characters to one byte; an even number
+         * of characters is expected.
+         */
+        if (i%2) {
+            val = (val << 4) | (byte & 0xF);
+            bytearr[i/2] = val;
+        } else {
+            val = (byte & 0xF);
+        }
+    }
+    return 0;
+}
+
+/*
+ * uint2hex
+ */
+static int uint2hex(uint8_t *bytearr, char *hexarr, int lenbytearr) {
+    int i;
+    for (i = 0; i < lenbytearr; i++) {
+        /* Use sprintf (0 termination is overwritten until write) */
+        sprintf(&hexarr[i * 2], "%02x", bytearr[i]);
+    }
+    return 0;
+}
+
+static void usage()
+{
+    LOG_W("Usage:");
+    LOG_W("Write AES key to SE");
+    LOG_W("\t ex_aeskey setkey <key-id> <input-file> <i2c-dev>");
+    LOG_W("Get AES key from SE");
+    LOG_W("\t ex_aeskey getkey <key-id> <ouput-file> <i2c-dev>");
+    LOG_W("Erase key from SE");
+    LOG_W("\t ex_aeskey erasekey <key-id> <i2c-dev>");
+}
+
+sss_status_t ex_sss_entry(ex_sss_boot_ctx_t *pCtx)
+{
+    sss_status_t status = kStatus_SSS_Success;
+    int argc = gex_sss_argc;
+    const char **argv = gex_sss_argv;
+    int setkey = 0;
+    int getkey = 0;
+    int erasekey = 0;
+    char filepath[MAX_FILE_NAME_SIZE] = {0};
+    FILE *keyfile = NULL;
+    uint32_t keyid = 0;
+    sss_key_part_t keyPart;
+    sss_cipher_type_t cipherType;
+    sss_object_t key = {0};
+    size_t keyByteLenMax = MAX_BYTE_LENGTH;
+    uint8_t keydata[MAX_BYTE_LENGTH] = {0};
+    char chexdata[MAX_BYTE_LENGTH * 2 + 1] = {0};
+
+    keyPart    = kSSS_KeyPart_Default;
+    /*
+     * We set the cipherType to binary for now, because the AES type
+     * does not allow to read out the key again.
+     * It may be possible to inject readable AES by parsing modified
+     * policies.
+     */
+    //cipherType = kSSS_CipherType_AES;
+    cipherType = kSSS_CipherType_Binary;
+
+
+    /* Evaluate arguments */
+    if (argc < 2) {
+        usage();
+        goto cleanup;
+    }
+
+    if (strncmp(argv[1], "setkey", sizeof("setkey")) == 0) {
+        setkey = 1;
+    } else if (strncmp(argv[1], "getkey", sizeof("getkey")) == 0) {
+        getkey = 1;
+    } else if (strncmp(argv[1], "erasekey", sizeof("erasekey")) == 0) {
+        erasekey = 1;
+    } else {
+        usage();
+        goto cleanup;
+    }
+
+    /*
+     * setkey function
+     *   - Open and parse file and keyid
+     *   - Check if the legth of the parsed key is AES compatible
+     *   - Store key in SE
+     */
+    if (setkey) {
+        if (argc < 4) {
+            status = kStatus_SSS_Fail;
+            usage ();
+            goto cleanup;
+        }
+
+        LOG_I("setkey function called");
+
+        strncpy(filepath, argv[3], sizeof(filepath) - 1);
+        keyfile = fopen(filepath, "rb");
+        if (keyfile == NULL) {
+            LOG_E("Can not open file");
+            goto cleanup;
+        }
+
+        fseek(keyfile, 0, SEEK_END);
+        long fsize = ftell(keyfile);
+        fseek(keyfile, 0, SEEK_SET);
+
+        /*
+         * We expect a file that contains only hex numbers
+         * in text format without trailing new line. Since
+         * the key is represented in characters, the
+         * determined file size has twice as many bytes as
+         * the byte-encoded version.
+         */
+        if (fsize != 32 && fsize != 48 && fsize != 64) {
+            LOG_E("Invalid AES key length");
+            goto cleanup;
+        }
+
+        if (fread(chexdata, 1, fsize, keyfile) != (size_t) fsize) {
+            LOG_E("Failed to read key file");
+            goto cleanup;
+        }
+
+        hex2uint(chexdata, keydata, fsize);
+
+        LOG_MAU8_I("Key array:", keydata, fsize/2);
+
+        keyid = (uint32_t) strtoul(argv[2], (char **)NULL, 16);
+
+        status = sss_key_object_init(&key, &pCtx->ks);
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+
+        status = sss_key_object_allocate_handle(
+                &key,
+                keyid,
+                keyPart,
+                cipherType,
+                keyByteLenMax,
+                kKeyObject_Mode_Persistent
+                );
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+
+        status = sss_key_store_set_key(
+                &pCtx->ks,
+                &key,
+                keydata,
+                fsize/2,
+                fsize/2 * 8,
+                NULL,
+                0
+                );
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+        LOG_I("Key set successfully");
+        LOG_X32_I(keyid);
+    }
+
+    /*
+     * getkey function
+     *   - Parse keyid
+     *   - Get key from SE
+     *   - Write key to output file
+     */
+    if (getkey) {
+        if (argc < 4) {
+            status = kStatus_SSS_Fail;
+            usage ();
+            goto cleanup;
+        }
+        LOG_I("getkey function called");
+
+        strncpy(filepath, argv[3], sizeof(filepath) - 1);
+        keyfile = fopen(filepath, "wb");
+
+        keyid = (uint32_t) strtoul(argv[2], (char **)NULL, 16);
+
+        status = sss_key_object_init(&key, &pCtx->ks);
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+        LOG_X32_I(keyid);
+
+        status = sss_key_object_get_handle(
+                &key,
+                keyid
+                );
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+
+        size_t datalen = sizeof(keydata);
+        size_t pKeyBitLen = sizeof(keydata)*8;
+        status = sss_key_store_get_key(
+                &pCtx->ks,
+                &key,
+                keydata,
+                &datalen,
+                &pKeyBitLen
+                );
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+        LOG_MAU8_I("Key data: ", keydata, datalen);
+
+        uint2hex(keydata, chexdata, datalen);
+        if (fputs(chexdata, keyfile) == EOF) {
+            LOG_E("Error writing output file");
+            goto cleanup;
+        }
+
+        LOG_I("Key successfully written to file");
+        LOG_X32_I(keyid);
+    }
+
+    /*
+     * erasekey function
+     *   - Parse keyid
+     *   - Erase key from SE
+     */
+    if (erasekey) {
+        if (argc < 3) {
+            status = kStatus_SSS_Fail;
+            usage ();
+            goto cleanup;
+        }
+        LOG_I("erasekey function called");
+
+        keyid = (uint32_t) strtoul(argv[2], (char **)NULL, 16);
+
+        status = sss_key_object_init(&key, &pCtx->ks);
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+
+        status = sss_key_object_get_handle(
+                &key,
+                keyid
+                );
+        ENSURE_OR_GO_CLEANUP(status == kStatus_SSS_Success);
+
+        status = sss_key_store_erase_key(
+                &pCtx->ks,
+                &key
+                );
+
+        LOG_I("Key successfully removed");
+        LOG_X32_I(keyid);
+    }
+
+    /*
+     * cleanup
+     *   - Free everything
+     *   - return status
+     */
+cleanup:
+    LOG_I("Cleanup");
+    if (keyfile != NULL)
+        fclose(keyfile);
+
+    sss_key_object_free(&key);
+    return status;
+}