Skip to content

Commit

Permalink
Created the iis-orchestrator store_type readme stub md
Browse files Browse the repository at this point in the history
  • Loading branch information
Keyfactor committed Sep 11, 2023
1 parent a32a06b commit 0ff2957
Showing 1 changed file with 107 additions and 16 deletions.
123 changes: 107 additions & 16 deletions readme-src/store-types-tables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ kfutil store - types create--name Windows Certificate
| Field Name | Required | Value |
|-------------------------|----------|-------------------------------------------|
| Name | ✓ | Windows Certificate |
| ShortName | ✓ | Windows Certificate |
| ShortName | ✓ | WinCert |
| Custom Capability | | Unchecked [ ] |
| Supported Job Types | ✓ | Inventory,Add,Enrollment,Remove |
| Needs Server | ✓ | Checked [x] |
Expand All @@ -23,24 +23,38 @@ kfutil store - types create--name Windows Certificate
| Requires Store Password | | Unchecked [ ] |
| Supports Entry Password | | Unchecked [ ] |
![k8sstlssecr_basic.png](docs%2Fscreenshots%2Fstore_types%2Fwindows certificate_basic.png)
![wincert_basic.png](docs%2Fscreenshots%2Fstore_types%2Fwincert_basic.png)

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

![k8sstlssecr_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fwindows certificate_advanced.png)
![wincert_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fwincert_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`|
| -------------- | -------------------- | ------ | -------- | ------------- |
|spnwithport|SPN With Port|Bool|false|false|
|WinRM Protocol|WinRM Protocol|MultipleChoice|https,http|true|
|WinRM Port|WinRM Port|String|5986|true|
|ServerUsername|Server Username|Secret|null|false|
|ServerPassword|Server Password|Secret|null|false|
|ServerUseSsl|Use SSL|Bool|true|true|


**Entry Parameters:**

Entry parameters are inventoried and maintained for each entry within a certificate store.
They are typically used to support binding of a certificate to a resource.

|Name|Display Name| Type|Default Value|Required When |
|----|------------|-----|-------------|--------------|
|ProviderName|Crypto Provider Name|String|||
|SAN|SAN|String||Reenrolling|


### IIS Bound Certificate Store Type
Expand All @@ -58,7 +72,7 @@ kfutil store - types create--name IIS Bound Certificate
| Field Name | Required | Value |
|-------------------------|----------|-------------------------------------------|
| Name | ✓ | IIS Bound Certificate |
| ShortName | ✓ | IIS Bound Certificate |
| ShortName | ✓ | IISU |
| Custom Capability | | Unchecked [ ] |
| Supported Job Types | ✓ | Inventory,Add,Enrollment,Remove |
| Needs Server | ✓ | Checked [x] |
Expand All @@ -67,22 +81,99 @@ kfutil store - types create--name IIS Bound Certificate
| Requires Store Password | | Unchecked [ ] |
| Supports Entry Password | | Unchecked [ ] |
![k8sstlssecr_basic.png](docs%2Fscreenshots%2Fstore_types%2Fiis bound certificate_basic.png)
![iisu_basic.png](docs%2Fscreenshots%2Fstore_types%2Fiisu_basic.png)

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

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

##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value |
| -------------- | -------------------- | ------ | -------- | ------------- |
|spnwithport|SPN With Port|Bool|false|false|
|WinRm Protocol|WinRm Protocol|MultipleChoice|https,http|true|
|WinRm Port|WinRm Port|String|5986|true|
|ServerUsername|Server Username|Secret|null|false|
|ServerPassword|Server Password|Secret|null|false|
|ServerUseSsl|Use SSL|Bool|true|true|


**Entry Parameters:**

Entry parameters are inventoried and maintained for each entry within a certificate store.
They are typically used to support binding of a certificate to a resource.

|Name|Display Name| Type|Default Value|Required When |
|----|------------|-----|-------------|--------------|
|Port|Port|String|443||
|IPAddress|IP Address|String|*|Adding,Removing,Reenrolling|
|HostName|Host Name|String|||
|SiteName|IIS Site Name|String|Default Web Site|Adding,Removing,Reenrolling|
|SniFlag|SNI Support|MultipleChoice|0 - No SNI||
|Protocol|Protocol|MultipleChoice|https|Adding,Removing,Reenrolling|
|ProviderName|Crypto Provider Name|String|||
|SAN|SAN|String|||


### WinSql Store Type
#### kfutil Create WinSql 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 WinSql
```

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

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

![winsql_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fwinsql_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`|
| -------------- | -------------------- | ------ | -------- | ------------- |
|WinRm Protocol|WinRm Protocol|MultipleChoice|https,http|true|
|WinRm Port|WinRm Port|String|5986|true|
|ServerUsername|Server Username|Secret|null|false|
|ServerPassword|Server Password|Secret|null|false|
|ServerUseSsl|Use SSL|Bool|true|true|
|RestartService|Restart SQL Service After Cert Installed|Bool|false|true|


**Entry Parameters:**

Entry parameters are inventoried and maintained for each entry within a certificate store.
They are typically used to support binding of a certificate to a resource.

|Name|Display Name| Type|Default Value|Required When |
|----|------------|-----|-------------|--------------|
|InstanceName|Instance Name|String|undefined||

0 comments on commit 0ff2957

Please sign in to comment.