quick installation guide for development

POC/clients/gccn_client/package.json

@@ -19,6 +19,7 @@
     "express": "^4.14.0",
     "express-session": "^1.17.2",
     "fs": "^0.0.1-security",
+    "gccntrust-registry-network": "file:",
     "jsonwebtoken": "^8.5.1",
     "mongoose": "^6.6.5",
     "morgan": "^1.7.0",

Phase2/tfm/README.md

@@ -14,14 +14,31 @@ For more information please visit the website: https://www.hci.iao.fraunhofer.de
 
 ## Requirements
 
-- Java 17 or newer
-- Maven ~3.6.0
+- Java 21 or newer
+- Maven ~3.9.8
 - Internet access
-- TRAIN Trust Infrastructure
-- Zone Manager
+- Running instance of Zone Manager
 
 ## Documentation
 
+### Quick deployment guide for development
+
+To have a development running instance of TFM, follow these steps:
+
+```bash
+git clone [email protected]:undp/Regi-TRUST.git
+```
+
+Setup variables in [application.yml](./src/main/resources/application.yml). Then install and run.
+
+```bash
+cd Regi-TRUST/Phase2/tfm/
+mvn clean install
+mvn spring-boot:run
+```
+
+## This still needs to be orginized to simplify documentation for Phase 2:
+
 ### [Short Software Description](./README.md#description)
 
 ### [Usage Guide](./doc/README.md)

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/Address.java

