Add fips_module_id api

[Wenxing-hou]

Reference: #1260

Fix: #1573

Signed-off-by: Wenxing Hou wenxing.hou@intel.com

[jyao1]

According to #1573,

1. we need to expose this API even without FIPS mode.
2. we need to expose publicly, not in internal.

[steven-bellock]

It should return a uint32_t.

[jyao1]

@steven-bellock , I think we can use the semantic version, align with libspdm release. 4 bytes in total.

byte3 - libspdm major version
byte2 - libspdm minor version
byte1 - libspdm patch version
byte0 - FIPS mode enable/disable

Thought?

[steven-bellock]

Byte0 should be the release status.
0x00 - unreleased and pending
0x10 - pre-release
0x20 - released

There should be a separate mechanism to determine if FIPS is enabled or not.

[jyao1]

Good idea to include tag release. But I dont think we need distinguish unrelease v.s. pre-release. They should be same. One bit is enough. I suggest:
BIT[0] - official release tag or no tag.
BIT[1:5] - reserved.
BIT[6] - debug build or release debug
BIT[7] - FIPS mode or not

Why we need use different mechanism for reporting?

[steven-bellock]

The library's version is completely orthogonal to whether FIPS is enabled or not.

[jyao1]

I would say: the Byte0 is to provide additional binary info.
What we provide is

• official release tag or not
• release build or debug build
• FIPS mode or not

That helps people to understand what this binary is.

If you dont like FIPS info, then we should make it reserved to 0.

[steven-bellock]

I don't like the FIPS information in libspdm_module_version. So maybe we should have something more generic like

typedef enum {
  LIBSPDM_INFO_VERSION,
  LIBSPDM_INF_BUILD,
  LIBSPDM_INFO_FIPS,
 } libspdm_info_t;

uint32_t libspdm_get_module_info (libspdm_info_t info);

Then we can expand the enum as needed.

[Wenxing-hou]

Thanks. I am fixing for it.

[jyao1]

I think we can use below APIs:

/*
byte3 - libspdm major version
byte2 - libspdm minor version
byte1 - libspdm patch version
byte0 - libspdm alpha (office release with tag: 0, release candidate with tag: 1, non official release: 0xFF)
*/
uint32_t libspdm_module_version(void);

/* true: FIPS enabled, false: FIPS disabled*/
bool libspdm_get_fips_mode(void);

[steven-bellock]

It should return a uint32_t.

[steven-bellock]

Byte0 should be the release status.
0x00 - unreleased and pending
0x10 - pre-release
0x20 - released

There should be a separate mechanism to determine if FIPS is enabled or not.

[steven-bellock]

This needs to be available to the Integrator at compile time, so it will need to reside in include/library/spdm_common_lib.h.

[jyao1]

Please 1. resolve conflict. 2. use the final conclusion below:

/*
byte3 - libspdm major version
byte2 - libspdm minor version
byte1 - libspdm patch version
byte0 - libspdm alpha (office release with tag: 0, release candidate with tag: 1, non official release: 0xFF)
*/
uint32_t libspdm_module_version(void);

/* true: FIPS enabled, false: FIPS disabled*/
bool libspdm_get_fips_mode(void);

[jyao1]

please change to 0x03.0x00.0x00.0xff

[Wenxing-hou]

Thanks. I have changed it.