diff mbox

[1/2,v2] acpi: tpm2: Add ACPI TPM2 test

Message ID 1437036453-16688-1-git-send-email-alex.hung@canonical.com
State Rejected
Headers show

Commit Message

Alex Hung July 16, 2015, 8:47 a.m. UTC
Signed-off-by: Alex Hung <alex.hung@canonical.com>
---
 src/Makefile.am             |   1 +
 src/acpi/tpm2/tpm2.c        | 104 ++++++++++++++++++++++++++++++++++++++++++++
 src/lib/include/fwts_acpi.h |   9 ++++
 3 files changed, 114 insertions(+)
 create mode 100644 src/acpi/tpm2/tpm2.c

Comments

Colin Ian King July 16, 2015, 8:55 a.m. UTC | #1
Thanks,

Spotted two minor mistakes in the error messages...

On 16/07/15 09:47, Alex Hung wrote:
> Signed-off-by: Alex Hung <alex.hung@canonical.com>
> ---
>  src/Makefile.am             |   1 +
>  src/acpi/tpm2/tpm2.c        | 104 ++++++++++++++++++++++++++++++++++++++++++++
>  src/lib/include/fwts_acpi.h |   9 ++++
>  3 files changed, 114 insertions(+)
>  create mode 100644 src/acpi/tpm2/tpm2.c
> 
> diff --git a/src/Makefile.am b/src/Makefile.am
> index 3a77196..ba626f0 100644
> --- a/src/Makefile.am
> +++ b/src/Makefile.am
> @@ -75,6 +75,7 @@ fwts_SOURCES = main.c 				\
>  	acpi/spcr/spcr.c 			\
>  	acpi/spmi/spmi.c 			\
>  	acpi/tcpa/tcpa.c 			\
> +	acpi/tpm2/tpm2.c 			\
>  	acpi/srat/srat.c 			\
>  	acpi/syntaxcheck/syntaxcheck.c 		\
>  	acpi/uefi/uefi.c			\
> diff --git a/src/acpi/tpm2/tpm2.c b/src/acpi/tpm2/tpm2.c
> new file mode 100644
> index 0000000..ce18e16
> --- /dev/null
> +++ b/src/acpi/tpm2/tpm2.c
> @@ -0,0 +1,104 @@
> +/*
> + * Copyright (C) 2010-2015 Canonical
> + *
> +  * 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 2
> + * 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.
> + *
> + */
> +#include "fwts.h"
> +#include <stdlib.h>
> +#include <stdio.h>
> +#include <string.h>
> +#include <unistd.h>
> +#include <inttypes.h>
> +#include <stdbool.h>
> +
> +static fwts_acpi_table_info *table;
> +
> +static int tpm2_init(fwts_framework *fw)
> +{
> +	if (fwts_acpi_find_table(fw, "TPM2", 0, &table) != FWTS_OK) {
> +		fwts_log_error(fw, "Cannot load ACPI table");
> +		return FWTS_ERROR;
> +	}
> +	if (table == NULL) {
> +		fwts_log_error(fw, "ACPI TPM2 table does not exist, skipping test");
> +		return FWTS_ERROR;
> +	}
> +
> +	return FWTS_OK;
> +}
> +
> +/*
> + * TPM2 table
> + *   available @ http://www.trustedcomputinggroup.org/files/static_page_files/648D7D46-1A4B-B294-D088037B8F73DAAF/TCG_ACPIGeneralSpecification_1-10_0-37-Published.pdf
> + */
> +static int tpm2_test1(fwts_framework *fw)
> +{
> +	fwts_acpi_table_tpm2 *tpm2 = (fwts_acpi_table_tpm2*) table->data;
> +	bool passed = true;
> +
> +	fwts_log_info_verbatum(fw, "TPM2 Table:");
> +	fwts_log_info_verbatum(fw, "  Platform Class:                  0x%4.4"   PRIx16, tpm2->platform_class);
> +	fwts_log_info_verbatum(fw, "  Reserved:                        0x%4.4"   PRIx32, tpm2->reserved);
> +	fwts_log_info_verbatum(fw, "  Address of Control Area:         0x%16.16" PRIx64, tpm2->address_of_control_area);
> +	fwts_log_info_verbatum(fw, "  Start Method:                    0x%8.8"   PRIx32, tpm2->start_method);
> +
> +	if (tpm2->platform_class != 0 && tpm2->platform_class != 1) {
> +		passed = false;
> +		fwts_failed(fw, LOG_LEVEL_HIGH,
> +			"TPM2BadPlatformClass",
> +			"TPM2's platform class must be zero (client) or one (server), got 0x%" PRIx16,
> +			tpm2->platform_class);
> +	}
> +
> +	if (tpm2->reserved != 0) {
> +		passed = false;
> +		fwts_failed(fw, LOG_LEVEL_LOW,
> +			"TPM2ReservedNonZero",
> +			"TPM2 reserved field must be zero, got "
> +			"0x%4.4" PRIx16 " instead", tpm2->reserved);
> +	}
> +
> +	if (tpm2->start_method < 1 || tpm2->start_method >= 9) {
> +		passed = false;
> +		fwts_failed(fw, LOG_LEVEL_HIGH,
> +			"TPM2BadStartMethod",
> +			"TPM2's Start Method must between one to eight, got 0x%" PRIx16,
> +			tpm2->start_method);

"TPM2's Start Method must between one to eight" should be
"TPM2's Start Method must be between one to eight"

> +	}
> +
> +	if (tpm2->start_method == 2 && table->length != sizeof(fwts_acpi_table_tpm2) + 4) {
> +		passed = false;
> +		fwts_failed(fw, LOG_LEVEL_HIGH,
> +			"TPM2BadPlatformParameters",
> +			"Table lenght must be 0x%" PRIx32 " if Start method equals 2, got 0x%" PRIx32,

typo, "lenght" -> "length"

> +			(uint32_t) sizeof(fwts_acpi_table_tpm2) + 4,
> +			(uint32_t) table->length);
> +	}
> +
> +	if (passed)
> +		fwts_passed(fw, "No issues found in TPM2 table.");
> +
> +	return FWTS_OK;
> +}
> +
> +static fwts_framework_minor_test tpm2_tests[] = {
> +	{ tpm2_test1, "Validate TPM2 table." },
> +	{ NULL, NULL }
> +};
> +
> +static fwts_framework_ops tpm2_ops = {
> +	.description = "TPM2 Trusted Platform Module 2 test.",
> +	.init        = tpm2_init,
> +	.minor_tests = tpm2_tests
> +};
> +
> +FWTS_REGISTER("tpm2", &tpm2_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_TEST_ACPI)
> diff --git a/src/lib/include/fwts_acpi.h b/src/lib/include/fwts_acpi.h
> index c113dd1..61f7129 100644
> --- a/src/lib/include/fwts_acpi.h
> +++ b/src/lib/include/fwts_acpi.h
> @@ -535,6 +535,15 @@ typedef struct {
>  	};
>  }  __attribute__ ((packed)) fwts_acpi_table_tcpa;
>  
> +typedef struct {
> +	fwts_acpi_table_header	header;
> +	uint16_t	platform_class;
> +	uint16_t	reserved;
> +	uint64_t	address_of_control_area;
> +	uint32_t	start_method;
> +	uint8_t		platform_specific_parameters[0];
> +}  __attribute__ ((packed)) fwts_acpi_table_tpm2;
> +
>  /* From http://wiki.xenproject.org/mediawiki/images/c/c4/Xen-environment-table.pdf */
>  typedef struct {
>  	fwts_acpi_table_header	header;
>
Alex Hung July 16, 2015, 9:03 a.m. UTC | #2
Thanks Colin,

I will send v3 shortly

On Thu, Jul 16, 2015 at 4:55 PM, Colin Ian King
<colin.king@canonical.com> wrote:
> Thanks,
>
> Spotted two minor mistakes in the error messages...
>
> On 16/07/15 09:47, Alex Hung wrote:
>> Signed-off-by: Alex Hung <alex.hung@canonical.com>
>> ---
>>  src/Makefile.am             |   1 +
>>  src/acpi/tpm2/tpm2.c        | 104 ++++++++++++++++++++++++++++++++++++++++++++
>>  src/lib/include/fwts_acpi.h |   9 ++++
>>  3 files changed, 114 insertions(+)
>>  create mode 100644 src/acpi/tpm2/tpm2.c
>>
>> diff --git a/src/Makefile.am b/src/Makefile.am
>> index 3a77196..ba626f0 100644
>> --- a/src/Makefile.am
>> +++ b/src/Makefile.am
>> @@ -75,6 +75,7 @@ fwts_SOURCES = main.c                               \
>>       acpi/spcr/spcr.c                        \
>>       acpi/spmi/spmi.c                        \
>>       acpi/tcpa/tcpa.c                        \
>> +     acpi/tpm2/tpm2.c                        \
>>       acpi/srat/srat.c                        \
>>       acpi/syntaxcheck/syntaxcheck.c          \
>>       acpi/uefi/uefi.c                        \
>> diff --git a/src/acpi/tpm2/tpm2.c b/src/acpi/tpm2/tpm2.c
>> new file mode 100644
>> index 0000000..ce18e16
>> --- /dev/null
>> +++ b/src/acpi/tpm2/tpm2.c
>> @@ -0,0 +1,104 @@
>> +/*
>> + * Copyright (C) 2010-2015 Canonical
>> + *
>> +  * 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 2
>> + * 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.
>> + *
>> + */
>> +#include "fwts.h"
>> +#include <stdlib.h>
>> +#include <stdio.h>
>> +#include <string.h>
>> +#include <unistd.h>
>> +#include <inttypes.h>
>> +#include <stdbool.h>
>> +
>> +static fwts_acpi_table_info *table;
>> +
>> +static int tpm2_init(fwts_framework *fw)
>> +{
>> +     if (fwts_acpi_find_table(fw, "TPM2", 0, &table) != FWTS_OK) {
>> +             fwts_log_error(fw, "Cannot load ACPI table");
>> +             return FWTS_ERROR;
>> +     }
>> +     if (table == NULL) {
>> +             fwts_log_error(fw, "ACPI TPM2 table does not exist, skipping test");
>> +             return FWTS_ERROR;
>> +     }
>> +
>> +     return FWTS_OK;
>> +}
>> +
>> +/*
>> + * TPM2 table
>> + *   available @ http://www.trustedcomputinggroup.org/files/static_page_files/648D7D46-1A4B-B294-D088037B8F73DAAF/TCG_ACPIGeneralSpecification_1-10_0-37-Published.pdf
>> + */
>> +static int tpm2_test1(fwts_framework *fw)
>> +{
>> +     fwts_acpi_table_tpm2 *tpm2 = (fwts_acpi_table_tpm2*) table->data;
>> +     bool passed = true;
>> +
>> +     fwts_log_info_verbatum(fw, "TPM2 Table:");
>> +     fwts_log_info_verbatum(fw, "  Platform Class:                  0x%4.4"   PRIx16, tpm2->platform_class);
>> +     fwts_log_info_verbatum(fw, "  Reserved:                        0x%4.4"   PRIx32, tpm2->reserved);
>> +     fwts_log_info_verbatum(fw, "  Address of Control Area:         0x%16.16" PRIx64, tpm2->address_of_control_area);
>> +     fwts_log_info_verbatum(fw, "  Start Method:                    0x%8.8"   PRIx32, tpm2->start_method);
>> +
>> +     if (tpm2->platform_class != 0 && tpm2->platform_class != 1) {
>> +             passed = false;
>> +             fwts_failed(fw, LOG_LEVEL_HIGH,
>> +                     "TPM2BadPlatformClass",
>> +                     "TPM2's platform class must be zero (client) or one (server), got 0x%" PRIx16,
>> +                     tpm2->platform_class);
>> +     }
>> +
>> +     if (tpm2->reserved != 0) {
>> +             passed = false;
>> +             fwts_failed(fw, LOG_LEVEL_LOW,
>> +                     "TPM2ReservedNonZero",
>> +                     "TPM2 reserved field must be zero, got "
>> +                     "0x%4.4" PRIx16 " instead", tpm2->reserved);
>> +     }
>> +
>> +     if (tpm2->start_method < 1 || tpm2->start_method >= 9) {
>> +             passed = false;
>> +             fwts_failed(fw, LOG_LEVEL_HIGH,
>> +                     "TPM2BadStartMethod",
>> +                     "TPM2's Start Method must between one to eight, got 0x%" PRIx16,
>> +                     tpm2->start_method);
>
> "TPM2's Start Method must between one to eight" should be
> "TPM2's Start Method must be between one to eight"
>
>> +     }
>> +
>> +     if (tpm2->start_method == 2 && table->length != sizeof(fwts_acpi_table_tpm2) + 4) {
>> +             passed = false;
>> +             fwts_failed(fw, LOG_LEVEL_HIGH,
>> +                     "TPM2BadPlatformParameters",
>> +                     "Table lenght must be 0x%" PRIx32 " if Start method equals 2, got 0x%" PRIx32,
>
> typo, "lenght" -> "length"
>
>> +                     (uint32_t) sizeof(fwts_acpi_table_tpm2) + 4,
>> +                     (uint32_t) table->length);
>> +     }
>> +
>> +     if (passed)
>> +             fwts_passed(fw, "No issues found in TPM2 table.");
>> +
>> +     return FWTS_OK;
>> +}
>> +
>> +static fwts_framework_minor_test tpm2_tests[] = {
>> +     { tpm2_test1, "Validate TPM2 table." },
>> +     { NULL, NULL }
>> +};
>> +
>> +static fwts_framework_ops tpm2_ops = {
>> +     .description = "TPM2 Trusted Platform Module 2 test.",
>> +     .init        = tpm2_init,
>> +     .minor_tests = tpm2_tests
>> +};
>> +
>> +FWTS_REGISTER("tpm2", &tpm2_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_TEST_ACPI)
>> diff --git a/src/lib/include/fwts_acpi.h b/src/lib/include/fwts_acpi.h
>> index c113dd1..61f7129 100644
>> --- a/src/lib/include/fwts_acpi.h
>> +++ b/src/lib/include/fwts_acpi.h
>> @@ -535,6 +535,15 @@ typedef struct {
>>       };
>>  }  __attribute__ ((packed)) fwts_acpi_table_tcpa;
>>
>> +typedef struct {
>> +     fwts_acpi_table_header  header;
>> +     uint16_t        platform_class;
>> +     uint16_t        reserved;
>> +     uint64_t        address_of_control_area;
>> +     uint32_t        start_method;
>> +     uint8_t         platform_specific_parameters[0];
>> +}  __attribute__ ((packed)) fwts_acpi_table_tpm2;
>> +
>>  /* From http://wiki.xenproject.org/mediawiki/images/c/c4/Xen-environment-table.pdf */
>>  typedef struct {
>>       fwts_acpi_table_header  header;
>>
>
>
> --
> fwts-devel mailing list
> fwts-devel@lists.ubuntu.com
> Modify settings or unsubscribe at: https://lists.ubuntu.com/mailman/listinfo/fwts-devel
diff mbox

Patch

diff --git a/src/Makefile.am b/src/Makefile.am
index 3a77196..ba626f0 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -75,6 +75,7 @@  fwts_SOURCES = main.c 				\
 	acpi/spcr/spcr.c 			\
 	acpi/spmi/spmi.c 			\
 	acpi/tcpa/tcpa.c 			\
+	acpi/tpm2/tpm2.c 			\
 	acpi/srat/srat.c 			\
 	acpi/syntaxcheck/syntaxcheck.c 		\
 	acpi/uefi/uefi.c			\
diff --git a/src/acpi/tpm2/tpm2.c b/src/acpi/tpm2/tpm2.c
new file mode 100644
index 0000000..ce18e16
--- /dev/null
+++ b/src/acpi/tpm2/tpm2.c
@@ -0,0 +1,104 @@ 
+/*
+ * Copyright (C) 2010-2015 Canonical
+ *
+  * 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 2
+ * 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.
+ *
+ */
+#include "fwts.h"
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <unistd.h>
+#include <inttypes.h>
+#include <stdbool.h>
+
+static fwts_acpi_table_info *table;
+
+static int tpm2_init(fwts_framework *fw)
+{
+	if (fwts_acpi_find_table(fw, "TPM2", 0, &table) != FWTS_OK) {
+		fwts_log_error(fw, "Cannot load ACPI table");
+		return FWTS_ERROR;
+	}
+	if (table == NULL) {
+		fwts_log_error(fw, "ACPI TPM2 table does not exist, skipping test");
+		return FWTS_ERROR;
+	}
+
+	return FWTS_OK;
+}
+
+/*
+ * TPM2 table
+ *   available @ http://www.trustedcomputinggroup.org/files/static_page_files/648D7D46-1A4B-B294-D088037B8F73DAAF/TCG_ACPIGeneralSpecification_1-10_0-37-Published.pdf
+ */
+static int tpm2_test1(fwts_framework *fw)
+{
+	fwts_acpi_table_tpm2 *tpm2 = (fwts_acpi_table_tpm2*) table->data;
+	bool passed = true;
+
+	fwts_log_info_verbatum(fw, "TPM2 Table:");
+	fwts_log_info_verbatum(fw, "  Platform Class:                  0x%4.4"   PRIx16, tpm2->platform_class);
+	fwts_log_info_verbatum(fw, "  Reserved:                        0x%4.4"   PRIx32, tpm2->reserved);
+	fwts_log_info_verbatum(fw, "  Address of Control Area:         0x%16.16" PRIx64, tpm2->address_of_control_area);
+	fwts_log_info_verbatum(fw, "  Start Method:                    0x%8.8"   PRIx32, tpm2->start_method);
+
+	if (tpm2->platform_class != 0 && tpm2->platform_class != 1) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"TPM2BadPlatformClass",
+			"TPM2's platform class must be zero (client) or one (server), got 0x%" PRIx16,
+			tpm2->platform_class);
+	}
+
+	if (tpm2->reserved != 0) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_LOW,
+			"TPM2ReservedNonZero",
+			"TPM2 reserved field must be zero, got "
+			"0x%4.4" PRIx16 " instead", tpm2->reserved);
+	}
+
+	if (tpm2->start_method < 1 || tpm2->start_method >= 9) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"TPM2BadStartMethod",
+			"TPM2's Start Method must between one to eight, got 0x%" PRIx16,
+			tpm2->start_method);
+	}
+
+	if (tpm2->start_method == 2 && table->length != sizeof(fwts_acpi_table_tpm2) + 4) {
+		passed = false;
+		fwts_failed(fw, LOG_LEVEL_HIGH,
+			"TPM2BadPlatformParameters",
+			"Table lenght must be 0x%" PRIx32 " if Start method equals 2, got 0x%" PRIx32,
+			(uint32_t) sizeof(fwts_acpi_table_tpm2) + 4,
+			(uint32_t) table->length);
+	}
+
+	if (passed)
+		fwts_passed(fw, "No issues found in TPM2 table.");
+
+	return FWTS_OK;
+}
+
+static fwts_framework_minor_test tpm2_tests[] = {
+	{ tpm2_test1, "Validate TPM2 table." },
+	{ NULL, NULL }
+};
+
+static fwts_framework_ops tpm2_ops = {
+	.description = "TPM2 Trusted Platform Module 2 test.",
+	.init        = tpm2_init,
+	.minor_tests = tpm2_tests
+};
+
+FWTS_REGISTER("tpm2", &tpm2_ops, FWTS_TEST_ANYTIME, FWTS_FLAG_BATCH | FWTS_FLAG_TEST_ACPI)
diff --git a/src/lib/include/fwts_acpi.h b/src/lib/include/fwts_acpi.h
index c113dd1..61f7129 100644
--- a/src/lib/include/fwts_acpi.h
+++ b/src/lib/include/fwts_acpi.h
@@ -535,6 +535,15 @@  typedef struct {
 	};
 }  __attribute__ ((packed)) fwts_acpi_table_tcpa;
 
+typedef struct {
+	fwts_acpi_table_header	header;
+	uint16_t	platform_class;
+	uint16_t	reserved;
+	uint64_t	address_of_control_area;
+	uint32_t	start_method;
+	uint8_t		platform_specific_parameters[0];
+}  __attribute__ ((packed)) fwts_acpi_table_tpm2;
+
 /* From http://wiki.xenproject.org/mediawiki/images/c/c4/Xen-environment-table.pdf */
 typedef struct {
 	fwts_acpi_table_header	header;