issue_896: deleted abstract plat form config class, replaced it with plat config v1 (which already exists), moved attribuutes associated with v2 to the v2 class, when validating the aca will now verify if the platform config associated with the cert is v1 or v2. Made corrections to attributes names to better align with tcg docs.

Author: ThatSilentCoder

Diff for: HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/ComponentResult.java

@@ -98,7 +98,7 @@ public class ComponentResult extends ArchivableEntity {
      *
      * @param boardSerialNumber       associated platform certificate serial number.
      * @param certificateSerialNumber unique number associated with header info.
-     * @param certificateType         parameter holds version 1.2 or 2.0.
+     * @param certificateType         type of certificate. parameter holds version 1.2 or 2.0.
      * @param componentIdentifier     object with information from the platform certificate components.
      */
     public ComponentResult(final String boardSerialNumber, final String certificateSerialNumber,
@@ -116,18 +116,18 @@ public ComponentResult(final String boardSerialNumber, final String certificateS
         }
 
         StringBuilder sb = new StringBuilder();
-        for (ComponentAddress element : componentIdentifier.getComponentAddress()) {
+        for (ComponentAddress element : componentIdentifier.getComponentAddresses()) {
             sb.append(String.format("%s:%s;", element.getAddressTypeValue(),
                     element.getAddressValue().toString()));
         }
         componentAddress = sb.toString();
     }
 
     /**
-     * @param boardSerialNumber
-     * @param certificateSerialNumber
-     * @param certificateType
-     * @param componentIdentifierV2
+     * @param boardSerialNumber       associated platform certificate serial number
+     * @param certificateSerialNumber unique number associated with header info
+     * @param certificateType         type of certificate. Parameter holds version 1.2 or 2.0.
+     * @param componentIdentifierV2   version 2 component identifier
      */
     public ComponentResult(final String boardSerialNumber, final String certificateSerialNumber,
                            final String certificateType,
@@ -145,7 +145,7 @@ public ComponentResult(final String boardSerialNumber, final String certificateS
         }
 
         StringBuilder sb = new StringBuilder();
-        for (ComponentAddress element : componentIdentifierV2.getComponentAddress()) {
+        for (ComponentAddress element : componentIdentifierV2.getComponentAddresses()) {
             sb.append(String.format("%s:%s;", element.getAddressTypeValue(),
                     element.getAddressValue().toString()));
         }
@@ -156,10 +156,10 @@ public ComponentResult(final String boardSerialNumber, final String certificateS
         this.componentClassType = componentIdentifierV2.getComponentClass().getRegistryType();
         this.attributeStatus = componentIdentifierV2.getAttributeStatus();
         this.version2 = true;
-        if (componentIdentifierV2.getCertificateIdentifier() != null) {
-            this.issuerDN = componentIdentifierV2.getCertificateIdentifier().getIssuerDN().toString();
-            if (componentIdentifierV2.getComponentPlatformUri() != null) {
-                this.uniformResourceIdentifier = componentIdentifierV2.getComponentPlatformUri()
+        if (componentIdentifierV2.getComponentPlatformCert() != null) {
+            this.issuerDN = componentIdentifierV2.getComponentPlatformCert().getIssuerDN().toString();
+            if (componentIdentifierV2.getComponentPlatformCertUri() != null) {
+                this.uniformResourceIdentifier = componentIdentifierV2.getComponentPlatformCertUri()
                         .getUniformResourceIdentifier().toString();
             }
         }

Diff for: HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/PlatformCredential.java

@@ -2,7 +2,6 @@
 
 import com.google.common.base.Preconditions;
 import hirs.attestationca.persist.entity.userdefined.certificate.attributes.ComponentIdentifier;
-import hirs.attestationca.persist.entity.userdefined.certificate.attributes.PlatformConfiguration;
 import hirs.attestationca.persist.entity.userdefined.certificate.attributes.PlatformConfigurationV1;
 import hirs.attestationca.persist.entity.userdefined.certificate.attributes.TBBSecurityAssertion;
 import hirs.attestationca.persist.entity.userdefined.certificate.attributes.URIReference;
@@ -261,8 +260,8 @@ public static PlatformCredential parseWithPossibleHeader(final byte[] certificat
     /**
      * Verify if the AlgorithmIdentifiers are equal.
      *
-     * @param id1 AlgorithIdentifier one
-     * @param id2 AlgorithIdentifier two
+     * @param id1 Algorithm Identifier one
+     * @param id2 Algorithm Identifier two
      * @return True if are the same, False if not
      */
     public static boolean isAlgIdEqual(final AlgorithmIdentifier id1,
@@ -356,7 +355,7 @@ public boolean isSignatureValid(final ContentVerifierProvider verifierProvider)
     }
 
     /**
-     * @throws IOException
+     * Parses the Platform Certificate fields.
      */
     private void parseFields() throws IOException {
         AttributeCertificateInfo certificate = getAttributeCertificate().getAcinfo();
@@ -412,7 +411,7 @@ private void parseFields() throws IOException {
     }
 
     /**
-     * Parse a 1.2 Platform Certificate (Attribute Certificate).
+     * Parses a 1.2 Platform Certificate (Attribute Certificate).
      *
      * @param certificate Attribute Certificate
      */
@@ -465,7 +464,7 @@ private void parseAttributeCert(final AttributeCertificateInfo certificate) {
     }
 
     /**
-     * Parse a 2.0 Platform Certificate (Attribute Certificate).
+     * Parses a 2.0 Platform Certificate (Attribute Certificate).
      *
      * @param certificate Attribute Certificate
      */
@@ -514,7 +513,7 @@ private void parseAttributeCert2(final AttributeCertificateInfo certificate)
     }
 
     /**
-     * Get the x509 Platform Certificate version.
+     * Retrieves the x509 Platform Certificate version.
      *
      * @return a big integer representing the certificate version.
      */
@@ -533,7 +532,7 @@ public int getX509CredentialVersion() {
     }
 
     /**
-     * Get the cPSuri from the Certificate Policies.
+     * Retrieves the cPSuri from the Certificate Policies.
      *
      * @return cPSuri from the CertificatePolicies.
      * @throws IOException when reading the certificate.
@@ -549,7 +548,7 @@ public String getCPSuri() throws IOException {
     }
 
     /**
-     * Get the Platform Configuration Attribute from the Platform Certificate.
+     * Retrieves the Platform Configuration Attribute from the Platform Certificate.
      *
      * @return a map with all the attributes
      * @throws IllegalArgumentException when there is a parsing error
@@ -618,12 +617,12 @@ public Object getAttribute(final String attributeName)
      * @throws IllegalArgumentException when there is a parsing error
      * @throws IOException              when reading the certificate.
      */
-    public PlatformConfiguration getPlatformConfiguration()
+    public PlatformConfigurationV1 getPlatformConfigurationV1()
             throws IllegalArgumentException, IOException {
 
         if (getAttribute("platformConfiguration") != null
-                && getAttribute("platformConfiguration") instanceof PlatformConfiguration) {
-            return (PlatformConfiguration) getAttribute("platformConfiguration");
+                && getAttribute("platformConfiguration") instanceof PlatformConfigurationV1) {
+            return (PlatformConfigurationV1) getAttribute("platformConfiguration");
         }
 
         return null;
@@ -710,15 +709,15 @@ private void getTCGCredentialSpecification(final ASN1Sequence attributeSequence)
     }
 
     /**
-     * Get the list of component identifiers if there are any.
+     * Retrieves the list of component identifiers if there are any.
      *
      * @return the list of component identifiers if there are any
      */
     public List<ComponentIdentifier> getComponentIdentifiers() {
         try {
-            PlatformConfiguration platformConfig = getPlatformConfiguration();
+            PlatformConfigurationV1 platformConfig = getPlatformConfigurationV1();
             if (platformConfig != null) {
-                return platformConfig.getComponentIdentifier();
+                return platformConfig.getComponentIdentifiers();
             }
         } catch (IOException e) {
             log.error("Unable to parse Platform Configuration from Platform Credential or find"
@@ -728,15 +727,16 @@ public List<ComponentIdentifier> getComponentIdentifiers() {
     }
 
     /**
-     * Get the list of version 2 component identifiers if there are any.
+     * Retrieves the list of version 2 component identifiers if there are any.
      *
      * @return the list of version 2 component identifiers if there are any
      */
     public List<ComponentIdentifierV2> getComponentIdentifiersV2() {
         try {
             PlatformConfigurationV2 platformConfigV2 = getPlatformConfigurationV2();
+
             if (platformConfigV2 != null) {
-                return platformConfigV2.getComponentIdentifierV2();
+                return platformConfigV2.getComponentIdentifiers();
             }
         } catch (IOException e) {
             log.error("Unable to parse Platform Configuration Version 2 from Platform Credential or find"

Diff for: HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/attributes/ComponentAddress.java

@@ -8,9 +8,9 @@
 import org.bouncycastle.asn1.ASN1UTF8String;
 
 /**
- * Basic class that handle component addresses from the component identifier.
+ * Basic class that represents the component addresses from the component identifier object.
  * <pre>
- * componentAddress ::= SEQUENCE {
+ * componentAddresses ::= SEQUENCE {
  *      addressType AddressType,
  *      addressValue UTF8String (SIZE (1..STRMAX)) }
  * where STRMAX is 256

Diff for: HIRS_AttestationCA/src/main/java/hirs/attestationca/persist/entity/userdefined/certificate/attributes/ComponentIdentifier.java

@@ -16,8 +16,8 @@
 import java.util.stream.Collectors;
 
 /**
- * Basic class that handle component identifiers from the Platform Configuration
- * Attribute.
+ * Basic class that represents version 1 of the component identifiers from the Version 1
+ * Platform Configuration Attribute.
  * <pre>
  * ComponentIdentifier ::= SEQUENCE {
  *      componentManufacturer UTF8String (SIZE (1..STRMAX)),
@@ -26,7 +26,7 @@
  *      componentRevision [1] IMPLICIT UTF8String (SIZE (1..STRMAX)) OPTIONAL,
  *      componentManufacturerId [2] IMPLICIT PrivateEnterpriseNumber OPTIONAL,
  *      fieldReplaceable [3] IMPLICIT BOOLEAN OPTIONAL,
- *      componentAddress [4] IMPLICIT
+ *      componentAddresses [4] IMPLICIT
  *          SEQUENCE(SIZE(1..CONFIGMAX)) OF ComponentAddress OPTIONAL}
  * where STRMAX is 256, CONFIGMAX is 32
  * </pre>
@@ -80,7 +80,7 @@ public class ComponentIdentifier {
 
     private ASN1Boolean fieldReplaceable;
 
-    private List<ComponentAddress> componentAddress;
+    private List<ComponentAddress> componentAddresses;
 
     private boolean validationResult = true;
 
@@ -94,7 +94,7 @@ public ComponentIdentifier() {
         componentRevision = new DERUTF8String(NOT_SPECIFIED_COMPONENT);
         componentManufacturerId = null;
         fieldReplaceable = null;
-        componentAddress = new ArrayList<>();
+        componentAddresses = new ArrayList<>();
     }
 
     /**
@@ -121,7 +121,7 @@ public ComponentIdentifier(final DERUTF8String componentManufacturer,
         this.componentRevision = componentRevision;
         this.componentManufacturerId = componentManufacturerId;
         this.fieldReplaceable = fieldReplaceable;
-        this.componentAddress = componentAddress.stream().toList();
+        this.componentAddresses = componentAddress.stream().toList();
     }
 
     /**
@@ -160,7 +160,7 @@ public ComponentIdentifier(final ASN1Sequence sequence) throws IllegalArgumentEx
                     break;
                 case COMPONENT_ADDRESS:
                     ASN1Sequence addressesSequence = ASN1Sequence.getInstance(taggedObj, false);
-                    componentAddress = retrieveComponentAddress(addressesSequence);
+                    componentAddresses = retrieveComponentAddress(addressesSequence);
                     break;
                 default:
                     throw new IllegalArgumentException("Component identifier contains "
@@ -229,14 +229,14 @@ public String toString() {
         if (fieldReplaceable != null) {
             sb.append(fieldReplaceable);
         }
-        sb.append(", componentAddress=");
-        if (!componentAddress.isEmpty()) {
-            sb.append(componentAddress
+        sb.append(", componentAddresses=");
+        if (!componentAddresses.isEmpty()) {
+            sb.append(componentAddresses
                     .stream()
                     .map(Object::toString)
                     .collect(Collectors.joining(",")));
         }
-        sb.append(", certificateIdentifier=");
+        sb.append(", componentPlatformCert=");
         sb.append("}");
 
         return sb.toString();