diff --git a/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests-aas.xml b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests-aas.xml new file mode 100644 index 00000000..d16387ea --- /dev/null +++ b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests-aas.xml @@ -0,0 +1,472 @@ + + + + + defaultAdminShell + + + en + defaultAdminShell + + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#CertificateSigningRequests + + Type + + + + ModelReference + + + Submodel + urn:samm:io.catenax.certificate_signing_requests:1.0.0#CertificateSigningRequests/submodel + + + + + + + + + CertificateSigningRequests + + + en + The certificate signing requests model contains the essential information needed to request specific certificates for a unique ECU component via a Certificate Signing Request (CSR) and to validate and certificate the ECU against this data. + + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#CertificateSigningRequests/submodel + Template + + ModelReference + + + ConceptDescription + urn:samm:io.catenax.certificate_signing_requests:1.0.0#CertificateSigningRequests + + + + + + certificateSigningRequestList + + + en + Certificate Signing Request List + + + + + en + Describes one or more Certificate Singing Requests (CSR). Each set entry contains additional information (e.g. subjectCommonName, subjectLocality, etc.) in readable form, which is otherwise part of the encrypted CSR. + + + true + DataElement + + + CertificateSigningRequestsEntity + + + en + Certificate Signing Requests Entity + + + + + en + The Entity of a certificate signing requests to additionally structure the set. + + + + + subjectCommonName + + + en + Subject Common Name + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.certificate_signing_requests:1.0.0#subjectCommonName + + + + xs:string + + + + subjectLocality + + + en + Subject Locality + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.certificate_signing_requests:1.0.0#subjectLocality + + + + xs:string + + + + certificateSigningRequest + + + en + Certificate Signing Request + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.certificate_signing_requests:1.0.0#certificateSigningRequest + + + + xs:string + + + + subjectSerialNumber + + + en + Subject Serial Number + + + + ExternalReference + + + ConceptDescription + urn:samm:io.catenax.certificate_signing_requests:1.0.0#subjectSerialNumber + + + + + + ExternalReference + + + GlobalReference + https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part + + + + + xs:string + + + + + + + + + + + + APPLICATION_CLASS + CertificateSigningRequests + + + en + Certificate Signing Requests + + + + + en + The certificate signing requests model contains the essential information needed to request specific certificates for a unique ECU component via a Certificate Signing Request (CSR) and to validate and certificate the ECU against this data. + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#CertificateSigningRequests + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate Signing Requests + + + + + en + CertificateSigningRequests + + + + + en + The certificate signing requests model contains the essential information needed to request specific certificates for a unique ECU component via a Certificate Signing Request (CSR) and to validate and certificate the ECU against this data. + + + + + + + + + subjectCommonName + + + en + Subject Common Name + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#subjectCommonName + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Subject Common Name + + + + + en + subjectCommonName + + + STRING + + + en + Describes the common name on where the certificate is requested. + + + + + + + + + subjectLocality + + + en + Subject Locality + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#subjectLocality + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Subject Locality + + + + + en + subjectLocality + + + STRING + + + en + Provides information about the specific type of the ECU that will be certified. + +The value for the subjectLocality is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR. + + + + + + + + + certificateSigningRequest + + + en + Certificate Signing Request + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#certificateSigningRequest + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate Signing Request + + + + + en + certificateSigningRequest + + + STRING + + + en + A CSR (Certificate Signing Request) is a 64-based PEM formatted and encrypted message to request and receive a digital certificate. The CSR validates the information required by a specific certification authority (CA) to issue the associated digital certificate. + +The CSR consists of encrypted data, which can include, for example, basic information about the ECU and its manufacturer (common name, company, organizational unit, country, city/town, etc.), information about the public key attached to the certificate, as well as information on the key type and length. + + + + + + + + + subjectSerialNumber + + + en + Subject Serial Number + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#subjectSerialNumber + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Subject Serial Number + + + + + en + subjectSerialNumber + + + STRING + + + en + The serial number of the assembly part generated by the manufacturer that is used to identify the ECU component in a unique way. The subject serial number is identical to the serial number (partInstanceId) specified in the aspect model SerialPart. + +The value for the subjectSerialNumber is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR. + + + + + + + + + certificateSigningRequestList + + + en + Certificate Signing Request List + + + urn:samm:io.catenax.certificate_signing_requests:1.0.0#certificateSigningRequestList + + + + ExternalReference + + + GlobalReference + https://admin-shell.io/DataSpecificationTemplates/DataSpecificationIec61360/3/0 + + + + + + + + en + Certificate Signing Request List + + + + + en + certificateSigningRequestList + + + STRING + + + en + Describes one or more Certificate Singing Requests (CSR). Each set entry contains additional information (e.g. subjectCommonName, subjectLocality, etc.) in readable form, which is otherwise part of the encrypted CSR. + + + + + + + + + diff --git a/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests-schema.json b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests-schema.json new file mode 100644 index 00000000..a633a47b --- /dev/null +++ b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests-schema.json @@ -0,0 +1,62 @@ +{ + "$schema" : "http://json-schema.org/draft-04/schema", + "description" : "The certificate signing requests model contains the essential information needed to request specific certificates for a unique ECU component via a Certificate Signing Request (CSR) and to validate and certificate the ECU against this data.", + "type" : "object", + "components" : { + "schemas" : { + "urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectCommonNameCharacteristic" : { + "type" : "string", + "description" : "The characteristic of the subject common characteristic, that is defined as a String." + }, + "urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectLocalityCharacteristic" : { + "type" : "string", + "description" : "The characteristic of the subject locality, that is defined as a String." + }, + "urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestCharacteristic" : { + "type" : "string", + "description" : "The characteristic of the certificate signing request ID, that is defined as a String." + }, + "urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectSerialNumberCharacteristic" : { + "type" : "string", + "description" : "The characteristic of the subject serial number, that is defined as a String." + }, + "urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsEntity" : { + "description" : "The Entity of a certificate signing requests to additionally structure the set.", + "type" : "object", + "properties" : { + "subjectCommonName" : { + "description" : "Describes the common name on where the certificate is requested.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectCommonNameCharacteristic" + }, + "subjectLocality" : { + "description" : "Provides information about the specific type of the ECU that will be certified. \n\nThe value for the subjectLocality is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectLocalityCharacteristic" + }, + "certificateSigningRequest" : { + "description" : "A CSR (Certificate Signing Request) is a 64-based PEM formatted and encrypted message to request and receive a digital certificate. The CSR validates the information required by a specific certification authority (CA) to issue the associated digital certificate.\n\nThe CSR consists of encrypted data, which can include, for example, basic information about the ECU and its manufacturer (common name, company, organizational unit, country, city/town, etc.), information about the public key attached to the certificate, as well as information on the key type and length.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestCharacteristic" + }, + "subjectSerialNumber" : { + "description" : "The serial number of the assembly part generated by the manufacturer that is used to identify the ECU component in a unique way. The subject serial number is identical to the serial number (partInstanceId) specified in the aspect model SerialPart.\n\nThe value for the subjectSerialNumber is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectSerialNumberCharacteristic" + } + }, + "required" : [ "subjectCommonName", "subjectLocality", "certificateSigningRequest", "subjectSerialNumber" ] + }, + "urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsCharacteristic" : { + "description" : "A data set that can contain several Certificate Signing Requests (CSR). If CSRs exist, all subject information must be provided.", + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsEntity" + }, + "uniqueItems" : true + } + } + }, + "properties" : { + "certificateSigningRequestList" : { + "description" : "Describes one or more Certificate Singing Requests (CSR). Each set entry contains additional information (e.g. subjectCommonName, subjectLocality, etc.) in readable form, which is otherwise part of the encrypted CSR.", + "$ref" : "#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsCharacteristic" + } + } +} \ No newline at end of file diff --git a/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.aasx b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.aasx new file mode 100644 index 00000000..04bab073 Binary files /dev/null and b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.aasx differ diff --git a/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.html b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.html new file mode 100644 index 00000000..c6ab7dbd --- /dev/null +++ b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.html @@ -0,0 +1,634 @@ + + + + + + + + + + + + + + Documentation Certificate Signing Requests + + +
+
+
+
+