@@ -0,0 +1,36 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "Address",propOrder = {
+		"street",
+		"local",
+		"postalCode",
+		"country"
+})
+public class Address implements Serializable{
+
+	@XmlElement(name = "StreetAddress")
+	private  String street;
+
+	@XmlElement(name = "Locality")
+	private String local;
+
+	@XmlElement(name = "PostalCode")
+	private String postalCode;
+
+	@XmlElement(name = "CountryName")
+	private String country;
+
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/FrameworkInformationType.java

@@ -0,0 +1,68 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "FrameworkInformationType",propOrder = {
+		"tSLVersionIdentifier",
+		"tSLSequenceNumber",
+		"tSLType",
+		"frameworkOperatorName",
+		"frameworkOperatorAddress",
+		"frameworkName",
+		"frameworkInformationURI",
+		"frameworkAuditURI",
+		"frameworkTypeCommunityRules",
+		"frameworkScope",
+		"policyOrLegalNotice",
+		"listIssueDateTime"	
+})
+public class FrameworkInformationType{
+
+	@XmlElement(name = "TSLVersionIdentifier")
+	private int tSLVersionIdentifier;
+
+	@XmlElement(name = "TSLSequenceNumber")
+	private int tSLSequenceNumber;
+
+	@XmlElement(name = "TSLType")
+	private String tSLType;
+
+	@XmlElement(name = "FrameworkOperatorName")
+	private NameType frameworkOperatorName;
+
+	@XmlElement(name = "FrameworkOperatorAddress")
+	private FrameworkOperatorAddressType frameworkOperatorAddress;
+
+	@XmlElement(name = "FrameworkName")
+	private  NameType frameworkName;
+
+	@XmlElement(name = "FrameworkInformationURI")
+	private URIType frameworkInformationURI;
+
+	@XmlElement(name = "FrameworkAuditURI")
+	private URIType frameworkAuditURI;
+
+	@XmlElement(name = "FrameworkTypeCommunityRules")
+	private URIType frameworkTypeCommunityRules;
+
+	@XmlElement(name = "FrameworkScope")
+	private String frameworkScope;
+
+	@XmlElement(name = "PolicyOrLegalNotice")
+	private PolicyOrLegalNoticeType policyOrLegalNotice;
+
+	@XmlElement(name = "ListIssueDateTime")
+	private String listIssueDateTime;
+
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/FrameworkOperatorAddressType.java

@@ -0,0 +1,28 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "FrameworkOperatorAddressType",propOrder = {"postalAddresses","electronicAddress"})
+public class FrameworkOperatorAddressType implements Serializable{
+
+	@XmlElement(name = "PostalAddresses")
+	private PostalAddressesType postalAddresses;
+
+	@XmlElement(name = "ElectronicAddress")
+	private URIType electronicAddress;
+
+
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/NameType.java

@@ -0,0 +1,25 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+import java.util.List;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "NameType",propOrder = {"name"})
+public class NameType implements Serializable {
+
+	@XmlElement(name = "Name")
+	private String name;
+
+
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/PolicyOrLegalNoticeType.java

@@ -0,0 +1,23 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+import java.util.List;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "PolicyOrLegalNoticeType",propOrder = {"tSLLegalNotice"})
+public class PolicyOrLegalNoticeType implements Serializable{
+
+	@XmlElement(name="TSLLegalNotice")
+	private String tSLLegalNotice;
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/PostalAddressesType.java

@@ -0,0 +1,23 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+import java.util.List;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "PostalAddressesType",propOrder = {"postalAddress"})
+public class PostalAddressesType implements Serializable{
+	@XmlElement(name = "PostalAddress")
+	private List<Address> postalAddress;
+
+
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/TrustServiceStatusList.java

@@ -0,0 +1,25 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import eu.xfsc.train.tspa.model.trustlist.tsp.TrustServiceProviderListCustomType;
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlRootElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlRootElement(name = "TrustServiceStatusList")
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "TrustServiceStatusList",propOrder = {"frameworkInformation","trustServiceProviderList"})
+public class TrustServiceStatusList {
+
+	@XmlElement(name = "FrameworkInformation")
+	private FrameworkInformationType frameworkInformation;
+
+	@XmlElement(name = "TrustServiceProviderList")
+	private TrustServiceProviderListCustomType trustServiceProviderList;
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/URIType.java

@@ -0,0 +1,23 @@
+package eu.xfsc.train.tspa.model.trustlist;
+
+import java.io.Serializable;
+import java.util.List;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "URIType",propOrder = {"uri"})
+public class URIType implements Serializable{
+
+	@XmlElement(name = "URI")
+	private String uri;
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/tsp/AdditionalServiceInformationType.java

@@ -0,0 +1,45 @@
+package eu.xfsc.train.tspa.model.trustlist.tsp;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "AdditionalServiceInformationType",propOrder = {
+		"serviceBusinessRulesURI",
+		"serviceGovernanceURI",
+		"serviceIssuedCredentialTypes",
+		"serviceContractType",
+		"servicePolicySet",
+		"serviceSchemaURI",
+		"serviceSupplyPoint"
+})
+public class AdditionalServiceInformationType {
+
+	@XmlElement(name = "ServiceBusinessRulesURI")
+	private String serviceBusinessRulesURI;
+
+	@XmlElement(name = "ServiceGovernanceURI")
+	private String serviceGovernanceURI;
+
+	@XmlElement(name = "ServiceIssuedCredentialTypes")
+	private ServiceIssuedCredentialType serviceIssuedCredentialTypes;
+
+	@XmlElement(name = "ServiceContractType")
+	private String serviceContractType;
+
+	@XmlElement(name = "ServicePolicySet")
+	private String servicePolicySet;
+
+	@XmlElement(name = "ServiceSchemaURI")
+	private String serviceSchemaURI;
+
+	@XmlElement(name = "ServiceSupplyPoint")
+	private String serviceSupplyPoint;
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/tsp/CredentialCustomType.java

@@ -0,0 +1,19 @@
+package eu.xfsc.train.tspa.model.trustlist.tsp;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "CredentialCustomType",propOrder = {"type"})
+public class CredentialCustomType {
+
+	@XmlElement(name = "Type")
+	private String type;
+
+}

Phase2/tfm/src/main/java/eu/xfsc/train/tspa/model/trustlist/tsp/DigitalIdType.java

@@ -0,0 +1,22 @@
+package eu.xfsc.train.tspa.model.trustlist.tsp;
+
+import jakarta.xml.bind.annotation.XmlAccessType;
+import jakarta.xml.bind.annotation.XmlAccessorType;
+import jakarta.xml.bind.annotation.XmlElement;
+import jakarta.xml.bind.annotation.XmlType;
+import lombok.Getter;
+import lombok.Setter;
+
+@Getter
+@Setter
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "DigitalIdType",propOrder = {"x509Certificate","did"})
+public class DigitalIdType {
+
+	@XmlElement(name = "X509Certificate")
+	private String x509Certificate;
+
+	@XmlElement(name = "DID")
+	private String did;
+
+}