ExternalVendorCode/HIRS
1
0
Fork 0
mirror of https://github.com/nsacyber/HIRS.git synced 2024-12-19 21:17:59 +00:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

This commit sets up the suppression filter file. The locations previous

Browse Source 
established have been removed.  The configuration is the root directory
This commit is contained in:
Cyrus 2024-02-05 10:50:12 -05:00
parent c6f5fc26e3
commit e819dad52b
12 changed files with 47 additions and 276 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
HIRS_AttestationCA/config/checkstyle/suppressions.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.2//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress checks="MagicNumber" files=".*[/\\]src[/\\]test[/\\]+" />
<suppress checks="FinalParameters" files=".*[/\\]src[/\\]test[/\\]+" />
<suppress checks="JavadocPackage" files=".*[/\\]src[/\\]test[/\\]+" />
<!-- <suppress files="src/main/java/hirs/attestationca/configuration/provisionerTpm2/ProvisionerTpm2\.java" checks="[a-zA-Z0-9]*"/>-->
<suppress files="[\\/]hirs[\\/]attestationca[\\/]configuration[\\/]provisionerTpm2[\\/]ProvisionerTpm2" checks="."/>
</suppressions>

9
HIRS_AttestationCAPortal/config/checkstyle/suppressions.xml
View File

@ -1,9 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.2//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress checks="MagicNumber" files=".*[/\\]src[/\\]test[/\\]+" />
</suppressions>

9
HIRS_Structs/config/checkstyle/suppressions.xml
View File

@ -1,9 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.2//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress checks="MagicNumber" files=".*[/\\]src[/\\]test[/\\]+" />
</suppressions>

11
HIRS_Utils/config/checkstyle/suppressions.xml
View File

@ -1,11 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.2//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress checks="MagicNumber" files=".*[/\\]src[/\\]test[/\\]+" />
<suppress checks="FinalParameters" files=".*[/\\]src[/\\]test[/\\]+" />
<suppress checks="JavadocPackage" files=".*[/\\]src[/\\]test[/\\]+" />
</suppressions>

12
HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiBootVariable.java
View File

