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.client.service; 28 29 import java.io.IOException; 30 import java.io.UnsupportedEncodingException; 31 import java.nio.file.Files; 32 import java.nio.file.Path; 33 import java.nio.file.Paths; 34 import java.util.List; 35 36 public class PayloadBuilderServiceImpl implements PayloadBuilderService { 37 38 // Element names, required for constructing REST request payload 39 public static final String SWID_BODY_ELEMENT = "body"; 40 public static final String TAG_TYPE_ELEMENT = "tagType"; 41 public static final String SWID_ELEMENT = "swid"; 42 public static final String SWID_LIST_ELEMENT = "swidList"; 43 44 private static final String SOFTWARE_IDENTITY_ELEMENT = "<SoftwareIdentity"; 45 46 /** 47 * Construct payload from one or more tag files 48 */ 49 @Override 50 public String buildPayload(List<String> tagFileNames, TagType tagType) 51 throws UnsupportedEncodingException, IOException { 52 String content = ""; 53 // Tagtype option provided will be used for all SWIDs posted 54 String tagElement = constructTagTypeElement(tagType); 55 for (String filename : tagFileNames) { 56 content += constructSwidElementFromFile(Paths.get(filename), tagElement); 57 } 58 content = this.constructXMLElement(content, SWID_LIST_ELEMENT); 59 return content; 60 } 61 62 /** 63 * Wrap tagType, swidData into SWID element 64 * 65 * @param path 66 * @param tagElement 67 * @return 68 * @throws UnsupportedEncodingException 69 * @throws IOException 70 */ 71 private String constructSwidElementFromFile(Path path, String tagElement) 72 throws UnsupportedEncodingException, IOException { 73 String content = new String(Files.readAllBytes(path), "UTF-8"); 74 String swidData = ""; 75 // Remove the XML declaration provided in each SWID tag 76 int swidDataStartIndex = content.indexOf(SOFTWARE_IDENTITY_ELEMENT); 77 if (swidDataStartIndex > 0) { 78 swidData = content.substring(swidDataStartIndex); 79 } 80 String bodyElement = constructBodyElement(swidData); 81 return this.constructXMLElement(tagElement + bodyElement, SWID_ELEMENT); 82 } 83 84 /** 85 * Wrap the swid data 86 * 87 * @param swidData 88 * @return 89 */ 90 private String constructBodyElement(String swidData) { 91 92 return this.constructXMLElement(swidData, SWID_BODY_ELEMENT); 93 } 94 95 /** 96 * Wrap tag type 97 * 98 * @param type 99 * @return 100 */ 101 private String constructTagTypeElement(TagType type) { 102 if (type == null) { 103 return ""; 104 } 105 return this.constructXMLElement(type.getName(), TAG_TYPE_ELEMENT); 106 } 107 108 /** 109 * Constructs XML element given data and element name 110 * 111 * @param input 112 * @param elementName 113 * @return 114 */ 115 private String constructXMLElement(String input, String elementName) { 116 117 return "<" + elementName + ">" + input + "</" + elementName + ">";// TODO 118 // check 119 // this 120 } 121 }