From a50ec7458cddaee3669dacf45fa95d1435ac4316 Mon Sep 17 00:00:00 2001 From: iadgovuser58 <124906646+iadgovuser58@users.noreply.github.com> Date: Thu, 27 Jun 2024 18:11:01 -0400 Subject: [PATCH] spdm processing --- .../hirs/utils/tpm/eventlog/TpmPcrEvent.java | 2 + .../eventlog/events/DeviceSecurityEvent.java | 15 +- .../events/DeviceSecurityEventData.java | 4 +- .../events/DeviceSecurityEventData2.java | 48 +++++- .../events/DeviceSecurityEventDataHeader.java | 27 ++-- .../DeviceSecurityEventDataHeader2.java | 146 +++++++++++++++++- .../DeviceSecurityEventDataSubHeader.java | 20 +++ ...ventDataSubHeaderSpdmMeasurementBlock.java | 106 +++++++++++++ .../events/DeviceSecurityEventHeader.java | 16 +- .../events/EvEfiSpdmDeviceSecurityEvent.java | 50 ++++-- .../eventlog/spdm/SpdmMeasurementBlock.java | 49 ++++-- 11 files changed, 434 insertions(+), 49 deletions(-) create mode 100644 HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeader.java create mode 100644 HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock.java diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java index ca4a851e..f1be1b57 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/TpmPcrEvent.java @@ -396,6 +396,8 @@ public class TpmPcrEvent { } catch (UnsupportedEncodingException ueEx) { log.error(ueEx); sb.append(ueEx.toString()); + } catch (IOException e) { + throw new RuntimeException(e); } break; default: diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEvent.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEvent.java index 0e97f8a1..fe8d9ec1 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEvent.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEvent.java @@ -50,6 +50,12 @@ import lombok.Getter; */ public abstract class DeviceSecurityEvent { + /** + * DeviceSecurityEventDataContext Object. + */ + @Getter + private DeviceSecurityEventDataDeviceContext dsedDevContext = null; + /** * Human readable description of the data within the * DEVICE_SECURITY_EVENT_DATA_DEVICE_CONTEXT. DEVICE can be either PCI or USB. @@ -83,12 +89,15 @@ public abstract class DeviceSecurityEvent { deviceContextLength); if (deviceType == 0) { - deviceContextInfo = "No Device Context (indicated by device type value of 0"; + deviceContextInfo = "\n No Device Context (indicated by device type value of 0"; } else if (deviceType == 1) { - DeviceSecurityEventDataPciContext dSEDpciContext +// DeviceSecurityEventDataPciContext dSEDpciContext +// = new DeviceSecurityEventDataPciContext(deviceContextBytes); +// deviceContextInfo = dSEDpciContext.toString(); + dsedDevContext = new DeviceSecurityEventDataPciContext(deviceContextBytes); - deviceContextInfo = dSEDpciContext.toString(); + deviceContextInfo = dsedDevContext.toString(); } //else if (deviceType == 2) { //DeviceSecurityEventDataUsbContext dSEDusbContext diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData.java index 4f996548..1043f74d 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData.java @@ -1,6 +1,8 @@ package hirs.utils.tpm.eventlog.events; import lombok.Getter; + +import java.io.IOException; import java.io.UnsupportedEncodingException; /** @@ -26,7 +28,7 @@ public class DeviceSecurityEventData extends DeviceSecurityEvent { * * @param dSEDbytes byte array holding the DeviceSecurityEventData. */ - public DeviceSecurityEventData(final byte[] dSEDbytes) throws UnsupportedEncodingException { + public DeviceSecurityEventData(final byte[] dSEDbytes) throws IOException { dsedHeader = new DeviceSecurityEventDataHeader(dSEDbytes); parseDeviceContext(dSEDbytes, dsedHeader.getDSEDheaderByteSize(), dsedHeader.getDeviceType()); } diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData2.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData2.java index 014b6fe0..81ae1ccf 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData2.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventData2.java @@ -1,7 +1,14 @@ package hirs.utils.tpm.eventlog.events; +import hirs.utils.HexUtils; import lombok.Getter; +import java.io.IOException; +import java.io.UnsupportedEncodingException; + +import static hirs.utils.tpm.eventlog.events.DeviceSecurityEventDataHeader2.SUBHEADERTYPE_CERT_CHAIN; +import static hirs.utils.tpm.eventlog.events.DeviceSecurityEventDataHeader2.SUBHEADERTYPE_MEAS_BLOCK; + // TODO Placeholder class to be implemented upon getting test pattern /** * Class to process DEVICE_SECURITY_EVENT_DATA2. @@ -22,14 +29,50 @@ public class DeviceSecurityEventData2 extends DeviceSecurityEvent { @Getter private DeviceSecurityEventDataHeader2 dsedHeader2 = null; + /** + * DeviceSecurityEventDataSubHeader Object. + */ + @Getter + private DeviceSecurityEventDataSubHeader dsedSubHeader = null; + + /** + * Human readable description of the data within the + * DEVICE_SECURITY_EVENT_DATA_SUB_HEADER. SUB_HEADER can be either + * DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_MEASUREMENT_BLOCK or + * DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_CERT_CHAIN + */ + @Getter + String subHeaderInfo = ""; + /** * DeviceSecurityEventData2 Constructor. * * @param dSEDbytes byte array holding the DeviceSecurityEventData2. */ - public DeviceSecurityEventData2(final byte[] dSEDbytes) { + public DeviceSecurityEventData2(final byte[] dSEDbytes) throws IOException { dsedHeader2 = new DeviceSecurityEventDataHeader2(dSEDbytes); + int dSEDheaderByteSize = dsedHeader2.getDSEDheaderByteSize(); + int subHeaderType = dsedHeader2.getSubHeaderType(); + int subHeaderLength = dsedHeader2.getSubHeaderLength(); + + subHeaderInfo = "\nSub header type: " + subHeaderType; + + byte[] dSEDsubHeaderBytes = new byte[subHeaderLength]; + System.arraycopy(dSEDbytes, dSEDheaderByteSize, dSEDsubHeaderBytes, 0, subHeaderLength); + + if (subHeaderType == SUBHEADERTYPE_MEAS_BLOCK) { + dsedSubHeader = new DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock(dSEDsubHeaderBytes); + subHeaderInfo += dsedSubHeader.toString(); + } + else if (subHeaderType == SUBHEADERTYPE_CERT_CHAIN) { + // TBD: + // dsedSubHeader = new DeviceSecurityEventDataSubHeaderCertChain(); + } + else { + subHeaderInfo += "Subheader type unknown"; + } + // get subheader parseDeviceContext(dSEDbytes, dsedHeader2.getDSEDheaderByteSize(), dsedHeader2.getDeviceType()); } @@ -41,6 +84,9 @@ public class DeviceSecurityEventData2 extends DeviceSecurityEvent { */ public String toString() { String dsedInfo = ""; + dsedInfo += dsedHeader2.toString(); + dsedInfo += dsedSubHeader.toString(); + dsedInfo += getDeviceContextInfo(); return dsedInfo; } } diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader.java index 3c9ac444..bca6cd33 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader.java @@ -6,6 +6,8 @@ import hirs.utils.tpm.eventlog.spdm.SpdmMeasurementBlock; import hirs.utils.tpm.eventlog.uefi.UefiConstants; import lombok.Getter; +import java.io.ByteArrayInputStream; +import java.io.IOException; import java.io.UnsupportedEncodingException; /** @@ -49,39 +51,44 @@ public class DeviceSecurityEventDataHeader extends DeviceSecurityEventHeader { /** * DeviceSecurityEventDataHeader Constructor. * - * @param dSEDbytes byte array holding the DeviceSecurityEventData. + * @param dsedBytes byte array holding the DeviceSecurityEventData. */ - public DeviceSecurityEventDataHeader(final byte[] dSEDbytes) throws UnsupportedEncodingException { + public DeviceSecurityEventDataHeader(final byte[] dsedBytes) throws IOException { - super(dSEDbytes); + super(dsedBytes); byte[] lengthBytes = new byte[UefiConstants.SIZE_2]; - System.arraycopy(dSEDbytes, 18, lengthBytes, 0, + System.arraycopy(dsedBytes, 18, lengthBytes, 0, UefiConstants.SIZE_2); length = HexUtils.leReverseInt(lengthBytes); byte[] spdmHashAlgoBytes = new byte[UefiConstants.SIZE_4]; - System.arraycopy(dSEDbytes, UefiConstants.OFFSET_20, spdmHashAlgoBytes, 0, + System.arraycopy(dsedBytes, UefiConstants.OFFSET_20, spdmHashAlgoBytes, 0, UefiConstants.SIZE_4); spdmHashAlgo = HexUtils.leReverseInt(spdmHashAlgoBytes); - extractDeviceType(dSEDbytes, 24); + extractDeviceType(dsedBytes, 24); // get the size of the SPDM Measurement Block byte[] sizeOfSpdmMeasBlockBytes = new byte[UefiConstants.SIZE_2]; - System.arraycopy(dSEDbytes, 30, sizeOfSpdmMeasBlockBytes, 0, + System.arraycopy(dsedBytes, 30, sizeOfSpdmMeasBlockBytes, 0, UefiConstants.SIZE_2); int sizeOfSpdmMeas = HexUtils.leReverseInt(sizeOfSpdmMeasBlockBytes); int sizeOfSpdmMeasBlock = sizeOfSpdmMeas + 4; // header is 4 bytes // extract the bytes from the SPDM Measurement Block byte[] spdmMeasBlockBytes = new byte[sizeOfSpdmMeasBlock]; - System.arraycopy(dSEDbytes, 28, spdmMeasBlockBytes, 0, + System.arraycopy(dsedBytes, 28, spdmMeasBlockBytes, 0, sizeOfSpdmMeasBlock); - spdmMeasurementBlock = new SpdmMeasurementBlock(spdmMeasBlockBytes); + +// spdmMeasurementBlock = new SpdmMeasurementBlock(spdmMeasBlockBytes); + + ByteArrayInputStream spdmMeasurementBlockData = + new ByteArrayInputStream(spdmMeasBlockBytes); + spdmMeasurementBlock = new SpdmMeasurementBlock(spdmMeasurementBlockData); int devPathLenStartByte = 28 + sizeOfSpdmMeasBlock; - extractDevicePathAndFinalSize(dSEDbytes, devPathLenStartByte); + extractDevicePathAndFinalSize(dsedBytes, devPathLenStartByte); } /** diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader2.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader2.java index 8e7589a9..5ebef017 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader2.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataHeader2.java @@ -1,12 +1,130 @@ package hirs.utils.tpm.eventlog.events; +import hirs.utils.HexUtils; import hirs.utils.tpm.eventlog.spdm.SpdmHa; +import hirs.utils.tpm.eventlog.spdm.SpdmMeasurementBlock; +import hirs.utils.tpm.eventlog.uefi.UefiConstants; +import lombok.Getter; -// Placeholder for Header2 data structure. +import java.io.UnsupportedEncodingException; + +/** + * Class to process the DEVICE_SECURITY_EVENT_DATA_HEADER2. + * DEVICE_SECURITY_EVENT_DATA_HEADER2 contains the measurement(s) and hash algorithm identifier + * returned by the SPDM "GET_MEASUREMENTS" function. + * + * HEADERS defined by PFP v1.06 Rev 52: + *

+ * typedef struct tdDEVICE_SECURITY_EVENT_DATA_HEADER2 { + * UINT8 Signature[16]; + * UINT16 Version; + * UINT8 AuthState; + * UINT8 Reserved + * UINT32 Length; + * UINT32 DeviceType; + * UINT32 SubHeaderType; + * UINT32 SubHeaderLength; + * UINT64 SubHeaderUID; + * UINT64 DevicePathLength; + * UNIT8 DevicePath[DevicePathLength] + * } DEVICE_SECURITY_EVENT_DATA_HEADER2; + *

+ * Assumption: there is only 1 SpdmMeasurementBlock per event. Need more test patterns to verify. + */ public class DeviceSecurityEventDataHeader2 extends DeviceSecurityEventHeader { - public DeviceSecurityEventDataHeader2(final byte[] dSEDbytes) { + /** + * Event auth state + */ + @Getter + private int authState = 0; + /** + * Event data length. + */ + @Getter + private int length = 0; + /** + * Event sub headerType + */ + @Getter + private int subHeaderType = 0; + /** + * Event sub header length. + */ + @Getter + private int subHeaderLength = 0; + /** + * Event sub header UID. + */ + @Getter + private String subHeaderUid = ""; + /** + * Auth state - success + */ + public static final int AUTH_SUCCESS = 0; + /** + * Auth state - digital signature of the data is valid, but the public key certificate chain is not + * validated with the entry in in the UEFI device signature variable + */ + public static final int AUTH_NO_AUTHORITY = 1; + /** + * Auth state - digital signature of the measurement data is valid, but the reported device capabilities, + * negotiated parameters or certificate chains were not validated by a transcript. + */ + public static final int AUTH_NO_BINDING = 2; + /** + * Auth state - data has no digital signature + */ + public static final int AUTH_FAIL_NO_SIG = 3; + /** + * Auth state - data is invalid + */ + public static final int AUTH_FAIL_INVALID = 4; + /** + * Auth state - device is not an SPDM-capable device + */ + public static final int AUTH_NO_SPDM = 0xFF; + /** + * Sub header type - SPDM measurement block + */ + public static final int SUBHEADERTYPE_MEAS_BLOCK = 0; + /** + * Sub header type - SPDM cert chain + */ + public static final int SUBHEADERTYPE_CERT_CHAIN = 1; + + + public DeviceSecurityEventDataHeader2(final byte[] dsedBytes) throws UnsupportedEncodingException { + + super(dsedBytes); + + byte[] authStateBytes = new byte[1]; + System.arraycopy(dsedBytes, 18, authStateBytes, 0, 1); + authState = HexUtils.leReverseInt(authStateBytes); + + // byte[] reserved[Bytes]: 1 byte + + byte[] lengthBytes = new byte[4]; + System.arraycopy(dsedBytes, 20, lengthBytes, 0, 4); + length = HexUtils.leReverseInt(lengthBytes); + + extractDeviceType(dsedBytes, 24); + + byte[] subHeaderTypeBytes = new byte[4]; + System.arraycopy(dsedBytes, 44, subHeaderTypeBytes, 0, 4); + subHeaderType = HexUtils.leReverseInt(subHeaderTypeBytes); + + byte[] subHeaderLengthBytes = new byte[4]; + System.arraycopy(dsedBytes, 48, subHeaderLengthBytes, 0, 4); + subHeaderLength = HexUtils.leReverseInt(subHeaderLengthBytes); + + byte[] subHeaderUidBytes = new byte[8]; + System.arraycopy(dsedBytes, 52, subHeaderUidBytes, 0, 8); + subHeaderUid = HexUtils.byteArrayToHexString(subHeaderUidBytes); + + int devPathLenStartByte = 60; + extractDevicePathAndFinalSize(dsedBytes, devPathLenStartByte); } /** @@ -17,6 +135,30 @@ public class DeviceSecurityEventDataHeader2 extends DeviceSecurityEventHeader { public String toString() { String dsedHeader2Info = ""; + dsedHeader2Info += super.toString(); + dsedHeader2Info += "\n AuthState: " + getAuthStateString(); + dsedHeader2Info += "\n Sub header UID: " + subHeaderUid; + return dsedHeader2Info; } + + public String getAuthStateString() { + + switch (authState) { + case AUTH_SUCCESS: + return ("AUTH_SUCCESS"); + case AUTH_NO_AUTHORITY: + return ("AUTH_NO_AUTHORITY"); + case AUTH_NO_BINDING: + return ("AUTH_NO_BINDING"); + case AUTH_FAIL_NO_SIG: + return ("AUTH_FAIL_NO_SIG"); + case AUTH_FAIL_INVALID: + return ("AUTH_FAIL_INVALID"); + case AUTH_NO_SPDM: + return ("AUTH_NO_SPDM"); + default: + return ("Auth State unknown"); + } + } } diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeader.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeader.java new file mode 100644 index 00000000..8c7b0764 --- /dev/null +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeader.java @@ -0,0 +1,20 @@ +package hirs.utils.tpm.eventlog.events; + + +/** + * Class to process the DEVICE_SECURITY_EVENT_DATA_SUB_HEADER event per PFP. + * + *

+ * typedef union tdDEVICE_SECURITY_EVENT_DATA_SUB_HEADER { + * DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_MEASUREMENT_BLOCK SpdmMeasurementBlock; + * DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_CERT_CHAIN SpdmCertChain; + * DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_OEM_MEASUREMENT OemMeasurement; + * } DEVICE_SECURITY_EVENT_DATA_SUB_HEADER; + *

+ */ +public abstract class DeviceSecurityEventDataSubHeader { + + public DeviceSecurityEventDataSubHeader() { + } + +} diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock.java new file mode 100644 index 00000000..5a3196ec --- /dev/null +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock.java @@ -0,0 +1,106 @@ +package hirs.utils.tpm.eventlog.events; + +import hirs.utils.HexUtils; +import hirs.utils.tpm.eventlog.spdm.SpdmMeasurementBlock; +import hirs.utils.tpm.eventlog.uefi.UefiConstants; +import hirs.utils.tpm.eventlog.uefi.UefiSignatureList; +import lombok.Getter; + +import java.io.ByteArrayInputStream; +import java.io.IOException; +import java.io.UnsupportedEncodingException; +import java.util.ArrayList; +import java.util.List; + +/** + * Class to process the DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_MEASUREMENT_BLOCK event per PFP. + * + *

+ * typedef union tdDEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_MEASUREMENT_BLOCK { + * UINT16 SpdmVersion; + * UINT8 SpdmMeasurementBlockCount; + * UINT8 Reserved; + * UINT32 SpdmMeasurementHashAlgo; + * SPDM_MEASUREMENT_BLOCK SpdmMeasurementBlock[SpdmMeasurementBlockCount]; + * } DEVICE_SECURITY_EVENT_DATA_SUB_HEADER_SPDM_MEASUREMENT_BLOCK; + *

+ */ +public class DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock extends DeviceSecurityEventDataSubHeader { + + /** + * SPDM version. + */ + @Getter + private int spdmVersion = 0; + /** + * SPDM measurement block count. + */ + @Getter + private int spdmMeasurementBlockCount = 0; + /** + * SPDM measurement hash algorithm. + */ + @Getter + private int spdmMeasurementHashAlgo = -1; + + /** + * List of SPDM Measurement Blocks. + */ + private List spdmMeasurementBlockList; +// /** +// * SPDM Measurement Block. +// */ +// private SpdmMeasurementBlock spdmMeasurementBlock = null; + + /** + * DeviceSecurityEventDataHeader Constructor. + * + * @param dsedSubHBytes byte array holding the DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock. + */ + public DeviceSecurityEventDataSubHeaderSpdmMeasurementBlock(final byte[] dsedSubHBytes) throws IOException { + +// super(); + + spdmMeasurementBlockList = new ArrayList<>(); + + byte[] spdmVersionBytes = new byte[2]; + System.arraycopy(dsedSubHBytes, 0, spdmVersionBytes, 0, 2); + spdmVersion = HexUtils.leReverseInt(spdmVersionBytes); + + byte[] spdmMeasurementBlockCountBytes = new byte[1]; + System.arraycopy(dsedSubHBytes, 2, spdmMeasurementBlockCountBytes, 0, 1); + spdmMeasurementBlockCount = HexUtils.leReverseInt(spdmMeasurementBlockCountBytes); + + // byte[] reserved[Bytes]: 1 byte + + byte[] spdmMeasurementHashAlgoBytes = new byte[4]; + System.arraycopy(dsedSubHBytes, 4, spdmMeasurementHashAlgoBytes, 0, 4); + spdmMeasurementHashAlgo = HexUtils.leReverseInt(spdmMeasurementHashAlgoBytes); + + int spdmMeasurementBlockListSize = dsedSubHBytes.length - 8; + byte[] spdmMeasurementBlockListBytes = new byte[spdmMeasurementBlockListSize]; + System.arraycopy(dsedSubHBytes, 8, spdmMeasurementBlockListBytes, 0, + spdmMeasurementBlockListSize); + + ByteArrayInputStream spdmMeasurementBlockListData = + new ByteArrayInputStream(spdmMeasurementBlockListBytes); + while (spdmMeasurementBlockListData.available() > 0) { + + SpdmMeasurementBlock spdmMeasurementBlock; + spdmMeasurementBlock = new SpdmMeasurementBlock(spdmMeasurementBlockListData); + + spdmMeasurementBlockList.add(spdmMeasurementBlock); + } + } + + /** + * Returns a human readable description of the data within this structure. + * + * @return a description of this structure. + */ + public String toString() { + String dsedSubHeaderInfo = ""; +// dsedSubHeaderInfo += dsedHeader2.toString(); + return dsedSubHeaderInfo; + } +} diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventHeader.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventHeader.java index b7192054..5fb7b7f7 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventHeader.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/DeviceSecurityEventHeader.java @@ -4,6 +4,7 @@ import hirs.utils.HexUtils; import hirs.utils.tpm.eventlog.uefi.UefiConstants; import hirs.utils.tpm.eventlog.uefi.UefiDevicePath; import lombok.Getter; +import lombok.Setter; import java.io.UnsupportedEncodingException; import java.nio.charset.StandardCharsets; @@ -57,6 +58,7 @@ public abstract class DeviceSecurityEventHeader { */ @Getter private Integer dSEDheaderByteSize = 0; + /** * Signature (text) data. */ @@ -131,14 +133,14 @@ public abstract class DeviceSecurityEventHeader { /** * Parse the device type from the Device Security Event Data Header/Header2. * - * @param dSEDbytes byte array holding the DeviceSecurityEventData/Data2. + * @param dsedBytes byte array holding the DeviceSecurityEventData/Data2. * @param startByte starting byte of device type (depends on header fields before it). */ - public void extractDeviceType(final byte[] dSEDbytes, int startByte) { + public void extractDeviceType(final byte[] dsedBytes, int startByte) { // get the device type ID byte[] deviceTypeBytes = new byte[UefiConstants.SIZE_4]; - System.arraycopy(dSEDbytes, startByte, deviceTypeBytes, 0, + System.arraycopy(dsedBytes, startByte, deviceTypeBytes, 0, UefiConstants.SIZE_4); deviceType = HexUtils.leReverseInt(deviceTypeBytes); } @@ -147,15 +149,15 @@ public abstract class DeviceSecurityEventHeader { * Parse the device path from the Device Security Event Data Header/Header2. * Also, determine final length of header (will be used to extract the next data structure). * - * @param dSEDbytes byte array holding the DeviceSecurityEventData/Data2. + * @param dsedBytes byte array holding the DeviceSecurityEventData/Data2. * @param startByte starting byte of device path (depends on header fields before it). */ - public void extractDevicePathAndFinalSize(final byte[] dSEDbytes, int startByte) + public void extractDevicePathAndFinalSize(final byte[] dsedBytes, int startByte) throws UnsupportedEncodingException { // get the device path length byte[] devicePathLengthBytes = new byte[UefiConstants.SIZE_8]; - System.arraycopy(dSEDbytes, startByte, devicePathLengthBytes, 0, + System.arraycopy(dsedBytes, startByte, devicePathLengthBytes, 0, UefiConstants.SIZE_8); int devicePathLength = HexUtils.leReverseInt(devicePathLengthBytes); @@ -163,7 +165,7 @@ public abstract class DeviceSecurityEventHeader { if (devicePathLength != 0) { startByte = startByte + UefiConstants.SIZE_8; byte[] devPathBytes = new byte[devicePathLength]; - System.arraycopy(dSEDbytes, startByte, devPathBytes, + System.arraycopy(dsedBytes, startByte, devPathBytes, 0, devicePathLength); devicePath = new UefiDevicePath(devPathBytes); devicePathValid = true; diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/EvEfiSpdmDeviceSecurityEvent.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/EvEfiSpdmDeviceSecurityEvent.java index bb395337..66d1b7ee 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/EvEfiSpdmDeviceSecurityEvent.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/events/EvEfiSpdmDeviceSecurityEvent.java @@ -2,7 +2,9 @@ package hirs.utils.tpm.eventlog.events; import hirs.utils.HexUtils; import hirs.utils.tpm.eventlog.uefi.UefiConstants; +import lombok.Getter; +import java.io.IOException; import java.io.UnsupportedEncodingException; import java.nio.charset.StandardCharsets; @@ -31,10 +33,17 @@ import java.nio.charset.StandardCharsets; */ public class EvEfiSpdmDeviceSecurityEvent { + /** + * DeviceSecurityEvent Object. + */ + @Getter + private DeviceSecurityEvent dSED = null; + /** * Signature (text) data. */ private String signature = ""; + /** * Human readable description of the data within this DEVICE_SECURITY_EVENT_DATA/..DATA2 event. */ @@ -46,32 +55,43 @@ public class EvEfiSpdmDeviceSecurityEvent { * @param eventData byte array holding the event to process. * @throws java.io.UnsupportedEncodingException if input fails to parse. */ - public EvEfiSpdmDeviceSecurityEvent(final byte[] eventData) throws UnsupportedEncodingException { + public EvEfiSpdmDeviceSecurityEvent(final byte[] eventData) throws IOException { - byte[] signatureBytes = new byte[UefiConstants.SIZE_15]; - System.arraycopy(eventData, 0, signatureBytes, 0, UefiConstants.SIZE_15); + byte[] signatureBytes = new byte[UefiConstants.SIZE_16]; + System.arraycopy(eventData, 0, signatureBytes, 0, UefiConstants.SIZE_16); signature = new String(signatureBytes, StandardCharsets.UTF_8); signature = signature.replaceAll("[^\\P{C}\t\r\n]", ""); // remove null characters - if (signature.contains("SPDM Device Sec")) { // implies Device Security event + byte[] versionBytes = new byte[UefiConstants.SIZE_2]; + System.arraycopy(eventData, UefiConstants.OFFSET_16, versionBytes, 0, + UefiConstants.SIZE_2); + String version = HexUtils.byteArrayToHexString(versionBytes); + if (version == "") { + version = "version not readable"; + } + + if (signature.contains("SPDM Device Sec2")) { + + spdmInfo = " Signature = SPDM Device Sec2"; + + if (version.equals("0200")) { + dSED = new DeviceSecurityEventData2(eventData); + spdmInfo += dSED.toString(); + } + else { + spdmInfo += " Incompatible version for DeviceSecurityEventData2: " + version; + } + } + else if (signature.contains("SPDM Device Sec")) { // implies Device Security event spdmInfo = " Signature = SPDM Device Sec"; - byte[] versionBytes = new byte[UefiConstants.SIZE_2]; - System.arraycopy(eventData, UefiConstants.OFFSET_16, versionBytes, 0, - UefiConstants.SIZE_2); - String version = HexUtils.byteArrayToHexString(versionBytes); - if (version.equals("0100")) { - DeviceSecurityEventData dSED = new DeviceSecurityEventData(eventData); + dSED = new DeviceSecurityEventData(eventData); spdmInfo += dSED.toString(); } - else if (version.equals("0200")) { - DeviceSecurityEventData2 dSED2 = new DeviceSecurityEventData2(eventData); - spdmInfo += dSED2.toString(); - } else { - spdmInfo += " Unknown version of DeviceSecurityEventData structure"; + spdmInfo += " Incompatible version for DeviceSecurityEventData: " + version; } } else { diff --git a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/spdm/SpdmMeasurementBlock.java b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/spdm/SpdmMeasurementBlock.java index 4b1345eb..a193dcf3 100644 --- a/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/spdm/SpdmMeasurementBlock.java +++ b/HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/spdm/SpdmMeasurementBlock.java @@ -4,6 +4,9 @@ import hirs.utils.HexUtils; import hirs.utils.tpm.eventlog.uefi.UefiConstants; import lombok.Getter; +import java.io.ByteArrayInputStream; +import java.io.IOException; + /** * Class to process the SpdmMeasurementBlock. *

@@ -42,32 +45,58 @@ public class SpdmMeasurementBlock { /** * SpdmMeasurementBlock Constructor. * - * @param spdmMeasBlockBytes byte array holding the SPDM Measurement Block bytes. + * @param spdmMeasBlocks byte array holding the SPDM Measurement Block bytes. */ - public SpdmMeasurementBlock(final byte[] spdmMeasBlockBytes) { +// public SpdmMeasurementBlock(final ByteArrayInputStream spdmMeasBlocks) { + public SpdmMeasurementBlock(final ByteArrayInputStream spdmMeasBlocks) throws IOException { byte[] indexBytes = new byte[1]; - System.arraycopy(spdmMeasBlockBytes, 0, indexBytes, 0, - 1); + spdmMeasBlocks.read(indexBytes); index = HexUtils.leReverseInt(indexBytes); byte[] measurementSpecBytes = new byte[1]; - System.arraycopy(spdmMeasBlockBytes, 1, measurementSpecBytes, 0, - 1); + spdmMeasBlocks.read(measurementSpecBytes); measurementSpec = HexUtils.leReverseInt(measurementSpecBytes); // in future, can crosscheck this measurement size with the MeasurementSpec hash alg size byte[] measurementSizeBytes = new byte[2]; - System.arraycopy(spdmMeasBlockBytes, 2, measurementSizeBytes, 0, - 2); + spdmMeasBlocks.read(measurementSizeBytes); int measurementSize = HexUtils.leReverseInt(measurementSizeBytes); byte[] measurementBytes = new byte[measurementSize]; - System.arraycopy(spdmMeasBlockBytes, 4, measurementBytes, 0, - measurementSize); + spdmMeasBlocks.read(measurementBytes); spdmMeasurement = new SpdmMeasurement(measurementBytes); } +// /** +// * SpdmMeasurementBlock Constructor. +// * +// * @param spdmMeasBlockBytes byte array holding the SPDM Measurement Block bytes. +// */ +// public SpdmMeasurementBlock(final byte[] spdmMeasBlockBytes) { +// +// byte[] indexBytes = new byte[1]; +// System.arraycopy(spdmMeasBlockBytes, 0, indexBytes, 0, +// 1); +// index = HexUtils.leReverseInt(indexBytes); +// +// byte[] measurementSpecBytes = new byte[1]; +// System.arraycopy(spdmMeasBlockBytes, 1, measurementSpecBytes, 0, +// 1); +// measurementSpec = HexUtils.leReverseInt(measurementSpecBytes); +// +// // in future, can crosscheck this measurement size with the MeasurementSpec hash alg size +// byte[] measurementSizeBytes = new byte[2]; +// System.arraycopy(spdmMeasBlockBytes, 2, measurementSizeBytes, 0, +// 2); +// int measurementSize = HexUtils.leReverseInt(measurementSizeBytes); +// +// byte[] measurementBytes = new byte[measurementSize]; +// System.arraycopy(spdmMeasBlockBytes, 4, measurementBytes, 0, +// measurementSize); +// spdmMeasurement = new SpdmMeasurement(measurementBytes); +// } + /** * Returns a human readable description of the data within this structure. *