From a0fbb4dbbb6d4865f4f4f2e280b557e516f1d47b Mon Sep 17 00:00:00 2001 From: Cyrus <24922493+cyrus-dev@users.noreply.github.com> Date: Wed, 21 Feb 2024 15:50:57 -0500 Subject: [PATCH] Updated the code to use the pci.ids files for ComponentResult --- .../certificate/ComponentResult.java | 3 + .../attestationca/persist/util/PciIds.java | 81 +++++++++++++++++++ .../CertificateAttributeScvValidator.java | 2 - .../utils/CertificateStringMapBuilder.java | 4 +- 4 files changed, 86 insertions(+), 4 deletions(-) diff --git a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/ComponentResult.java b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/ComponentResult.java index 9ecf731d..eee59c77 100644 --- a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/ComponentResult.java +++ b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/ComponentResult.java @@ -10,6 +10,7 @@ import lombok.AccessLevel; import lombok.EqualsAndHashCode; import lombok.Getter; import lombok.NoArgsConstructor; +import lombok.Setter; import java.util.LinkedList; import java.util.List; @@ -25,7 +26,9 @@ import java.util.List; public class ComponentResult extends ArchivableEntity { // embedded component info + @Setter private String manufacturer; + @Setter private String model; private String serialNumber; private String revisionNumber; diff --git a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/util/PciIds.java b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/util/PciIds.java index df421e65..d35ff26b 100644 --- a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/util/PciIds.java +++ b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/util/PciIds.java @@ -4,11 +4,13 @@ import com.github.marandus.pciid.model.Device; import com.github.marandus.pciid.model.Vendor; import com.github.marandus.pciid.service.PciIdsDatabase; import com.google.common.base.Strings; +import hirs.attestationca.persist.entity.userdefined.certificate.ComponentResult; import hirs.attestationca.persist.entity.userdefined.certificate.attributes.ComponentIdentifier; import hirs.attestationca.persist.entity.userdefined.certificate.attributes.V2.ComponentIdentifierV2; import lombok.AccessLevel; import lombok.NoArgsConstructor; +import lombok.extern.log4j.Log4j2; import org.bouncycastle.asn1.ASN1UTF8String; import org.bouncycastle.asn1.DERUTF8String; @@ -23,6 +25,7 @@ import java.util.List; /** * Provide Java access to PCI IDs. */ +@Log4j2 @NoArgsConstructor(access = AccessLevel.PRIVATE) public final class PciIds { /** @@ -52,6 +55,7 @@ public final class PciIds { String dbFile = null; for (final String path : PCI_IDS_PATH) { if ((new File(path)).exists()) { + log.info("PCI IDs file was found {}", path); dbFile = path; break; } @@ -113,6 +117,23 @@ public final class PciIds { return newList; } + /** + * Iterate through all components and translate PCI hardware IDs as necessary. It will only + * translate ComponentResults objects as it relies on Component Class information. + * @param componentResults List of ComponentResults. + * @return the translated list of ComponentResults. + */ + public static List translateResults(final List componentResults) { + List newList = new ArrayList<>(); + if (componentResults != null && !componentResults.isEmpty()) { + for (final ComponentResult componentResult : componentResults) { + newList.add(translateResult(componentResult)); + } + } + + return newList; + } + /** * Translate Vendor and Device IDs, if found, in ComponentIdentifierV2 objects. * It will only translate ID values, any other value will pass through. @@ -149,6 +170,24 @@ public final class PciIds { return newComponent; } + /** + * Translate Vendor and Device IDs, if found, in ComponentResult objects. + * It will only translate ID values, any other value will pass through. + * @param componentResult ComponentResult object. + * @return the translated ComponentResult object. + */ + public static ComponentResult translateResult(final ComponentResult componentResult) { + ComponentResult newComponent = null; + if (componentResult != null) { + newComponent = componentResult; + + newComponent.setManufacturer(translateVendor(componentResult.getManufacturer())); + newComponent.setModel(translateDevice(componentResult.getManufacturer(), + componentResult.getModel())); + } + return newComponent; + } + /** * Look up the vendor name from the PCI IDs list, if the input string contains an ID. * If any part of this fails, return the original manufacturer value. @@ -166,6 +205,23 @@ public final class PciIds { return manufacturer; } + /** + * Look up the vendor name from the PCI IDs list, if the input string contains an ID. + * If any part of this fails, return the original manufacturer value. + * @param refManufacturer String, likely from a ComponentResult + * @return String with the discovered vendor name, or the original manufacturer value. + */ + public static String translateVendor(final String refManufacturer) { + String manufacturer = refManufacturer; + if (manufacturer != null && manufacturer.trim().matches("^[0-9A-Fa-f]{4}$")) { + Vendor ven = DB.findVendor(manufacturer.toLowerCase()); + if (ven != null && !Strings.isNullOrEmpty(ven.getName())) { + manufacturer = ven.getName(); + } + } + return manufacturer; + } + /** * Look up the device name from the PCI IDs list, if the input strings contain IDs. * The Device lookup requires the Vendor ID AND the Device ID to be valid values. @@ -190,4 +246,29 @@ public final class PciIds { } return model; } + + /** + * Look up the device name from the PCI IDs list, if the input strings contain IDs. + * The Device lookup requires the Vendor ID AND the Device ID to be valid values. + * If any part of this fails, return the original model value. + * @param refManufacturer String, likely from a ComponentResult + * @param refModel String, likely from a ComponentResult + * @return String with the discovered device name, or the original model value. + */ + public static String translateDevice(final String refManufacturer, + final String refModel) { + String manufacturer = refManufacturer; + String model = refModel; + if (manufacturer != null + && model != null + && manufacturer.trim().matches("^[0-9A-Fa-f]{4}$") + && model.trim().matches("^[0-9A-Fa-f]{4}$")) { + Device dev = DB.findDevice(manufacturer.toLowerCase(), + model.toLowerCase()); + if (dev != null && !Strings.isNullOrEmpty(dev.getName())) { + model = dev.getName(); + } + } + return model; + } } diff --git a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/validation/CertificateAttributeScvValidator.java b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/validation/CertificateAttributeScvValidator.java index 0ea947b8..c3593a51 100644 --- a/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/validation/CertificateAttributeScvValidator.java +++ b/HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/validation/CertificateAttributeScvValidator.java @@ -460,7 +460,6 @@ public class CertificateAttributeScvValidator extends SupplyChainCredentialValid List componentInfoList = getV2PaccorOutput(paccorOutputString); // this is what I want to rewrite unmatchedComponents = validateV2PlatformCredentialAttributes( - certificateId, baseCompList, componentInfoList); fieldValidation &= unmatchedComponents.isEmpty(); @@ -496,7 +495,6 @@ public class CertificateAttributeScvValidator extends SupplyChainCredentialValid } private static String validateV2PlatformCredentialAttributes( - final UUID certificateId, final List fullDeltaChainComponents, final List allDeviceInfoComponents) { ComponentIdentifierV2 ciV2; diff --git a/HIRS_AttestationCAPortal/src/main/java/hirs/attestationca/portal/page/utils/CertificateStringMapBuilder.java b/HIRS_AttestationCAPortal/src/main/java/hirs/attestationca/portal/page/utils/CertificateStringMapBuilder.java index 9e01190c..b6bf0a49 100644 --- a/HIRS_AttestationCAPortal/src/main/java/hirs/attestationca/portal/page/utils/CertificateStringMapBuilder.java +++ b/HIRS_AttestationCAPortal/src/main/java/hirs/attestationca/portal/page/utils/CertificateStringMapBuilder.java @@ -363,8 +363,8 @@ public final class CertificateStringMapBuilder { data.put("x509Version", certificate.getX509CredentialVersion()); //CPSuri data.put("CPSuri", certificate.getCPSuri()); - data.put("componentResults", componentResultRepository - .findByBoardSerialNumber(certificate.getPlatformSerial())); + data.put("componentResults", PciIds.translateResults(componentResultRepository + .findByBoardSerialNumber(certificate.getPlatformSerial()))); //Get platform Configuration values and set map with it