Skip to content

Commit

Permalink
Updates from PR#79 to fix readme and manifest in main
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Henderson committed Sep 27, 2023
1 parent e836b7c commit 5cdcaad
Show file tree
Hide file tree
Showing 3 changed files with 156 additions and 74 deletions.
124 changes: 66 additions & 58 deletions integration-manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@
"supportsInventory": false,
"platformSupport": "Unused"
},
"store_types": {
"WinCert": {
"Name": "WinCert",
"store_types": [
{
"Name": "Windows Certificate",
"ShortName": "WinCert",
"Capability": "WinCert",
"LocalStore": false,
Expand All @@ -51,18 +51,18 @@
},
{
"Name": "WinRM Protocol",
"DisplayName": "WinRm Protocol",
"DisplayName": "WinRM Protocol",
"Type": "MultipleChoice",
"DependsOn": "",
"DefaultValue": "http, https",
"DefaultValue": "https,http",
"Required": true
},
{
"Name": "WinRm Port",
"DisplayName": "WinRm Port",
"Name": "WinRM Port",
"DisplayName": "WinRM Port",
"Type": "String",
"DependsOn": "",
"DefaultValue": "5985",
"DefaultValue": "5986",
"Required": true
},
{
Expand Down Expand Up @@ -93,14 +93,17 @@
"EntryParameters": [
{
"Name": "ProviderName",
"DisplayName": "Provider Name",
"DisplayName": "Crypto Provider Name",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
}
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
},
{
"Name": "SAN",
Expand All @@ -111,28 +114,26 @@
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": true
}
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
}
],
"PasswordOptions": {
"EntrySupported": false,
"StoreRequired": false,
"Style": "Default"
},
"StorePathValue": "",
"PrivateKeyAllowed": "Required",
"JobProperties": [
"ProviderName",
"SAN"
],
"ServerRequired": true,
"PowerShell": false,
"BlueprintAllowed": false,
"CustomAliasAllowed": "Forbidden",
"ServerRegistration": 7,
"InventoryEndpoint": "/AnyInventory/Update"
"CustomAliasAllowed": "Forbidden"
},
"IISU": {
"Name": "IISU",
{
"Name": "IIS Bound Certificate",
"ShortName": "IISU",
"Capability": "IISU",
"LocalStore": false,
Expand All @@ -146,26 +147,26 @@
"Properties": [
{
"Name": "spnwithport",
"DisplayName": "SPN With Port?",
"DisplayName": "SPN With Port",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "false",
"Required": false
},
{
"Name": "WinRM Protocol",
"Name": "WinRm Protocol",
"DisplayName": "WinRm Protocol",
"Type": "MultipleChoice",
"DependsOn": "",
"DefaultValue": "http,https",
"DefaultValue": "https,http",
"Required": true
},
{
"Name": "WinRm Port",
"DisplayName": "WinRm Port",
"Type": "String",
"DependsOn": "",
"DefaultValue": "5985",
"DefaultValue": "5986",
"Required": true
},
{
Expand All @@ -186,7 +187,7 @@
},
{
"Name": "ServerUseSsl",
"DisplayName": "Use SSL?",
"DisplayName": "Use SSL",
"Type": "Bool",
"DependsOn": "",
"DefaultValue": "true",
Expand All @@ -195,28 +196,32 @@
],
"EntryParameters": [
{
"Name": "IPAddress",
"DisplayName": "IP Address",
"Name": "Port",
"DisplayName": "Port",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": true,
"OnRemove": true,
"OnReenrollment": true
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
},
"DefaultValue": "*"
"DependsOn": "",
"DefaultValue": "443",
"Options": ""
},
{
"Name": "Port",
"DisplayName": "Port",
"Name": "IPAddress",
"DisplayName": "IP Address",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": true,
"OnRemove": true,
"OnReenrollment": true
},
"DefaultValue": "443"
"DependsOn": "",
"DefaultValue": "*",
"Options": ""
},
{
"Name": "HostName",
Expand All @@ -227,31 +232,38 @@
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
}
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
},
{
"Name": "SiteName",
"DisplayName": "Site Name",
"DisplayName": "IIS Site Name",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": true,
"OnRemove": true,
"OnReenrollment": true
},
"DefaultValue": "Default Web Site"
"DependsOn": "",
"DefaultValue": "Default Web Site",
"Options": ""
},
{
"Name": "SniFlag",
"DisplayName": "SNI Flag",
"Type": "String",
"DisplayName": "SNI Support",
"Type": "MultipleChoice",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
},
"DefaultValue": "0 - No SNI"
"DependsOn": "",
"DefaultValue": "0 - No SNI",
"Options": "0 - No SNI,1 - SNI Enabled,2 - Non SNI Binding,3 - SNI Binding"
},
{
"Name": "Protocol",
Expand All @@ -263,19 +275,23 @@
"OnRemove": true,
"OnReenrollment": true
},
"DependsOn": "",
"DefaultValue": "https",
"Options": "http, https"
"Options": "https,http"
},
{
"Name": "ProviderName",
"DisplayName": "Provider Name",
"DisplayName": "Crypto Provider Name",
"Type": "String",
"RequiredWhen": {
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": false
}
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
},
{
"Name": "SAN",
Expand All @@ -285,8 +301,11 @@
"HasPrivateKey": false,
"OnAdd": false,
"OnRemove": false,
"OnReenrollment": true
}
"OnReenrollment": false
},
"DependsOn": "",
"DefaultValue": "",
"Options": ""
}
],
"PasswordOptions": {
Expand All @@ -296,23 +315,12 @@
},
"StorePathValue": "[\"My\",\"WebHosting\"]",
"PrivateKeyAllowed": "Required",
"JobProperties": [
"IPAddress",
"Port",
"HostName",
"SiteName",
"SniFlag",
"Protocol",
"ProviderName",
"SAN"
],
"ServerRequired": true,
"PowerShell": false,
"BlueprintAllowed": false,
"CustomAliasAllowed": "Forbidden",
"InventoryEndpoint": "/AnyInventory/Update"
"CustomAliasAllowed": "Forbidden"
}
}
]
}
}
}
88 changes: 88 additions & 0 deletions readme-src/store-types-tables.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@

