1c84ccd0aSEtienne Carriere /* SPDX-License-Identifier: BSD-2-Clause */ 2c84ccd0aSEtienne Carriere /* 3c84ccd0aSEtienne Carriere * Copyright (c) 2017-2020, Linaro Limited 4c84ccd0aSEtienne Carriere */ 5c84ccd0aSEtienne Carriere #ifndef PKCS11_TA_PKCS11_TOKEN_H 6c84ccd0aSEtienne Carriere #define PKCS11_TA_PKCS11_TOKEN_H 7c84ccd0aSEtienne Carriere 8c84ccd0aSEtienne Carriere #include <sys/queue.h> 9c84ccd0aSEtienne Carriere #include <tee_api_types.h> 10c84ccd0aSEtienne Carriere #include <tee_internal_api.h> 11c84ccd0aSEtienne Carriere 12c84ccd0aSEtienne Carriere enum pkcs11_token_state { 13c84ccd0aSEtienne Carriere PKCS11_TOKEN_RESET = 0, 14c84ccd0aSEtienne Carriere PKCS11_TOKEN_READ_WRITE, 15c84ccd0aSEtienne Carriere PKCS11_TOKEN_READ_ONLY, 16c84ccd0aSEtienne Carriere }; 17c84ccd0aSEtienne Carriere 18c84ccd0aSEtienne Carriere #define PKCS11_MAX_USERS 2 19c84ccd0aSEtienne Carriere #define PKCS11_TOKEN_PIN_SIZE 128 20c84ccd0aSEtienne Carriere 21c84ccd0aSEtienne Carriere /* 22c84ccd0aSEtienne Carriere * Persistent state of the token 23c84ccd0aSEtienne Carriere * 24c84ccd0aSEtienne Carriere * @version - currently unused... 25c84ccd0aSEtienne Carriere * @label - pkcs11 formatted token label, set by client 26c84ccd0aSEtienne Carriere * @flags - pkcs11 token flags 27c84ccd0aSEtienne Carriere * @so_pin_count - counter on security officer login failure 28c84ccd0aSEtienne Carriere * @so_pin_size - byte size of the provisioned SO PIN 29c84ccd0aSEtienne Carriere * @so_pin - stores the SO PIN 30c84ccd0aSEtienne Carriere * @user_pin_count - counter on user login failure 31c84ccd0aSEtienne Carriere * @user_pin_size - byte size of the provisioned user PIN 32c84ccd0aSEtienne Carriere * @user_pin - stores the user PIN 33c84ccd0aSEtienne Carriere */ 34c84ccd0aSEtienne Carriere struct token_persistent_main { 35c84ccd0aSEtienne Carriere uint32_t version; 36c84ccd0aSEtienne Carriere uint8_t label[PKCS11_TOKEN_LABEL_SIZE]; 37c84ccd0aSEtienne Carriere uint32_t flags; 38c84ccd0aSEtienne Carriere uint32_t so_pin_count; 39c84ccd0aSEtienne Carriere uint32_t so_pin_size; 40c84ccd0aSEtienne Carriere uint8_t so_pin[PKCS11_TOKEN_PIN_SIZE]; 41c84ccd0aSEtienne Carriere uint32_t user_pin_count; 42c84ccd0aSEtienne Carriere uint32_t user_pin_size; 43c84ccd0aSEtienne Carriere uint8_t user_pin[PKCS11_TOKEN_PIN_SIZE]; 44c84ccd0aSEtienne Carriere }; 45c84ccd0aSEtienne Carriere 46c84ccd0aSEtienne Carriere /* 47c84ccd0aSEtienne Carriere * Runtime state of the token, complies with pkcs11 48c84ccd0aSEtienne Carriere * 49c84ccd0aSEtienne Carriere * @state - Pkcs11 login is public, user, SO or custom 50c84ccd0aSEtienne Carriere * @session_count - Counter for opened Pkcs11 sessions 51c84ccd0aSEtienne Carriere * @rw_session_count - Count for opened Pkcs11 read/write sessions 52c84ccd0aSEtienne Carriere * @db_main - Volatile copy of the persistent main database 53c84ccd0aSEtienne Carriere */ 54c84ccd0aSEtienne Carriere struct ck_token { 55c84ccd0aSEtienne Carriere enum pkcs11_token_state state; 56c84ccd0aSEtienne Carriere uint32_t session_count; 57c84ccd0aSEtienne Carriere uint32_t rw_session_count; 58c84ccd0aSEtienne Carriere /* Copy in RAM of the persistent database */ 59c84ccd0aSEtienne Carriere struct token_persistent_main *db_main; 60c84ccd0aSEtienne Carriere }; 61c84ccd0aSEtienne Carriere 62c84ccd0aSEtienne Carriere /* Initialize static token instance(s) from default/persistent database */ 63c84ccd0aSEtienne Carriere TEE_Result pkcs11_init(void); 64c84ccd0aSEtienne Carriere void pkcs11_deinit(void); 65c84ccd0aSEtienne Carriere 66*d38f9635SEtienne Carriere /* Speculation safe lookup of token instance from token identifier */ 67c84ccd0aSEtienne Carriere struct ck_token *get_token(unsigned int token_id); 68c84ccd0aSEtienne Carriere 69c84ccd0aSEtienne Carriere /* Return token identified from token instance address */ 70c84ccd0aSEtienne Carriere unsigned int get_token_id(struct ck_token *token); 71c84ccd0aSEtienne Carriere 72c84ccd0aSEtienne Carriere /* Access to persistent database */ 73c84ccd0aSEtienne Carriere struct ck_token *init_persistent_db(unsigned int token_id); 74c84ccd0aSEtienne Carriere void close_persistent_db(struct ck_token *token); 75c84ccd0aSEtienne Carriere 7622ac6984SEtienne Carriere /* Entry point for the TA commands */ 7722ac6984SEtienne Carriere uint32_t entry_ck_slot_list(uint32_t ptypes, TEE_Param *params); 7822ac6984SEtienne Carriere 79c84ccd0aSEtienne Carriere #endif /*PKCS11_TA_PKCS11_TOKEN_H*/ 80