@ -59,11 +59,14 @@ public class UefiBootVariable {
System.arraycopy(bootVar, UefiConstants.OFFSET_6, blob, 0, blobLength); System.arraycopy(bootVar, UefiConstants.OFFSET_6, blob, 0, blobLength);
int descLength = getChar16ArrayLength(blob); int descLength = getChar16ArrayLength(blob);
byte[] desc = new byte[descLength * UefiConstants.SIZE_2]; byte[] desc = new byte[descLength * UefiConstants.SIZE_2];
System.arraycopy(bootVar, UefiConstants.OFFSET_6, desc, 0, descLength * UefiConstants.SIZE_2); System.arraycopy(bootVar, UefiConstants.OFFSET_6, desc, 0,
description = new String(UefiDevicePath.convertChar16tobyteArray(desc), StandardCharsets.UTF_8); descLength * UefiConstants.SIZE_2);
description = new String(UefiDevicePath.convertChar16tobyteArray(desc),
StandardCharsets.UTF_8);
// Data following the Description should be EFI Partition Data (EFI_DEVICE_PATH_PROTOCOL) // Data following the Description should be EFI Partition Data (EFI_DEVICE_PATH_PROTOCOL)
int devPathLength = blobLength; int devPathLength = blobLength;
int devPathOffset = UefiConstants.OFFSET_6 + descLength; //attributes+bloblength+desc+length+2 //attributes+bloblength+desc+length+2
int devPathOffset = UefiConstants.OFFSET_6 + descLength;
byte[] devPath = new byte[devPathLength]; byte[] devPath = new byte[devPathLength];
System.arraycopy(bootVar, devPathOffset, devPath, 0, devPathLength); System.arraycopy(bootVar, devPathOffset, devPath, 0, devPathLength);
efiDevPath = new UefiDevicePath(devPath); efiDevPath = new UefiDevicePath(devPath);
@ -79,7 +82,8 @@ public class UefiBootVariable {
*/ */
public String toString() { public String toString() {
StringBuilder bootInfo = new StringBuilder("Description = "); StringBuilder bootInfo = new StringBuilder("Description = ");
String bootVar = description.replaceAll("[^a-zA-Z_0-0\\s]", ""); // remove all non ascii chars // remove all non ascii chars
String bootVar = description.replaceAll("[^a-zA-Z_0-0\\s]", "");
bootInfo.append(bootVar + "\n" + efiDevPath.toString()); bootInfo.append(bootVar + "\n" + efiDevPath.toString());
return bootInfo.toString(); return bootInfo.toString();
} }

8
HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiGuid.java
View File

@ -65,6 +65,8 @@ public class UefiGuid {
* Converts a GUID with a byte array to a RFC-1422 UUID object. * Converts a GUID with a byte array to a RFC-1422 UUID object.
* Assumes a MS format and converts to Big Endian format used by most others , including Linux * Assumes a MS format and converts to Big Endian format used by most others , including Linux
* Matched uuids found in /sys/firmware/efi/efivars on Centos 7. * Matched uuids found in /sys/firmware/efi/efivars on Centos 7.
* @param guid byte array holding the guid data.
* @return UUID processed from the passed in guid
*/ */
private static UUID processGuid(final byte[] guid) { private static UUID processGuid(final byte[] guid) {
byte[] msb1 = new byte[UefiConstants.SIZE_4]; byte[] msb1 = new byte[UefiConstants.SIZE_4];
@ -181,10 +183,10 @@ public class UefiGuid {
/** /**
* Retrieves the timestamp within a time based GUID. * Retrieves the timestamp within a time based GUID.
* *
* @param uuid uuid object * @param uuidTimeStamp uuid object
* @return long representing the time stamp from the GUID * @return long representing the time stamp from the GUID
*/ */
public long getTimeFromUUID(final UUID uuid) { public long getTimeFromUUID(final UUID uuidTimeStamp) {
return (uuid.timestamp() - UUID_EPOCH_INTERVALS) / UUID_EPOCH_DIVISOR; return (uuidTimeStamp.timestamp() - UUID_EPOCH_INTERVALS) / UUID_EPOCH_DIVISOR;
} }
} }

31
HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiVariable.java
View File

@ -61,9 +61,12 @@ public class UefiVariable {
* the class used to parse the data within the "VariableData". * the class used to parse the data within the "VariableData".
* *
* @param variableData byte array holding the UEFI Variable. * @param variableData byte array holding the UEFI Variable.
* @throws java.security.cert.CertificateException If there a problem parsing the X509 certificate. * @throws java.security.cert.CertificateException If there a problem
* @throws java.security.NoSuchAlgorithmException if there's a problem hashing the certificate. * parsing the X509 certificate.
* @throws java.io.IOException If there's a problem parsing the signature data. * @throws java.security.NoSuchAlgorithmException if there's a problem
* hashing the certificate.
* @throws java.io.IOException If there's a problem
* parsing the signature data.
*/ */
public UefiVariable(final byte[] variableData) public UefiVariable(final byte[] variableData)
throws CertificateException, NoSuchAlgorithmException, IOException { throws CertificateException, NoSuchAlgorithmException, IOException {
@ -77,9 +80,11 @@ public class UefiVariable {
System.arraycopy(variableData, 0, guid, 0, UefiConstants.SIZE_16); System.arraycopy(variableData, 0, guid, 0, UefiConstants.SIZE_16);
uefiVarGuid = new UefiGuid(guid); uefiVarGuid = new UefiGuid(guid);
System.arraycopy(variableData, UefiConstants.SIZE_16, nameLength, 0, UefiConstants.SIZE_8); System.arraycopy(variableData, UefiConstants.SIZE_16, nameLength,
0, UefiConstants.SIZE_8);
int nlength = HexUtils.leReverseInt(nameLength); int nlength = HexUtils.leReverseInt(nameLength);
System.arraycopy(variableData, UefiConstants.OFFSET_24, dataLength, 0, UefiConstants.SIZE_8); System.arraycopy(variableData, UefiConstants.OFFSET_24, dataLength,
0, UefiConstants.SIZE_8);
nameTemp = new byte[nlength * UefiConstants.SIZE_2]; nameTemp = new byte[nlength * UefiConstants.SIZE_2];
System.arraycopy(variableData, UefiConstants.OFFSET_32, System.arraycopy(variableData, UefiConstants.OFFSET_32,
@ -120,9 +125,12 @@ public class UefiVariable {
* Processes the data as a UEFI defined Signature List. * Processes the data as a UEFI defined Signature List.
* *
* @param data the bye array holding the Signature List. * @param data the bye array holding the Signature List.
* @throws java.security.cert.CertificateException If there a problem parsing the X509 certificate. * @throws java.security.cert.CertificateException If there a problem
* @throws java.security.NoSuchAlgorithmException if there's a problem hashing the certificate. * parsing the X509 certificate.
* @throws java.io.IOException If there's a problem parsing the signature data. * @throws java.security.NoSuchAlgorithmException if there's a problem
* hashing the certificate.
* @throws java.io.IOException If there's a problem
* parsing the signature data.
*/ */
private void processSigList(final byte[] data) private void processSigList(final byte[] data)
throws CertificateException, NoSuchAlgorithmException, IOException { throws CertificateException, NoSuchAlgorithmException, IOException {
@ -168,8 +176,8 @@ public class UefiVariable {
break; break;
default: default:
if (!tmpName.isEmpty()) { if (!tmpName.isEmpty()) {
efiVariable.append(String.format("Data not provided for UEFI variable named %s ", efiVariable.append(String.format("Data not provided for "
tmpName)); + "UEFI variable named %s ", tmpName));
} else { } else {
efiVariable.append("Data not provided "); efiVariable.append("Data not provided ");
} }
@ -190,7 +198,8 @@ public class UefiVariable {
public String printCert(final byte[] data, final int offset) { public String printCert(final byte[] data, final int offset) {
String certInfo = ""; String certInfo = "";
byte[] certLength = new byte[UefiConstants.SIZE_2]; byte[] certLength = new byte[UefiConstants.SIZE_2];
System.arraycopy(data, offset + UefiConstants.OFFSET_2, certLength, 0, UefiConstants.SIZE_2); System.arraycopy(data, offset + UefiConstants.OFFSET_2, certLength,
0, UefiConstants.SIZE_2);
int cLength = new BigInteger(certLength).intValue() + UefiConstants.SIZE_4; int cLength = new BigInteger(certLength).intValue() + UefiConstants.SIZE_4;
byte[] certData = new byte[cLength]; byte[] certData = new byte[cLength];
System.arraycopy(data, offset, certData, 0, cLength); System.arraycopy(data, offset, certData, 0, cLength);

3
HIRS_Utils/src/main/java/hirs/utils/tpm/eventlog/uefi/UefiX509Cert.java
View File

@ -27,7 +27,8 @@ public class UefiX509Cert {
* @throws java.security.cert.CertificateException If the certificate cannot parse. * @throws java.security.cert.CertificateException If the certificate cannot parse.
* @throws java.security.NoSuchAlgorithmException if a hash cannot be generated from the cert. * @throws java.security.NoSuchAlgorithmException if a hash cannot be generated from the cert.
*/ */
public UefiX509Cert(final byte[] certData) throws CertificateException, NoSuchAlgorithmException { public UefiX509Cert(final byte[] certData) throws CertificateException,
NoSuchAlgorithmException {
CertificateFactory cf; CertificateFactory cf;
cf = CertificateFactory.getInstance("X.509"); cf = CertificateFactory.getInstance("X.509");
InputStream targetStream = new ByteArrayInputStream(certData); InputStream targetStream = new ByteArrayInputStream(certData);

10
config/checkstyle/checkstyle.xml
View File

@ -49,10 +49,10 @@
</module> </module>
<!-- https://checkstyle.org/filters/suppressionfilter.html --> <!-- https://checkstyle.org/filters/suppressionfilter.html -->
<!-- <module name="SuppressionFilter">--> <module name="SuppressionFilter">
<!-- <property name="file" value="${org.checkstyle.google.suppressionfilter.config}" default="${rootDir}/config/checkstyle/suppressions.xml"/>--> <property name="file" value="${config_loc}/suppressions.xml"/>
<!-- <property name="optional" value="false"/>--> <property name="optional" value="false"/>
<!-- </module>--> </module>
<!-- Checks that a package-info.java file exists for each package. --> <!-- Checks that a package-info.java file exists for each package. -->
<!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage --> <!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage -->
@ -189,4 +189,4 @@
</module> </module>
</module> </module>

190
config/checkstyle/sun_checks.xml
View File

@ -1,190 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
"https://checkstyle.org/dtds/configuration_1_3.dtd">
<!--
Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at
https://docs.oracle.com/javase/specs/jls/se11/html/index.html
- the Sun Code Conventions at https://www.oracle.com/java/technologies/javase/codeconventions-contents.html
- the Javadoc guidelines at
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
- the JDK Api documentation https://docs.oracle.com/en/java/javase/11/
- some best practices
Checkstyle is very configurable. Be sure to read the documentation at
https://checkstyle.org (or in your downloaded distribution).
Most Checks are configurable, be sure to consult the documentation.
To completely disable a check, just comment it out or delete it from the file.
To suppress certain violations please review suppression filters.
Finally, it is worth reading the documentation.
-->
<module name="Checker">
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
https://checkstyle.org/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->
<property name="severity" value="error"/>
<property name="fileExtensions" value="java, properties, xml"/>
<!-- Excludes all 'module-info.java' files -->
<!-- See https://checkstyle.org/filefilters/index.html -->
<module name="BeforeExecutionExclusionFileFilter">
<property name="fileNamePattern" value="module\-info\.java$"/>
</module>
<!-- https://checkstyle.org/filters/suppressionfilter.html -->
<module name="SuppressionFilter">
<property name="file" value="${basedir}/suppressions.xml"/>
<property name="optional" value="true"/>
</module>
<!-- Checks that a package-info.java file exists for each package. -->
<!-- See https://checkstyle.org/checks/javadoc/javadocpackage.html#JavadocPackage -->
<module name="JavadocPackage"/>
<!-- Checks whether files end with a new line. -->
<!-- See https://checkstyle.org/checks/misc/newlineatendoffile.html -->
<module name="NewlineAtEndOfFile"/>
<!-- Checks that property files contain the same keys. -->
<!-- See https://checkstyle.org/checks/misc/translation.html -->
<module name="Translation"/>
<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/checks/sizes/index.html -->
<module name="FileLength"/>
<module name="LineLength">
<property name="fileExtensions" value="java"/>
</module>
<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<module name="FileTabCharacter"/>
<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/checks/misc/index.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>
<!-- Checks for Headers -->
<!-- See https://checkstyle.org/checks/header/index.html -->
<!-- <module name="Header"> -->
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
<!-- <property name="fileExtensions" value="java"/> -->
<!-- </module> -->
<module name="TreeWalker">
<!-- Checks for Javadoc comments. -->
<!-- See https://checkstyle.org/checks/javadoc/index.html -->
<module name="InvalidJavadocPosition"/>
<module name="JavadocMethod"/>
<module name="JavadocType"/>
<module name="JavadocVariable"/>
<module name="JavadocStyle"/>
<module name="MissingJavadocMethod"/>
<!-- Checks for Naming Conventions. -->
<!-- See https://checkstyle.org/checks/naming/index.html -->
<module name="ConstantName"/>
<module name="LocalFinalVariableName"/>
<module name="LocalVariableName"/>
<module name="MemberName"/>
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName"/>
<module name="StaticVariableName"/>
<module name="TypeName"/>
<!-- Checks for imports -->
<!-- See https://checkstyle.org/checks/imports/index.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
<module name="RedundantImport"/>
<module name="UnusedImports">
<property name="processJavadoc" value="false"/>
</module>
<!-- Checks for Size Violations. -->
<!-- See https://checkstyle.org/checks/sizes/index.html -->
<module name="MethodLength"/>
<module name="ParameterNumber"/>
<!-- Checks for whitespace -->
<!-- See https://checkstyle.org/checks/whitespace/index.html -->
<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap"/>
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAfter"/>
<module name="WhitespaceAround"/>
<!-- Modifier Checks -->
<!-- See https://checkstyle.org/checks/modifier/index.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>
<!-- Checks for blocks. You know, those {}'s -->
<!-- See https://checkstyle.org/checks/blocks/index.html -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"/>
<module name="RightCurly"/>
<!-- Checks for common coding problems -->
<!-- See https://checkstyle.org/checks/coding/index.html -->
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="HiddenField"/>
<module name="IllegalInstantiation"/>
<module name="InnerAssignment"/>
<module name="MagicNumber"/>
<module name="MissingSwitchDefault"/>
<module name="MultipleVariableDeclarations"/>
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<!-- Checks for class design -->
<!-- See https://checkstyle.org/checks/design/index.html -->
<module name="DesignForExtension"/>
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<module name="InterfaceIsType"/>
<module name="VisibilityModifier"/>
<!-- Miscellaneous other checks. -->
<!-- See https://checkstyle.org/checks/misc/index.html -->
<module name="ArrayTypeStyle"/>
<module name="FinalParameters"/>
<module name="TodoComment"/>
<module name="UpperEll"/>
</module>
</module>

13
config/checkstyle/suppressions.xml
View File

@ -5,11 +5,12 @@
"http://www.puppycrawl.com/dtds/suppressions_1_2.dtd"> "http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
<suppressions> <suppressions>
<!-- Ignore Auto generated files -->
<suppress files="[/\\]hirs[/\\]utils[/\\]xjc[/\\]" checks=".*" />
<suppress files="ProvisionerTpm2.java" checks=".*" />
<suppress checks="MagicNumber" files=".*[/\\]src[/\\]test[/\\]+" /> <!-- HIRS_Utils -->
<suppress checks="FinalParameters" files=".*[/\\]src[/\\]test[/\\]+" /> <!-- This ignores checking all public variable for a javadoc -->
<suppress checks="JavadocPackage" files=".*[/\\]src[/\\]test[/\\]+" /> <suppress files="SwidTagConstants.java" checks="LineLength" />
<!-- <suppress files="src/main/java/hirs/attestationca/configuration/provisionerTpm2/ProvisionerTpm2\.java" checks="[a-zA-Z0-9]*"/>--> <suppress files="SwidTagConstants.java" checks="JavadocVariable" />
<suppress files="[\\/]hirs[\\/]attestationca[\\/]configuration[\\/]provisionerTpm2[\\/]ProvisionerTpm2" checks="."/>
</suppressions> </suppressions>

12
tools/tcg_eventlog_tool/config/checkstyle/suppressions.xml
View File

@ -1,12 +0,0 @@
<?xml version="1.0"?>
<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.2//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_2.dtd">
<suppressions>
<suppress files="Main.java" checks="HideUtilityClassConstructor" />
<suppress checks="MagicNumber" files=".*[/\\]src[/\\]test[/\\]+" />
<suppress checks="FinalParameters" files=".*[/\\]src[/\\]test[/\\]+" />
<suppress checks="JavadocPackage" files=".*[/\\]src[/\\]test[/\\]+" />
</suppressions>