### Windows Certificate Store Type
#### kfutil Create Windows Certificate Store Type
The following commands can be used with [kfutil](https://github.com/Keyfactor/kfutil). Please refer to the kfutil documentation for more information on how to use the tool to interact w/ Keyfactor Command.

```
bash
kfutil login
kfutil store - types create--name Windows Certificate
```

#### UI Configuration
##### UI Basic Tab
| Field Name | Required | Value |
|-------------------------|----------|-------------------------------------------|
| Name | ✓ | Windows Certificate |
| ShortName | ✓ | Windows Certificate |
| Custom Capability | | Unchecked [ ] |
| Supported Job Types | ✓ | Inventory,Add,Enrollment,Remove |
| Needs Server | ✓ | Checked [x] |
| Blueprint Allowed | | Unchecked [ ] |
| Uses PowerShell | | Unchecked [ ] |
| Requires Store Password | | Unchecked [ ] |
| Supports Entry Password | | Unchecked [ ] |
![k8sstlssecr_basic.png](docs%2Fscreenshots%2Fstore_types%2Fwindows certificate_basic.png)

##### UI Advanced Tab
| Field Name | Required | Value |
|-----------------------|----------|-----------------------|
| Store Path Type | | undefined |
| Supports Custom Alias | | Forbidden |
| Private Key Handling | | Required |
| PFX Password Style | | Default |

![k8sstlssecr_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fwindows certificate_advanced.png)

##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value |
|----------------|----------------------|--------|----------|---------------|
| KubeNamespace | Kube Namespace | String | | `default` |
| KubeSecretName | Kube Secret Name | String | ✓ | |
| KubeSecretType | Kube Secret Type | String | ✓ | `tls_secret`|


### IIS Bound Certificate Store Type
#### kfutil Create IIS Bound Certificate Store Type
The following commands can be used with [kfutil](https://github.com/Keyfactor/kfutil). Please refer to the kfutil documentation for more information on how to use the tool to interact w/ Keyfactor Command.

```
bash
kfutil login
kfutil store - types create--name IIS Bound Certificate
```

#### UI Configuration
##### UI Basic Tab
| Field Name | Required | Value |
|-------------------------|----------|-------------------------------------------|
| Name | ✓ | IIS Bound Certificate |
| ShortName | ✓ | IIS Bound Certificate |
| Custom Capability | | Unchecked [ ] |
| Supported Job Types | ✓ | Inventory,Add,Enrollment,Remove |
| Needs Server | ✓ | Checked [x] |
| Blueprint Allowed | | Unchecked [ ] |
| Uses PowerShell | | Unchecked [ ] |
| Requires Store Password | | Unchecked [ ] |
| Supports Entry Password | | Unchecked [ ] |
![k8sstlssecr_basic.png](docs%2Fscreenshots%2Fstore_types%2Fiis bound certificate_basic.png)

##### UI Advanced Tab
| Field Name | Required | Value |
|-----------------------|----------|-----------------------|
| Store Path Type | | undefined |
| Supports Custom Alias | | Forbidden |
| Private Key Handling | | Required |
| PFX Password Style | | Default |

![k8sstlssecr_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fiis bound certificate_advanced.png)

##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value |
|----------------|----------------------|--------|----------|---------------|
| KubeNamespace | Kube Namespace | String | | `default` |
| KubeSecretName | Kube Secret Name | String | ✓ | |
| KubeSecretType | Kube Secret Type | String | ✓ | `tls_secret`|

Loading

0 comments on commit 5cdcaad

Please sign in to comment.