Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
 into oktaauth
  • Loading branch information
bhillkeyfactor committed Oct 19, 2023
2 parents dd32080 + 0ef089c commit ce45cfd
Showing 1 changed file with 46 additions and 37 deletions.
83 changes: 46 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,42 +153,51 @@ See [image](/Images/CertStore2.gif) for mappings. Note screen could change in f
<details>
<summary>Cert Store Type and Cert Store Setup</summary>

Cert Store Types Settings - Basic
---------------
| Section | Settings |
| ----------- | ----------- |
| Details | Name="Custom Name", Short Name="AWSCerManA" |
| Supported Job Types | Inventory, Add, Remove |
| General Settings | Needs Server, Blueprint Allowed |
| Password Settings | Supports Entry Password |

![image.png](/Images/CertStoreType-Basic-IAM.gif)

Cert Store Types Settings - Advanced
---------------
| Section | Settings |
| ----------- | ----------- |
| Store Path Type | Freeform |
| Other Settings | Supports Custom Alias=Optional, Private Key Handling=Optional, PFX Password Style=Default|

![image.png](/Images/CertStoreType-Advanced.gif)

Cert Store Types Settings - Custom Fields
---------------
| Name | Display Name | Required | Type | Description |
| ----------- | ----------- | ----------- | ----------- | ----------- |
| awsrole | AWS Assume Identity Role | True | string | This role has to be created in AWS IAM so you can assume an identity and get temp credentials
| awsregions | AWS Regions | True | string | This will be the list of regions for the account the store iterates through when doing inventory.

![image.png](/Images/CertStoreType-CustomFields-IAM.gif)

Cert Store Types Settings - Entry Params
---------------
| Name | Display Name | Type | Default Value | Multiple Choice Questions | Required When |
| ----------- | ----------- | ----------- | ----------- | ----------- | ----------- |
| AWS Region | AWS Region | Multiple Choice | us-east-1 | us-east-1,us-east-2... | Adding an Entry, Reenrolling Entry |

![image.png](/Images/CertStoreType-EntryParams.gif)
**Basic Settings:**

CONFIG ELEMENT | VALUE | DESCRIPTION
--|--|--
Name | Any Custom Name | Display name for the store type (may be customized)
Short Name| AWSCerManA | Short display name for the store type
Custom Capability | N/A | Store type name orchestrator will register with. Check the box to allow entry of value
Supported Job Types | Inventory, Add, Remove | Job types the extension supports
Needs Server | Checked | Determines if a target server name is required when creating store
Blueprint Allowed | Checked | Determines if store type may be included in an Orchestrator blueprint
Uses PowerShell | Unchecked | Determines if underlying implementation is PowerShell
Requires Store Password | Unchecked | Determines if a store password is required when configuring an individual store.
Supports Entry Password | Unchecked | Determines if an individual entry within a store can have a password.

**Advanced Settings:**

CONFIG ELEMENT | VALUE | DESCRIPTION
--|--|--
Store Path Type | Freeform | Determines what restrictions are applied to the store path field when configuring a new store.
Store Path Value | N/A | This is reserved for the AWS Account Id when setting up the store.
Supports Custom Alias | Optional | Determines if an individual entry within a store can have a custom Alias.
Private Keys | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store.
PFX Password Style | Default or Custom | "Default" - PFX password is randomly generated, "Custom" - PFX password may be specified when the enrollment job is created (Requires the *Allow Custom Password* application setting to be enabled.)


**Custom Fields:**

Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote
target server containing the certificate store to be managed

Name|Display Name|Type|Default Value / Options|Required|Description
---|---|---|---|---|---
awsrole | AWS Assume Identity Role | string | N/A | Yes | This role has to be created in AWS IAM so you can assume an identity and get temp credentials
awsregions | AWS Regions | string | N/A | Yes | This will be the list of regions for the account the store iterates through when doing inventory.


**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|Description
---|---|---|---|---|---
AWS Region | AWS Region | Multiple Choice | us-east-1 | Adding | When enrolling, this is the Region that the Certificate will be enrolled to.


Cert Store Settings
===============
Expand All @@ -201,7 +210,7 @@ Cert Store Settings
| 4 | User Name | IAM Access Key | Obtained from AWS |
| 5 | Password | IAM Access Secret | Obtained from the AWS |

![image.png](/Images/CertStore-IAM.gif)

</details>
</details>

0 comments on commit ce45cfd

Please sign in to comment.