tpm2_unseal.c анализа исходного кода tpm2-tools (1)

Исходный файл, соответствующий команде tpm2_unseal в TPM 2.0, — это tpm2_unseal.c, который находится в папке tpm2-tools/tools/ и содержит 306 строк (версия 5.5).

Функция tpm2_unseal — вернуть большой двоичный объект данных в загруженном объекте TPM. Большой двоичный объект данных очищается по возвращении. Данные архивируются при создании объектов с помощью инструмента tpm2_create.

Далее используется объем нескольких статей для проведения всестороннего и полного анализа файла tpm2_unseal.c в сочетании с командой tpm2_unseal.

Давайте посмотрим на первый кусок кода:

// Register this tool with tpm2_tool.c
TPM2_TOOL_REGISTER("unseal", tpm2_tool_onstart, tpm2_tool_onrun,
    tpm2_tool_onstop, NULL)

TPM2_TOOL_REGISTER — это определение макроса, в tpm2-tools/tools/tpm2_tool.h код выглядит следующим образом:

#define TPM2_TOOL_REGISTER(tool_name,tool_onstart,tool_onrun,tool_onstop,tool_onexit) \
	static const tpm2_tool tool = { \
		.name		= tool_name, \
		.onstart	= tool_onstart, \
		.onrun		= tool_onrun, \
		.onstop		= tool_onstop, \
		.onexit		= tool_onexit, \
	}; \
	static void \
	__attribute__((__constructor__)) \
	__attribute__((__used__)) \
	_tpm2_tool_init(void) \
	{ \
		tpm2_tool_register(&tool); \
	}

Определение макроса TPM2_TOOLS_REGISTER используется всеми командами всех инструментов tpm2 и является кодом платформы.

В этом файле tpm2_unseal.c также можно сказать, что в команде tpm2_unseal расширение макроса такое:

static const tpm2_tool tool = {
    .name		= "unseal",
	.onstart	= tpm2_tool_onstart,
	.onrun		= tpm2_tool_onrun,
	.onstop		= tpm2_tool_onstop,
	.onexit		= 0,
};
static void
	__attribute__((__constructor__))
	__attribute__((__used__))
    _tpm2_tool_init(void)
{
		tpm2_tool_register(&tool);
}

Определение структуры tpm2_tool также есть в tpm2-tools/tools/tpm2_tool.h, код такой:

typedef struct {
	const char * name;
	tpm2_tool_onstart_t onstart;
	tpm2_tool_onrun_t onrun;
	tpm2_tool_onstop_t onstop;
	tpm2_tool_onexit_t onexit;
} tpm2_tool;

Соответствующие указатели функций, содержащиеся в нем, следующие (в том же файле, чуть выше):

/**
 * An optional interface for tools to specify what options they support.
 * They are concatenated with main's options and passed to getopt_long.
 * @param opts
 *  The callee can choose to set *opts to a tpm_options pointer allocated
 *  via tpm2_options_new(). Setting *opts to NULL is not an error, and
 *  Indicates that no options are specified by the tool.
 *
 * @return
 *  True on success, false on error.
 */
typedef bool (*tpm2_tool_onstart_t)(tpm2_options **opts);
 
/**
 * This is the main interface for tools, after tcti and sapi/esapi initialization
 * are performed.
 * @param ectx
 *  The system/esapi api context.
 * @param flags
 *  Flags that tools may wish to respect.
 * @return
 *  A tool_rc indicating status.
 */
typedef tool_rc (*tpm2_tool_onrun_t)(ESYS_CONTEXT *ectx, tpm2_option_flags flags);
 
/**
 * Called after tpm2_tool_onrun() is invoked. ESAPI context is still valid during this call.
 * @param ectx
 *  The system/esapi api context.
 * @return
 *  A tool_rc indicating status.
 */
typedef tool_rc (*tpm2_tool_onstop_t)(ESYS_CONTEXT *ectx);
 
/**
 * Called when the tool is exiting, useful for cleanup.
 */
typedef void (*tpm2_tool_onexit_t)(void);

Функция tpm2_tool_register реализована в tpm2-tools/tools/tpm2_tools.c, код такой:

/*
 * Build a list of the TPM2 tools linked into this executable
 */
#ifndef TPM2_TOOLS_MAX
#define TPM2_TOOLS_MAX 1024
#endif
static const tpm2_tool *tools[TPM2_TOOLS_MAX];
static unsigned tool_count;
 
void tpm2_tool_register(const tpm2_tool *tool) {
 
    if (tool_count < TPM2_TOOLS_MAX) {
        tools[tool_count++] = tool;
    } else {
        LOG_ERR("Over tool count");
        abort();
    }
}

Вернитесь к tpm2_unseal.c, чтобы увидеть конкретные функции.

（1）tpm2_tool_onstart

Код функции tpm2_tool_onstart выглядит следующим образом:

static bool tpm2_tool_onstart(tpm2_options **opts) {

    static const struct option topts[] = {
      { "auth",             required_argument, NULL, 'p' },
      { "output",           required_argument, NULL, 'o' },
      { "object-context",   required_argument, NULL, 'c' },
      { "cphash",           required_argument, NULL,  0  },
      { "rphash",           required_argument, NULL,  1  },
      { "session",          required_argument, NULL, 'S' },
    };

    *opts = tpm2_options_new("S:p:o:c:", ARRAY_LEN(topts), topts, on_option,
        NULL, 0);

    return *opts != NULL;
}

（2）tpm2_tool_onrun

Код функции tpm2_tool_onrun выглядит следующим образом:

static tool_rc tpm2_tool_onrun(ESYS_CONTEXT *ectx, tpm2_option_flags flags) {

    UNUSED(flags);

    /*
     * 1. Process options
     */
    tool_rc rc = check_options();
    if (rc != tool_rc_success) {
        return rc;
    }

    /*
     * 2. Process inputs
     */
    rc = process_inputs(ectx);
    if (rc != tool_rc_success) {
        return rc;
    }

    /*
     * 3. TPM2_CC_<command> call
     */
    rc = unseal(ectx);
    if (rc != tool_rc_success) {
        return rc;
    }

    /*
     * 4. Process outputs
     */
    return process_output(ectx);
}

（3）tpm2_tool_onstop

Код функции tpm2_tool_onstop выглядит следующим образом:

static tool_rc tpm2_tool_onstop(ESYS_CONTEXT *ectx) {

    UNUSED(ectx);
    /*
     * 1. Free objects
     */
    free(ctx.output_data);

    /*
     * 2. Close authorization sessions
     */
    tool_rc rc = tool_rc_success;
    tool_rc tmp_rc = tool_rc_success;
    if (!ctx.cp_hash_path) {
        tmp_rc = tpm2_session_close(&ctx.sealkey.object.session);
        if (tmp_rc != tool_rc_success) {
            rc = tmp_rc;
        }
    }

    /*
     * 3. Close auxiliary sessions
     */
    uint8_t i = 0;
    for(i = 0; i < ctx.aux_session_cnt; i++) {
        if (ctx.aux_session_path[i]) {
            tmp_rc = tpm2_session_close(&ctx.aux_session[i]);
        }
        if (tmp_rc != tool_rc_success) {
            rc = tmp_rc;
        }
    }

    return rc;
}

В последующих статьях будет представлен углубленный анализ этих функций.