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.swidval;
28  
29  import gov.nist.secauto.decima.xml.document.XMLDocument;
30  import gov.nist.secauto.decima.xml.document.XPathEvaluator;
31  import gov.nist.secauto.decima.xml.document.XPathNamespaceContext;
32  
33  import java.util.Objects;
34  
35  import javax.xml.xpath.XPathConstants;
36  import javax.xml.xpath.XPathExpressionException;
37  import javax.xml.xpath.XPathFactoryConfigurationException;
38  
39  public class SWIDTagCharacteristics {
40    /**
41     * Detects the SWID tag characteristics for the provided file.
42     * 
43     * @param doc
44     *          the file to generate characteristics for
45     * @return the detected SWID tag characteristics
46     * @throws XPathExpressionException
47     *           if an error occurred while evaluating the XPath expressions used to determine the
48     *           characteristics
49     * @throws XPathFactoryConfigurationException
50     *           if an error occurred while establishing the XPath evaluation environment
51     */
52    public static SWIDTagCharacteristics getSWIDTagCharacteristics(XMLDocument doc)
53        throws XPathExpressionException, XPathFactoryConfigurationException {
54      XPathEvaluator eval = doc.newXPathEvaluator();
55      XPathNamespaceContext nsContext = new XPathNamespaceContext();
56      nsContext.addNamespace("swid", "http://standards.iso.org/iso/19770/-2/2015/schema.xsd");
57      eval.setNamespaceContext(nsContext);
58  
59      boolean authoritative = eval.test("//swid:Entity[contains(@role,'tagCreator') and "
60          + "(contains(@role,'aggregator') or contains(@role,'distributor') or contains(@role,'licensor') or "
61          + "contains(@role,'softwareCreator'))]");
62      String tagTypeValue = eval.evaluateSingle(
63          "if (/swid:SoftwareIdentity[@patch='true']) then 'patch' "
64              + "else (if (/swid:SoftwareIdentity[@supplemental='true']) then 'supplemental' "
65              + "else (if (/swid:SoftwareIdentity[@corpus='true']) then 'corpus' else 'primary'))",
66          XPathConstants.STRING, null);
67      TagType tagType = TagType.lookup(tagTypeValue);
68      return new SWIDTagCharacteristics(tagType, authoritative);
69    }
70  
71    private final TagType tagType;
72    private final boolean authoritative;
73  
74    /**
75     * Construct a new SWID tag characteristics using the provided characteristics.
76     * 
77     * @param tagType
78     *          the type of the tag
79     * @param authoritative
80     *          <code>true</code> if the tag is authoritative, or <code>false</code> otherwise
81     */
82    public SWIDTagCharacteristics(TagType tagType, boolean authoritative) {
83      Objects.requireNonNull(tagType, "tagType");
84      this.tagType = tagType;
85      this.authoritative = authoritative;
86    }
87  
88    /**
89     * Retrieve the tag type.
90     * 
91     * @return the tagType
92     */
93    public TagType getTagType() {
94      return tagType;
95    }
96  
97    /**
98     * Determine if the tag is authoritative or not.
99     * 
100    * @return <code>true</code> if the tag is authoritative, or <code>false</code> otherwise
101    */
102   public boolean isAuthoritative() {
103     return authoritative;
104   }
105 }