@itentialopensource/adapter-digicert_pki 0.1.1 → 1.1.0

package/entities/EnrollmentProfiles/mockdatafiles/updateEnrollmentProfile-default.json

@@ -0,0 +1,117 @@
+{
+  "name": "Example name",
+  "enrollment_methods": [
+    "API",
+    "PORTAL"
+  ],
+  "allowed_ip_addresses": [
+    "1.1.1.1",
+    "2.2.2.2"
+  ],
+  "allowed_hours_from": "09:45:00",
+  "allowed_hours_to": "17:30:00",
+  "timezone": "America/New_York",
+  "valid_from": "2021-06-25",
+  "expires_on": "2022-06-25",
+  "key_generation_allow_to_change": true,
+  "key_generation_option": null,
+  "key_generation_type": null,
+  "allow_key_cache": true,
+  "key_cache_validity_period_type": null,
+  "key_cache_validity_period": "string",
+  "require_approval_for_enroll": true,
+  "require_approval_for_renew": true,
+  "digest_email_notification_period": null,
+  "approvers": [
+    {
+      "id": "4db36e5c-4bb8-4a41-a941-1b31a82529bd",
+      "full_name": "John Doe",
+      "email": "john.doe@example.com",
+      "active": true,
+      "user_type": null,
+      "locale": null
+    },
+    {
+      "id": "4db36e5c-4bb8-4a41-a941-1b31a82529bd",
+      "full_name": "John Doe",
+      "email": "john.doe@example.com",
+      "active": true,
+      "user_type": null,
+      "locale": null
+    },
+    {
+      "id": "4db36e5c-4bb8-4a41-a941-1b31a82529bd",
+      "full_name": "John Doe",
+      "email": "john.doe@example.com",
+      "active": true,
+      "user_type": null,
+      "locale": null
+    }
+  ],
+  "notification_email_list": [
+    "string",
+    "string",
+    "string",
+    "string",
+    "string",
+    "string",
+    "string",
+    "string"
+  ],
+  "id": "IOT_502ac648-c826-4e71-991e-5629a23850c1",
+  "connector_url": "https://one.digicert.com",
+  "connector_type": null,
+  "passcode": "passcode",
+  "api_key": "<api_token>",
+  "auth_cert_pkcs12": "<auth_cert_pkcs12>",
+  "auth_cert_password_pkcs12": "passcode",
+  "external_enrollment_profile_id": "string",
+  "device_profile": {
+    "id": "f5218cc5-fd11-47ac-bff8-0058f8e2d0ed",
+    "name": "Device profile name"
+  },
+  "certificate_profile": {
+    "id": "880daffe-e70f-4eb3-bfd5-673419cef80b",
+    "name": "Certificate profile name"
+  },
+  "created_at": "2021-06-09T13:49:54Z",
+  "ica": {
+    "id": "AAC2E2DD6BEAE2E5EE93954BAE15E34D",
+    "name": "ICA Name"
+  },
+  "status": null,
+  "allowed_signature_algorithms": [
+    "sha1WithRSA",
+    "sha256WithRSA",
+    "sha384WithRSA",
+    "sha512WithRSA"
+  ],
+  "direct_mapping": true,
+  "account_id": "742a7efb-0cf1-499d-abd5-abb87f42aa5f",
+  "ca_body": "<certificate_data>",
+  "gp_ca_body": "<certificate_data>",
+  "ca_chain": [
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    }
+  ],
+  "gp_ca_chain": [
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    },
+    {
+      "cert_type": null,
+      "blob": "<certificate_data>"
+    }
+  ],
+  "certificate_template": {
+    "id": "ebe32558-6485-4810-938b-56882daed038",
+    "name": "Certificate Template Name"
+  }
+}

package/entities/EnrollmentProfiles/schema.json

@@ -0,0 +1,148 @@
+{
+  "$id": "schema.json",
+  "type": "object",
+  "schema": "http://json-schema.org/draft-07/schema#",
+  "translate": false,
+  "dynamicfields": true,
+  "properties": {
+    "ph_request_type": {
+      "type": "string",
+      "description": "type of request (internal to adapter)",
+      "default": "",
+      "enum": [
+        "listEnrollmentProfiles",
+        "createEnrollmentProfile",
+        "getExampleCertificateRequestEnrollmentProfileID",
+        "getEnrollmentProfile",
+        "updateEnrollmentProfile",
+        "listAssignableICAs",
+        "getIssuingICA",
+        "getEnrollmentProfileSpecification",
+        "getEnrollmentProfileStatus"
+      ],
+      "external_name": "ph_request_type"
+    },
+    "deviceProfileId": {
+      "type": "string",
+      "description": "Limits results to enrollment profiles with a device profile ID that is an exact match for the given string. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_profile_id"
+    },    
+    "deviceProfileName": {
+      "type": "string",
+      "description": "Limits results to enrollment profiles with a device profile name that starts with the given string. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "device_profile_name"
+    },    
+    "enrollmentMethods": {
+      "type": "",
+      "description": "Limits results to enrollment profiles that use any of the enrollment methods from the given comma-separated list. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_methods"
+    },    
+    "ipAddresses": {
+      "type": "string",
+      "description": "Limits results to enrollment profiles that allow requests from all IP addresses in the given comma-separated list.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "ip_addresses"
+    },    
+    "createdFrom": {
+      "type": "string",
+      "description": "Limits results to enrollment profiles created after the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_from"
+    },    
+    "createdTo": {
+      "type": "string",
+      "description": "Limits results to enrollment profiles created before the given date. Format: `YYYY-MM-DD`",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "created_to"
+    },    
+    "certificateType": {
+      "type": "",
+      "description": "Limits results to enrollment profiles for the given certificate type (end-entity or intermediate). Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "certificate_type"
+    },    
+    "sortBy": {
+      "type": "",
+      "description": "Sorts results by the given property. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_by"
+    },    
+    "sortDirection": {
+      "type": "",
+      "description": "Sorts results in ascending or descending order by the value of the `sort_by` property. Case-insensitive.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "sort_direction"
+    },    
+    "enrollmentProfileId": {
+      "type": "string",
+      "description": "Enrollment profile ID.",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "enrollment_profile_id"
+    },    
+    "includeChain": {
+      "type": "boolean",
+      "description": "If true, response includes the full certificate chain (ICAs and root certificate) for the enrollment profile's issuing ICA. If false (default), response only includes the...(description truncated)",
+      "parse": false,
+      "encode": false,
+      "encrypt": {
+        "type": "AES",
+        "key": ""
+      },
+      "external_name": "include_chain"
+    }
+  },
+  "definitions": {}
+}