Aspect Model Certificate Signing Requests

+
urn:samm:io.catenax.certificate_signing_requests:1.0.0#CertificateSigningRequests
+
+
+
+
+
+
+
+ +
+ + +
+ The certificate signing requests model contains the essential information needed to request specific certificates for a unique ECU component via a Certificate Signing Request (CSR) and to validate and certificate the ECU against this data. +
+ + +
+

Overview

+
+
+
+
+ Aspect Model Diagram +
+
+
+ + +
+
+

Properties

+
+ +
+ +
+

Certificate Signing Request List

+
+ +Describes one or more Certificate Singing Requests (CSR). Each set entry contains additional information (e.g. subjectCommonName, subjectLocality, etc.) in readable form, which is otherwise part of the encrypted CSR. + +
+
Name
+
certificateSigningRequestList
+
+ + + +
+
Characteristic
+
+
+
+
Set
+
+
+
Has no order
+
+
+
Duplicates not allowed
+
+ +
+
+
+ + +
+
Optional
+
+ Yes
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
certificateSigningRequestList
+
+ + +
+
+ + + +
+
+

Entities

+
+ +
+
+

Certificate Signing Requests Entity

+
+
+ The Entity of a certificate signing requests to additionally structure the set. +
+ +
+

Properties

+
+
+ +
+
Subject Common Name
+
+ +Describes the common name on where the certificate is requested. + +
+
Name
+
subjectCommonName
+
+ + + +
+
Characteristic
+ +
+ +
+
Example
+
IPsec-Internal
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subjectCommonName
+
+ + +
+
+ +
+
Subject Locality
+
+ +Provides information about the specific type of the ECU that will be certified. + +The value for the subjectLocality is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR. + +
+
Name
+
subjectLocality
+
+ + + +
+
Characteristic
+ +
+ +
+
Example
+
ATM--02
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subjectLocality
+
+ + +
+
+ +
+
Certificate Signing Request
+
+ +A CSR (Certificate Signing Request) is a 64-based PEM formatted and encrypted message to request and receive a digital certificate. The CSR validates the information required by a specific certification authority (CA) to issue the associated digital certificate. + +The CSR consists of encrypted data, which can include, for example, basic information about the ECU and its manufacturer (common name, company, organizational unit, country, city/town, etc.), information about the public key attached to the certificate, as well as information on the key type and length. + +
+
Name
+
certificateSigningRequest
+
+ + + +
+
Characteristic
+ +
+ +
+
Example
+
MIIC2TCCAToCAQAwgZwxEzARBgNVBAgTClByb2R1Y3Rpb24xDDAKBgNVBAcMA0FUTTESMBAGA1UEChMJQk1XIEdyb3VwMRcwFQYDVQQLEw5WZWhpY2xlUEtJLUVDVTEXMBUGA1UEAxMOSVBzZWMtaW50ZXJuYWwxMTAvBgNVBAUTKEVDVS1VSUQ6QzAwMDgyNDI3MUREQTYwMDAwMDAwMDAwMjdBQTg0MjQwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAShNm4y5Mdzu4b9xDW3TfBZr
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
certificateSigningRequest
+
+ + +
+
+ +
+
Subject Serial Number
+
+ +The serial number of the assembly part generated by the manufacturer that is used to identify the ECU component in a unique way. The subject serial number is identical to the serial number (partInstanceId) specified in the aspect model SerialPart. + +The value for the subjectSerialNumber is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR. + +
+
Name
+
subjectSerialNumber
+
+ + + +
+
Characteristic
+ +
+ +
+
Example
+
ECU-UID:SN12345678
+
+ +
+
Optional
+
+ No
+
+ +
+
In payload
+
+ Yes
+
+ +
+
Payload key
+
subjectSerialNumber
+
+ +
+
Reference
+
+
    +
  • https://github.com/eclipse-tractusx/sldt-semantic-models/tree/main/io.catenax.serial_part
  • +
