You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
trezor-firmware/core/embed/trezorhal/optiga/optiga_commands.c

962 lines
31 KiB

/*
* This file is part of the Trezor project, https://trezor.io/
*
* Copyright (c) SatoshiLabs
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/*
* Reference manuals:
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/Infineon_I2C_Protocol_v2.03.pdf
*/
#include "optiga_commands.h"
#include <string.h>
#include "der.h"
#include "ecdsa.h"
#include "hmac.h"
#include "memzero.h"
#include "nist256p1.h"
#include "optiga_transport.h"
#include "sha2.h"
// Static buffer for commands and responses.
static uint8_t tx_buffer[OPTIGA_MAX_APDU_SIZE] = {0};
static size_t tx_size = 0;
const optiga_metadata_item OPTIGA_META_LCS_OPERATIONAL = {
(const uint8_t *)"\x07", 1};
const optiga_metadata_item OPTIGA_META_ACCESS_ALWAYS = {
(const uint8_t[]){OPTIGA_ACCESS_COND_ALW}, 1};
const optiga_metadata_item OPTIGA_META_ACCESS_NEVER = {
(const uint8_t[]){OPTIGA_ACCESS_COND_NEV}, 1};
const optiga_metadata_item OPTIGA_META_KEY_USE_ENC = {
(const uint8_t[]){OPTIGA_KEY_USAGE_ENC}, 1};
const optiga_metadata_item OPTIGA_META_KEY_USE_KEYAGREE = {
(const uint8_t[]){OPTIGA_KEY_USAGE_KEYAGREE}, 1};
const optiga_metadata_item OPTIGA_META_VERSION_DEFAULT = {
(const uint8_t[]){0x00, 0x00}, 2};
#if PRODUCTION
#define OPTIGA_LOG(prefix, data, data_size)
#else
static optiga_log_hex_t log_hex = NULL;
void optiga_command_set_log_hex(optiga_log_hex_t f) { log_hex = f; }
#define OPTIGA_LOG(prefix, data, data_size) \
if (log_hex != NULL) { \
log_hex(prefix, data, data_size); \
}
#endif
static optiga_result process_output(uint8_t **out_data, size_t *out_size) {
// Check that there is no trailing output data in the response.
if (tx_size < 4 || (tx_buffer[2] << 8) + tx_buffer[3] != tx_size - 4) {
return OPTIGA_ERR_UNEXPECTED;
}
// Check response status code.
if (tx_buffer[0] != 0) {
OPTIGA_LOG("FAILED", NULL, 0)
return OPTIGA_ERR_CMD;
}
*out_data = tx_buffer + 4;
*out_size = tx_size - 4;
OPTIGA_LOG("SUCCESS ", *out_data, *out_size)
return OPTIGA_SUCCESS;
}
static optiga_result process_output_fixedlen(uint8_t *data, size_t data_size) {
uint8_t *out_data = NULL;
size_t out_size = 0;
optiga_result ret = process_output(&out_data, &out_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
// Expecting data_size bytes of output data in the response.
if (out_size != data_size) {
return OPTIGA_ERR_UNEXPECTED;
}
if (data_size != 0) {
memcpy(data, out_data, data_size);
memzero(tx_buffer, tx_size);
}
return OPTIGA_SUCCESS;
}
static optiga_result process_output_varlen(uint8_t *data, size_t max_data_size,
size_t *data_size) {
uint8_t *out_data = NULL;
size_t out_size = 0;
optiga_result ret = process_output(&out_data, &out_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
if (out_size > max_data_size) {
return OPTIGA_ERR_SIZE;
}
memcpy(data, out_data, out_size);
memzero(tx_buffer, tx_size);
*data_size = out_size;
return OPTIGA_SUCCESS;
}
static void write_uint16(uint8_t **ptr, uint16_t i) {
**ptr = i >> 8;
*ptr += 1;
**ptr = i & 0xff;
*ptr += 1;
}
static void write_prefixed_data(uint8_t **ptr, const uint8_t *data,
size_t data_size) {
write_uint16(ptr, data_size);
if (data_size > 0) {
memcpy(*ptr, data, data_size);
*ptr += data_size;
}
}
/*
* For metadata description see:
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#metadata-expression
*/
static const struct {
size_t offset;
uint8_t tag;
const optiga_metadata_item *default_value;
} METADATA_OFFSET_TAG_MAP[] = {
{offsetof(optiga_metadata, lcso), 0xC0, &OPTIGA_META_LCS_OPERATIONAL},
{offsetof(optiga_metadata, version), 0xC1, &OPTIGA_META_VERSION_DEFAULT},
{offsetof(optiga_metadata, max_size), 0xC4, NULL},
{offsetof(optiga_metadata, used_size), 0xC5, NULL},
{offsetof(optiga_metadata, change), 0xD0, &OPTIGA_META_ACCESS_NEVER},
{offsetof(optiga_metadata, read), 0xD1, &OPTIGA_META_ACCESS_NEVER},
{offsetof(optiga_metadata, execute), 0xD3, &OPTIGA_META_ACCESS_NEVER},
{offsetof(optiga_metadata, meta_update), 0xD8, NULL},
{offsetof(optiga_metadata, algorithm), 0xE0, NULL},
{offsetof(optiga_metadata, key_usage), 0xE1, NULL},
{offsetof(optiga_metadata, data_type), 0xE8, NULL},
{offsetof(optiga_metadata, reset_type), 0xF0, NULL},
};
static const size_t METADATA_TAG_COUNT =
sizeof(METADATA_OFFSET_TAG_MAP) / sizeof(METADATA_OFFSET_TAG_MAP[0]);
optiga_result optiga_parse_metadata(const uint8_t *serialized,
size_t serialized_size,
optiga_metadata *metadata) {
memzero(metadata, sizeof(*metadata));
if (serialized_size < 2 || serialized[0] != 0x20 ||
serialized[1] + 2 != serialized_size) {
return OPTIGA_ERR_PARAM;
}
size_t pos = 2;
while (pos < serialized_size) {
if (pos + 2 >= serialized_size) {
return OPTIGA_ERR_PARAM;
}
// Determine metadata type from tag.
optiga_metadata_item *item = NULL;
for (int i = 0; i < METADATA_TAG_COUNT; ++i) {
if (METADATA_OFFSET_TAG_MAP[i].tag == serialized[pos]) {
item = (void *)((char *)metadata + METADATA_OFFSET_TAG_MAP[i].offset);
break;
}
}
if (item == NULL || item->ptr != NULL) {
// Invalid tag or multiply defined tag.
return OPTIGA_ERR_PARAM;
}
item->ptr = &serialized[pos + 2];
item->len = serialized[pos + 1];
pos += 2 + serialized[pos + 1];
}
if (pos != serialized_size) {
return OPTIGA_ERR_PARAM;
}
return OPTIGA_SUCCESS;
}
optiga_result optiga_serialize_metadata(const optiga_metadata *metadata,
uint8_t *serialized,
size_t max_serialized,
size_t *serialized_size) {
*serialized_size = 0;
if (max_serialized < 2) {
return OPTIGA_ERR_SIZE;
}
serialized[0] = 0x20; // Metadata constructed TLV-Object tag.
size_t pos = 2; // Leave room for length byte.
for (int i = 0; i < METADATA_TAG_COUNT; ++i) {
optiga_metadata_item *item =
(void *)((char *)metadata + METADATA_OFFSET_TAG_MAP[i].offset);
if (item->ptr == NULL) {
continue;
}
if (max_serialized < pos + 2 + item->len) {
return OPTIGA_ERR_SIZE;
}
serialized[pos++] = METADATA_OFFSET_TAG_MAP[i].tag;
serialized[pos++] = item->len;
memcpy(&serialized[pos], item->ptr, item->len);
pos += item->len;
}
// Set length byte.
if (pos - 2 > 256) {
return OPTIGA_ERR_SIZE;
}
serialized[1] = pos - 2;
*serialized_size = pos;
return OPTIGA_SUCCESS;
}
// Returns true if all items defined in the expected metadata have the same
// value in the stored metadata, i.e. items that are not defined in the expected
// metadata may have arbitrary value in the stored metadata.
bool optiga_compare_metadata(const optiga_metadata *expected,
const optiga_metadata *stored) {
for (int i = 0; i < METADATA_TAG_COUNT; ++i) {
const optiga_metadata_item *expected_item =
(void *)((char *)expected + METADATA_OFFSET_TAG_MAP[i].offset);
if (expected_item->ptr == NULL) {
// Ignore undefined items.
continue;
}
const optiga_metadata_item *stored_item =
(void *)((char *)stored + METADATA_OFFSET_TAG_MAP[i].offset);
if (stored_item->ptr == NULL) {
if (METADATA_OFFSET_TAG_MAP[i].default_value == NULL) {
return false;
}
stored_item = METADATA_OFFSET_TAG_MAP[i].default_value;
}
if (stored_item->len != expected_item->len ||
memcmp(stored_item->ptr, expected_item->ptr, expected_item->len) != 0) {
return false;
}
}
return true;
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#openapplication
*/
optiga_result optiga_open_application(void) {
static const uint8_t OPEN_APP[] = {
0xF0, 0x00, 0x00, 0x10, 0xD2, 0x76, 0x00, 0x00, 0x04, 0x47,
0x65, 0x6E, 0x41, 0x75, 0x74, 0x68, 0x41, 0x70, 0x70, 0x6C,
};
OPTIGA_LOG(__func__, OPEN_APP, sizeof(OPEN_APP))
optiga_result ret = optiga_execute_command(
OPEN_APP, sizeof(OPEN_APP), tx_buffer, sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(NULL, 0);
}
optiga_result optiga_get_error_code(uint8_t *error_code) {
tx_size = 6;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x01; // command code
*(ptr++) = 0x00; // get data
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, OPTIGA_OID_ERROR_CODE);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(error_code, 1);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#getdataobject
*/
optiga_result optiga_get_data_object(uint16_t oid, bool get_metadata,
uint8_t *data, size_t max_data_size,
size_t *data_size) {
tx_size = 6;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x81; // command code
*(ptr++) = get_metadata ? 0x01 : 0x00;
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, oid);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_varlen(data, max_data_size, data_size);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#setdataobject
*/
optiga_result optiga_set_data_object(uint16_t oid, bool set_metadata,
const uint8_t *data, size_t data_size) {
tx_size = data_size + 8;
if (tx_size > sizeof(tx_buffer)) {
return OPTIGA_ERR_PARAM;
}
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x82; // command code
*(ptr++) = set_metadata ? 0x01 : 0x40;
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, oid);
write_uint16(&ptr, 0); // offset
if (data_size != 0) {
memcpy(ptr, data, data_size);
}
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
memzero(tx_buffer + 8, data_size);
return ret;
}
ret = process_output_fixedlen(NULL, 0);
memzero(tx_buffer + 8, data_size);
return ret;
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#setdataobject
*/
optiga_result optiga_count_data_object(uint16_t oid, uint8_t count) {
if (count == 0) {
return OPTIGA_SUCCESS;
}
tx_size = 9;
if (tx_size > sizeof(tx_buffer)) {
return OPTIGA_ERR_PARAM;
}
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x82; // command code
*(ptr++) = 0x02; // count data object
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, oid);
write_uint16(&ptr, 0); // offset
*(ptr++) = count;
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
ret = process_output_fixedlen(NULL, 0);
return ret;
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#getrandom
*/
optiga_result optiga_get_random(uint8_t *random, size_t random_size) {
if (random_size < OPTIGA_RANDOM_MIN_SIZE ||
random_size > OPTIGA_RANDOM_MAX_SIZE) {
return OPTIGA_ERR_SIZE;
}
tx_size = 6;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x8C; // command code
*(ptr++) = 0x00; // random number from TRNG
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, random_size);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(random, random_size);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#encryptsym
* Returns 0x61, mac_size (2 bytes), mac.
*/
optiga_result optiga_encrypt_sym(optiga_sym_mode mode, uint16_t oid,
const uint8_t *input, size_t input_size,
uint8_t *output, size_t max_output_size,
size_t *output_size) {
if (input_size < 1 || input_size > 640) {
return OPTIGA_ERR_PARAM;
}
tx_size = 9 + input_size;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x94; // command code
*(ptr++) = mode;
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, oid);
*(ptr++) = 0x01; // start and final data block
write_prefixed_data(&ptr, input, input_size);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret == OPTIGA_SUCCESS) {
ret = process_output_varlen(output, max_output_size, output_size);
}
memzero(tx_buffer + 7, input_size);
return ret;
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#decryptsym
*/
optiga_result optiga_set_auto_state(uint16_t nonce_oid, uint16_t key_oid,
const uint8_t *key, size_t key_size) {
uint8_t nonce[16] = {0};
tx_size = 11;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x8C; // command code
*(ptr++) = 0x00; // random number from TRNG
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, sizeof(nonce));
write_uint16(&ptr, nonce_oid);
*(ptr++) = 0x41; // pre-pending optional data tag
write_uint16(&ptr, 0);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
ret = process_output_fixedlen(nonce, sizeof(nonce));
if (ret != OPTIGA_SUCCESS) {
return ret;
}
tx_size = 11 + sizeof(nonce) + 3 + SHA256_DIGEST_LENGTH;
ptr = tx_buffer;
*(ptr++) = 0x95; // command code
*(ptr++) = 0x20; // HMAC-SHA256
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, key_oid);
*(ptr++) = 0x01; // start and final data block
write_uint16(&ptr, 2 + sizeof(nonce)); // data length
write_uint16(&ptr, nonce_oid);
memcpy(ptr, nonce, sizeof(nonce));
ptr += sizeof(nonce);
*(ptr++) = 0x43; // verification value tag
write_uint16(&ptr, SHA256_DIGEST_LENGTH);
hmac_sha256(key, key_size, nonce, sizeof(nonce), ptr);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer, sizeof(tx_buffer),
&tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(NULL, 0);
}
optiga_result optiga_clear_auto_state(uint16_t key_oid) {
tx_size = 12;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0x95; // command code
*(ptr++) = 0x20; // HMAC-SHA256
write_uint16(&ptr, tx_size - 4);
write_uint16(&ptr, key_oid);
*(ptr++) = 0x01; // start and final data block
write_uint16(&ptr, 0); // data length
*(ptr++) = 0x43; // verification value tag
write_uint16(&ptr, 0); // verification value length
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
// Expecting no output data. Response status code should indicate failure.
if (tx_size != 4 || tx_buffer[0] != 0xff || tx_buffer[2] != 0 ||
tx_buffer[3] != 0) {
return OPTIGA_ERR_UNEXPECTED;
}
return OPTIGA_SUCCESS;
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#calcsign
* Returns a signature pair (r,s) encoded as two DER INTEGERs.
*/
optiga_result optiga_calc_sign(uint16_t oid, const uint8_t *digest,
size_t digest_size, uint8_t *signature,
size_t max_sig_size, size_t *sig_size) {
tx_size = digest_size + 12;
if (tx_size > sizeof(tx_buffer)) {
return OPTIGA_ERR_PARAM;
}
uint8_t *ptr = tx_buffer;
*(ptr++) = 0xB1; // command code
*(ptr++) = 0x11; // ECDSA signature scheme
write_uint16(&ptr, tx_size - 4);
*(ptr++) = 0x01; // digest tag
write_prefixed_data(&ptr, digest, digest_size);
*(ptr++) = 0x03; // signature key OID tag
write_uint16(&ptr, 2);
write_uint16(&ptr, oid);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
uint8_t *out_data = NULL;
size_t out_size = 0;
ret = process_output(&out_data, &out_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
// On average 1 in every 256 signatures produced by Optiga has an invalid DER
// encoding. We reencode the signature to ensure correctness.
BUFFER_READER sig_reader = {0};
BUFFER_WRITER sig_writer = {0};
buffer_reader_init(&sig_reader, out_data, out_size);
buffer_writer_init(&sig_writer, signature, max_sig_size);
for (int i = 0; i < 2; ++i) {
if (!der_reencode_int(&sig_reader, &sig_writer)) {
return OPTIGA_ERR_PROCESS;
}
}
if (buffer_remaining(&sig_reader) != 0) {
// Unexpected trailing data.
return OPTIGA_ERR_UNEXPECTED;
}
*sig_size = buffer_written_size(&sig_writer);
return OPTIGA_SUCCESS;
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#verifysign
* The public_key is encoded as a DER BIT STRING.
* The signature pair (r,s) is encoded as two DER INTEGERs.
*/
optiga_result optiga_verify_sign(optiga_curve curve, const uint8_t *public_key,
size_t public_key_size, const uint8_t *digest,
size_t digest_size, const uint8_t *signature,
size_t sig_size) {
tx_size = 17 + digest_size + sig_size + public_key_size;
if (tx_size > sizeof(tx_buffer)) {
return OPTIGA_ERR_PARAM;
}
uint8_t *ptr = tx_buffer;
*(ptr++) = 0xB2; // command code
*(ptr++) = 0x11; // ECDSA signature scheme
write_uint16(&ptr, tx_size - 4);
*(ptr++) = 0x01; // digest tag
write_prefixed_data(&ptr, digest, digest_size);
*(ptr++) = 0x02; // signature tag
write_prefixed_data(&ptr, signature, sig_size);
*(ptr++) = 0x05; // curve tag
write_uint16(&ptr, 1);
*(ptr++) = curve;
*(ptr++) = 0x06; // public key tag
write_prefixed_data(&ptr, public_key, public_key_size);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(NULL, 0);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#genkeypair
* Returns 0x02, public_key_size (2 bytes), public_key.
* The public_key is encoded as a DER BIT STRING.
*/
optiga_result optiga_gen_key_pair(optiga_curve curve, optiga_key_usage usage,
uint16_t oid, uint8_t *public_key,
size_t max_public_key_size,
size_t *public_key_size) {
tx_size = 13;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0xB8; // command code
*(ptr++) = curve;
write_uint16(&ptr, tx_size - 4);
*(ptr++) = 0x01; // private key OID tag
write_uint16(&ptr, 2);
write_uint16(&ptr, oid);
*(ptr++) = 0x02; // key usage tag
write_uint16(&ptr, 1);
*(ptr++) = usage;
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_varlen(public_key, max_public_key_size,
public_key_size);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#gensymkey
*/
optiga_result optiga_gen_sym_key(optiga_aes algorithm, optiga_key_usage usage,
uint16_t oid) {
tx_size = 13;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0xB9; // command code
*(ptr++) = algorithm;
write_uint16(&ptr, tx_size - 4);
*(ptr++) = 0x01; // key OID tag
write_uint16(&ptr, 2);
write_uint16(&ptr, oid);
*(ptr++) = 0x02; // key usage tag
write_uint16(&ptr, 1);
*(ptr++) = usage;
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(NULL, 0);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#calcssec
* The public_key is encoded as a DER BIT STRING.
*/
optiga_result optiga_calc_ssec(optiga_curve curve, uint16_t oid,
const uint8_t *public_key,
size_t public_key_size, uint8_t *secret,
size_t max_secret_size, size_t *secret_size) {
// Size of a P521 public key encoded as a DER BIT STRING.
static const size_t MAX_PUBKEY_SIZE = 5 + 2 * 66;
if (public_key_size > MAX_PUBKEY_SIZE) {
return OPTIGA_ERR_PARAM;
}
tx_size = 16 + public_key_size + 3;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0xB3; // command code
*(ptr++) = 0x01; // ECDH key agreement
write_uint16(&ptr, tx_size - 4);
*(ptr++) = 0x01; // private key OID tag
write_uint16(&ptr, 2);
write_uint16(&ptr, oid);
*(ptr++) = 0x05; // curve tag
write_uint16(&ptr, 1);
*(ptr++) = curve;
*(ptr++) = 0x06; // public key tag
write_prefixed_data(&ptr, public_key, public_key_size);
*(ptr++) = 0x07; // export tag
write_uint16(&ptr, 0);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_varlen(secret, max_secret_size, secret_size);
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#derivekey
*/
optiga_result optiga_derive_key(optiga_key_derivation deriv, uint16_t oid,
const uint8_t *salt, size_t salt_size,
uint8_t *info, size_t info_size, uint8_t *key,
size_t key_size) {
const bool is_hkdf =
(deriv == OPTIGA_DERIV_HKDF_SHA256 || deriv == OPTIGA_DERIV_HKDF_SHA384 ||
deriv == OPTIGA_DERIV_HKDF_SHA512);
if (salt_size > 1024 || (!is_hkdf && salt_size < 8)) {
return OPTIGA_ERR_PARAM;
}
if (info_size > 256 || (!is_hkdf && info_size != 0)) {
return OPTIGA_ERR_PARAM;
}
tx_size = is_hkdf ? 23 + salt_size + info_size : 20 + salt_size;
uint8_t *ptr = tx_buffer;
*(ptr++) = 0xB4; // command code
*(ptr++) = deriv;
write_uint16(&ptr, tx_size - 4);
*(ptr++) = 0x01; // PRESSEC OID tag
write_uint16(&ptr, 2);
write_uint16(&ptr, oid);
*(ptr++) = 0x02; // derivation salt tag
write_prefixed_data(&ptr, salt, salt_size);
*(ptr++) = 0x03; // key size tag
write_uint16(&ptr, 2);
write_uint16(&ptr, key_size);
if (is_hkdf) {
*(ptr++) = 0x04; // info tag
write_prefixed_data(&ptr, info, info_size);
}
*(ptr++) = 0x07; // export tag
write_uint16(&ptr, 0);
OPTIGA_LOG(__func__, tx_buffer, tx_size)
optiga_result ret = optiga_execute_command(tx_buffer, tx_size, tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret == OPTIGA_SUCCESS) {
ret = process_output_fixedlen(key, key_size);
}
memzero(&tx_buffer[12], salt_size);
memzero(&tx_buffer[20 + salt_size], info_size);
return ret;
}
optiga_result optiga_set_trust_anchor(void) {
// Trust anchor certificate.
const uint8_t TA_CERT[] = {
0x30, 0x82, 0x01, 0x49, 0x30, 0x81, 0xf0, 0xa0, 0x03, 0x02, 0x01, 0x02,
0x02, 0x01, 0x01, 0x30, 0x0a, 0x06, 0x08, 0x2a, 0x86, 0x48, 0xce, 0x3d,
0x04, 0x03, 0x02, 0x30, 0x0d, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03, 0x55,
0x04, 0x03, 0x0c, 0x02, 0x54, 0x41, 0x30, 0x20, 0x17, 0x0d, 0x32, 0x33,
0x30, 0x37, 0x32, 0x34, 0x31, 0x35, 0x31, 0x31, 0x34, 0x37, 0x5a, 0x18,
0x0f, 0x32, 0x30, 0x35, 0x33, 0x30, 0x37, 0x32, 0x33, 0x31, 0x35, 0x31,
0x31, 0x34, 0x37, 0x5a, 0x30, 0x0d, 0x31, 0x0b, 0x30, 0x09, 0x06, 0x03,
0x55, 0x04, 0x03, 0x0c, 0x02, 0x54, 0x41, 0x30, 0x59, 0x30, 0x13, 0x06,
0x07, 0x2a, 0x86, 0x48, 0xce, 0x3d, 0x02, 0x01, 0x06, 0x08, 0x2a, 0x86,
0x48, 0xce, 0x3d, 0x03, 0x01, 0x07, 0x03, 0x42, 0x00, 0x04, 0x9b, 0xbf,
0x06, 0xda, 0xd9, 0xab, 0x59, 0x05, 0xe0, 0x54, 0x71, 0xce, 0x16, 0xd5,
0x22, 0x2c, 0x89, 0xc2, 0xca, 0xa3, 0x9f, 0x26, 0x26, 0x7a, 0xc0, 0x74,
0x71, 0x29, 0x88, 0x5f, 0xbd, 0x44, 0x1b, 0xcc, 0x7f, 0xa8, 0x4d, 0xe1,
0x20, 0xa3, 0x67, 0x55, 0xda, 0xf3, 0x0a, 0x6f, 0x47, 0xe8, 0xc0, 0xd4,
0xbd, 0xdc, 0x15, 0x03, 0x6e, 0xd2, 0xa3, 0x44, 0x7d, 0xfa, 0x7a, 0x1d,
0x3e, 0x88, 0xa3, 0x3f, 0x30, 0x3d, 0x30, 0x0c, 0x06, 0x03, 0x55, 0x1d,
0x13, 0x01, 0x01, 0xff, 0x04, 0x02, 0x30, 0x00, 0x30, 0x0e, 0x06, 0x03,
0x55, 0x1d, 0x0f, 0x01, 0x01, 0xff, 0x04, 0x04, 0x03, 0x02, 0x07, 0x80,
0x30, 0x1d, 0x06, 0x03, 0x55, 0x1d, 0x0e, 0x04, 0x16, 0x04, 0x14, 0x68,
0x36, 0xfc, 0x5d, 0x40, 0xb5, 0xbe, 0x47, 0xd4, 0xb0, 0xe2, 0x46, 0x7a,
0xfe, 0x54, 0x3d, 0x8a, 0xd7, 0x0e, 0x26, 0x30, 0x0a, 0x06, 0x08, 0x2a,
0x86, 0x48, 0xce, 0x3d, 0x04, 0x03, 0x02, 0x03, 0x48, 0x00, 0x30, 0x45,
0x02, 0x21, 0x00, 0xff, 0x39, 0x3d, 0x00, 0x1d, 0x9f, 0x88, 0xdc, 0xc1,
0x58, 0x12, 0x68, 0xa5, 0x7f, 0x06, 0x18, 0x1e, 0x65, 0x77, 0x88, 0x12,
0xcb, 0xa5, 0x9d, 0x47, 0xd0, 0x17, 0x85, 0xcd, 0xb8, 0xdc, 0xaa, 0x02,
0x20, 0x08, 0xb8, 0xbe, 0x65, 0xd4, 0xbe, 0x31, 0xe7, 0x74, 0x64, 0x46,
0xfb, 0xe7, 0x70, 0x48, 0x02, 0xd1, 0x08, 0x64, 0xf8, 0xe8, 0x4e, 0xfc,
0xb0, 0xa5, 0x21, 0x2c, 0x54, 0x3a, 0x6c, 0x04, 0x72,
};
return optiga_set_data_object(OPTIGA_OID_CA_CERT, false, TA_CERT,
sizeof(TA_CERT));
}
/*
* https://github.com/Infineon/optiga-trust-m/blob/develop/documents/OPTIGA%E2%84%A2%20Trust%20M%20Solution%20Reference%20Manual.md#setobjectprotected
*/
optiga_result optiga_set_priv_key(uint16_t oid, const uint8_t priv_key[32]) {
uint8_t metadata_buffer[256] = {0};
size_t metadata_size = 0;
optiga_result ret = optiga_get_data_object(
oid, true, metadata_buffer, sizeof(metadata_buffer), &metadata_size);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
optiga_metadata metadata = {0};
ret = optiga_parse_metadata(metadata_buffer, metadata_size, &metadata);
if (ret != OPTIGA_SUCCESS) {
return ret;
}
uint16_t payload_version = 0;
if (metadata.version.ptr != NULL) {
if (metadata.version.len != 2) {
return OPTIGA_ERR_UNEXPECTED;
}
payload_version =
((metadata.version.ptr[0] & 0x7f) << 8) + metadata.version.ptr[1];
}
payload_version += 1;
if (payload_version > 23) {
// CBOR integer encoding not implemented.
return OPTIGA_ERR_PARAM;
}
// Trust anchor private key.
const uint8_t TA_PRIV_KEY[32] = {1};
// First part of the SetObjectProtected command containing the manifest.
uint8_t sop_cmd1[145] = {
0x83, 0x01, 0x00, 0x8d, 0x30, 0x00, 0x8a, 0x84, 0x43, 0xA1, 0x01, 0x26,
0xA1, 0x04, 0x42, 0xE0, 0xE8, 0x58, 0x3C, 0x86, 0x01, 0xF6, 0xF6, 0x84,
0x22, 0x18, 0x23, 0x03, 0x82, 0x03, 0x10, 0x82, 0x82, 0x20, 0x58, 0x25,
0x82, 0x18, 0x29, 0x58, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
0x00, 0xF6, 0x82, 0x40, 0x42, 0xE0, 0xF2, 0x58, 0x40,
};
// Second part of the SetObjectProtected command containing the fragment
// with the private key.
uint8_t sop_cmd2[42] = {
0x83, 0x01, 0x00, 0x26, 0x31, 0x00, 0x23, 0x01, 0x00, 0x20,
};
memcpy(&sop_cmd2[10], &priv_key[0], 32);
sha256_Raw(&sop_cmd2[7], 35, &sop_cmd1[41]);
sop_cmd1[27] = payload_version;
sop_cmd1[77] = oid >> 8;
sop_cmd1[78] = oid & 0xff;
// NOTE sop_cmd1[26] = fragment length (1 + 2 + 32)
// NOTE sop_cmd1[30] = key usage
const uint8_t signature_header[] = {
0x84, 0x4A, 0x53, 0x69, 0x67, 0x6E, 0x61, 0x74, 0x75,
0x72, 0x65, 0x31, 0x43, 0xA1, 0x01, 0x26, 0x40,
};
uint8_t digest[SHA256_DIGEST_LENGTH] = {0};
SHA256_CTX context = {0};
sha256_Init(&context);
sha256_Update(&context, signature_header, sizeof(signature_header));
sha256_Update(&context, &sop_cmd1[17], 62);
sha256_Final(&context, digest);
if (0 != ecdsa_sign_digest(&nist256p1, TA_PRIV_KEY, digest, &sop_cmd1[81],
NULL, NULL)) {
memzero(sop_cmd2, sizeof(sop_cmd2));
return OPTIGA_ERR_PROCESS;
}
OPTIGA_LOG(__func__, sop_cmd1, sizeof(sop_cmd1))
ret = optiga_execute_command(sop_cmd1, sizeof(sop_cmd1), tx_buffer,
sizeof(tx_buffer), &tx_size);
if (ret != OPTIGA_SUCCESS) {
memzero(sop_cmd2, sizeof(sop_cmd2));
return ret;
}
ret = process_output_fixedlen(NULL, 0);
if (ret != OPTIGA_SUCCESS) {
memzero(sop_cmd2, sizeof(sop_cmd2));
return ret;
}
OPTIGA_LOG(__func__, sop_cmd2, sizeof(sop_cmd2))
ret = optiga_execute_command(sop_cmd2, sizeof(sop_cmd2), tx_buffer,
sizeof(tx_buffer), &tx_size);
memzero(sop_cmd2, sizeof(sop_cmd2));
if (ret != OPTIGA_SUCCESS) {
return ret;
}
return process_output_fixedlen(NULL, 0);
}