diff --git a/.github/workflows/keyfactor-starter-workflow.yml b/.github/workflows/keyfactor-starter-workflow.yml index c9b180c..487d4c0 100644 --- a/.github/workflows/keyfactor-starter-workflow.yml +++ b/.github/workflows/keyfactor-starter-workflow.yml @@ -11,17 +11,9 @@ on: jobs: call-starter-workflow: - uses: keyfactor/actions/.github/workflows/starter.yml@v4 - with: - command_token_url: ${{ vars.COMMAND_TOKEN_URL }} # Only required for doctool generated screenshots - command_hostname: ${{ vars.COMMAND_HOSTNAME }} # Only required for doctool generated screenshots - command_base_api_path: ${{ vars.COMMAND_API_PATH }} # Only required for doctool generated screenshots + uses: keyfactor/actions/.github/workflows/starter.yml@v5 secrets: - token: ${{ secrets.V2BUILDTOKEN}} # REQUIRED - gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} # Only required for golang builds - gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} # Only required for golang builds - scan_token: ${{ secrets.SAST_TOKEN }} # REQUIRED - entra_username: ${{ secrets.DOCTOOL_ENTRA_USERNAME }} # Only required for doctool generated screenshots - entra_password: ${{ secrets.DOCTOOL_ENTRA_PASSWD }} # Only required for doctool generated screenshots - command_client_id: ${{ secrets.COMMAND_CLIENT_ID }} # Only required for doctool generated screenshots - command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }} # Only required for doctool generated screenshots \ No newline at end of file + token: ${{ secrets.V2BUILDTOKEN }} + gpg_key: ${{ secrets.KF_GPG_PRIVATE_KEY }} + gpg_pass: ${{ secrets.KF_GPG_PASSPHRASE }} + scan_token: ${{ secrets.SAST_TOKEN }} diff --git a/AzureEnterpriseApplicationOrchestrator.Tests/AzureEnterpriseApplicationOrchestrator.Tests.csproj b/AzureEnterpriseApplicationOrchestrator.Tests/AzureEnterpriseApplicationOrchestrator.Tests.csproj index ff06551..8a9f5e9 100644 --- a/AzureEnterpriseApplicationOrchestrator.Tests/AzureEnterpriseApplicationOrchestrator.Tests.csproj +++ b/AzureEnterpriseApplicationOrchestrator.Tests/AzureEnterpriseApplicationOrchestrator.Tests.csproj @@ -1,4 +1,4 @@ - + net8.0 @@ -10,6 +10,7 @@ + diff --git a/AzureEnterpriseApplicationOrchestrator.Tests/MockPAMSecretResolver.cs b/AzureEnterpriseApplicationOrchestrator.Tests/MockPAMSecretResolver.cs index b95fb19..93bf450 100644 --- a/AzureEnterpriseApplicationOrchestrator.Tests/MockPAMSecretResolver.cs +++ b/AzureEnterpriseApplicationOrchestrator.Tests/MockPAMSecretResolver.cs @@ -24,7 +24,7 @@ public MockPAMSecretResolver(Dictionary predefinedSecrets) public string Resolve(string instanceInfo) { // For testing, if we have a predefined secret, return it - if (_secrets.ContainsKey(instanceInfo)) + if (instanceInfo != null && _secrets.ContainsKey(instanceInfo)) { return _secrets[instanceInfo]; } diff --git a/AzureEnterpriseApplicationOrchestrator/AzureEnterpriseApplicationOrchestrator.csproj b/AzureEnterpriseApplicationOrchestrator/AzureEnterpriseApplicationOrchestrator.csproj index d0bc9a2..ffd4b51 100644 --- a/AzureEnterpriseApplicationOrchestrator/AzureEnterpriseApplicationOrchestrator.csproj +++ b/AzureEnterpriseApplicationOrchestrator/AzureEnterpriseApplicationOrchestrator.csproj @@ -5,6 +5,7 @@ net6.0;net8.0;net10.0 true disable + $(NoWarn);SYSLIB0057 @@ -16,13 +17,13 @@ all - - + + - + diff --git a/AzureEnterpriseApplicationOrchestrator/Client/GraphClient.cs b/AzureEnterpriseApplicationOrchestrator/Client/GraphClient.cs index 07a1a99..e90ddc9 100644 --- a/AzureEnterpriseApplicationOrchestrator/Client/GraphClient.cs +++ b/AzureEnterpriseApplicationOrchestrator/Client/GraphClient.cs @@ -1,4 +1,4 @@ -// Copyright 2024 Keyfactor +// Copyright 2026 Keyfactor // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. @@ -242,15 +242,13 @@ public void AddApplicationCertificate(string certificateName, string certificate throw new Exception("Could not calculate thumbprint for certificate"); // Calculate the SHA256 hash of the certificate's thumbprint - byte[] customKeyId = Encoding.UTF8.GetBytes(certificate.Thumbprint)[..32]; + byte[] customKeyId = certificate.GetCertHash(); - _logger.LogDebug($"Adding certificate called \"{certificateName}\" to Object ID \"{_targetObjectId}\" (custom key ID {Encoding.UTF8.GetString(customKeyId)})"); + _logger.LogDebug($"Adding certificate called \"{certificateName}\" to Object ID \"{_targetObjectId}\" (custom key ID {Convert.ToHexString(customKeyId)})"); // Get the application object Application application = GetApplication(); - char[] certPem = PemEncoding.Write("CERTIFICATE", certificate.RawData); - // Update the application object _logger.LogDebug($"Updating application object for Object ID \"{_targetObjectId}\""); try @@ -267,7 +265,7 @@ public void AddApplicationCertificate(string certificateName, string certificate StartDateTime = DateTimeOffset.Parse(certificate.GetEffectiveDateString()), EndDateTime = DateTimeOffset.Parse(certificate.GetExpirationDateString()), KeyId = Guid.NewGuid(), - Key = System.Text.Encoding.UTF8.GetBytes(certPem) + Key = certificate.Export(X509ContentType.Cert), } } }).Wait(); @@ -332,6 +330,7 @@ public bool ApplicationCertificateExists(string certificateName) public void AddServicePrincipalCertificate(string certificateName, string certificateData, string certificatePassword) { + // certificateData is a base64 encoded PFX certificate X509Certificate2 certificate = SerializeCertificate(certificateData, certificatePassword); if (certificate.Thumbprint == null) @@ -801,7 +800,7 @@ private OperationResult> InventoryFromKeyCrede foreach (KeyCredential keyCredential in keyCredentials) { - string customKeyIdentifier = Encoding.UTF8.GetString(keyCredential.CustomKeyIdentifier); + string customKeyIdentifier = Convert.ToHexString(keyCredential.CustomKeyIdentifier); if (!string.IsNullOrWhiteSpace(keyCredential.Usage) && keyCredential.Usage.Equals("Sign", StringComparison.OrdinalIgnoreCase)) { @@ -989,8 +988,9 @@ protected X509Certificate2 GetCertificateFromKeyCredential(KeyCredential keyCred return certificate; } - protected static X509Certificate2 SerializeCertificate(string certificateData, string password) + private X509Certificate2 SerializeCertificate(string certificateData, string password) { + _logger.LogDebug($"Certificate Base64: {certificateData}"); byte[] rawData = Convert.FromBase64String(certificateData); return new X509Certificate2(rawData, password, X509KeyStorageFlags.Exportable); } diff --git a/AzureEnterpriseApplicationOrchestrator/GraphJobClientBuilder.cs b/AzureEnterpriseApplicationOrchestrator/GraphJobClientBuilder.cs index 33f0beb..e4f9095 100644 --- a/AzureEnterpriseApplicationOrchestrator/GraphJobClientBuilder.cs +++ b/AzureEnterpriseApplicationOrchestrator/GraphJobClientBuilder.cs @@ -139,7 +139,7 @@ public GraphJobClientBuilder WithV2CertificateStoreDetails(Certificate if (!string.IsNullOrEmpty(serverPassword)) { _logger.LogDebug("Client certificate not present - Using Client Secret authentication"); - _logger.LogTrace($"Builder - ServerPassword => ClientSecret: {properties.ServerPassword}"); + _logger.LogTrace($"Builder - ServerPassword => ClientSecret: ******"); _builder.WithClientSecret(serverPassword); } else if (!string.IsNullOrEmpty(properties.ClientCertificate)) diff --git a/README.md b/README.md index 2c74bec..fd97ac1 100644 --- a/README.md +++ b/README.md @@ -49,21 +49,17 @@ Enterprise Application Orchestrator extension manages certificates for Azure App Enterprise Applications (Service Principals) differently. The Azure App Registration and Enterprise Application Universal Orchestrator extension implements 4 Certificate Store Types. Depending on your use case, you may elect to use one, or all of these Certificate Store Types. Descriptions of each are provided below. - - [Azure App Registration (Application)](#AzureApp) - - [Azure Enterprise Application (Service Principal)](#AzureSP) - - [Azure App Registration 2 (Application)](#AzureApp2) - - [Azure Enterprise Application 2 (Service Principal)](#AzureSP2) - ## Compatibility This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later. ## Support + The Azure App Registration and Enterprise Application Universal Orchestrator extension is supported by Keyfactor. If you require support for any issues or have feature request, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com. > If you want to contribute bug fixes or additional enhancements, use the **[Pull requests](../../pulls)** tab. @@ -72,7 +68,6 @@ The Azure App Registration and Enterprise Application Universal Orchestrator ext Before installing the Azure App Registration and Enterprise Application Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command. - ### Azure Service Principal (Graph API Authentication) The Azure App Registration and Enterprise Application Orchestrator extension uses @@ -173,7 +168,6 @@ Microsoft Graph API. The extension uses the following Graph API endpoints to man * [Update Application](https://learn.microsoft.com/en-us/graph/api/application-update?view=graph-rest-1.0&tabs=http) - Used to modify the App Registration to add or remove certificates. * Specifically, the extension manipulates the [`keyCredentials` resource](https://learn.microsoft.com/en-us/graph/api/resources/keycredential?view=graph-rest-1.0) of the Application object. - ## Certificate Store Types To use the Azure App Registration and Enterprise Application Universal Orchestrator extension, you **must** create the Certificate Store Types required for your use-case. This only needs to happen _once_ per Keyfactor Command instance. @@ -184,7 +178,6 @@ The Azure App Registration and Enterprise Application Universal Orchestrator ext
Click to expand details - Azure [App Registration/Application certificates](https://learn.microsoft.com/en-us/entra/identity-platform/certificate-credentials) are typically used for client authentication by applications and are typically public key only in Azure. The general model by which these credentials are consumed is that the certificate and private key are accessible by the Application @@ -196,9 +189,6 @@ Remove, and Discovery job types for managing these certificates. > AzureApp "Azure App Registration (Application)" is **Deprecated**. Please use **AzureApp2** "Azure App > Registration 2 (Application)" instead. - - - #### Azure App Registration (Application) Requirements Application certificates are used for client authentication and are typically public key only. No additional @@ -208,23 +198,22 @@ of [Certificates and Secrets](https://learn.microsoft.com/en-us/entra/identity-p Unless the Discovery job is used, you should collect the Application IDs for each App Registration that contains certificates to be managed. - - #### Supported Operations -| Operation | Is Supported | -|--------------|------------------------------------------------------------------------------------------------------------------------| -| Add | ✅ Checked | -| Remove | ✅ Checked | -| Discovery | ✅ Checked | +| Operation | Is Supported | +|--------------|--------------| +| Add | ✅ Checked | +| Remove | ✅ Checked | +| Discovery | ✅ Checked | | Reenrollment | 🔲 Unchecked | -| Create | 🔲 Unchecked | +| Create | 🔲 Unchecked | #### Store Type Creation ##### Using kfutil: `kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart) +
Click to expand AzureApp kfutil details ##### Using online definition from GitHub: @@ -243,10 +232,10 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out ```
- #### Manual Creation Below are instructions on how to create the AzureApp store type manually in the Keyfactor Command Portal +
Click to expand manual AzureApp details Create a store type called `AzureApp` with the attributes in the tables below: @@ -257,11 +246,11 @@ the Keyfactor Command Portal | Name | Azure App Registration (Application) | Display name for the store type (may be customized) | | Short Name | AzureApp | Short display name for the store type | | Capability | AzureApp | Store type name orchestrator will register with. Check the box to allow entry of value | - | Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add | - | Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove | - | Supports Discovery | ✅ Checked | Check the box. Indicates that the Store Type supports Discovery | - | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | - | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | + | Supports Add | ✅ Checked | Indicates that the Store Type supports Management Add | + | Supports Remove | ✅ Checked | Indicates that the Store Type supports Management Remove | + | Supports Discovery | ✅ Checked | Indicates that the Store Type supports Discovery | + | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | + | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | | Needs Server | ✅ Checked | Determines if a target server name is required when creating store | | Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint | | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell | @@ -270,18 +259,18 @@ the Keyfactor Command Portal The Basic tab should look like this: - ![AzureApp Basic Tab](docsource/images/AzureApp-basic-store-type-dialog.png) + ![AzureApp Basic Tab](docsource/images/AzureApp-basic-store-type-dialog.svg) ##### Advanced Tab | Attribute | Value | Description | | --------- | ----- | ----- | | Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. | - | Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | + | Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. | | PFX Password Style | Default | '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.) | The Advanced tab should look like this: - ![AzureApp Advanced Tab](docsource/images/AzureApp-advanced-store-type-dialog.png) + ![AzureApp Advanced Tab](docsource/images/AzureApp-advanced-store-type-dialog.svg) > For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX. @@ -297,8 +286,7 @@ the Keyfactor Command Portal The Custom Fields tab should look like this: - ![AzureApp Custom Fields Tab](docsource/images/AzureApp-custom-fields-store-type-dialog.png) - + ![AzureApp Custom Fields Tab](docsource/images/AzureApp-custom-fields-store-type-dialog.svg) ###### Server Username The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. @@ -308,8 +296,6 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Server Password A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used _and_ the Client Certificate's private key is not encrypted, you **must** select 'No Value' for this field. @@ -318,32 +304,18 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Client Certificate The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** select 'No Value' for this field. - ![AzureApp Custom Field - ClientCertificate](docsource/images/AzureApp-custom-field-ClientCertificate-dialog.png) - ![AzureApp Custom Field - ClientCertificate](docsource/images/AzureApp-custom-field-ClientCertificate-validation-options-dialog.png) - + ![AzureApp Custom Field - ClientCertificate](docsource/images/AzureApp-custom-field-ClientCertificate-dialog.svg) + ![AzureApp Custom Field - ClientCertificate](docsource/images/AzureApp-custom-field-ClientCertificate-validation-options-dialog.svg) ###### Azure Global Cloud Authority Host Specifies the Azure Cloud instance used by the organization. - ![AzureApp Custom Field - AzureCloud](docsource/images/AzureApp-custom-field-AzureCloud-dialog.png) - ![AzureApp Custom Field - AzureCloud](docsource/images/AzureApp-custom-field-AzureCloud-validation-options-dialog.png) - - - - ###### Use SSL - Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. - - ![AzureApp Custom Field - ServerUseSsl](docsource/images/AzureApp-custom-field-ServerUseSsl-dialog.png) - ![AzureApp Custom Field - ServerUseSsl](docsource/images/AzureApp-custom-field-ServerUseSsl-validation-options-dialog.png) - - - + ![AzureApp Custom Field - AzureCloud](docsource/images/AzureApp-custom-field-AzureCloud-dialog.svg) + ![AzureApp Custom Field - AzureCloud](docsource/images/AzureApp-custom-field-AzureCloud-validation-options-dialog.svg)
@@ -353,7 +325,6 @@ the Keyfactor Command Portal
Click to expand details - The Azure Enterprise Application/Service Principal certificate operations are implemented by the `AzureSP` store type, and supports the management of a single certificate for use in `SSO/SAML` assertion signing. The Management Add operation is only supported with the certificate replacement option, since adding a new certificate will replace the @@ -367,9 +338,6 @@ Principals in the tenant. > AzureSP "Azure Enterprise Application (Service Principal)" is **Deprecated**. Please use **AzureSP2** Azure > "Enterprise Application 2 (Service Principal)" instead. - - - #### Azure Enterprise Application (Service Principal) Requirements Service Principal certificates are typically used for SAML Token signing. Service Principals are created from Enterprise @@ -378,23 +346,22 @@ Microsoft's [SAML-based single sign-on](https://learn.microsoft.com/en-us/entra/ documentation. For more information on the mechanics of the Service Principal certificate management capabilities, please see the [mechanics](#extension-mechanics) section. - - #### Supported Operations -| Operation | Is Supported | -|--------------|------------------------------------------------------------------------------------------------------------------------| -| Add | ✅ Checked | -| Remove | ✅ Checked | -| Discovery | ✅ Checked | +| Operation | Is Supported | +|--------------|--------------| +| Add | ✅ Checked | +| Remove | ✅ Checked | +| Discovery | ✅ Checked | | Reenrollment | 🔲 Unchecked | -| Create | 🔲 Unchecked | +| Create | 🔲 Unchecked | #### Store Type Creation ##### Using kfutil: `kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart) +
Click to expand AzureSP kfutil details ##### Using online definition from GitHub: @@ -413,10 +380,10 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out ```
- #### Manual Creation Below are instructions on how to create the AzureSP store type manually in the Keyfactor Command Portal +
Click to expand manual AzureSP details Create a store type called `AzureSP` with the attributes in the tables below: @@ -427,11 +394,11 @@ the Keyfactor Command Portal | Name | Azure Enterprise Application (Service Principal) | Display name for the store type (may be customized) | | Short Name | AzureSP | Short display name for the store type | | Capability | AzureSP | Store type name orchestrator will register with. Check the box to allow entry of value | - | Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add | - | Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove | - | Supports Discovery | ✅ Checked | Check the box. Indicates that the Store Type supports Discovery | - | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | - | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | + | Supports Add | ✅ Checked | Indicates that the Store Type supports Management Add | + | Supports Remove | ✅ Checked | Indicates that the Store Type supports Management Remove | + | Supports Discovery | ✅ Checked | Indicates that the Store Type supports Discovery | + | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | + | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | | Needs Server | ✅ Checked | Determines if a target server name is required when creating store | | Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint | | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell | @@ -440,18 +407,18 @@ the Keyfactor Command Portal The Basic tab should look like this: - ![AzureSP Basic Tab](docsource/images/AzureSP-basic-store-type-dialog.png) + ![AzureSP Basic Tab](docsource/images/AzureSP-basic-store-type-dialog.svg) ##### Advanced Tab | Attribute | Value | Description | | --------- | ----- | ----- | | Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. | - | Private Key Handling | Required | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | + | Private Key Handling | Required | This determines if Keyfactor can send the private key associated with a certificate to the store. | | PFX Password Style | Default | '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.) | The Advanced tab should look like this: - ![AzureSP Advanced Tab](docsource/images/AzureSP-advanced-store-type-dialog.png) + ![AzureSP Advanced Tab](docsource/images/AzureSP-advanced-store-type-dialog.svg) > For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX. @@ -467,8 +434,7 @@ the Keyfactor Command Portal The Custom Fields tab should look like this: - ![AzureSP Custom Fields Tab](docsource/images/AzureSP-custom-fields-store-type-dialog.png) - + ![AzureSP Custom Fields Tab](docsource/images/AzureSP-custom-fields-store-type-dialog.svg) ###### Server Username The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. @@ -478,8 +444,6 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Server Password A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used _and_ the Client Certificate's private key is not encrypted, you **must** select 'No Value' for this field. @@ -488,24 +452,18 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Client Certificate The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** select 'No Value' for this field. - ![AzureSP Custom Field - ClientCertificate](docsource/images/AzureSP-custom-field-ClientCertificate-dialog.png) - ![AzureSP Custom Field - ClientCertificate](docsource/images/AzureSP-custom-field-ClientCertificate-validation-options-dialog.png) - + ![AzureSP Custom Field - ClientCertificate](docsource/images/AzureSP-custom-field-ClientCertificate-dialog.svg) + ![AzureSP Custom Field - ClientCertificate](docsource/images/AzureSP-custom-field-ClientCertificate-validation-options-dialog.svg) ###### Azure Global Cloud Authority Host Specifies the Azure Cloud instance used by the organization. - ![AzureSP Custom Field - AzureCloud](docsource/images/AzureSP-custom-field-AzureCloud-dialog.png) - ![AzureSP Custom Field - AzureCloud](docsource/images/AzureSP-custom-field-AzureCloud-validation-options-dialog.png) - - - + ![AzureSP Custom Field - AzureCloud](docsource/images/AzureSP-custom-field-AzureCloud-dialog.svg) + ![AzureSP Custom Field - AzureCloud](docsource/images/AzureSP-custom-field-AzureCloud-validation-options-dialog.svg)
@@ -515,7 +473,6 @@ the Keyfactor Command Portal
Click to expand details - Azure [App Registration/Application certificates](https://learn.microsoft.com/en-us/entra/identity-platform/certificate-credentials) are typically used for client authentication by applications and are typically public key only in Azure. The general model by which these credentials are consumed is that the certificate and private key are accessible by the Application @@ -523,9 +480,6 @@ using the App Registration, and are passed to the service authenticating the App Registration and Enterprise Application Orchestrator extension implements the Inventory, Management Add, Management Remove, and Discovery job types for managing these certificates. - - - #### Azure App Registration 2 (Application) Requirements Application certificates are used for client authentication and are typically public key only. No additional @@ -535,23 +489,22 @@ of [Certificates and Secrets](https://learn.microsoft.com/en-us/entra/identity-p Unless the Discovery job is used, you should collect the Application IDs for each App Registration that contains certificates to be managed. - - #### Supported Operations -| Operation | Is Supported | -|--------------|------------------------------------------------------------------------------------------------------------------------| -| Add | ✅ Checked | -| Remove | ✅ Checked | -| Discovery | ✅ Checked | +| Operation | Is Supported | +|--------------|--------------| +| Add | ✅ Checked | +| Remove | ✅ Checked | +| Discovery | ✅ Checked | | Reenrollment | 🔲 Unchecked | -| Create | 🔲 Unchecked | +| Create | 🔲 Unchecked | #### Store Type Creation ##### Using kfutil: `kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart) +
Click to expand AzureApp2 kfutil details ##### Using online definition from GitHub: @@ -570,10 +523,10 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out ```
- #### Manual Creation Below are instructions on how to create the AzureApp2 store type manually in the Keyfactor Command Portal +
Click to expand manual AzureApp2 details Create a store type called `AzureApp2` with the attributes in the tables below: @@ -584,11 +537,11 @@ the Keyfactor Command Portal | Name | Azure App Registration 2 (Application) | Display name for the store type (may be customized) | | Short Name | AzureApp2 | Short display name for the store type | | Capability | AzureApp2 | Store type name orchestrator will register with. Check the box to allow entry of value | - | Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add | - | Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove | - | Supports Discovery | ✅ Checked | Check the box. Indicates that the Store Type supports Discovery | - | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | - | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | + | Supports Add | ✅ Checked | Indicates that the Store Type supports Management Add | + | Supports Remove | ✅ Checked | Indicates that the Store Type supports Management Remove | + | Supports Discovery | ✅ Checked | Indicates that the Store Type supports Discovery | + | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | + | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | | Needs Server | ✅ Checked | Determines if a target server name is required when creating store | | Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint | | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell | @@ -597,18 +550,18 @@ the Keyfactor Command Portal The Basic tab should look like this: - ![AzureApp2 Basic Tab](docsource/images/AzureApp2-basic-store-type-dialog.png) + ![AzureApp2 Basic Tab](docsource/images/AzureApp2-basic-store-type-dialog.svg) ##### Advanced Tab | Attribute | Value | Description | | --------- | ----- | ----- | | Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. | - | Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | + | Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. | | PFX Password Style | Default | '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.) | The Advanced tab should look like this: - ![AzureApp2 Advanced Tab](docsource/images/AzureApp2-advanced-store-type-dialog.png) + ![AzureApp2 Advanced Tab](docsource/images/AzureApp2-advanced-store-type-dialog.svg) > For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX. @@ -625,8 +578,7 @@ the Keyfactor Command Portal The Custom Fields tab should look like this: - ![AzureApp2 Custom Fields Tab](docsource/images/AzureApp2-custom-fields-store-type-dialog.png) - + ![AzureApp2 Custom Fields Tab](docsource/images/AzureApp2-custom-fields-store-type-dialog.svg) ###### Server Username The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates. @@ -636,8 +588,6 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Server Password A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you **must** select 'No Value'. @@ -646,32 +596,25 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Client Certificate The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** check 'No Value'. - ![AzureApp2 Custom Field - ClientCertificate](docsource/images/AzureApp2-custom-field-ClientCertificate-dialog.png) - ![AzureApp2 Custom Field - ClientCertificate](docsource/images/AzureApp2-custom-field-ClientCertificate-validation-options-dialog.png) - + ![AzureApp2 Custom Field - ClientCertificate](docsource/images/AzureApp2-custom-field-ClientCertificate-dialog.svg) + ![AzureApp2 Custom Field - ClientCertificate](docsource/images/AzureApp2-custom-field-ClientCertificate-validation-options-dialog.svg) ###### Client Certificate Password The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you **must** check 'No Value'. - ![AzureApp2 Custom Field - ClientCertificatePassword](docsource/images/AzureApp2-custom-field-ClientCertificatePassword-dialog.png) - ![AzureApp2 Custom Field - ClientCertificatePassword](docsource/images/AzureApp2-custom-field-ClientCertificatePassword-validation-options-dialog.png) - + ![AzureApp2 Custom Field - ClientCertificatePassword](docsource/images/AzureApp2-custom-field-ClientCertificatePassword-dialog.svg) + ![AzureApp2 Custom Field - ClientCertificatePassword](docsource/images/AzureApp2-custom-field-ClientCertificatePassword-validation-options-dialog.svg) ###### Azure Global Cloud Authority Host Specifies the Azure Cloud instance used by the organization. - ![AzureApp2 Custom Field - AzureCloud](docsource/images/AzureApp2-custom-field-AzureCloud-dialog.png) - ![AzureApp2 Custom Field - AzureCloud](docsource/images/AzureApp2-custom-field-AzureCloud-validation-options-dialog.png) - - - + ![AzureApp2 Custom Field - AzureCloud](docsource/images/AzureApp2-custom-field-AzureCloud-dialog.svg) + ![AzureApp2 Custom Field - AzureCloud](docsource/images/AzureApp2-custom-field-AzureCloud-validation-options-dialog.svg)
@@ -681,7 +624,6 @@ the Keyfactor Command Portal
Click to expand details - The Azure Enterprise Application/Service Principal certificate operations are implemented by the `AzureSP` store type, and supports the management of a single certificate for use in `SSO/SAML` assertion signing. The Management Add operation is only supported with the certificate replacement option, since adding a new certificate will replace the existing @@ -690,9 +632,6 @@ Management Remove operation removes the certificate from the Enterprise Applicat as removing the `SSO/SAML` signing certificate. The Discovery operation discovers all Enterprise Applications/Service Principals in the tenant. - - - #### Azure Enterprise Application 2 (Service Principal) Requirements Service Principal certificates are typically used for SAML Token signing. Service Principals are created from Enterprise @@ -701,23 +640,22 @@ Microsoft's [SAML-based single sign-on](https://learn.microsoft.com/en-us/entra/ documentation. For more information on the mechanics of the Service Principal certificate management capabilities, please see the [mechanics](#extension-mechanics) section. - - #### Supported Operations -| Operation | Is Supported | -|--------------|------------------------------------------------------------------------------------------------------------------------| -| Add | ✅ Checked | -| Remove | ✅ Checked | -| Discovery | ✅ Checked | +| Operation | Is Supported | +|--------------|--------------| +| Add | ✅ Checked | +| Remove | ✅ Checked | +| Discovery | ✅ Checked | | Reenrollment | 🔲 Unchecked | -| Create | 🔲 Unchecked | +| Create | 🔲 Unchecked | #### Store Type Creation ##### Using kfutil: `kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types. For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out the [docs](https://github.com/Keyfactor/kfutil?tab=readme-ov-file#quickstart) +
Click to expand AzureSP2 kfutil details ##### Using online definition from GitHub: @@ -736,10 +674,10 @@ For more information on [kfutil](https://github.com/Keyfactor/kfutil) check out ```
- #### Manual Creation Below are instructions on how to create the AzureSP2 store type manually in the Keyfactor Command Portal +
Click to expand manual AzureSP2 details Create a store type called `AzureSP2` with the attributes in the tables below: @@ -750,11 +688,11 @@ the Keyfactor Command Portal | Name | Azure Enterprise Application 2 (Service Principal) | Display name for the store type (may be customized) | | Short Name | AzureSP2 | Short display name for the store type | | Capability | AzureSP2 | Store type name orchestrator will register with. Check the box to allow entry of value | - | Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add | - | Supports Remove | ✅ Checked | Check the box. Indicates that the Store Type supports Management Remove | - | Supports Discovery | ✅ Checked | Check the box. Indicates that the Store Type supports Discovery | - | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | - | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | + | Supports Add | ✅ Checked | Indicates that the Store Type supports Management Add | + | Supports Remove | ✅ Checked | Indicates that the Store Type supports Management Remove | + | Supports Discovery | ✅ Checked | Indicates that the Store Type supports Discovery | + | Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment | + | Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation | | Needs Server | ✅ Checked | Determines if a target server name is required when creating store | | Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint | | Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell | @@ -763,18 +701,18 @@ the Keyfactor Command Portal The Basic tab should look like this: - ![AzureSP2 Basic Tab](docsource/images/AzureSP2-basic-store-type-dialog.png) + ![AzureSP2 Basic Tab](docsource/images/AzureSP2-basic-store-type-dialog.svg) ##### Advanced Tab | Attribute | Value | Description | | --------- | ----- | ----- | | Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. | - | Private Key Handling | Required | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. | + | Private Key Handling | Required | This determines if Keyfactor can send the private key associated with a certificate to the store. | | PFX Password Style | Default | '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.) | The Advanced tab should look like this: - ![AzureSP2 Advanced Tab](docsource/images/AzureSP2-advanced-store-type-dialog.png) + ![AzureSP2 Advanced Tab](docsource/images/AzureSP2-advanced-store-type-dialog.svg) > For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX. @@ -791,8 +729,7 @@ the Keyfactor Command Portal The Custom Fields tab should look like this: - ![AzureSP2 Custom Fields Tab](docsource/images/AzureSP2-custom-fields-store-type-dialog.png) - + ![AzureSP2 Custom Fields Tab](docsource/images/AzureSP2-custom-fields-store-type-dialog.svg) ###### Server Username The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. @@ -802,8 +739,6 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Server Password A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you **must** check 'No Value'. @@ -812,32 +747,25 @@ the Keyfactor Command Portal > This field is created by the `Needs Server` on the Basic tab, do not create this field manually. - - ###### Client Certificate The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** check 'No Value'. - ![AzureSP2 Custom Field - ClientCertificate](docsource/images/AzureSP2-custom-field-ClientCertificate-dialog.png) - ![AzureSP2 Custom Field - ClientCertificate](docsource/images/AzureSP2-custom-field-ClientCertificate-validation-options-dialog.png) - + ![AzureSP2 Custom Field - ClientCertificate](docsource/images/AzureSP2-custom-field-ClientCertificate-dialog.svg) + ![AzureSP2 Custom Field - ClientCertificate](docsource/images/AzureSP2-custom-field-ClientCertificate-validation-options-dialog.svg) ###### Client Certificate Password The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you **must** check 'No Value'. - ![AzureSP2 Custom Field - ClientCertificatePassword](docsource/images/AzureSP2-custom-field-ClientCertificatePassword-dialog.png) - ![AzureSP2 Custom Field - ClientCertificatePassword](docsource/images/AzureSP2-custom-field-ClientCertificatePassword-validation-options-dialog.png) - + ![AzureSP2 Custom Field - ClientCertificatePassword](docsource/images/AzureSP2-custom-field-ClientCertificatePassword-dialog.svg) + ![AzureSP2 Custom Field - ClientCertificatePassword](docsource/images/AzureSP2-custom-field-ClientCertificatePassword-validation-options-dialog.svg) ###### Azure Global Cloud Authority Host Specifies the Azure Cloud instance used by the organization. - ![AzureSP2 Custom Field - AzureCloud](docsource/images/AzureSP2-custom-field-AzureCloud-dialog.png) - ![AzureSP2 Custom Field - AzureCloud](docsource/images/AzureSP2-custom-field-AzureCloud-validation-options-dialog.png) - - - + ![AzureSP2 Custom Field - AzureCloud](docsource/images/AzureSP2-custom-field-AzureCloud-dialog.svg) + ![AzureSP2 Custom Field - AzureCloud](docsource/images/AzureSP2-custom-field-AzureCloud-validation-options-dialog.svg)
@@ -848,14 +776,15 @@ the Keyfactor Command Portal 1. **Download the latest Azure App Registration and Enterprise Application Universal Orchestrator extension from GitHub.** - Navigate to the [Azure App Registration and Enterprise Application Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/azure-application-orchestrator/releases/latest). Refer to the compatibility matrix below to determine the asset should be downloaded. Then, click the corresponding asset to download the zip archive. + Navigate to the [Azure App Registration and Enterprise Application Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/azure-application-orchestrator/releases/latest). Refer to the compatibility matrix below to determine which asset should be downloaded. Then, click the corresponding asset to download the zip archive. | Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `azure-application-orchestrator` .NET version to download | | --------- | ----------- | ----------- | ----------- | | Older than `11.0.0` | | | `net6.0` | | Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` | - | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` || Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` | - | `11.6` _and_ newer | `net8.0` | | `net8.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` | + | Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` | + | `11.6` _and_ newer | `net8.0` | | `net8.0` | Unzip the archive containing extension assemblies to a known location. @@ -877,25 +806,20 @@ the Keyfactor Command Portal Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm). - 6. **(optional) PAM Integration** The Azure App Registration and Enterprise Application Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider. To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote). - > The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions). - - ## Defining Certificate Stores The Azure App Registration and Enterprise Application Universal Orchestrator extension implements 4 Certificate Store Types, each of which implements different functionality. Refer to the individual instructions below for each Certificate Store Type that you deemed necessary for your use case from the installation section.
Azure App Registration (Application) (AzureApp) - ### Store Creation #### Manually with the Command UI @@ -910,8 +834,8 @@ The Azure App Registration and Enterprise Application Universal Orchestrator ext Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- |---------------------------------------------------------| + | Attribute | Description | + | --------- | ----------- | | Category | Select "Azure App Registration (Application)" or the customized certificate store name from the previous step. | | Container | Optional container to associate certificate store with. | | Client Machine | The Azure Tenant (directory) ID that owns the Service Principal. | @@ -924,8 +848,6 @@ The Azure App Registration and Enterprise Application Universal Orchestrator ext
- - #### Using kfutil CLI
Click to expand details @@ -959,7 +881,6 @@ The Azure App Registration and Enterprise Application Universal Orchestrator ext
- #### PAM Provider Eligible Fields
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator @@ -976,15 +897,12 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- > The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). -
Azure Enterprise Application (Service Principal) (AzureSP) - ### Store Creation #### Manually with the Command UI @@ -999,8 +917,8 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- |---------------------------------------------------------| + | Attribute | Description | + | --------- | ----------- | | Category | Select "Azure Enterprise Application (Service Principal)" or the customized certificate store name from the previous step. | | Container | Optional container to associate certificate store with. | | Client Machine | The Azure Tenant (directory) ID that owns the Service Principal. | @@ -1013,8 +931,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- - #### Using kfutil CLI
Click to expand details @@ -1048,7 +964,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- #### PAM Provider Eligible Fields
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator @@ -1065,15 +980,12 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- > The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). -
Azure App Registration 2 (Application) (AzureApp2) - ### Store Creation #### Manually with the Command UI @@ -1088,8 +1000,8 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- |---------------------------------------------------------| + | Attribute | Description | + | --------- | ----------- | | Category | Select "Azure App Registration 2 (Application)" or the customized certificate store name from the previous step. | | Container | Optional container to associate certificate store with. | | Client Machine | The Azure Tenant (directory) ID where the Application is instantiated | @@ -1103,8 +1015,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- - #### Using kfutil CLI
Click to expand details @@ -1139,7 +1049,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- #### PAM Provider Eligible Fields
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator @@ -1157,15 +1066,12 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- > The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). -
Azure Enterprise Application 2 (Service Principal) (AzureSP2) - ### Store Creation #### Manually with the Command UI @@ -1180,8 +1086,8 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form. - | Attribute | Description | - | --------- |---------------------------------------------------------| + | Attribute | Description | + | --------- | ----------- | | Category | Select "Azure Enterprise Application 2 (Service Principal)" or the customized certificate store name from the previous step. | | Container | Optional container to associate certificate store with. | | Client Machine | The Azure Tenant (directory) ID where the Service Principal is instantiated | @@ -1195,8 +1101,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- - #### Using kfutil CLI
Click to expand details @@ -1231,7 +1135,6 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- #### PAM Provider Eligible Fields
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator @@ -1249,13 +1152,12 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
- > The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store). -
## Discovering Certificate Stores with the Discovery Job + Discovery for all four Certificate Store Types implemented by the Azure App Registration and Enterprise Application Orchestrator extension returns Store Paths in the format ` ()`. When defining Certificate Stores manually, you may elect to follow this format, or use the standard `` for the Store Path. @@ -1275,16 +1177,10 @@ The Discovery operation uses the "Directories to search" field and accepts input tenants. - - - - - - ## License Apache License 2.0, see [LICENSE](LICENSE). ## Related Integrations -See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). \ No newline at end of file +See all [Keyfactor Universal Orchestrator extensions](https://github.com/orgs/Keyfactor/repositories?q=orchestrator). diff --git a/docsource/images/AzureApp-advanced-store-type-dialog.svg b/docsource/images/AzureApp-advanced-store-type-dialog.svg new file mode 100644 index 0000000..6957ae3 --- /dev/null +++ b/docsource/images/AzureApp-advanced-store-type-dialog.svg @@ -0,0 +1,67 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + + Custom Fields + Entry Parameters + + + + + Store Path Type + + + + Freeform + + Fixed + + Multiple Choice + + + + + Other Settings + + Supports Custom Alias + + Forbidden + + Optional + + + Required + Private Key Handling + + + Forbidden + + Optional + + Required + PFX Password Style + + + Default + + Custom + \ No newline at end of file diff --git a/docsource/images/AzureApp-basic-store-type-dialog.svg b/docsource/images/AzureApp-basic-store-type-dialog.svg new file mode 100644 index 0000000..99504c3 --- /dev/null +++ b/docsource/images/AzureApp-basic-store-type-dialog.svg @@ -0,0 +1,84 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + + Advanced + Custom Fields + Entry Parameters + + + + + Details + + Name + + Azure App Registration (Application) + Short Name + + AzureApp + Custom Capability + + + Custom Capability + + + + Supported Job Types + + + + Inventory + + + Add + + + Remove + + Create + + + Discovery + + ODKG + + + + General Settings + + + + Needs Server + + Blueprint Allowed + + Uses PowerShell + + + + Password Settings + + + Requires Store Password + + Supports Entry Password + \ No newline at end of file diff --git a/docsource/images/AzureApp-custom-field-AzureCloud-dialog.svg b/docsource/images/AzureApp-custom-field-AzureCloud-dialog.svg new file mode 100644 index 0000000..e11ea3f --- /dev/null +++ b/docsource/images/AzureApp-custom-field-AzureCloud-dialog.svg @@ -0,0 +1,49 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + AzureCloud + Display Name + + Azure Global Cloud Authority Host + Type + + MultipleChoice + ∨ + Multiple Choice Options + + public,china,germany,government + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp-custom-field-AzureCloud-validation-options-dialog.svg b/docsource/images/AzureApp-custom-field-AzureCloud-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureApp-custom-field-AzureCloud-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp-custom-field-ClientCertificate-dialog.svg b/docsource/images/AzureApp-custom-field-ClientCertificate-dialog.svg new file mode 100644 index 0000000..4b82ca9 --- /dev/null +++ b/docsource/images/AzureApp-custom-field-ClientCertificate-dialog.svg @@ -0,0 +1,49 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ClientCertificate + Display Name + + Client Certificate + Type + + Secret + ∨ + Default Value + + + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp-custom-field-ClientCertificate-validation-options-dialog.svg b/docsource/images/AzureApp-custom-field-ClientCertificate-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureApp-custom-field-ClientCertificate-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp-custom-fields-store-type-dialog.svg b/docsource/images/AzureApp-custom-fields-store-type-dialog.svg new file mode 100644 index 0000000..3035b10 --- /dev/null +++ b/docsource/images/AzureApp-custom-fields-store-type-dialog.svg @@ -0,0 +1,79 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + Custom Fields + + Entry Parameters + + + + + + ADD + + EDIT + + DELETE + Total: 4 + + + Display Name + Type + Default Value / Options + + + + + + + + + + + Server Username + Secret + + + + + + + Server Password + Secret + + + + + + + Client Certificate + Secret + + + + + + + Azure Global Cloud Authority Host + MultipleChoice + public,china,germany,government + \ No newline at end of file diff --git a/docsource/images/AzureApp2-advanced-store-type-dialog.svg b/docsource/images/AzureApp2-advanced-store-type-dialog.svg new file mode 100644 index 0000000..6957ae3 --- /dev/null +++ b/docsource/images/AzureApp2-advanced-store-type-dialog.svg @@ -0,0 +1,67 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + + Custom Fields + Entry Parameters + + + + + Store Path Type + + + + Freeform + + Fixed + + Multiple Choice + + + + + Other Settings + + Supports Custom Alias + + Forbidden + + Optional + + + Required + Private Key Handling + + + Forbidden + + Optional + + Required + PFX Password Style + + + Default + + Custom + \ No newline at end of file diff --git a/docsource/images/AzureApp2-basic-store-type-dialog.svg b/docsource/images/AzureApp2-basic-store-type-dialog.svg new file mode 100644 index 0000000..e477686 --- /dev/null +++ b/docsource/images/AzureApp2-basic-store-type-dialog.svg @@ -0,0 +1,84 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + + Advanced + Custom Fields + Entry Parameters + + + + + Details + + Name + + Azure App Registration 2 (Application) + Short Name + + AzureApp2 + Custom Capability + + + Custom Capability + + + + Supported Job Types + + + + Inventory + + + Add + + + Remove + + Create + + + Discovery + + ODKG + + + + General Settings + + + + Needs Server + + Blueprint Allowed + + Uses PowerShell + + + + Password Settings + + + Requires Store Password + + Supports Entry Password + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-field-AzureCloud-dialog.svg b/docsource/images/AzureApp2-custom-field-AzureCloud-dialog.svg new file mode 100644 index 0000000..e11ea3f --- /dev/null +++ b/docsource/images/AzureApp2-custom-field-AzureCloud-dialog.svg @@ -0,0 +1,49 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + AzureCloud + Display Name + + Azure Global Cloud Authority Host + Type + + MultipleChoice + ∨ + Multiple Choice Options + + public,china,germany,government + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-field-AzureCloud-validation-options-dialog.svg b/docsource/images/AzureApp2-custom-field-AzureCloud-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureApp2-custom-field-AzureCloud-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-field-ClientCertificate-dialog.svg b/docsource/images/AzureApp2-custom-field-ClientCertificate-dialog.svg new file mode 100644 index 0000000..2da2f5a --- /dev/null +++ b/docsource/images/AzureApp2-custom-field-ClientCertificate-dialog.svg @@ -0,0 +1,50 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ClientCertificate + Display Name + + Client Certificate + Type + + Secret + ∨ + Default Value + + + Depends On + + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-field-ClientCertificate-validation-options-dialog.svg b/docsource/images/AzureApp2-custom-field-ClientCertificate-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureApp2-custom-field-ClientCertificate-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-field-ClientCertificatePassword-dialog.svg b/docsource/images/AzureApp2-custom-field-ClientCertificatePassword-dialog.svg new file mode 100644 index 0000000..e0d1e5d --- /dev/null +++ b/docsource/images/AzureApp2-custom-field-ClientCertificatePassword-dialog.svg @@ -0,0 +1,50 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ClientCertificatePassword + Display Name + + Client Certificate Password + Type + + Secret + ∨ + Default Value + + + Depends On + + + + Client Certificate + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-field-ClientCertificatePassword-validation-options-dialog.svg b/docsource/images/AzureApp2-custom-field-ClientCertificatePassword-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureApp2-custom-field-ClientCertificatePassword-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureApp2-custom-fields-store-type-dialog.svg b/docsource/images/AzureApp2-custom-fields-store-type-dialog.svg new file mode 100644 index 0000000..276f852 --- /dev/null +++ b/docsource/images/AzureApp2-custom-fields-store-type-dialog.svg @@ -0,0 +1,87 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + Custom Fields + + Entry Parameters + + + + + + ADD + + EDIT + + DELETE + Total: 5 + + + Display Name + Type + Default Value / Options + + + + + + + + + + + Server Username + Secret + + + + + + + Server Password + Secret + + + + + + + Client Certificate + Secret + + + + + + + Client Certificate Password + Secret + + + + + + + Azure Global Cloud Authority Host + MultipleChoice + public,china,germany,government + \ No newline at end of file diff --git a/docsource/images/AzureSP-advanced-store-type-dialog.svg b/docsource/images/AzureSP-advanced-store-type-dialog.svg new file mode 100644 index 0000000..123a979 --- /dev/null +++ b/docsource/images/AzureSP-advanced-store-type-dialog.svg @@ -0,0 +1,67 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + + Custom Fields + Entry Parameters + + + + + Store Path Type + + + + Freeform + + Fixed + + Multiple Choice + + + + + Other Settings + + Supports Custom Alias + + Forbidden + + Optional + + + Required + Private Key Handling + + Forbidden + + Optional + + + Required + PFX Password Style + + + Default + + Custom + \ No newline at end of file diff --git a/docsource/images/AzureSP-basic-store-type-dialog.svg b/docsource/images/AzureSP-basic-store-type-dialog.svg new file mode 100644 index 0000000..8967fb1 --- /dev/null +++ b/docsource/images/AzureSP-basic-store-type-dialog.svg @@ -0,0 +1,84 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + + Advanced + Custom Fields + Entry Parameters + + + + + Details + + Name + + Azure Enterprise Application (Service Principal) + Short Name + + AzureSP + Custom Capability + + + Custom Capability + + + + Supported Job Types + + + + Inventory + + + Add + + + Remove + + Create + + + Discovery + + ODKG + + + + General Settings + + + + Needs Server + + Blueprint Allowed + + Uses PowerShell + + + + Password Settings + + + Requires Store Password + + Supports Entry Password + \ No newline at end of file diff --git a/docsource/images/AzureSP-custom-field-AzureCloud-dialog.svg b/docsource/images/AzureSP-custom-field-AzureCloud-dialog.svg new file mode 100644 index 0000000..e11ea3f --- /dev/null +++ b/docsource/images/AzureSP-custom-field-AzureCloud-dialog.svg @@ -0,0 +1,49 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + AzureCloud + Display Name + + Azure Global Cloud Authority Host + Type + + MultipleChoice + ∨ + Multiple Choice Options + + public,china,germany,government + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP-custom-field-AzureCloud-validation-options-dialog.svg b/docsource/images/AzureSP-custom-field-AzureCloud-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureSP-custom-field-AzureCloud-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP-custom-field-ClientCertificate-dialog.svg b/docsource/images/AzureSP-custom-field-ClientCertificate-dialog.svg new file mode 100644 index 0000000..4b82ca9 --- /dev/null +++ b/docsource/images/AzureSP-custom-field-ClientCertificate-dialog.svg @@ -0,0 +1,49 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ClientCertificate + Display Name + + Client Certificate + Type + + Secret + ∨ + Default Value + + + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP-custom-field-ClientCertificate-validation-options-dialog.svg b/docsource/images/AzureSP-custom-field-ClientCertificate-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureSP-custom-field-ClientCertificate-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP-custom-fields-store-type-dialog.svg b/docsource/images/AzureSP-custom-fields-store-type-dialog.svg new file mode 100644 index 0000000..3035b10 --- /dev/null +++ b/docsource/images/AzureSP-custom-fields-store-type-dialog.svg @@ -0,0 +1,79 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + Custom Fields + + Entry Parameters + + + + + + ADD + + EDIT + + DELETE + Total: 4 + + + Display Name + Type + Default Value / Options + + + + + + + + + + + Server Username + Secret + + + + + + + Server Password + Secret + + + + + + + Client Certificate + Secret + + + + + + + Azure Global Cloud Authority Host + MultipleChoice + public,china,germany,government + \ No newline at end of file diff --git a/docsource/images/AzureSP2-advanced-store-type-dialog.svg b/docsource/images/AzureSP2-advanced-store-type-dialog.svg new file mode 100644 index 0000000..123a979 --- /dev/null +++ b/docsource/images/AzureSP2-advanced-store-type-dialog.svg @@ -0,0 +1,67 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + + Custom Fields + Entry Parameters + + + + + Store Path Type + + + + Freeform + + Fixed + + Multiple Choice + + + + + Other Settings + + Supports Custom Alias + + Forbidden + + Optional + + + Required + Private Key Handling + + Forbidden + + Optional + + + Required + PFX Password Style + + + Default + + Custom + \ No newline at end of file diff --git a/docsource/images/AzureSP2-basic-store-type-dialog.svg b/docsource/images/AzureSP2-basic-store-type-dialog.svg new file mode 100644 index 0000000..89f58db --- /dev/null +++ b/docsource/images/AzureSP2-basic-store-type-dialog.svg @@ -0,0 +1,84 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + + Advanced + Custom Fields + Entry Parameters + + + + + Details + + Name + + Azure Enterprise Application 2 (Service Principal) + Short Name + + AzureSP2 + Custom Capability + + + Custom Capability + + + + Supported Job Types + + + + Inventory + + + Add + + + Remove + + Create + + + Discovery + + ODKG + + + + General Settings + + + + Needs Server + + Blueprint Allowed + + Uses PowerShell + + + + Password Settings + + + Requires Store Password + + Supports Entry Password + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-field-AzureCloud-dialog.svg b/docsource/images/AzureSP2-custom-field-AzureCloud-dialog.svg new file mode 100644 index 0000000..e11ea3f --- /dev/null +++ b/docsource/images/AzureSP2-custom-field-AzureCloud-dialog.svg @@ -0,0 +1,49 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + AzureCloud + Display Name + + Azure Global Cloud Authority Host + Type + + MultipleChoice + ∨ + Multiple Choice Options + + public,china,germany,government + Depends On + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-field-AzureCloud-validation-options-dialog.svg b/docsource/images/AzureSP2-custom-field-AzureCloud-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureSP2-custom-field-AzureCloud-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-field-ClientCertificate-dialog.svg b/docsource/images/AzureSP2-custom-field-ClientCertificate-dialog.svg new file mode 100644 index 0000000..2da2f5a --- /dev/null +++ b/docsource/images/AzureSP2-custom-field-ClientCertificate-dialog.svg @@ -0,0 +1,50 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ClientCertificate + Display Name + + Client Certificate + Type + + Secret + ∨ + Default Value + + + Depends On + + + + Server Username + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-field-ClientCertificate-validation-options-dialog.svg b/docsource/images/AzureSP2-custom-field-ClientCertificate-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureSP2-custom-field-ClientCertificate-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-field-ClientCertificatePassword-dialog.svg b/docsource/images/AzureSP2-custom-field-ClientCertificatePassword-dialog.svg new file mode 100644 index 0000000..e0d1e5d --- /dev/null +++ b/docsource/images/AzureSP2-custom-field-ClientCertificatePassword-dialog.svg @@ -0,0 +1,50 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + + Validation Options + + Name + + ClientCertificatePassword + Display Name + + Client Certificate Password + Type + + Secret + ∨ + Default Value + + + Depends On + + + + Client Certificate + ∨ + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-field-ClientCertificatePassword-validation-options-dialog.svg b/docsource/images/AzureSP2-custom-field-ClientCertificatePassword-validation-options-dialog.svg new file mode 100644 index 0000000..22f8bbd --- /dev/null +++ b/docsource/images/AzureSP2-custom-field-ClientCertificatePassword-validation-options-dialog.svg @@ -0,0 +1,39 @@ + + + + + + + + + Edit Custom Field + × + + + + Basic Information + Validation Options + + + Creating a certificate store + + + Optional + + Required + + Hidden + + + CANCEL + + SAVE + \ No newline at end of file diff --git a/docsource/images/AzureSP2-custom-fields-store-type-dialog.svg b/docsource/images/AzureSP2-custom-fields-store-type-dialog.svg new file mode 100644 index 0000000..276f852 --- /dev/null +++ b/docsource/images/AzureSP2-custom-fields-store-type-dialog.svg @@ -0,0 +1,87 @@ + + + + + + + + + Edit Certificate Store Type + + + + Basic + Advanced + Custom Fields + + Entry Parameters + + + + + + ADD + + EDIT + + DELETE + Total: 5 + + + Display Name + Type + Default Value / Options + + + + + + + + + + + Server Username + Secret + + + + + + + Server Password + Secret + + + + + + + Client Certificate + Secret + + + + + + + Client Certificate Password + Secret + + + + + + + Azure Global Cloud Authority Host + MultipleChoice + public,china,germany,government + \ No newline at end of file diff --git a/scripts/store_types/bash/curl_create_store_types.sh b/scripts/store_types/bash/curl_create_store_types.sh index dfb43f2..655d312 100755 --- a/scripts/store_types/bash/curl_create_store_types.sh +++ b/scripts/store_types/bash/curl_create_store_types.sh @@ -1,83 +1,24 @@ -#!/usr/bin/env bash +#!/bin/bash +# Store Type creation script using curl +# Generated by Doctool -# Creates all 4 store types via the Keyfactor Command REST API using curl. -# -# Authentication (first matching method is used): -# OAuth access token: KEYFACTOR_AUTH_ACCESS_TOKEN -# OAuth client creds: KEYFACTOR_AUTH_CLIENT_ID + KEYFACTOR_AUTH_CLIENT_SECRET -# + KEYFACTOR_AUTH_TOKEN_URL -# Basic auth (AD): KEYFACTOR_USERNAME + KEYFACTOR_PASSWORD + KEYFACTOR_DOMAIN -# -# Always required: -# KEYFACTOR_HOSTNAME Command hostname (e.g. my-command.example.com) -# -# Auto-generated by doctool generate-store-type-scripts — do not edit by hand. +set -e -if [ -z "${KEYFACTOR_HOSTNAME}" ]; then - echo "ERROR: KEYFACTOR_HOSTNAME is required" - exit 1 -fi +# Configuration - set these variables before running +KEYFACTOR_HOSTNAME="${KEYFACTOR_HOSTNAME}" +KEYFACTOR_API_PATH="${KEYFACTOR_API_PATH:-KeyfactorAPI}" +KEYFACTOR_AUTH_TOKEN="${KEYFACTOR_AUTH_TOKEN}" -BASE_URL="https://${KEYFACTOR_HOSTNAME}/keyfactorapi" - -# --------------------------------------------------------------------------- -# Resolve auth -# --------------------------------------------------------------------------- -if [ -n "${KEYFACTOR_AUTH_ACCESS_TOKEN}" ]; then - BEARER_TOKEN="${KEYFACTOR_AUTH_ACCESS_TOKEN}" -elif [ -n "${KEYFACTOR_AUTH_CLIENT_ID}" ] && [ -n "${KEYFACTOR_AUTH_CLIENT_SECRET}" ] && [ -n "${KEYFACTOR_AUTH_TOKEN_URL}" ]; then - echo "Fetching OAuth token..." - BEARER_TOKEN=$(curl -s -X POST "${KEYFACTOR_AUTH_TOKEN_URL}" \ - -H "Content-Type: application/x-www-form-urlencoded" \ - --data-urlencode "grant_type=client_credentials" \ - --data-urlencode "client_id=${KEYFACTOR_AUTH_CLIENT_ID}" \ - --data-urlencode "client_secret=${KEYFACTOR_AUTH_CLIENT_SECRET}" | jq -r '.access_token') - if [ -z "${BEARER_TOKEN}" ] || [ "${BEARER_TOKEN}" = "null" ]; then - echo "ERROR: Failed to fetch OAuth token from ${KEYFACTOR_AUTH_TOKEN_URL}" - exit 1 - fi -elif [ -n "${KEYFACTOR_USERNAME}" ] && [ -n "${KEYFACTOR_PASSWORD}" ] && [ -n "${KEYFACTOR_DOMAIN}" ]; then - BEARER_TOKEN="" -else - echo "ERROR: Authentication required. Set one of:" - echo " KEYFACTOR_AUTH_ACCESS_TOKEN" - echo " KEYFACTOR_AUTH_CLIENT_ID + KEYFACTOR_AUTH_CLIENT_SECRET + KEYFACTOR_AUTH_TOKEN_URL" - echo " KEYFACTOR_USERNAME + KEYFACTOR_PASSWORD + KEYFACTOR_DOMAIN" - exit 1 -fi - -if [ -n "${BEARER_TOKEN}" ]; then - CURL_AUTH=("-H" "Authorization: Bearer ${BEARER_TOKEN}") -else - CURL_AUTH=("-u" "${KEYFACTOR_USERNAME}@${KEYFACTOR_DOMAIN}:${KEYFACTOR_PASSWORD}") -fi - -create_store_type() { - local name="$1" - local body="$2" - echo "Creating ${name} store type..." - response=$(curl -s -o /dev/null -w "%{http_code}" \ - -X POST "${BASE_URL}/certificatestoretypes" \ - -H "Content-Type: application/json" \ - -H "x-keyfactor-requested-with: APIClient" \ - "${CURL_AUTH[@]}" \ - -d "${body}") - if [ "$response" = "200" ] || [ "$response" = "201" ]; then - echo " OK (HTTP ${response})" - else - echo " FAILED (HTTP ${response})" - fi -} - -# --------------------------------------------------------------------------- -# AzureApp — The Azure Tenant (directory) ID that owns the Service Principal. -# --------------------------------------------------------------------------- -create_store_type "AzureApp" '{ +echo "Creating store type: AzureApp" +curl -s -X POST "https://${KEYFACTOR_HOSTNAME}/${KEYFACTOR_API_PATH}/CertificateStoreTypes" \ + -H "Authorization: Bearer ${KEYFACTOR_AUTH_TOKEN}" \ + -H "Content-Type: application/json" \ + -H "x-keyfactor-requested-with: APIClient" \ + -d '{ "Name": "Azure App Registration (Application)", "ShortName": "AzureApp", "Capability": "AzureApp", "LocalStore": false, - "StorePathDescription": "The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -86,10 +27,25 @@ create_store_type "AzureApp" '{ "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used _and_ the Client Certificate's private key is not encrypted, you **must** select 'No Value' for this field.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** select 'No Value' for this field.", "Required": false }, { @@ -97,6 +53,7 @@ create_store_type "AzureApp" '{ "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -112,15 +69,16 @@ create_store_type "AzureApp" '{ "CustomAliasAllowed": "Required" }' -# --------------------------------------------------------------------------- -# AzureSP — The Azure Tenant (directory) ID that owns the Service Principal. -# --------------------------------------------------------------------------- -create_store_type "AzureSP" '{ +echo "Creating store type: AzureSP" +curl -s -X POST "https://${KEYFACTOR_HOSTNAME}/${KEYFACTOR_API_PATH}/CertificateStoreTypes" \ + -H "Authorization: Bearer ${KEYFACTOR_AUTH_TOKEN}" \ + -H "Content-Type: application/json" \ + -H "x-keyfactor-requested-with: APIClient" \ + -d '{ "Name": "Azure Enterprise Application (Service Principal)", "ShortName": "AzureSP", "Capability": "AzureSP", "LocalStore": false, - "StorePathDescription": "The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -129,10 +87,25 @@ create_store_type "AzureSP" '{ "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used _and_ the Client Certificate's private key is not encrypted, you **must** select 'No Value' for this field.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** select 'No Value' for this field.", "Required": false }, { @@ -140,6 +113,7 @@ create_store_type "AzureSP" '{ "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -155,15 +129,16 @@ create_store_type "AzureSP" '{ "CustomAliasAllowed": "Required" }' -# --------------------------------------------------------------------------- -# AzureApp2 — The Azure Tenant (directory) ID where the Application is instantiated -# --------------------------------------------------------------------------- -create_store_type "AzureApp2" '{ +echo "Creating store type: AzureApp2" +curl -s -X POST "https://${KEYFACTOR_HOSTNAME}/${KEYFACTOR_API_PATH}/CertificateStoreTypes" \ + -H "Authorization: Bearer ${KEYFACTOR_AUTH_TOKEN}" \ + -H "Content-Type: application/json" \ + -H "x-keyfactor-requested-with: APIClient" \ + -d '{ "Name": "Azure App Registration 2 (Application)", "ShortName": "AzureApp2", "Capability": "AzureApp2", "LocalStore": false, - "StorePathDescription": "The Object ID of the target Application/App Registration that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -172,11 +147,27 @@ create_store_type "AzureApp2" '{ "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "DependsOn": "ServerUsername", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you **must** select 'No Value'.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "DependsOn": "ServerUsername", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** check 'No Value'.", "Required": false }, { @@ -184,6 +175,7 @@ create_store_type "AzureApp2" '{ "DisplayName": "Client Certificate Password", "DependsOn": "ClientCertificate", "Type": "Secret", + "Description": "The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you **must** check 'No Value'.", "Required": false }, { @@ -191,6 +183,7 @@ create_store_type "AzureApp2" '{ "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -206,15 +199,16 @@ create_store_type "AzureApp2" '{ "CustomAliasAllowed": "Required" }' -# --------------------------------------------------------------------------- -# AzureSP2 — The Azure Tenant (directory) ID where the Service Principal is instantiated -# --------------------------------------------------------------------------- -create_store_type "AzureSP2" '{ +echo "Creating store type: AzureSP2" +curl -s -X POST "https://${KEYFACTOR_HOSTNAME}/${KEYFACTOR_API_PATH}/CertificateStoreTypes" \ + -H "Authorization: Bearer ${KEYFACTOR_AUTH_TOKEN}" \ + -H "Content-Type: application/json" \ + -H "x-keyfactor-requested-with: APIClient" \ + -d '{ "Name": "Azure Enterprise Application 2 (Service Principal)", "ShortName": "AzureSP2", "Capability": "AzureSP2", "LocalStore": false, - "StorePathDescription": "The Object ID of the target Service Principal/Enterprise Application that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -223,11 +217,27 @@ create_store_type "AzureSP2" '{ "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "DependsOn": "ServerUsername", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you **must** check 'No Value'.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "DependsOn": "ServerUsername", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** check 'No Value'.", "Required": false }, { @@ -235,6 +245,7 @@ create_store_type "AzureSP2" '{ "DisplayName": "Client Certificate Password", "DependsOn": "ClientCertificate", "Type": "Secret", + "Description": "The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you **must** check 'No Value'.", "Required": false }, { @@ -242,6 +253,7 @@ create_store_type "AzureSP2" '{ "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -257,5 +269,3 @@ create_store_type "AzureSP2" '{ "CustomAliasAllowed": "Required" }' - -echo "Completed." diff --git a/scripts/store_types/bash/kfutil_create_store_types.sh b/scripts/store_types/bash/kfutil_create_store_types.sh index 46ab6c0..ebbc437 100755 --- a/scripts/store_types/bash/kfutil_create_store_types.sh +++ b/scripts/store_types/bash/kfutil_create_store_types.sh @@ -1,31 +1,18 @@ -#!/usr/bin/env bash +#!/bin/bash +# Store Type creation script using kfutil +# Generated by Doctool -# Creates all 4 store types using kfutil. -# kfutil reads definitions from the Keyfactor integration catalog. -# -# Auth environment variables (first matching method is used): -# OAuth access token: KEYFACTOR_AUTH_ACCESS_TOKEN -# OAuth client creds: KEYFACTOR_AUTH_CLIENT_ID + KEYFACTOR_AUTH_CLIENT_SECRET -# + KEYFACTOR_AUTH_TOKEN_URL -# Basic auth (AD): KEYFACTOR_HOSTNAME + KEYFACTOR_USERNAME + KEYFACTOR_PASSWORD -# + KEYFACTOR_DOMAIN -# -# Auto-generated by doctool generate-store-type-scripts — do not edit by hand. +set -e -if ! command -v kfutil &> /dev/null; then - echo "kfutil could not be found. Please install kfutil" - echo "See https://github.com/Keyfactor/kfutil#quickstart" - exit 1 -fi +echo "Creating store type: AzureApp" +kfutil store-types create AzureApp -if [ -z "$KEYFACTOR_HOSTNAME" ]; then - echo "KEYFACTOR_HOSTNAME not set — launching kfutil login" - kfutil login -fi +echo "Creating store type: AzureSP" +kfutil store-types create AzureSP -kfutil store-types create --name "AzureApp" -kfutil store-types create --name "AzureSP" -kfutil store-types create --name "AzureApp2" -kfutil store-types create --name "AzureSP2" +echo "Creating store type: AzureApp2" +kfutil store-types create AzureApp2 + +echo "Creating store type: AzureSP2" +kfutil store-types create AzureSP2 -echo "Done. All store types created." diff --git a/scripts/store_types/powershell/kfutil_create_store_types.ps1 b/scripts/store_types/powershell/kfutil_create_store_types.ps1 index c86f3a5..de09026 100644 --- a/scripts/store_types/powershell/kfutil_create_store_types.ps1 +++ b/scripts/store_types/powershell/kfutil_create_store_types.ps1 @@ -1,32 +1,15 @@ -# Creates all 4 store types using kfutil. -# kfutil reads definitions from the Keyfactor integration catalog. -# -# Auth environment variables (first matching method is used): -# OAuth access token: KEYFACTOR_AUTH_ACCESS_TOKEN -# OAuth client creds: KEYFACTOR_AUTH_CLIENT_ID + KEYFACTOR_AUTH_CLIENT_SECRET -# + KEYFACTOR_AUTH_TOKEN_URL -# Basic auth (AD): KEYFACTOR_HOSTNAME + KEYFACTOR_USERNAME + KEYFACTOR_PASSWORD -# + KEYFACTOR_DOMAIN -# -# Auto-generated by doctool generate-store-type-scripts — do not edit by hand. +# Store Type creation script using kfutil +# Generated by Doctool -# Uncomment if kfutil is not in your PATH -# Set-Alias -Name kfutil -Value 'C:\Program Files\Keyfactor\kfutil\kfutil.exe' +Write-Host "Creating store type: AzureApp" +kfutil store-types create AzureApp -if ($null -eq (Get-Command "kfutil" -ErrorAction SilentlyContinue)) { - Write-Host "kfutil could not be found. Please install kfutil" - Write-Host "See https://github.com/Keyfactor/kfutil#quickstart" - exit 1 -} +Write-Host "Creating store type: AzureSP" +kfutil store-types create AzureSP -if (-not $env:KEYFACTOR_HOSTNAME) { - Write-Host "KEYFACTOR_HOSTNAME not set — launching kfutil login" - & kfutil login -} +Write-Host "Creating store type: AzureApp2" +kfutil store-types create AzureApp2 -& kfutil store-types create --name "AzureApp" -& kfutil store-types create --name "AzureSP" -& kfutil store-types create --name "AzureApp2" -& kfutil store-types create --name "AzureSP2" +Write-Host "Creating store type: AzureSP2" +kfutil store-types create AzureSP2 -Write-Host "Done. All store types created." diff --git a/scripts/store_types/powershell/restmethod_create_store_types.ps1 b/scripts/store_types/powershell/restmethod_create_store_types.ps1 index e8b85b4..e7838c0 100644 --- a/scripts/store_types/powershell/restmethod_create_store_types.ps1 +++ b/scripts/store_types/powershell/restmethod_create_store_types.ps1 @@ -1,76 +1,24 @@ -# Creates all 4 store types via the Keyfactor Command REST API -# using PowerShell Invoke-RestMethod. -# -# Authentication (first matching method is used): -# OAuth access token: KEYFACTOR_AUTH_ACCESS_TOKEN -# OAuth client creds: KEYFACTOR_AUTH_CLIENT_ID + KEYFACTOR_AUTH_CLIENT_SECRET -# + KEYFACTOR_AUTH_TOKEN_URL -# Basic auth (AD): KEYFACTOR_USERNAME + KEYFACTOR_PASSWORD + KEYFACTOR_DOMAIN -# -# Always required: -# KEYFACTOR_HOSTNAME Command hostname (e.g. my-command.example.com) -# -# Auto-generated by doctool generate-store-type-scripts — do not edit by hand. +# Store Type creation script using Invoke-RestMethod +# Generated by Doctool -if (-not $env:KEYFACTOR_HOSTNAME) { - Write-Error "KEYFACTOR_HOSTNAME is required" - exit 1 -} - -$uri = "https://$($env:KEYFACTOR_HOSTNAME)/keyfactorapi/certificatestoretypes" -$headers = @{ - 'Content-Type' = "application/json" - 'x-keyfactor-requested-with' = "APIClient" -} - -# --------------------------------------------------------------------------- -# Resolve auth -# --------------------------------------------------------------------------- -if ($env:KEYFACTOR_AUTH_ACCESS_TOKEN) { - $headers['Authorization'] = "Bearer $($env:KEYFACTOR_AUTH_ACCESS_TOKEN)" -} elseif ($env:KEYFACTOR_AUTH_CLIENT_ID -and $env:KEYFACTOR_AUTH_CLIENT_SECRET -and $env:KEYFACTOR_AUTH_TOKEN_URL) { - Write-Host "Fetching OAuth token..." - $tokenBody = @{ - grant_type = 'client_credentials' - client_id = $env:KEYFACTOR_AUTH_CLIENT_ID - client_secret = $env:KEYFACTOR_AUTH_CLIENT_SECRET - } - $tokenResp = Invoke-RestMethod -Method Post -Uri $env:KEYFACTOR_AUTH_TOKEN_URL -Body $tokenBody - $headers['Authorization'] = "Bearer $($tokenResp.access_token)" -} elseif ($env:KEYFACTOR_USERNAME -and $env:KEYFACTOR_PASSWORD -and $env:KEYFACTOR_DOMAIN) { - $cred = [System.Convert]::ToBase64String( - [System.Text.Encoding]::ASCII.GetBytes( - "$($env:KEYFACTOR_USERNAME)@$($env:KEYFACTOR_DOMAIN):$($env:KEYFACTOR_PASSWORD)")) - $headers['Authorization'] = "Basic $cred" -} else { - Write-Error ("Authentication required. Set one of:`n" + - " KEYFACTOR_AUTH_ACCESS_TOKEN`n" + - " KEYFACTOR_AUTH_CLIENT_ID + KEYFACTOR_AUTH_CLIENT_SECRET + KEYFACTOR_AUTH_TOKEN_URL`n" + - " KEYFACTOR_USERNAME + KEYFACTOR_PASSWORD + KEYFACTOR_DOMAIN") - exit 1 -} +# Configuration - set these variables before running +$KeyfactorHostname = $env:KEYFACTOR_HOSTNAME +$KeyfactorApiPath = if ($env:KEYFACTOR_API_PATH) { $env:KEYFACTOR_API_PATH } else { "KeyfactorAPI" } +$KeyfactorAuthToken = $env:KEYFACTOR_AUTH_TOKEN -function New-StoreType { - param([string]$Name, [string]$Body) - Write-Host "Creating $Name store type..." - try { - Invoke-RestMethod -Method Post -Uri $uri -Headers $headers -Body $Body -ContentType "application/json" | Out-Null - Write-Host " OK" - } catch { - Write-Warning " FAILED: $($_.Exception.Message)" - } +$Headers = @{ + "Authorization" = "Bearer $KeyfactorAuthToken" + "Content-Type" = "application/json" + "x-keyfactor-requested-with" = "APIClient" } -# --------------------------------------------------------------------------- -# AzureApp — The Azure Tenant (directory) ID that owns the Service Principal. -# --------------------------------------------------------------------------- -New-StoreType "AzureApp" @' +Write-Host "Creating store type: AzureApp" +$Body = @' { "Name": "Azure App Registration (Application)", "ShortName": "AzureApp", "Capability": "AzureApp", "LocalStore": false, - "StorePathDescription": "The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -79,10 +27,25 @@ New-StoreType "AzureApp" @' "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used _and_ the Client Certificate's private key is not encrypted, you **must** select 'No Value' for this field.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** select 'No Value' for this field.", "Required": false }, { @@ -90,6 +53,7 @@ New-StoreType "AzureApp" @' "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -106,16 +70,15 @@ New-StoreType "AzureApp" @' } '@ -# --------------------------------------------------------------------------- -# AzureSP — The Azure Tenant (directory) ID that owns the Service Principal. -# --------------------------------------------------------------------------- -New-StoreType "AzureSP" @' +Invoke-RestMethod -Uri "https://$KeyfactorHostname/$KeyfactorApiPath/CertificateStoreTypes" -Method POST -Headers $Headers -Body $Body + +Write-Host "Creating store type: AzureSP" +$Body = @' { "Name": "Azure Enterprise Application (Service Principal)", "ShortName": "AzureSP", "Capability": "AzureSP", "LocalStore": false, - "StorePathDescription": "The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -124,10 +87,25 @@ New-StoreType "AzureSP" @' "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used _and_ the Client Certificate's private key is not encrypted, you **must** select 'No Value' for this field.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** select 'No Value' for this field.", "Required": false }, { @@ -135,6 +113,7 @@ New-StoreType "AzureSP" @' "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -151,16 +130,15 @@ New-StoreType "AzureSP" @' } '@ -# --------------------------------------------------------------------------- -# AzureApp2 — The Azure Tenant (directory) ID where the Application is instantiated -# --------------------------------------------------------------------------- -New-StoreType "AzureApp2" @' +Invoke-RestMethod -Uri "https://$KeyfactorHostname/$KeyfactorApiPath/CertificateStoreTypes" -Method POST -Headers $Headers -Body $Body + +Write-Host "Creating store type: AzureApp2" +$Body = @' { "Name": "Azure App Registration 2 (Application)", "ShortName": "AzureApp2", "Capability": "AzureApp2", "LocalStore": false, - "StorePathDescription": "The Object ID of the target Application/App Registration that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -169,11 +147,27 @@ New-StoreType "AzureApp2" @' "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "DependsOn": "ServerUsername", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you **must** select 'No Value'.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "DependsOn": "ServerUsername", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** check 'No Value'.", "Required": false }, { @@ -181,6 +175,7 @@ New-StoreType "AzureApp2" @' "DisplayName": "Client Certificate Password", "DependsOn": "ClientCertificate", "Type": "Secret", + "Description": "The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you **must** check 'No Value'.", "Required": false }, { @@ -188,6 +183,7 @@ New-StoreType "AzureApp2" @' "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -204,16 +200,15 @@ New-StoreType "AzureApp2" @' } '@ -# --------------------------------------------------------------------------- -# AzureSP2 — The Azure Tenant (directory) ID where the Service Principal is instantiated -# --------------------------------------------------------------------------- -New-StoreType "AzureSP2" @' +Invoke-RestMethod -Uri "https://$KeyfactorHostname/$KeyfactorApiPath/CertificateStoreTypes" -Method POST -Headers $Headers -Body $Body + +Write-Host "Creating store type: AzureSP2" +$Body = @' { "Name": "Azure Enterprise Application 2 (Service Principal)", "ShortName": "AzureSP2", "Capability": "AzureSP2", "LocalStore": false, - "StorePathDescription": "The Object ID of the target Service Principal/Enterprise Application that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension.", "SupportedOperations": { "Add": true, "Remove": true, @@ -222,11 +217,27 @@ New-StoreType "AzureSP2" @' "Inventory": true }, "Properties": [ + { + "Name": "ServerUsername", + "DisplayName": "Server Username", + "Type": "Secret", + "Description": "The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates.", + "Required": true + }, + { + "Name": "ServerPassword", + "DisplayName": "Server Password", + "DependsOn": "ServerUsername", + "Type": "Secret", + "Description": "A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you **must** check 'No Value'.", + "Required": false + }, { "Name": "ClientCertificate", "DisplayName": "Client Certificate", "DependsOn": "ServerUsername", "Type": "Secret", + "Description": "The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the [requirements](#client-certificate-or-client-secret) for more information. If Client Certificate Auth is not used, you **must** check 'No Value'.", "Required": false }, { @@ -234,6 +245,7 @@ New-StoreType "AzureSP2" @' "DisplayName": "Client Certificate Password", "DependsOn": "ClientCertificate", "Type": "Secret", + "Description": "The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you **must** check 'No Value'.", "Required": false }, { @@ -241,6 +253,7 @@ New-StoreType "AzureSP2" @' "DisplayName": "Azure Global Cloud Authority Host", "Type": "MultipleChoice", "DefaultValue": "public,china,germany,government", + "Description": "Specifies the Azure Cloud instance used by the organization.", "Required": false } ], @@ -257,5 +270,5 @@ New-StoreType "AzureSP2" @' } '@ +Invoke-RestMethod -Uri "https://$KeyfactorHostname/$KeyfactorApiPath/CertificateStoreTypes" -Method POST -Headers $Headers -Body $Body -Write-Host "Completed."