[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v5 2/4] hvmloader: fix SMBIOS table length checks



Hello,

Le 24/08/2025 à 00:29, Petr Beneš a écrit :
> From: Petr Beneš <w1benny@xxxxxxxxx>
>
> SMBIOS specification dictates that tables should have a minimal length.
> This commit introduces further validation for user-input SMBIOS tables.
>
> As per SMBIOS Reference Specification:
> * Type 0: For version 2.3 and later implementations, the length is at least 
> 14h
> * Type 1: 1Bh for 2.4 and later
> * Type 2: at least 08h
> * Type 3: 0Dh for version 2.1 and later
> * Type 11: 5h (+ strings)
> * Type 22: 1Ah (+ strings)
> * Type 39: a minimum of 10h
>
> Notably, this also fixes previously incorrect check for chassis handle in
> smbios_type_2_init. Chassis handle is a WORD, therefore, the condition now
> correctly checks for >= 13 instead of > 13.
>
> hvmloader currently implements version 2.4
>
> Furthermore, this commit introduces smbios_pt_copy helper function to 
> substitute
> previously repeating pattern of locating the struct in physical memory (via
> get_smbios_pt_struct), checking the length and copying it into SMBIOS region.
>
> Signed-off-by: Petr Beneš <w1benny@xxxxxxxxx>
> Acked-by: Jan Beulich <jbeulich@xxxxxxxx>
> ---
>   tools/firmware/hvmloader/smbios.c       | 178 ++++++++++++++----------
>   tools/firmware/hvmloader/smbios_types.h |  32 ++---
>   2 files changed, 123 insertions(+), 87 deletions(-)
>
> diff --git a/tools/firmware/hvmloader/smbios.c 
> b/tools/firmware/hvmloader/smbios.c
> index 6bcdcc233a..de3ba78e87 100644
> --- a/tools/firmware/hvmloader/smbios.c
> +++ b/tools/firmware/hvmloader/smbios.c
> @@ -47,6 +47,8 @@ static void
>   smbios_pt_init(void);
>   static void*
>   get_smbios_pt_struct(uint8_t type, uint32_t *length_out);
> +static void *
> +smbios_pt_copy(void *start, uint8_t type, uint16_t handle, size_t 
> table_size);
>   static void
>   get_cpu_manufacturer(char *buf, int len);
>   static int
> @@ -154,6 +156,24 @@ get_smbios_pt_struct(uint8_t type, uint32_t *length_out)
>       return NULL;
>   }
>
> +static void *
> +smbios_pt_copy(void *start, uint8_t type, uint16_t handle, size_t min_size)
> +{
> +    struct smbios_structure_header *header = start;
> +    void *pts;
> +    uint32_t length;
> +
> +    pts = get_smbios_pt_struct(type, &length);
> +    if ( pts != NULL && length >= min_size )
> +    {
> +        memcpy(start, pts, length);
> +        header->handle = handle;
> +        return start + length;
> +    }
> +
> +    return start;
> +}
> +
>   static void
>   get_cpu_manufacturer(char *buf, int len)
>   {
> @@ -381,16 +401,17 @@ smbios_type_0_init(void *start, const char *xen_version,
>       struct smbios_type_0 *p = start;
>       static const char *smbios_release_date = __SMBIOS_DATE__;
>       const char *s;
> -    void *pts;
> -    uint32_t length;
> +    void *next;
>
> -    pts = get_smbios_pt_struct(0, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE0;
> -        return start + length;
> -    }
> +    /*
> +     * Specification says Type 0 table has length of at least 18h for 
> v2.4-3.0.
> +     */
> +
> +    BUILD_BUG_ON(sizeof(*p) != 24);
> +
> +    next = smbios_pt_copy(start, 0, SMBIOS_HANDLE_TYPE0, sizeof(*p));
> +    if ( next != start )
> +        return next;
>
>       memset(p, 0, sizeof(*p));
>
> @@ -440,16 +461,14 @@ smbios_type_1_init(void *start, const char *xen_version,
>       char uuid_str[37];
>       struct smbios_type_1 *p = start;
>       const char *s;
> -    void *pts;
> -    uint32_t length;
> +    void *next;
>
> -    pts = get_smbios_pt_struct(1, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE1;
> -        return start + length;
> -    }
> +    /* Specification says Type 1 table has length of 1Bh for v2.4 and later. 
> */
> +    BUILD_BUG_ON(sizeof(*p) != 27);
> +
> +    next = smbios_pt_copy(start, 1, SMBIOS_HANDLE_TYPE1, sizeof(*p));
> +    if ( next != start )
> +        return next;
>
>       memset(p, 0, sizeof(*p));
>
> @@ -498,26 +517,29 @@ smbios_type_2_init(void *start)
>   {
>       struct smbios_type_2 *p = start;
>       const char *s;
> -    uint8_t *ptr;
> -    void *pts;
> -    uint32_t length;
> +    void *next;
>       unsigned int counter = 0;
>
> -    pts = get_smbios_pt_struct(2, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE2;
> +    /*
> +     * Specification says Type 2 table has length of at least 08h,
> +     * which corresponds with the end of the "Serial Number" field.
> +     */
> +
> +    BUILD_BUG_ON(endof_field(struct smbios_type_2, serial_number_str) != 8);
>
> +    next = smbios_pt_copy(start, 2, SMBIOS_HANDLE_TYPE2,
> +                          endof_field(struct smbios_type_2, 
> serial_number_str));
> +    if ( next != start )
> +    {
>           /* Set current chassis handle if present */
> -        if ( p->header.length > 13 )
> +        if ( p->header.length >= endof_field(struct smbios_type_2,
> +                                             chassis_handle) )
>           {
> -            ptr = ((uint8_t*)start) + 11;
> -            if ( *((uint16_t*)ptr) != 0 )
> -                *((uint16_t*)ptr) = SMBIOS_HANDLE_TYPE3;
> +            if ( p->chassis_handle != 0 )
> +                p->chassis_handle = SMBIOS_HANDLE_TYPE3;
>           }
>
> -        return start + length;
> +        return next;
>       }
>
>       memset(p, 0, sizeof(*p));
> @@ -593,18 +615,21 @@ smbios_type_3_init(void *start)
>   {
>       struct smbios_type_3 *p = start;
>       const char *s;
> -    void *pts;
> -    uint32_t length;
> +    void *next;
>       uint32_t counter = 0;
>
> -    pts = get_smbios_pt_struct(3, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE3;
> -        return start + length;
> -    }
> -
> +    /*
> +     * Specification says Type 3 table has length of at least 0Dh (for 
> v2.1+),
> +     * which corresponds with the end of the "Security Status" field.
> +     */
> +
> +    BUILD_BUG_ON(endof_field(struct smbios_type_3, security_status) != 13);
> +
> +    next = smbios_pt_copy(start, 3, SMBIOS_HANDLE_TYPE3,
> +                          offsetof(struct smbios_type_3, security_status));
> +    if ( next != start )
> +        return next;
> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 3;
> @@ -656,6 +681,9 @@ smbios_type_4_init(
>       struct smbios_type_4 *p = start;
>       uint32_t eax, ebx, ecx, edx;
>
> +    /* Specification says Type 4 table has length of 23h for v2.3+. */
> +    BUILD_BUG_ON(sizeof(*p) != 35);
> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 4;
> @@ -707,17 +735,15 @@ smbios_type_11_init(void *start)
>       struct smbios_type_11 *p = start;
>       char path[20];
>       const char *s;
> +    void *next;
>       int i;
> -    void *pts;
> -    uint32_t length;
>
> -    pts = get_smbios_pt_struct(11, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE11;
> -        return start + length;
> -    }
> +    /* Specification says Type 11 table has length of 05h. */
> +    BUILD_BUG_ON(sizeof(*p) != 5);
> +
> +    next = smbios_pt_copy(start, 11, SMBIOS_HANDLE_TYPE11, sizeof(*p));
> +    if ( next != start )
> +        return next;
>
>       p->header.type = 11;
>       p->header.length = sizeof(*p);
> @@ -756,6 +782,9 @@ smbios_type_16_init(void *start, uint32_t memsize, int 
> nr_mem_devs)
>   {
>       struct smbios_type_16 *p = start;
>
> +    /* Specification says Type 16 table has length of 0Fh for v2.1-2.7. */
> +    BUILD_BUG_ON(sizeof(*p) != 15);
> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 16;
> @@ -781,6 +810,9 @@ smbios_type_17_init(void *start, uint32_t memory_size_mb, 
> int instance)
>       char buf[16];
>       struct smbios_type_17 *p = start;
>
> +    /* Specification says Type 17 table has length of 1Bh for v2.3-2.6. */
> +    BUILD_BUG_ON(sizeof(*p) != 27);
> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 17;
> @@ -816,6 +848,9 @@ smbios_type_19_init(void *start, uint32_t memory_size_mb, 
> int instance)
>   {
>       struct smbios_type_19 *p = start;
>
> +    /* Specification says Type 19 table has length of 0Fh for v2.1-2.7. */
> +    BUILD_BUG_ON(sizeof(*p) != 15);
> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 19;
> @@ -838,6 +873,9 @@ smbios_type_20_init(void *start, uint32_t memory_size_mb, 
> int instance)
>   {
>       struct smbios_type_20 *p = start;
>
> +    /* Specification says Type 20 table has length of 13h for v2.1-2.7. */
> +    BUILD_BUG_ON(sizeof(*p) != 19);

Note that OVMF does replace the SMBIOS version to 2.8 which may
eventually invalidate what you expect (assuming the length only holds
for the versions you give in your comments).

I don't know enough SMBIOS and OVMF to know if it can be a problem (OVMF
may do some conversions in these cases).

> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 20;
> @@ -865,16 +903,14 @@ smbios_type_22_init(void *start)
>       struct smbios_type_22 *p = start;
>       static const char *smbios_release_date = __SMBIOS_DATE__;
>       const char *s;
> -    void *pts;
> -    uint32_t length;
> +    void *next;
>
> -    pts = get_smbios_pt_struct(22, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE22;
> -        return start + length;
> -    }
> +    /* Specification says Type 22 table has length of 1Ah. */
> +    BUILD_BUG_ON(sizeof(*p) != 26);
> +
> +    next = smbios_pt_copy(start, 22, SMBIOS_HANDLE_TYPE22, sizeof(*p));
> +    if ( next != start )
> +        return next;
>
>       s = xenstore_read(HVM_XS_SMBIOS_DEFAULT_BATTERY, "0");
>       if ( strncmp(s, "1", 1) != 0 )
> @@ -929,6 +965,9 @@ smbios_type_32_init(void *start)
>   {
>       struct smbios_type_32 *p = start;
>
> +    /* Specification says Type 32 table has length of at least 0Bh. */
> +    BUILD_BUG_ON(sizeof(*p) != 11);
> +
>       memset(p, 0, sizeof(*p));
>
>       p->header.type = 32;
> @@ -946,20 +985,17 @@ smbios_type_32_init(void *start)
>   static void *
>   smbios_type_39_init(void *start)
>   {
> -    struct smbios_type_39 *p = start;
> -    void *pts;
> -    uint32_t length;
> +    /*
> +     * Specification says Type 39 table has length of at least 10h,
> +     * which corresponds with the end of the "Characteristics" field.
> +     *
> +     * Only present when passed in.
> +     */
>
> -    pts = get_smbios_pt_struct(39, &length);
> -    if ( pts != NULL && length > 0 )
> -    {
> -        memcpy(start, pts, length);
> -        p->header.handle = SMBIOS_HANDLE_TYPE39;
> -        return start + length;
> -    }
> +    BUILD_BUG_ON(endof_field(struct smbios_type_39, characteristics) != 16);
>
> -    /* Only present when passed in */
> -    return start;
> +    return smbios_pt_copy(start, 39, SMBIOS_HANDLE_TYPE39,
> +                          endof_field(struct smbios_type_39, 
> characteristics));
>   }
>
>   static void *
> diff --git a/tools/firmware/hvmloader/smbios_types.h 
> b/tools/firmware/hvmloader/smbios_types.h
> index 7c648ece71..a04d194975 100644
> --- a/tools/firmware/hvmloader/smbios_types.h
> +++ b/tools/firmware/hvmloader/smbios_types.h
> @@ -90,13 +90,13 @@ struct smbios_type_2 {
>       uint8_t product_name_str;
>       uint8_t version_str;
>       uint8_t serial_number_str;
> -    uint8_t asset_tag_str;
> -    uint8_t feature_flags;
> -    uint8_t location_in_chassis_str;
> -    uint16_t chassis_handle;
> -    uint8_t board_type;
> -    uint8_t contained_handle_count;
> -    uint16_t contained_handles[];
> +    uint8_t asset_tag_str;                  /* Optional */
> +    uint8_t feature_flags;                  /* Optional */
> +    uint8_t location_in_chassis_str;        /* Optional */
> +    uint16_t chassis_handle;                /* Optional */
> +    uint8_t board_type;                     /* Optional */
> +    uint8_t contained_handle_count;         /* Optional */
> +    uint16_t contained_handles[];           /* Optional */
>   } __attribute__ ((packed));
>
>   /* System Enclosure - Contained Elements */
> @@ -118,12 +118,12 @@ struct smbios_type_3 {
>       uint8_t power_supply_state;
>       uint8_t thermal_state;
>       uint8_t security_status;
> -    uint32_t oem_specific;
> -    uint8_t height;
> -    uint8_t number_of_power_cords;
> -    uint8_t contained_element_count;
> -    uint8_t contained_element_length;
> -    struct smbios_contained_element contained_elements[];
> +    uint32_t oem_specific;                  /* Optional */
> +    uint8_t height;                         /* Optional */
> +    uint8_t number_of_power_cords;          /* Optional */
> +    uint8_t contained_element_count;        /* Optional */
> +    uint8_t contained_element_length;       /* Optional */
> +    struct smbios_contained_element contained_elements[]; /* Optional */
>   } __attribute__ ((packed));
>
>   /* SMBIOS type 4 - Processor Information */
> @@ -252,9 +252,9 @@ struct smbios_type_39 {
>       uint8_t revision_level_str;
>       uint16_t max_capacity;
>       uint16_t characteristics;
> -    uint16_t input_voltage_probe_handle;
> -    uint16_t cooling_device_handle;
> -    uint16_t input_current_probe_handle;
> +    uint16_t input_voltage_probe_handle;    /* Optional */
> +    uint16_t cooling_device_handle;         /* Optional */
> +    uint16_t input_current_probe_handle;    /* Optional */
>   } __attribute__ ((packed));
>
>   /* SMBIOS type 127 -- End-of-table */



Teddy Astie | Vates XCP-ng Developer

XCP-ng & Xen Orchestra - Vates solutions

web: https://vates.tech





 


Rackspace

Lists.xenproject.org is hosted with RackSpace, monitoring our
servers 24x7x365 and backed by RackSpace's Fanatical Support®.