3989

pending completion

Build # 3989

Build Type

Pull #716

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/stefanberger/swtpm/commit/<a class=hub.com/stefanberger/swtpm/commit/aaec8597a577b6f065719ddb1ba9f48d82709308">aaec8597a<a href="https://github.com/stefanberger/swtpm/commit/aaec8597a577b6f065719ddb1ba9f48d82709308">">Merge </a><a class="double-link" href="https://github.com/stefanberger/swtpm/commit/<a class="double-link" href="https://github.com/stefanberger/swtpm/commit/75852b1ae2b4c16f15270b0259777673a310418f">75852b1ae</a>">75852b1ae</a><a href="https://github.com/stefanberger/swtpm/commit/aaec8597a577b6f065719ddb1ba9f48d82709308"> into b8c1a0fc8">b8c1a0fc8</a>

Pull Request Pull Request #716: WIP: Add support for setting of a profile for a TPM 2

Run Details

325 of 325 new or added lines in 14 files covered. (100.0%)

6376 of 8510 relevant lines covered (74.92%)

15142.99 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

80.81

/src/swtpm/capabilities.c

/*
 * capabilities.c -- capabilities
 *
 * (c) Copyright IBM Corporation 2019.
 *
 * Author: Stefan Berger <stefanb@us.ibm.com>
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the names of the IBM Corporation nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include "config.h"

#define _GNU_SOURCE
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#include <libtpms/tpm_library.h>
#include <libtpms/tpm_error.h>

#include <json-glib/json-glib.h>

#include "compiler_dependencies.h"
#include "capabilities.h"
#include "logging.h"
#include "swtpm_nvstore.h"

/* Convert the RSA key size indicators supported by libtpms into capability
 * strings.
 * libtpms may return us something like this here:
 * "TPMAttributes":{"manufacturer":"id:00001014",\
 * "version":"id:20191023","model":"swtpm","RSAKeySizes":[1024,2048,3072]}}
 *
 * or an older version may not report RSA keysizes:
 * "TPMAttributes":{"manufacturer":"id:00001014",\
 * "version":"id:20191023","model":"swtpm"}}
 */
static int get_rsa_keysize_caps(char **keysizecaps)
{
    int ret = 0;
    char *start, *endptr;
    const char *needle = "\"RSAKeySizes\":[";
    char *info_data = TPMLIB_GetInfo(4 /*TPMLIB_INFO_TPMFEATURES*/);
    char buffer[128];
    off_t offset = 0;
    int n;

    if (!info_data)
        goto cleanup;

    start = strstr(info_data, needle);
    if (start) {
        start += strlen(needle);
        while (1) {
            unsigned long int keysize = strtoul(start, &endptr, 10);

            if (*endptr != ',' && *endptr != ']') {
                logprintf(STDERR_FILENO, "Malformed TPMLIB_GetInfo() string\n");
                ret = -1;
                goto cleanup;
            }

            n = snprintf(buffer + offset, sizeof(buffer) - offset,
                         ", \"rsa-keysize-%lu\"",
                          keysize);
            if (n < 0 || (unsigned)n >= sizeof(buffer) - offset) {
                logprintf(STDERR_FILENO, "%s: buffer is too small\n", __func__);
                ret = -1;
                goto cleanup;
            }
            if (*endptr == ']')
                break;

            offset += n;
            start = endptr + 1;
        }

        *keysizecaps = strndup(buffer, sizeof(buffer) - 1);
        if (*keysizecaps == NULL)
            goto oom;
    }

cleanup:
    free(info_data);
    return ret;

oom:
    logprintf(STDERR_FILENO, "Out of memory\n");
    ret = -1;
    goto cleanup;
}

#ifdef HAVE_LIBTPMS_SETPROFILE_API

static int get_profiles(gchar **profiles)
{
    char *info_data = TPMLIB_GetInfo(32 /*TPMLIB_INFO_AVAILABLE_PROFILES*/);
    JsonParser *jp = NULL;
    JsonReader *jr = NULL;
    g_autoptr(GError) error = NULL;
    JsonNode *root;
    gint i, num;
    int ret = 0;
    GString *gstr = g_string_new(NULL);

    jp = json_parser_new();

    if (!json_parser_load_from_data(jp, info_data, -1, &error)) {
        logprintf(STDERR_FILENO,
                  "Could not parse JSON data: %s\n", error->message);
        goto error;
    }

    root = json_parser_get_root(jp);
    jr = json_reader_new(root);

    if (!json_reader_read_member(jr, "AvailableProfiles")) {
        logprintf(STDERR_FILENO,
                  "Missing 'AvailableProfiles' field: %s\n",
                  info_data);
        goto error_unref_jr;
    }

    num = json_reader_count_elements(jr);
    for (i = 0; i < num; i++) {
        if (!json_reader_read_element(jr, i) ||
            !json_reader_read_member(jr, "name")) {
            logprintf(STDERR_FILENO,
                      "Failed to traverse JSON list.\n");
            goto error_unref_jr;
        }
        g_string_append_printf(gstr, "%s\"%s\"",
                               i > 0 ? ", " : " ",
                               json_reader_get_string_value(jr));
        json_reader_end_element(jr);
        json_reader_end_element(jr);
    }


error_unref_jr:
    g_object_unref(jr);

error:
    g_object_unref(jp);
    *profiles = g_string_free(gstr, false);
    free(info_data);

    return ret;
}