+
+
+ +
+
+
+ +
+ Third party licenses + +
+ +
+ + +
+ + + \ No newline at end of file diff --git a/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.json b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.json new file mode 100644 index 00000000..f62dc3bf --- /dev/null +++ b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.json @@ -0,0 +1,8 @@ +{ + "certificateSigningRequestList" : [ { + "certificateSigningRequest" : "MIIC2TCCAToCAQAwgZwxEzARBgNVBAgTClByb2R1Y3Rpb24xDDAKBgNVBAcMA0FUTTESMBAGA1UEChMJQk1XIEdyb3VwMRcwFQYDVQQLEw5WZWhpY2xlUEtJLUVDVTEXMBUGA1UEAxMOSVBzZWMtaW50ZXJuYWwxMTAvBgNVBAUTKEVDVS1VSUQ6QzAwMDgyNDI3MUREQTYwMDAwMDAwMDAwMjdBQTg0MjQwdjAQBgcqhkjOPQIBBgUrgQQAIgNiAAShNm4y5Mdzu4b9xDW3TfBZr", + "subjectSerialNumber" : "ECU-UID:SN12345678", + "subjectCommonName" : "IPsec-Internal", + "subjectLocality" : "ATM--02" + } ] +} \ No newline at end of file diff --git a/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.yml b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.yml new file mode 100644 index 00000000..f8c7ded7 --- /dev/null +++ b/io.catenax.certificate_signing_requests/1.0.0/gen/CertificateSigningRequests.yml @@ -0,0 +1,190 @@ +--- +openapi: 3.0.3 +info: + title: Certificate Signing Requests + version: v1 +servers: +- url: catenax.io/api/v1 + variables: + api-version: + default: v1 +paths: + /{tenant-id}/certificate-signing-requests: + get: + tags: + - CertificateSigningRequests + operationId: getCertificateSigningRequests + parameters: + - name: tenant-id + in: path + description: The ID of the tenant owning the requested Twin. + required: true + schema: + type: string + format: uuid + - name: start + in: query + description: Starting index which is starting by 0 + required: false + schema: + type: number + - name: count + in: query + description: Number of items to return per call. + required: false + schema: + type: number + - name: totalItemCount + in: query + description: Flag that indicates that the total counts should be returned. + required: false + schema: + type: boolean + responses: + "200": + $ref: '#/components/responses/CertificateSigningRequests' + "401": + $ref: '#/components/responses/ClientError' + "402": + $ref: '#/components/responses/Unauthorized' + "403": + $ref: '#/components/responses/Forbidden' + "404": + $ref: '#/components/responses/NotFoundError' +components: + schemas: + ErrorResponse: + type: object + required: + - error + properties: + error: + $ref: '#/components/schemas/Error' + Error: + type: object + required: + - details + properties: + message: + type: string + minLength: 1 + path: + type: string + minLength: 1 + details: + type: object + minLength: 1 + additionalProperties: + type: object + code: + type: string + nullable: true + PagingSchema: + type: object + properties: + items: + type: array + items: + $ref: '#/components/schemas/CertificateSigningRequests' + totalItems: + type: number + totalPages: + type: number + pageSize: + type: number + currentPage: + type: number + urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectCommonNameCharacteristic: + type: string + description: "The characteristic of the subject common characteristic, that\ + \ is defined as a String." + urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectLocalityCharacteristic: + type: string + description: "The characteristic of the subject locality, that is defined as\ + \ a String." + urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestCharacteristic: + type: string + description: "The characteristic of the certificate signing request ID, that\ + \ is defined as a String." + urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectSerialNumberCharacteristic: + type: string + description: "The characteristic of the subject serial number, that is defined\ + \ as a String." + urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsEntity: + description: The Entity of a certificate signing requests to additionally structure + the set. + type: object + properties: + subjectCommonName: + description: Describes the common name on where the certificate is requested. + $ref: '#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectCommonNameCharacteristic' + subjectLocality: + description: "Provides information about the specific type of the ECU that\ + \ will be certified. \n\nThe value for the subjectLocality is always the\ + \ same for an ECU and its attached CSRs, but is required to additionally\ + \ validate each individual CSR." + $ref: '#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectLocalityCharacteristic' + certificateSigningRequest: + description: |- + A CSR (Certificate Signing Request) is a 64-based PEM formatted and encrypted message to request and receive a digital certificate. The CSR validates the information required by a specific certification authority (CA) to issue the associated digital certificate. + + The CSR consists of encrypted data, which can include, for example, basic information about the ECU and its manufacturer (common name, company, organizational unit, country, city/town, etc.), information about the public key attached to the certificate, as well as information on the key type and length. + $ref: '#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestCharacteristic' + subjectSerialNumber: + description: |- + The serial number of the assembly part generated by the manufacturer that is used to identify the ECU component in a unique way. The subject serial number is identical to the serial number (partInstanceId) specified in the aspect model SerialPart. + + The value for the subjectSerialNumber is always the same for an ECU and its attached CSRs, but is required to additionally validate each individual CSR. + $ref: '#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_SubjectSerialNumberCharacteristic' + required: + - subjectCommonName + - subjectLocality + - certificateSigningRequest + - subjectSerialNumber + urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsCharacteristic: + description: "A data set that can contain several Certificate Signing Requests\ + \ (CSR). If CSRs exist, all subject information must be provided." + type: array + items: + $ref: '#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsEntity' + uniqueItems: true + CertificateSigningRequests: + description: The certificate signing requests model contains the essential information + needed to request specific certificates for a unique ECU component via a Certificate + Signing Request (CSR) and to validate and certificate the ECU against this + data. + type: object + properties: + certificateSigningRequestList: + description: "Describes one or more Certificate Singing Requests (CSR).\ + \ Each set entry contains additional information (e.g. subjectCommonName,\ + \ subjectLocality, etc.) in readable form, which is otherwise part of\ + \ the encrypted CSR." + $ref: '#/components/schemas/urn_samm_io.catenax.certificate_signing_requests_1.0.0_CertificateSigningRequestsCharacteristic' + responses: + Unauthorized: + description: The requesting user or client is not authenticated. + Forbidden: + description: The requesting user or client is not authorized to access resources + for the given tenant. + NotFoundError: + description: The requested Twin has not been found. + ClientError: + description: Payload or user input is invalid. See error details in the payload + for more. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + CertificateSigningRequests: + content: + application/json: + schema: + $ref: '#/components/schemas/PagingSchema' + description: The request was successful. + requestBodies: + CertificateSigningRequests: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateSigningRequests'