core/include/tee/tee_fs_key_manager.h

   1 /*
   2  * Copyright (c) 2015, Linaro Limited
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  *
   8  * 1. Redistributions of source code must retain the above copyright notice,
   9  * this list of conditions and the following disclaimer.
  10  *
  11  * 2. Redistributions in binary form must reproduce the above copyright notice,
  12  * this list of conditions and the following disclaimer in the documentation
  13  * and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  19  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  20  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  21  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  24  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  25  * POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 #ifndef TEE_FS_KEY_MANAGER_H
  29 #define TEE_FS_KEY_MANAGER_H
  30
  31 #include <tee_api_types.h>
  32 #include <utee_defines.h>
  33
  34 #define TEE_FS_KM_CHIP_ID_LENGTH    32
  35 #define TEE_FS_KM_HMAC_ALG          TEE_ALG_HMAC_SHA256
  36 #define TEE_FS_KM_AUTH_ENC_ALG      TEE_ALG_AES_GCM
  37 #define TEE_FS_KM_ENC_FEK_ALG       TEE_ALG_AES_ECB_NOPAD
  38 #define TEE_FS_KM_SSK_SIZE          TEE_SHA256_HASH_SIZE
  39 #define TEE_FS_KM_TSK_SIZE          TEE_SHA256_HASH_SIZE
  40 #define TEE_FS_KM_FEK_SIZE          16  /* bytes */
  41 #define TEE_FS_KM_IV_LEN            12  /* bytes */
  42 #define TEE_FS_KM_MAX_TAG_LEN       16  /* bytes */
  43
  44
  45 #define BLOCK_FILE_SHIFT        12
  46
  47 #define BLOCK_FILE_SIZE         (1 << BLOCK_FILE_SHIFT)
  48
  49 #define NUM_BLOCKS_PER_FILE     1024
  50
  51 enum tee_fs_file_type {
  52         META_FILE,
  53         BLOCK_FILE
  54 };
  55
  56 struct tee_fs_file_info {
  57         uint64_t length;
  58         uint32_t backup_version_table[NUM_BLOCKS_PER_FILE / 32];
  59 };
  60
  61 struct tee_fs_file_meta {
  62         struct tee_fs_file_info info;
  63         uint8_t encrypted_fek[TEE_FS_KM_FEK_SIZE];
  64         uint32_t counter;
  65 };
  66
  67 struct common_header {
  68         uint8_t iv[TEE_FS_KM_IV_LEN];
  69         uint8_t tag[TEE_FS_KM_MAX_TAG_LEN];
  70 };
  71
  72 struct meta_header {
  73         uint8_t encrypted_key[TEE_FS_KM_FEK_SIZE];
  74         struct common_header common;
  75 };
  76
  77 struct block_header {
  78         struct common_header common;
  79 };
  80
  81 size_t tee_fs_get_header_size(enum tee_fs_file_type type);
  82 TEE_Result tee_fs_generate_fek(uint8_t *encrypted_fek, int fek_size);
  83 TEE_Result tee_fs_encrypt_file(enum tee_fs_file_type file_type,
  84                 const uint8_t *plaintext, size_t plaintext_size,
  85                 uint8_t *ciphertext, size_t *ciphertext_size,
  86                 const uint8_t *encrypted_fek);
  87 TEE_Result tee_fs_decrypt_file(enum tee_fs_file_type file_type,
  88                 const uint8_t *data_in, size_t data_in_size,
  89                 uint8_t *plaintext, size_t *plaintext_size,
  90                 uint8_t *encrypted_fek);
  91 TEE_Result tee_fs_crypt_block(uint8_t *out, const uint8_t *in, size_t size,
  92                               uint16_t blk_idx, const uint8_t *encrypted_fek,
  93                               TEE_OperationMode mode);
  94 #endif