#else

static int get_profiles(gchar **profiles SWTPM_ATTR_UNUSED)
{
    return 0;
}

#endif

int capabilities_print_json(bool cusetpm, TPMLIB_TPMVersion tpmversion)
{
    char *string = NULL;
    int ret = -1;
    int n;
#ifdef WITH_SECCOMP
    const char *cmdarg_seccomp = "\"cmdarg-seccomp\", ";
#else
    const char *cmdarg_seccomp = "";
#endif
    const char *with_tpm1 = "";
    const char *with_tpm2 = "";
    char *keysizecaps = NULL;
    const char *nvram_backend_dir = "\"nvram-backend-dir\", ";
    const char *nvram_backend_file = "\"nvram-backend-file\"";
#ifdef HAVE_LIBTPMS_SETPROFILE_API
    const char *cmdarg_profile = "\"cmdarg-profile\"";
#else
    const char *cmdarg_profile = NULL;
#endif
    g_autofree gchar *profiles = NULL;
    bool comma1;

    /* ignore errors */
    TPMLIB_ChooseTPMVersion(tpmversion);

    ret = get_rsa_keysize_caps(&keysizecaps);
    if (ret < 0)
        goto cleanup;

    if (tpmversion == TPMLIB_TPM_VERSION_2) {
        ret = get_profiles(&profiles);
        if (ret < 0)
            goto cleanup;
    }

    if (TPMLIB_ChooseTPMVersion(TPMLIB_TPM_VERSION_1_2) == TPM_SUCCESS)
        with_tpm1 = "\"tpm-1.2\", ";
    if (TPMLIB_ChooseTPMVersion(TPMLIB_TPM_VERSION_2) == TPM_SUCCESS)
        with_tpm2 = "\"tpm-2.0\", ";

    comma1 = cmdarg_profile || profiles;

    n =  asprintf(&string,
         "{ "
         "\"type\": \"swtpm\", "
         "\"features\": [ "
             "%s%s%s%s%s%s%s%s%s%s%s%s%s"
          " ], "
#ifdef HAVE_LIBTPMS_SETPROFILE_API
         "\"profiles\": [%s ], "
#endif
         "\"version\": \"" VERSION "\" "
         "}",
         with_tpm1,
         with_tpm2,
         !cusetpm     ? "\"tpm-send-command-header\", ": "",
         true         ? "\"flags-opt-startup\", "      : "",
         cmdarg_seccomp,
         true         ? "\"cmdarg-key-fd\", "          : "",
         true         ? "\"cmdarg-pwd-fd\", "          : "",
         true         ? "\"cmdarg-print-states\", "    : "",
         nvram_backend_dir,
         nvram_backend_file,
         keysizecaps  ? keysizecaps                    : "",
         comma1       ? ", "                           : "",
         cmdarg_profile ? cmdarg_profile               : ""
#ifdef HAVE_LIBTPMS_SETPROFILE_API
                                                           ,
         profiles     ? profiles                       : ""
#endif
    );

    if (n < 0) {
        logprintf(STDERR_FILENO, "Out of memory\n");
        goto cleanup;
    }

    ret = 0;

    fprintf(stdout, "%s\n", string);

cleanup:
    free(keysizecaps);
    free(string);

    return ret;
}