package/entities/ExternalBatchCertificateEnrollment/action.json

@@ -0,0 +1,150 @@
+{
+  "actions": [
+    {
+      "name": "batchEnrollExternal",
+      "protocol": "REST",
+      "method": "POST",
+      "entitypath": "{base_path}/{version}/api/v1/enrollment-profile/{pathv1}/external-batch-enroll?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "requestDatatype": "FORM",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/batchEnrollExternal-default.json"
+        }
+      ]
+    },
+    {
+      "name": "downloadMapping",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/batch-enroll/{pathv1}/download-mapping?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": ""
+        }
+      ]
+    },
+    {
+      "name": "downloadByJobIdAndUniqueId",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/unique-identifier/{pathv2}/format/{pathv3}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/downloadByJobIdAndUniqueId-default.json"
+        }
+      ]
+    },
+    {
+      "name": "downloadByCommonName",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-download/common-name/{pathv1}/format/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/downloadByCommonName-default.json"
+        }
+      ]
+    },
+    {
+      "name": "downloadByJobIdAndCommonName",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/common-name/{pathv2}/format/{pathv3}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/downloadByJobIdAndCommonName-default.json"
+        }
+      ]
+    },
+    {
+      "name": "downloadByCertificateValue",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-download/certificate-value/{pathv1}/format/{pathv2}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/downloadByCertificateValue-default.json"
+        }
+      ]
+    },
+    {
+      "name": "downloadByJobIdAndCertificateValue",
+      "protocol": "REST",
+      "method": "GET",
+      "entitypath": "{base_path}/{version}/api/v1/certificate-download/job/{pathv1}/certificate-value/{pathv2}/format/{pathv3}?{query}",
+      "requestSchema": "schema.json",
+      "responseSchema": "schema.json",
+      "timeout": 0,
+      "sendEmpty": false,
+      "sendGetBody": false,
+      "requestDatatype": "JSON",
+      "responseDatatype": "JSON",
+      "headers": {},
+      "responseObjects": [
+        {
+          "type": "default",
+          "key": "",
+          "mockFile": "mockdatafiles/downloadByJobIdAndCertificateValue-default.json"
+        }
+      ]
+    }
+  ]
+}

package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/batchEnrollExternal-default.json

@@ -0,0 +1,16 @@
+{
+  "id": "a7cdd1ac-8e64-417e-80d7-c5c2d8bab0aa",
+  "name": "Example batch job",
+  "status": null,
+  "total_items": 10,
+  "failed_items": 3,
+  "processing_time": 9,
+  "job_type": null,
+  "requested_by_name": "example.admin",
+  "passcode_generation_option": null,
+  "description": "Example description.",
+  "emails": [
+    "bob@example.com",
+    "alice@example.com"
+  ]
+}

package/entities/ExternalBatchCertificateEnrollment/mockdatafiles/downloadByCertificateValue-default.json

@@ -0,0 +1,154 @@
+[
+  {
+    "certificate_id": "b5db525b-fff8-44de-abab-fd4e8b68f2c5",
+    "format": null,
+    "certificate": "string",
+    "private_key": "string",
+    "chain": [
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      }
+    ],
+    "pkcs12": "string",
+    "pkcs12_password": "string"
+  },
+  {
+    "certificate_id": "b5db525b-fff8-44de-abab-fd4e8b68f2c5",
+    "format": null,
+    "certificate": "string",
+    "private_key": "string",
+    "chain": [
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      }
+    ],
+    "pkcs12": "string",
+    "pkcs12_password": "string"
+  },
+  {
+    "certificate_id": "b5db525b-fff8-44de-abab-fd4e8b68f2c5",
+    "format": null,
+    "certificate": "string",
+    "private_key": "string",
+    "chain": [
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      }
+    ],
+    "pkcs12": "string",
+    "pkcs12_password": "string"
+  },
+  {
+    "certificate_id": "b5db525b-fff8-44de-abab-fd4e8b68f2c5",
+    "format": null,
+    "certificate": "string",
+    "private_key": "string",
+    "chain": [
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      },
+      {
+        "cert_type": null,
+        "blob": "string"
+      }
+    ],
+    "pkcs12": "string",
+    "pkcs12_password": "string"
+  }
+]