tpm2-tools源码分析之tpm2_getrandom.c（2）

接前一篇文章tpm2-tools源码分析之tpm2_getrandom.c（1）

本文对tpm2_getrandom.c中的tpm2_tool_onstart函数进行详细解析。

先再次贴出该函数源码：

static bool tpm2_tool_onstart(tpm2_options **opts) {

    const struct option topts[] = {
        { "output",       required_argument, NULL, 'o' },
        { "force",        required_argument, NULL, 'f' },
        { "hex",          no_argument,       NULL,  0  },
        { "session",      required_argument, NULL, 'S' },
        { "cphash",       required_argument, NULL,  1  },
        { "rphash",       required_argument, NULL,  2  }
    };

    *opts = tpm2_options_new("S:o:f", ARRAY_LEN(topts), topts, on_option, on_args,
            0);

    return *opts != NULL;
}

tpm2_options结构的定义在tpm2-tools/lib/tpm2_options.h中，代码如下：

struct tpm2_options {
    struct {
        tpm2_option_handler on_opt;
        tpm2_arg_handler on_arg;
    } callbacks;
    char *short_opts;
    size_t len;
    uint32_t flags;
    struct option long_opts[];
};

typedef struct tpm2_options tpm2_options;

struct option的定义在/usr/include/bits/getopt_ext.h中，代码如下：

struct option
{
    // name表示的是长参数名
    const char *name;

    // has_arg有3个值：
    // no_argument（或者0），表示该参数后面不跟参数值；
    // required_argument（或者1），表示该参数后面一定要跟参数值；
    // optional_argument（或者2），表示该参数后面可以跟、也可以不跟参数值。
    int has_arg;

    // flag用来决定getopt_long()的返回值到底是什么：
    // 如果这个指针为NULL，则getopt_long()返回该结构val字段中的数值；
    // 如果该指针不为NULL，则getopt_long()会使得它所指向的变量中填入val字段中的数值，并且getopt_long()返回0；
    // 如果该指针不是NULL，但未发现长选项，则它所指向的变量的数值不变。
    int *flag;

    // val和flag联合决定返回值：
    // 这个值是发现了长选项时的返回值，或者flag不是 NULL时载入*flag中的值。
    // 典型情况下，若flag不是NULL，那么val是个真／假值，譬如1 或0；
    // 另一方面，如果flag是NULL，那么val通常是字符常量。
    // 若长选项与短选项一致，那么该字符常量应该与optstring中出现的这个选项的参数相同。
    int val;
};

on_option函数的实现在同文件（tools/tpm_getrandom.c）中，如下：

static bool on_option(char key, char *value) {

    UNUSED(key);

    switch (key) {
    case 'f':
        ctx.force = true;
        break;
    case 'o':
        ctx.output_file = value;
        break;
    case 0:
        ctx.hex = true;
        break;
    case 1:
        ctx.cp_hash_path = value;
        break;
    case 2:
        ctx.rp_hash_path = value;
        break;
    case 'S':
        ctx.aux_session_path[ctx.aux_session_cnt] = value;
        if (ctx.aux_session_cnt < MAX_AUX_SESSIONS) {
            ctx.aux_session_cnt++;
        } else {
            LOG_ERR("Specify a max of 3 sessions");
            return false;
        }
        break;
        /* no default */
    }

    return true;
}

要更好地理解这些选项乃至tpm2_tool_onstart函数的功能，需要与tpm2_getrandom命令的说明相结合来看。tpm2_getrandom命令的详细说明参见：

https://github.com/tpm2-software/tpm2-tools/blob/master/man/tpm2_getrandom.1.md

下载了源码后，在tpm2-tools/man/tpm2_getrandom.1.md文件中。

其中的参数说明如下：

OPTIONS

-o, --output=FILE

Specifies the filename to output the raw bytes to. Defaults to stdout as a hex string. —— 指定要将原始字节输出到的文件的文件名。默认为十六进制字符串的stdout。

--hex

Convert the output data to hex format without a leading "0x". —— 将输出数据转换为十六进制格式，不带前导“0x”。

-f, --force

Override checking that the: —— 覆盖检查：

Requested size is within the hash size limit of the TPM. —— 请求的大小在TPM的哈希大小限制内。

Number of retrieved random bytes matches requested amount. —— 得到的随机字节数与请求的数量相匹配。

-S, --session=FILE:

The session created using tpm2_startauthsession. Multiple of these can be specified. For example, you can have one session for auditing and another for encryption of the parameters. —— 使用tpm2_startauthsesssion命令创建的会话。可以多次指定此选项。例如，你可以有一个用于审核的会话，另一个用于参数加密的会话。

--cphash=FILE:

File path to record the hash of the command parameters. This is commonly termed as cpHash. NOTE: When this option is selected, in absence of rphash option, The tool will not actually execute the command, it simply returns a cpHash. —— 用于记录命令参数哈希的文件的路径。通常被称为cpHash。注意：当此选项被选择，而rphash选项没有被选择，则该工具不会实际执行命令，它只是返回一个cpHash。

--rphash=FILE:

File path to record the hash of the response parameters. This is commonly termed as rpHash. —— 用于记录响应参数哈希的文件的路径。通常被称为rpHash。

ARGUMENT the command line argument specifies the size of the output.

tpm2_options_new函数属于公共代码，在tpm2-tools/lib/tpm2_options.c中，代码如下：

tpm2_options *tpm2_options_new(const char *short_opts, size_t len,
        const struct option *long_opts, tpm2_option_handler on_opt,
        tpm2_arg_handler on_arg, uint32_t flags) {

    tpm2_options *opts = calloc(1, sizeof(*opts) + (sizeof(*long_opts) * len));
    if (!opts) {
        LOG_ERR("oom");
        return NULL;
    }

    /*
     * On NULL, just make it a zero length string so we don't have to keep
     * checking it for NULL.
     */
    if (!short_opts) {
        short_opts = "";
    }

    opts->short_opts = strdup(short_opts);
    if (!opts->short_opts) {
        LOG_ERR("oom");
        free(opts);
        return NULL;
    }

    opts->callbacks.on_opt = on_opt;
    opts->callbacks.on_arg = on_arg;
    opts->len = len;
    opts->flags = flags;
    memcpy(opts->long_opts, long_opts, len * sizeof(*long_opts));

    return opts;
}

tpm2_new_options函数很容易理解，其功能是基于tpm2_tool_onstart函数中的struct option topts构建tpm2_options实例（*opts）。

tpm2-tools源码分析之tpm2_getrandom.c（2）

OPTIONS

猜你喜欢