1	/*
2	* capabilities.c -- capabilities
3	*
4	* (c) Copyright IBM Corporation 2019.
5	*
6	* Author: Stefan Berger <stefanb@us.ibm.com>
7	*
8	* All rights reserved.
9	*
10	* Redistribution and use in source and binary forms, with or without
11	* modification, are permitted provided that the following conditions are
12	* met:
13	*
14	* Redistributions of source code must retain the above copyright notice,
15	* this list of conditions and the following disclaimer.
16	*
17	* Redistributions in binary form must reproduce the above copyright
18	* notice, this list of conditions and the following disclaimer in the
19	* documentation and/or other materials provided with the distribution.
20	*
21	* Neither the names of the IBM Corporation nor the names of its
22	* contributors may be used to endorse or promote products derived from
23	* this software without specific prior written permission.
24	*
25	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
26	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
27	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
28	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
29	* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
30	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
31	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
35	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36	*/
37
38	#include "config.h"
39
40	#define _GNU_SOURCE
41	#include <stdio.h>
42	#include <stdlib.h>
43	#include <string.h>
44
45	#include <libtpms/tpm_library.h>
46	#include <libtpms/tpm_error.h>
47
48	#include <json-glib/json-glib.h>
49
50	#include "compiler_dependencies.h"
51	#include "capabilities.h"
52	#include "logging.h"
53	#include "swtpm_nvstore.h"
54
55	/* Convert the RSA key size indicators supported by libtpms into capability
56	* strings.
57	* libtpms may return us something like this here:
58	* "TPMAttributes":{"manufacturer":"id:00001014",\
59	* "version":"id:20191023","model":"swtpm","RSAKeySizes":[1024,2048,3072]}}
60	*
61	* or an older version may not report RSA keysizes:
62	* "TPMAttributes":{"manufacturer":"id:00001014",\
63	* "version":"id:20191023","model":"swtpm"}}
64	*/
65	static int get_rsa_keysize_caps(char **keysizecaps)	271✔
66	{
67	int ret = 0;	271✔
68	char start, endptr;
69	const char *needle = "\"RSAKeySizes\":[";	271✔
70	char info_data = TPMLIB_GetInfo(4 /TPMLIB_INFO_TPMFEATURES*/);	271✔
71	char buffer[128];
72	off_t offset = 0;	271✔
73	int n;
74
75	if (!info_data)	271✔
76	goto cleanup;
77
78	start = strstr(info_data, needle);	271✔
79	if (start) {	271✔
80	start += strlen(needle);	99✔
81	while (1) {	198✔
82	unsigned long int keysize = strtoul(start, &endptr, 10);	297✔
83
84	if (endptr != ',' && endptr != ']') {	297✔
85	logprintf(STDERR_FILENO, "Malformed TPMLIB_GetInfo() string\n");	×
86	ret = -1;	×
87	goto cleanup;	×
88	}
89
90	n = snprintf(buffer + offset, sizeof(buffer) - offset,	594✔
91	", \"rsa-keysize-%lu\"",
92	keysize);
93	if (n < 0 \|\| (unsigned)n >= sizeof(buffer) - offset) {	297✔
94	logprintf(STDERR_FILENO, "%s: buffer is too small\n", __func__);	×
95	ret = -1;	×
96	goto cleanup;	×
97	}
98	if (*endptr == ']')	297✔
99	break;
100
101	offset += n;	198✔
102	start = endptr + 1;	198✔
103	}
104
105	*keysizecaps = strndup(buffer, sizeof(buffer) - 1);	99✔
106	if (*keysizecaps == NULL)	99✔
107	goto oom;
108	}
109
110	cleanup:	271✔
111	free(info_data);	271✔
112	return ret;	271✔
113
114	oom:	×
115	logprintf(STDERR_FILENO, "Out of memory\n");	×
116	ret = -1;	×
117	goto cleanup;	×
118	}
119
120	#ifdef HAVE_LIBTPMS_SETPROFILE_API
121
122	static int get_profiles(gchar **profiles)	99✔
123	{
124	char info_data = TPMLIB_GetInfo(32 /TPMLIB_INFO_AVAILABLE_PROFILES*/);	99✔
125	JsonParser *jp = NULL;	99✔
126	JsonReader *jr = NULL;	99✔
127	g_autoptr(GError) error = NULL;	198✔
128	JsonNode *root;
129	gint i, num;
130	int ret = 0;	99✔
131	GString *gstr = g_string_new(NULL);	99✔
132
133	jp = json_parser_new();	99✔
134
135	if (!json_parser_load_from_data(jp, info_data, -1, &error)) {	99✔
136	logprintf(STDERR_FILENO,	×
137	"Could not parse JSON data: %s\n", error->message);	×
138	goto error;	×
139	}
140
141	root = json_parser_get_root(jp);	99✔
142	jr = json_reader_new(root);	99✔
143
144	if (!json_reader_read_member(jr, "AvailableProfiles")) {	99✔
145	logprintf(STDERR_FILENO,	×
146	"Missing 'AvailableProfiles' field: %s\n",
147	info_data);
148	goto error_unref_jr;	×
149	}
150
151	num = json_reader_count_elements(jr);	99✔
152	for (i = 0; i < num; i++) {	495✔
153	if (!json_reader_read_element(jr, i) \|\|	792✔
154	!json_reader_read_member(jr, "name")) {	396✔
155	logprintf(STDERR_FILENO,	×
156	"Failed to traverse JSON list.\n");
157	goto error_unref_jr;	×
158	}
159	g_string_append_printf(gstr, "%s\"%s\"",	396✔
160	i > 0 ? ", " : " ",
161	json_reader_get_string_value(jr));
162	json_reader_end_element(jr);	396✔
163	json_reader_end_element(jr);	396✔
164	}
165
166
167	error_unref_jr:	99✔
168	g_object_unref(jr);	99✔
169
170	error:	99✔
171	g_object_unref(jp);	99✔
172	*profiles = g_string_free(gstr, false);	99✔
173	free(info_data);	99✔
174
175	return ret;	99✔
176	}
177
178	#else
179
180	static int get_profiles(gchar **profiles SWTPM_ATTR_UNUSED)
181	{
182	return 0;
183	}
184
185	#endif
186
187	int capabilities_print_json(bool cusetpm, TPMLIB_TPMVersion tpmversion)	271✔
188	{
189	char *string = NULL;	271✔
190	int ret = -1;	271✔
191	int n;
192	#ifdef WITH_SECCOMP
193	const char *cmdarg_seccomp = "\"cmdarg-seccomp\", ";	271✔
194	#else
195	const char *cmdarg_seccomp = "";
196	#endif
197	const char *with_tpm1 = "";	271✔
198	const char *with_tpm2 = "";	271✔
199	char *keysizecaps = NULL;	271✔
200	const char *nvram_backend_dir = "\"nvram-backend-dir\", ";	271✔
201	const char *nvram_backend_file = "\"nvram-backend-file\"";	271✔
202	#ifdef HAVE_LIBTPMS_SETPROFILE_API
203	const char *cmdarg_profile = "\"cmdarg-profile\"";	271✔
204	#else
205	const char *cmdarg_profile = NULL;
206	#endif
207	g_autofree gchar *profiles = NULL;	542✔
208	bool comma1;
209
210	/* ignore errors */
211	TPMLIB_ChooseTPMVersion(tpmversion);	271✔
212
213	ret = get_rsa_keysize_caps(&keysizecaps);	271✔
214	if (ret < 0)	271✔
215	goto cleanup;
216
217	if (tpmversion == TPMLIB_TPM_VERSION_2) {	271✔
218	ret = get_profiles(&profiles);	99✔
219	if (ret < 0)	99✔
220	goto cleanup;
221	}
222
223	if (TPMLIB_ChooseTPMVersion(TPMLIB_TPM_VERSION_1_2) == TPM_SUCCESS)	271✔
224	with_tpm1 = "\"tpm-1.2\", ";	271✔
225	if (TPMLIB_ChooseTPMVersion(TPMLIB_TPM_VERSION_2) == TPM_SUCCESS)	271✔
226	with_tpm2 = "\"tpm-2.0\", ";	271✔
227
228	comma1 = cmdarg_profile \|\| profiles;	271✔
229
230	n = asprintf(&string,	813✔
231	"{ "
232	"\"type\": \"swtpm\", "
233	"\"features\": [ "
234	"%s%s%s%s%s%s%s%s%s%s%s%s%s"
235	" ], "
236	#ifdef HAVE_LIBTPMS_SETPROFILE_API
237	"\"profiles\": [%s ], "
238	#endif
239	"\"version\": \"" VERSION "\" "
240	"}",
241	with_tpm1,
242	with_tpm2,
243	!cusetpm ? "\"tpm-send-command-header\", ": "",
244	true ? "\"flags-opt-startup\", " : "",
245	cmdarg_seccomp,
246	true ? "\"cmdarg-key-fd\", " : "",
247	true ? "\"cmdarg-pwd-fd\", " : "",
248	true ? "\"cmdarg-print-states\", " : "",
249	nvram_backend_dir,
250	nvram_backend_file,
251	keysizecaps ? keysizecaps : "",	271✔
252	comma1 ? ", " : "",
253	cmdarg_profile ? cmdarg_profile : ""
254	#ifdef HAVE_LIBTPMS_SETPROFILE_API
255	,
256	profiles ? profiles : ""	271✔
257	#endif
258	);
259
260	if (n < 0) {	271✔
261	logprintf(STDERR_FILENO, "Out of memory\n");	×
262	goto cleanup;	×
263	}
264
265	ret = 0;	271✔
266
267	fprintf(stdout, "%s\n", string);	271✔
268
269	cleanup:	271✔
270	free(keysizecaps);	271✔
271	free(string);	271✔
272
273	return ret;	542✔
274	}

stefanberger / swtpm / 3989

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous