View Javadoc
1   /**
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.swid.builder.resource.firmware;
28  
29  import gov.nist.secauto.swid.builder.resource.HashAlgorithm;
30  import gov.nist.secauto.swid.builder.resource.HashUtils;
31  
32  import java.io.File;
33  import java.io.IOException;
34  import java.io.InputStream;
35  import java.security.NoSuchAlgorithmException;
36  import java.util.Objects;
37  
38  public class FirmwarePayloadDigest {
39    private final DigestType type;
40    private final HashAlgorithm algorithm;
41    private final byte[] value;
42    private final byte[] guidance;
43  
44    public FirmwarePayloadDigest(DigestType type, HashAlgorithm algorithm, File file)
45        throws NoSuchAlgorithmException, IOException {
46      this(type, algorithm, HashUtils.hash(algorithm, file));
47    }
48  
49    public FirmwarePayloadDigest(DigestType type, HashAlgorithm algorithm, File file, byte[] guidance)
50        throws NoSuchAlgorithmException, IOException {
51      this(type, algorithm, HashUtils.hash(algorithm, file), guidance);
52    }
53  
54    public FirmwarePayloadDigest(DigestType type, HashAlgorithm algorithm, InputStream is)
55        throws NoSuchAlgorithmException, IOException {
56      this(type, algorithm, HashUtils.hash(algorithm, is));
57    }
58  
59    public FirmwarePayloadDigest(DigestType type, HashAlgorithm algorithm, InputStream is, byte[] guidance)
60        throws NoSuchAlgorithmException, IOException {
61      this(type, algorithm, HashUtils.hash(algorithm, is), guidance);
62    }
63  
64    public FirmwarePayloadDigest(DigestType type, HashAlgorithm algorithm, byte[] value) {
65      this(type, algorithm, value, null);
66    }
67  
68    public FirmwarePayloadDigest(DigestType type, HashAlgorithm algorithm, byte[] value, byte[] guidance) {
69      super();
70      Objects.requireNonNull(type, "type");
71      Objects.requireNonNull(algorithm, "algorithm");
72      Objects.requireNonNull(value, "value");
73      this.type = type;
74      this.algorithm = algorithm;
75      this.value = value;
76      this.guidance = guidance;
77    }
78  
79    /**
80     * @return the type
81     */
82    public DigestType getType() {
83      return type;
84    }
85  
86    /**
87     * @return the algorithm
88     */
89    public HashAlgorithm getAlgorithm() {
90      return algorithm;
91    }
92  
93    /**
94     * @return the value
95     */
96    public byte[] getValue() {
97      return value;
98    }
99  
100   /**
101    * @return the guidance
102    */
103   public byte[] getGuidance() {
104     return guidance;
105   }
106 }