Skip to content

Commit 87fd8c6

Browse files
idimov-keeperidimov-keeper
committed
Improved Keeper module lookup
1 parent 7cb6440 commit 87fd8c6

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

‎step-templates/keeper-secretsmanager-retrieve-secrets.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
"Name": "Keeper Secrets Manager - Retrieve Secrets",
44
"Description": "This step retrieves one or more secrets from a Keeper Vault and creates [sensitive output variables](https://octopus.com/docs/projects/variables/output-variables#sensitive-output-variables) for each value retrieved. These values can be used in other steps in your deployment or runbook process.\n\nYou can retrieve secrets using Keeper Notation URIs, and you can choose a custom output variable name for each secret.\n\n---\n\n**Required:** \n- A [Keeper Secrets Manager](https://docs.keeper.io/secrets-manager/) application with permissions to retrieve secrets from the Keeper Vault.\n- The `SecretManagement.Keeper.Extension` PowerShell module installed on the target or worker. If the module can't be found, the step will fail. *The `SecretManagement.Keeper` module(s) can be installed from the [PowerShell gallery](https://www.powershellgallery.com/packages/SecretManagement.Keeper)*\n\nNotes:\n\n- Tested on Octopus `2022.4`.\n- Tested with both Windows PowerShell and PowerShell Core on Linux.\n\n",
55
"ActionType": "Octopus.Script",
6-
"Version": 1,
6+
"Version": 2,
77
"CommunityActionTemplateId": null,
88
"Packages": [],
99
"Properties": {
1010
"Octopus.Action.Script.ScriptSource": "Inline",
1111
"Octopus.Action.Script.Syntax": "PowerShell",
1212
"OctopusUseBundledTooling": "False",
13-
"Octopus.Action.Script.ScriptBody": "$ErrorActionPreference = 'Stop'\n\n# Variables\n$KsmModuleName = \"SecretManagement.Keeper.Extension\"\n$KsmConfig = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.Config\"]\n$VaultSecrets = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.VaultSecrets\"]\n$KsmModuleSpecificVersion = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.KsmModule.SpecificVersion\"]\n$KsmModuleCustomInstallLocation = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.KsmModule.CustomInstallLocation\"]\n$PrintVariableNames = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.PrintVariableNames\"]\n\n# Validation\nif ([string]::IsNullOrWhiteSpace($VaultSecrets)) {\n throw \"Required parameter Keeper.SecretsManager.RetrieveSecrets.VaultSecrets not specified\"\n}\n\nif ([string]::IsNullOrWhiteSpace($KsmModuleSpecificVersion) -eq $False) {\n $requiredVersion = [Version]$KdmModuleSpecificVersion\n}\n\n# Cross-platform bits\n$WindowsPowerShell = $True\nif ($PSEdition -eq \"Core\") {\n $WindowsPowerShell = $False\n}\n\n### Helper functions\nfunction Get-Module-CrossPlatform {\n [CmdletBinding()]\n Param(\n [Parameter(Mandatory = $true, Position = 0)]\n [string] $Name\n )\n\n $module = Get-Module -Name $Name -ListAvailable\n if($WindowsPowerShell -eq $True -and $null -eq $module) {\n $module = Get-InstalledModule -Name $Name\n }\n\n return $module\n}\n\n$PowerShellModuleName = $KsmModuleName\n\n# Check for Custom install location specified for KsmModule\nif ([string]::IsNullOrWhiteSpace($KsmModuleCustomInstallLocation) -eq $false) {\n if ((Test-Path $KsmModuleCustomInstallLocation -IsValid) -eq $false) {\n throw \"The path $KsmModuleCustomInstallLocation is not valid, please use a relative or absolute path.\"\n }\n \n $KsmModulesFolder = [System.IO.Path]::GetFullPath($KsmModuleCustomInstallLocation) \n $LocalModules = (New-Item \"$KsmModulesFolder\" -ItemType Directory -Force).FullName\n $env:PSModulePath = $LocalModules + [System.IO.Path]::PathSeparator + $env:PSModulePath\n\n # Check to see if there\n if ((Test-Path -Path \"$LocalModules/$KsmModuleName\") -eq $true)\n {\n # Use specific location\n $PowerShellModuleName = \"$LocalModules/$PowerShellModuleName\"\n }\n}\n\n# Import module\nif([string]::IsNullOrWhiteSpace($KsmModuleSpecificVersion)) {\n Write-Host \"Importing module $PowerShellModuleName ...\"\n Import-Module -Name $PowerShellModuleName\n}\nelse {\n Write-Host \"Importing module $PowerShellModuleName ($KsmModuleSpecificVersion)...\"\n Import-Module -Name $PowerShellModuleName -RequiredVersion $requiredVersion\n}\n\n# Check if SecretManagement.Keeper.Extension Module is installed.\n$ksmVaultModule = Get-Module-CrossPlatform -Name $KsmModuleName\t\nif ($null -eq $ksmVaultModule) {\n throw \"Cannot find the '$KsmModuleName' module on the machine. If you think it is installed, try restarting the Tentacle service for it to be detected.\"\t\n}\n\n$Secrets = @()\n$VariablesCreated = 0\n$StepName = $OctopusParameters[\"Octopus.Step.Name\"]\n\n# Extract lines and split into notations and variables\n$index = 0\n$usedNames = @()\n@(($VaultSecrets -Split \"`n\").Trim()) | ForEach-Object {\n if (![string]::IsNullOrWhiteSpace($_)) {\n Write-Verbose \"Working on: '$_'\"\n\n # Split 'Notation | VariableName' and generate new var name if needed\n $notation = $_\n $variableName = \"\"\n $n = $_.LastIndexOf(\"|\")\n if ($n -ge 0) {\n if ($n -lt $notation.Length-1) {\n $variableName = $notation.SubString($n+1).Trim()\n }\n $notation = $notation.SubString(0, $n).Trim()\n }\n if ([string]::IsNullOrWhiteSpace($variableName)) {\n do {\n $index++\n $variableName = \"KsmSecret\" + $index\n } while ($usedNames.Contains($variableName))\n }\n if($usedNames.Contains($variableName)) {\n throw \"Duplicate variable name: '$variableName'\"\n }\n $usedNames += $variableName\n\n if([string]::IsNullOrWhiteSpace($notation)) {\n throw \"Unable to establish notation URI from: '$($_)'\"\n }\n $secret = [PsCustomObject]@{\n Notation = $notation\n VariableName = $variableName\n }\n $Secrets += $secret\n }\n}\n\nWrite-Verbose \"Print variables: $PrintVariableNames\"\nWrite-Verbose \"Secrets to retrieve: $($Secrets.Count)\"\nWrite-Verbose \"KSM Version specified: $KsmModuleSpecificVersion\"\nWrite-Verbose \"KSM Custom Install Dir: $KsmModuleCustomInstallLocation\"\n\n# Retrieve Secrets\nforeach($secret in $secrets) {\n $notation = $secret.Notation\n $variableName = $secret.VariableName\n \n $ksmSecretValue = Get-Notation -Notation $notation -Config $KsmConfig\n \n Set-OctopusVariable -Name $variableName -Value $ksmSecretValue -Sensitive\n\n if($PrintVariableNames -eq $True) {\n Write-Host \"Created output variable: ##{Octopus.Action[$StepName].Output.$variableName}\"\n }\n $VariablesCreated += 1\n}\n\nWrite-Host \"Created $variablesCreated output variables\"\n"
13+
"Octopus.Action.Script.ScriptBody": "$ErrorActionPreference = 'Stop'\n\n# Variables\n$KsmModuleName = \"SecretManagement.Keeper.Extension\"\n$KsmParentModuleName = \"SecretManagement.Keeper\"\n$KsmConfig = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.Config\"]\n$VaultSecrets = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.VaultSecrets\"]\n$KsmModuleSpecificVersion = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.KsmModule.SpecificVersion\"]\n$KsmModuleCustomInstallLocation = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.KsmModule.CustomInstallLocation\"]\n$PrintVariableNames = $OctopusParameters[\"Keeper.SecretsManager.RetrieveSecrets.PrintVariableNames\"]\n\n# Validation\nif ([string]::IsNullOrWhiteSpace($VaultSecrets)) {\n throw \"Required parameter Keeper.SecretsManager.RetrieveSecrets.VaultSecrets not specified\"\n}\n\nif ([string]::IsNullOrWhiteSpace($KsmModuleSpecificVersion) -eq $False) {\n $requiredVersion = [Version]$KdmModuleSpecificVersion\n}\n\n# Cross-platform bits\n$WindowsPowerShell = $True\nif ($PSEdition -eq \"Core\") {\n $WindowsPowerShell = $False\n}\n\n### Helper functions\nfunction Get-Module-CrossPlatform {\n [CmdletBinding()]\n Param(\n [Parameter(Mandatory = $true, Position = 0)]\n [string] $Name\n )\n\n $module = Get-Module -Name $Name -ListAvailable\n if($WindowsPowerShell -eq $True -and $null -eq $module) {\n $module = Get-InstalledModule -Name $Name\n }\n\n return $module\n}\n\nfunction Load-Module {\n Param(\n [Parameter(Mandatory = $true)][string] $name\n )\n\n $retVal = $true\n if (!(Get-Module -Name $name)) {\n $isAvailable = Get-Module -ListAvailable | where { $_.Name -eq $name }\n if ($isAvailable) {\n try {\n Import-Module $name -ErrorAction SilentlyContinue\n } catch {\n $retVal = $false\n }\n } else {\n $retVal = $false\n }\n }\n return $retVal\n}\n\n$PowerShellModuleName = $KsmModuleName\n\n# Check for Custom install location specified for KsmModule\nif ([string]::IsNullOrWhiteSpace($KsmModuleCustomInstallLocation) -eq $false) {\n if ((Test-Path $KsmModuleCustomInstallLocation -IsValid) -eq $false) {\n throw \"The path $KsmModuleCustomInstallLocation is not valid, please use a relative or absolute path.\"\n }\n \n $KsmModulesFolder = [System.IO.Path]::GetFullPath($KsmModuleCustomInstallLocation)\n $LocalModules = (New-Item \"$KsmModulesFolder\" -ItemType Directory -Force).FullName\n $env:PSModulePath = $LocalModules + [System.IO.Path]::PathSeparator + $env:PSModulePath\n\n # Check to see if there\n if ((Test-Path -Path \"$LocalModules/$KsmModuleName\") -eq $true)\n {\n # Use specific location\n $PowerShellModuleName = \"$LocalModules/$PowerShellModuleName\"\n }\n}\n\n# Import module\nif([string]::IsNullOrWhiteSpace($KsmModuleSpecificVersion)) {\n Write-Host \"Importing module $PowerShellModuleName ...\"\n if ((Load-Module -Name $PowerShellModuleName) -eq $false) {\n Write-Host \"Extension module not found $PowerShellModuleName - trying to find sub-module in parent $KsmParentModuleName\"\n if (Get-Module -ListAvailable -Name $KsmParentModuleName) {\n $KsmParentModuleDir = Split-Path -Path (Get-Module -ListAvailable -Name $KsmParentModuleName).Path\n $KsmModuleFolder = [System.IO.Path]::GetFullPath($KsmParentModuleDir)\n $LocalModules = (New-Item \"$KsmModuleFolder\" -ItemType Directory -Force).FullName\n $env:PSModulePath = $LocalModules + [System.IO.Path]::PathSeparator + $env:PSModulePath\n\n if ((Test-Path -Path \"$LocalModules/$KsmModuleName\") -eq $true)\n {\n $PowerShellModuleName = \"$LocalModules/$PowerShellModuleName\"\n try {\n Import-Module -Name $PowerShellModuleName -ErrorAction SilentlyContinue\n Write-Host \"Imported sub-module $PowerShellModuleName ...\"\n } catch {\n Write-Host \"Failed to import sub-module $PowerShellModuleName ...\"\n }\n }\n } else {\n Write-Host \"Module does not exist\"\n }\n }\n}\nelse {\n Write-Host \"Importing module $PowerShellModuleName ($KsmModuleSpecificVersion)...\"\n Import-Module -Name $PowerShellModuleName -RequiredVersion $requiredVersion\n}\n\n# Check if SecretManagement.Keeper.Extension Module is installed.\n$ksmVaultModule = Get-Module-CrossPlatform -Name $KsmModuleName\nif ($null -eq $ksmVaultModule) {\n throw \"Cannot find the '$KsmModuleName' module on the machine. If you think it is installed, try restarting the Tentacle service for it to be detected.\"\n}\n\n$Secrets = @()\n$VariablesCreated = 0\n$StepName = $OctopusParameters[\"Octopus.Step.Name\"]\n\n# Extract lines and split into notations and variables\n$index = 0\n$usedNames = @()\n@(($VaultSecrets -Split \"`n\").Trim()) | ForEach-Object {\n if (![string]::IsNullOrWhiteSpace($_)) {\n Write-Verbose \"Working on: '$_'\"\n\n # Split 'Notation | VariableName' and generate new var name if needed\n $notation = $_\n $variableName = \"\"\n $n = $_.LastIndexOf(\"|\")\n if ($n -ge 0) {\n if ($n -lt $notation.Length-1) {\n $variableName = $notation.SubString($n+1).Trim()\n }\n $notation = $notation.SubString(0, $n).Trim()\n }\n if ([string]::IsNullOrWhiteSpace($variableName)) {\n do {\n $index++\n $variableName = \"KsmSecret\" + $index\n } while ($usedNames.Contains($variableName))\n }\n # Duplicate var - either overlapping KsmSecretN or another user variable\n if($usedNames.Contains($variableName)) {\n throw \"Duplicate variable name: '$variableName'\"\n }\n $usedNames += $variableName\n\n if([string]::IsNullOrWhiteSpace($notation)) {\n throw \"Unable to establish notation URI from: '$($_)'\"\n }\n $secret = [PsCustomObject]@{\n Notation = $notation\n VariableName = $variableName\n }\n $Secrets += $secret\n }\n}\n\nWrite-Verbose \"Print variables: $PrintVariableNames\"\nWrite-Verbose \"Secrets to retrieve: $($Secrets.Count)\"\nWrite-Verbose \"KSM Version specified: $KsmModuleSpecificVersion\"\nWrite-Verbose \"KSM Custom Install Dir: $KsmModuleCustomInstallLocation\"\n\n# Retrieve Secrets\nforeach($secret in $secrets) {\n $notation = $secret.Notation\n $variableName = $secret.VariableName\n\n $ksmSecretValue = Get-Notation -Notation $notation -Config $KsmConfig\n\n Set-OctopusVariable -Name $variableName -Value $ksmSecretValue -Sensitive\n\n if($PrintVariableNames -eq $True) {\n Write-Host \"Created output variable: ##{Octopus.Action[$StepName].Output.$variableName}\"\n }\n $VariablesCreated += 1\n}\n\nWrite-Host \"Created $variablesCreated output variables\"\n"
1414
},
1515
"Parameters": [
1616
{
@@ -65,9 +65,9 @@
6565
}
6666
],
6767
"LastModifiedBy": "idimov-keeper",
68-
"LastModifiedAt": "2023-01-10T00:54:34.7240000Z",
68+
"LastModifiedAt": "2024-06-12T00:54:34.7240000Z",
6969
"$Meta": {
70-
"ExportedAt": "2023-01-10T00:54:34.7240000Z",
70+
"ExportedAt": "2024-06-12T00:54:34.7240000Z",
7171
"OctopusVersion": "2022.4.8319",
7272
"Type": "ActionTemplate"
7373
},

0 commit comments

Comments
 (0)