From patchwork Wed Apr 19 15:12:47 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Jorge Lopez X-Patchwork-Id: 13217008 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id DC7AAC7EE20 for ; Wed, 19 Apr 2023 15:13:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233317AbjDSPNK (ORCPT ); Wed, 19 Apr 2023 11:13:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:35036 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S233082AbjDSPNG (ORCPT ); Wed, 19 Apr 2023 11:13:06 -0400 Received: from mail-oo1-xc2e.google.com (mail-oo1-xc2e.google.com [IPv6:2607:f8b0:4864:20::c2e]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 9B3A91988; Wed, 19 Apr 2023 08:13:03 -0700 (PDT) Received: by mail-oo1-xc2e.google.com with SMTP id w5-20020a4ae9e5000000b0054711c8ad6fso758136ooc.1; Wed, 19 Apr 2023 08:13:03 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1681917183; x=1684509183; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:from:to:cc:subject:date:message-id :reply-to; bh=Ozalp3KCLsv/1XGFew3iV1PCSC100UuMGxEjJVQkDCM=; b=Zvx9BSFPu88+oMDbmj19SIyNMG2OaPkOmrq2Ful32HyvPvPbu+Uug1IAQEHnzlpgvL oOihRcGLkc4WbVYEbHQsjNlKTQtsgKEfkrcO6uRUfKldtoJAxj9OGdKR4NoD3HPDjOPN lwYmxLjibUyeIYe6dnkl/cIp4PW+S8zW6snf6i8V6JntQcTtBuf7jWWYsRfb8Xac1BFI wF/mDQVrfpo26rCdUXI6rzKmGJpSo3u69rS5+Mgk1IdCgWWdr1KAmuk72DHSMQWD/Jvc pb+GFDeI7hWJdYTzGfbiulsDQfnG5tTey1+7wFirZjbdI+o4hzIkHt+HosVamGyixMvP Je4A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1681917183; x=1684509183; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Ozalp3KCLsv/1XGFew3iV1PCSC100UuMGxEjJVQkDCM=; b=W/R+pOv1/bV2OCo7jCAQlVQcP72Fg2OUKrRRL8RSTOy8UcntEL75TYALUkBAS7fehY +gsQp9yKaM3Mc41z7usY3xbnsZE6lk8rR5V/E1Avo969ZRrJleyPWOwqLB083rKeq2Do BvqNT8fNbnr63pyxINsbjh7UrktZjB5q/UetgYJ87b6f0mphfK8rIH5lMSyAInBY46Z4 I6k2AJ/HCYlty02xn8S4KNo50dkKbhPqHV6myxKRmgh+bPmgsEbwlKDYpjLnRwddWSYy r+1jmTntvY4IA99kf5G20lETSJ7+iyLiFKknwHnEvGd2+B26NHZPPNIh8GybsIwYGFSp jAaQ== X-Gm-Message-State: AAQBX9f5cGIrPFtoHyAV2LG8vUHH5jLFJlENaZ+femXE/4Bd6aCQ4k8r wggGv1RwEOntKp0s8Y60AWs= X-Google-Smtp-Source: AKy350ZuCF8tXMm9VCM6l46M3r994LDNkV4ujuFvk3DxxEUCG6mMW0AyP6+W2Tk6L/QfEO5ml23uDg== X-Received: by 2002:a4a:88c7:0:b0:537:f9d4:a44c with SMTP id q7-20020a4a88c7000000b00537f9d4a44cmr106642ooh.5.1681917182429; Wed, 19 Apr 2023 08:13:02 -0700 (PDT) Received: from grumpy-VECTOR.hsd1.tx.comcast.net ([2601:2c3:480:7390:e175:6963:338:7453]) by smtp.gmail.com with ESMTPSA id o10-20020acad70a000000b0038bae910f7bsm5766847oig.1.2023.04.19.08.13.01 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 19 Apr 2023 08:13:02 -0700 (PDT) From: Jorge Lopez X-Google-Original-From: Jorge Lopez To: hdegoede@redhat.com, platform-driver-x86@vger.kernel.org, linux-kernel@vger.kernel.org, thomas@t-8ch.de Subject: [PATCH v10 07/14] HP BIOSCFG driver - string-attributes Date: Wed, 19 Apr 2023 10:12:47 -0500 Message-Id: <20230419151249.6126-8-jorge.lopez2@hp.com> X-Mailer: git-send-email 2.34.1 In-Reply-To: <20230419151249.6126-1-jorge.lopez2@hp.com> References: <20230419151249.6126-1-jorge.lopez2@hp.com> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: platform-driver-x86@vger.kernel.org HP BIOS Configuration driver purpose is to provide a driver supporting the latest sysfs class firmware attributes framework allowing the user to change BIOS settings and security solutions on HP Inc.’s commercial notebooks. Many features of HP Commercial notebooks can be managed using Windows Management Instrumentation (WMI). WMI is an implementation of Web-Based Enterprise Management (WBEM) that provides a standards-based interface for changing and monitoring system settings. HP BIOSCFG driver provides a native Linux solution and the exposed features facilitates the migration to Linux environments. The Linux security features to be provided in hp-bioscfg driver enables managing the BIOS settings and security solutions via sysfs, a virtual filesystem that can be used by user-mode applications. The new documentation cover HP-specific firmware sysfs attributes such Secure Platform Management and Sure Start. Each section provides security feature description and identifies sysfs directories and files exposed by the driver. Many HP Commercial notebooks include a feature called Secure Platform Management (SPM), which replaces older password-based BIOS settings management with public key cryptography. PC secure product management begins when a target system is provisioned with cryptographic keys that are used to ensure the integrity of communications between system management utilities and the BIOS. HP Commercial notebooks have several BIOS settings that control its behaviour and capabilities, many of which are related to security. To prevent unauthorized changes to these settings, the system can be configured to use a cryptographic signature-based authorization string that the BIOS will use to verify authorization to modify the setting. Linux Security components are under development and not published yet. The only linux component is the driver (hp bioscfg) at this time. Other published security components are under Windows. Signed-off-by: Jorge Lopez --- Based on the latest platform-drivers-x86.git/for-next --- .../x86/hp/hp-bioscfg/string-attributes.c | 451 ++++++++++++++++++ 1 file changed, 451 insertions(+) create mode 100644 drivers/platform/x86/hp/hp-bioscfg/string-attributes.c diff --git a/drivers/platform/x86/hp/hp-bioscfg/string-attributes.c b/drivers/platform/x86/hp/hp-bioscfg/string-attributes.c new file mode 100644 index 000000000000..7a14585d5506 --- /dev/null +++ b/drivers/platform/x86/hp/hp-bioscfg/string-attributes.c @@ -0,0 +1,451 @@ +// SPDX-License-Identifier: GPL-2.0 +/* + * Functions corresponding to string type attributes under + * HP_WMI_BIOS_STRING_GUID for use with hp-bioscfg driver. + * + * Copyright (c) 2022 HP Development Company, L.P. + */ + +#include "bioscfg.h" + +#define WMI_STRING_TYPE "HPBIOS_BIOSString" + +GET_INSTANCE_ID(string); + +static ssize_t current_value_show(struct kobject *kobj, struct kobj_attribute *attr, char *buf) +{ + int instance_id = get_string_instance_id(kobj); + + if (instance_id < 0) + return -EIO; + + return sysfs_emit(buf, "%s\n", + bioscfg_drv.string_data[instance_id].current_value); +} + +/* + * validate_string_input() - + * Validate input of current_value against min and max lengths + * + * @instance_id: The instance on which input is validated + * @buf: Input value + */ +static int validate_string_input(int instance_id, const char *buf) +{ + int in_len = strlen(buf); + + /* BIOS treats it as a read only attribute */ + if (bioscfg_drv.string_data[instance_id].common.is_readonly) + return -EIO; + + if ((in_len < bioscfg_drv.string_data[instance_id].min_length) || + (in_len > bioscfg_drv.string_data[instance_id].max_length)) + return -ERANGE; + + /* + * set pending reboot flag depending on + * "RequiresPhysicalPresence" value + */ + if (bioscfg_drv.string_data[instance_id].common.requires_physical_presence) + bioscfg_drv.pending_reboot = true; + return 0; +} + +static void update_string_value(int instance_id, char *attr_value) +{ + /* Write settings to BIOS */ + strscpy(bioscfg_drv.string_data[instance_id].current_value, + attr_value, + sizeof(bioscfg_drv.string_data[instance_id].current_value)); +} + +ATTRIBUTE_S_COMMON_PROPERTY_SHOW(display_name_language_code, string); +static struct kobj_attribute string_display_langcode = + __ATTR_RO(display_name_language_code); + +ATTRIBUTE_S_COMMON_PROPERTY_SHOW(display_name, string); +static struct kobj_attribute string_display_name = + __ATTR_RO(display_name); + +ATTRIBUTE_PROPERTY_STORE(current_value, string); +static struct kobj_attribute string_current_val = + __ATTR_RW_MODE(current_value, 0644); + +ATTRIBUTE_N_PROPERTY_SHOW(min_length, string); +static struct kobj_attribute string_min_length = + __ATTR_RO(min_length); + +ATTRIBUTE_N_PROPERTY_SHOW(max_length, string); +static struct kobj_attribute string_max_length = + __ATTR_RO(max_length); + +ATTRIBUTE_N_COMMON_PROPERTY_SHOW(prerequisites_size, string); +static struct kobj_attribute string_prerequisites_size_val = + __ATTR_RO(prerequisites_size); + +ATTRIBUTE_V_COMMON_PROPERTY_SHOW(prerequisites, string); +static struct kobj_attribute string_prerequisites_val = + __ATTR_RO(prerequisites); + +static ssize_t type_show(struct kobject *kobj, struct kobj_attribute *attr, + char *buf) +{ + return sysfs_emit(buf, "string\n"); +} +static struct kobj_attribute string_type = + __ATTR_RO(type); + +static struct attribute *string_attrs[] = { + &string_display_langcode.attr, + &string_display_name.attr, + &string_current_val.attr, + &string_min_length.attr, + &string_max_length.attr, + &string_prerequisites_size_val.attr, + &string_prerequisites_val.attr, + &string_type.attr, + NULL +}; + +static const struct attribute_group string_attr_group = { + .attrs = string_attrs, +}; + +int alloc_string_data(void) +{ + int ret = 0; + + bioscfg_drv.string_instances_count = get_instance_count(HP_WMI_BIOS_STRING_GUID); + bioscfg_drv.string_data = kcalloc(bioscfg_drv.string_instances_count, + sizeof(struct string_data), GFP_KERNEL); + if (!bioscfg_drv.string_data) { + bioscfg_drv.string_instances_count = 0; + ret = -ENOMEM; + } + return ret; +} + +/* Expected Values types associated with each element */ +static const acpi_object_type expected_string_types[] = { + [NAME] = ACPI_TYPE_STRING, + [VALUE] = ACPI_TYPE_STRING, + [PATH] = ACPI_TYPE_STRING, + [IS_READONLY] = ACPI_TYPE_INTEGER, + [DISPLAY_IN_UI] = ACPI_TYPE_INTEGER, + [REQUIRES_PHYSICAL_PRESENCE] = ACPI_TYPE_INTEGER, + [SEQUENCE] = ACPI_TYPE_INTEGER, + [PREREQUISITES_SIZE] = ACPI_TYPE_INTEGER, + [PREREQUISITES] = ACPI_TYPE_STRING, + [SECURITY_LEVEL] = ACPI_TYPE_INTEGER, + [STR_MIN_LENGTH] = ACPI_TYPE_INTEGER, + [STR_MAX_LENGTH] = ACPI_TYPE_INTEGER +}; + +/* + * populate_string_package_data() - + * Populate all properties of an instance under string attribute + * + * @string_obj: ACPI object with string data + * @instance_id: The instance to enumerate + * @attr_name_kobj: The parent kernel object + */ +int populate_string_package_data(union acpi_object *string_obj, + int instance_id, + struct kobject *attr_name_kobj) +{ + bioscfg_drv.string_data[instance_id].attr_name_kobj = attr_name_kobj; + + populate_string_elements_from_package(string_obj, + string_obj->package.count, + instance_id); + + update_attribute_permissions(bioscfg_drv.string_data[instance_id].common.is_readonly, + &string_current_val); + friendly_user_name_update(bioscfg_drv.string_data[instance_id].common.path, + attr_name_kobj->name, + bioscfg_drv.string_data[instance_id].common.display_name, + sizeof(bioscfg_drv.string_data[instance_id].common.display_name)); + return sysfs_create_group(attr_name_kobj, &string_attr_group); +} + +int populate_string_elements_from_package(union acpi_object *string_obj, + int string_obj_count, + int instance_id) +{ + char *str_value = NULL; + int value_len; + int ret = 0; + u32 size = 0; + u32 int_value; + int elem = 0; + int reqs; + int eloc; + + if (!string_obj) + return -EINVAL; + + strscpy(bioscfg_drv.string_data[instance_id].common.display_name_language_code, + LANG_CODE_STR, + sizeof(bioscfg_drv.string_data[instance_id].common.display_name_language_code)); + + for (elem = 1, eloc = 1; elem < string_obj_count; elem++, eloc++) { + + /* ONLY look at the first STRING_ELEM_CNT elements */ + if (eloc == STRING_ELEM_CNT) + goto exit_string_package; + + switch (string_obj[elem].type) { + case ACPI_TYPE_STRING: + + if (elem != PREREQUISITES) { + ret = convert_hexstr_to_str(string_obj[elem].string.pointer, + string_obj[elem].string.length, + &str_value, &value_len); + + if (ret) + continue; + } + break; + case ACPI_TYPE_INTEGER: + int_value = (u32)string_obj[elem].integer.value; + break; + default: + pr_warn("Unsupported object type [%d]\n", string_obj[elem].type); + continue; + } + + /* Check that both expected and read object type match */ + if (expected_string_types[eloc] != string_obj[elem].type) { + pr_err("Error expected type %d for elem %d, but got type %d instead\n", + expected_string_types[eloc], elem, string_obj[elem].type); + return -EIO; + } + + /* Assign appropriate element value to corresponding field*/ + switch (eloc) { + case VALUE: + strscpy(bioscfg_drv.string_data[instance_id].current_value, + str_value, sizeof(bioscfg_drv.string_data[instance_id].current_value)); + break; + case PATH: + strscpy(bioscfg_drv.string_data[instance_id].common.path, str_value, + sizeof(bioscfg_drv.string_data[instance_id].common.path)); + break; + case IS_READONLY: + bioscfg_drv.string_data[instance_id].common.is_readonly = int_value; + break; + case DISPLAY_IN_UI: + bioscfg_drv.string_data[instance_id].common.display_in_ui = int_value; + break; + case REQUIRES_PHYSICAL_PRESENCE: + bioscfg_drv.string_data[instance_id].common.requires_physical_presence = int_value; + break; + case SEQUENCE: + bioscfg_drv.string_data[instance_id].common.sequence = int_value; + break; + case PREREQUISITES_SIZE: + bioscfg_drv.string_data[instance_id].common.prerequisites_size = int_value; + if (size > MAX_PREREQUISITES_SIZE) + pr_warn("Prerequisites size value exceeded the maximum number of elements supported or data may be malformed\n"); + /* + * This HACK is needed to keep the expected + * element list pointing to the right obj[elem].type + * when the size is zero. PREREQUISITES + * object is omitted by BIOS when the size is + * zero. + */ + if (int_value == 0) + eloc++; + break; + case PREREQUISITES: + size = bioscfg_drv.string_data[instance_id].common.prerequisites_size; + + for (reqs = 0; reqs < size && reqs < MAX_PREREQUISITES_SIZE; reqs++) { + if (elem >= string_obj_count) { + pr_err("Error elem-objects package is too small\n"); + return -EINVAL; + } + + ret = convert_hexstr_to_str(string_obj[elem + reqs].string.pointer, + string_obj[elem + reqs].string.length, + &str_value, &value_len); + + if (ret) + continue; + + strscpy(bioscfg_drv.string_data[instance_id].common.prerequisites[reqs], + str_value, + sizeof(bioscfg_drv.string_data[instance_id].common.prerequisites[reqs])); + kfree(str_value); + } + break; + + case SECURITY_LEVEL: + bioscfg_drv.string_data[instance_id].common.security_level = int_value; + break; + case STR_MIN_LENGTH: + bioscfg_drv.string_data[instance_id].min_length = int_value; + break; + case STR_MAX_LENGTH: + bioscfg_drv.string_data[instance_id].max_length = int_value; + break; + default: + pr_warn("Invalid element: %d found in String attribute or data may be malformed\n", elem); + break; + } + + kfree(str_value); + } + +exit_string_package: + kfree(str_value); + return 0; +} + +/* + * populate_string_data() - + * Populate all properties of an instance under string attribute + * + * @buffer_ptr: Buffer pointer + * @buffer_size: Buffer size + * @instance_id: The instance to enumerate + * @attr_name_kobj: The parent kernel object + */ +int populate_string_buffer_data(u8 *buffer_ptr, u32 *buffer_size, + int instance_id, + struct kobject *attr_name_kobj) +{ + bioscfg_drv.string_data[instance_id].attr_name_kobj = attr_name_kobj; + + populate_string_elements_from_buffer(buffer_ptr, buffer_size, + instance_id); + + update_attribute_permissions(bioscfg_drv.string_data[instance_id].common.is_readonly, + &string_current_val); + friendly_user_name_update(bioscfg_drv.string_data[instance_id].common.path, + attr_name_kobj->name, + bioscfg_drv.string_data[instance_id].common.display_name, + sizeof(bioscfg_drv.string_data[instance_id].common.display_name)); + + return sysfs_create_group(attr_name_kobj, &string_attr_group); +} + +int populate_string_elements_from_buffer(u8 *buffer_ptr, u32 *buffer_size, + int instance_id) +{ + int ret; + char *dst = NULL; + int elem; + int reqs; + int int_value; + int size = 0; + int dst_size = *buffer_size / sizeof(u16); + + dst = kcalloc(dst_size, sizeof(char), GFP_KERNEL); + if (!dst) + return -ENOMEM; + + strscpy(bioscfg_drv.string_data[instance_id].common.display_name_language_code, + LANG_CODE_STR, + sizeof(bioscfg_drv.string_data[instance_id].common.display_name_language_code)); + + for (elem = 1; elem < 3; elem++) { + ret = get_string_from_buffer(&buffer_ptr, buffer_size, dst, dst_size); + /* Ignore. Zero length string values */ + if (ret < 0) + continue; + + switch (elem) { + case VALUE: + strscpy(bioscfg_drv.string_data[instance_id].current_value, + dst, sizeof(bioscfg_drv.string_data[instance_id].current_value)); + break; + case PATH: + strscpy(bioscfg_drv.string_data[instance_id].common.path, dst, + sizeof(bioscfg_drv.string_data[instance_id].common.path)); + break; + default: + pr_warn("Invalid element: %d found in String attribute or data may be malformed\n", elem); + break; + } + } + + for (elem = 3; elem < STRING_ELEM_CNT; elem++) { + if (elem != PREREQUISITES) { + ret = get_integer_from_buffer((int **)&buffer_ptr, + buffer_size, + (int *)&int_value); + if (ret < 0) + continue; + } + + switch (elem) { + case IS_READONLY: + bioscfg_drv.string_data[instance_id].common.is_readonly = int_value; + break; + case DISPLAY_IN_UI: + bioscfg_drv.string_data[instance_id].common.display_in_ui = int_value; + break; + case REQUIRES_PHYSICAL_PRESENCE: + bioscfg_drv.string_data[instance_id].common.requires_physical_presence = int_value; + break; + case SEQUENCE: + bioscfg_drv.string_data[instance_id].common.sequence = int_value; + break; + case PREREQUISITES_SIZE: + bioscfg_drv.string_data[instance_id].common.prerequisites_size = int_value; + if (int_value > MAX_PREREQUISITES_SIZE) + pr_warn("Prerequisites size value exceeded the maximum number of elements supported or data may be malformed\n"); + break; + + case PREREQUISITES: + size = bioscfg_drv.string_data[instance_id].common.prerequisites_size; + for (reqs = 0; reqs < size && reqs < MAX_PREREQUISITES_SIZE; reqs++) { + ret = get_string_from_buffer(&buffer_ptr, buffer_size, dst, dst_size); + /* Ignore. Zero length string values */ + if (ret < 0) + continue; + strscpy(bioscfg_drv.string_data[instance_id].common.prerequisites[reqs], + dst, + sizeof(bioscfg_drv.string_data[instance_id].common.prerequisites[reqs])); + } + break; + case SECURITY_LEVEL: + bioscfg_drv.string_data[instance_id].common.security_level = int_value; + break; + case STR_MIN_LENGTH: + bioscfg_drv.string_data[instance_id].min_length = int_value; + break; + case STR_MAX_LENGTH: + bioscfg_drv.string_data[instance_id].max_length = int_value; + break; + default: + pr_warn("Invalid element: %d found in String attribute or data may be malformed\n", elem); + break; + } + } + kfree(dst); + return 0; +} + +/* + * exit_string_attributes() - Clear all attribute data + * + * Clears all data allocated for this group of attributes + */ +void exit_string_attributes(void) +{ + int instance_id; + + for (instance_id = 0; instance_id < bioscfg_drv.string_instances_count; instance_id++) { + + struct kobject *attr_name_kobj = bioscfg_drv.string_data[instance_id].attr_name_kobj; + + if (attr_name_kobj) + sysfs_remove_group(attr_name_kobj, &string_attr_group); + } + bioscfg_drv.string_instances_count = 0; + + kfree(bioscfg_drv.string_data); + bioscfg_drv.string_data = NULL; +}