-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Open-Secret - allows for checking out a secret
- Loading branch information
Showing
4 changed files
with
140 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| function Open-Secret { | ||
| <# | ||
| .SYNOPSIS | ||
| Checkout a Secret | ||
| .DESCRIPTION | ||
| Checkout a Secret | ||
| .LINK | ||
| https://thycotic-ps.github.io/thycotic.secretserver/commands/Open-TssSecret | ||
| .LINK | ||
| https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secrets/Open-Secret.ps1 | ||
| .EXAMPLE | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Checkout-TssSecret -TssSession $session -Id 72 -TicketId 'N000354' | ||
| Checkout Secret ID 72 providing ticket number required by Ticket Integration | ||
| .EXAMPLE | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Open-TssSecret -TssSession $session -Id 376 | ||
| Checkout Secret ID 376 | ||
| .EXAMPLE | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Open-TssSecret -TssSession $session -Id 42 -Comment "CI process" | ||
| Checkout Secret ID 42 providing a comment (Secret configured to checkout and require comment) | ||
| .NOTES | ||
| Requires TssSession object returned by New-TssSession | ||
| #> | ||
| [CmdletBinding(SupportsShouldProcess)] | ||
| [OutputType('TssSecret')] | ||
| param ( | ||
| # TssSession object created by New-TssSession for auth | ||
| [Parameter(Mandatory,ValueFromPipeline,Position = 0)] | ||
| [TssSession] | ||
| $TssSession, | ||
|
|
||
| # Secret ID | ||
| [Alias("SecretId")] | ||
| [int] | ||
| $Id, | ||
|
|
||
| # Comment to provide for restricted secret (Require Comment is enabled) | ||
| [string] | ||
| $Comment, | ||
|
|
||
| # Associated ticket number (required for ticket integrations) | ||
| [string] | ||
| $TicketNumber, | ||
|
|
||
| # Associated ticket system ID (required for ticket integrations) | ||
| [int] | ||
| $TicketSystemId | ||
| ) | ||
| begin { | ||
| $tssParams = $PSBoundParameters | ||
| $invokeViewCommentParams = . $GetInvokeTssParams $TssSession | ||
| $invokeCheckoutParams = . $GetInvokeTssParams $TssSession | ||
| } | ||
| process { | ||
| Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)" | ||
| if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { | ||
| . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation | ||
|
|
||
| # Checkout endpoint requires a pre-checkout comment be sent | ||
| $restrictedBody = @{} | ||
| switch ($tssParams.Keys) { | ||
| 'Comment' { $restrictedBody.Add('comment',$Comment) } | ||
| 'TicketNumber' { $restrictedBody.Add('ticketNumber', $TicketNumber) } | ||
| 'TicketSystemId' { $restrictedBody.Add('ticketSystemId', $TicketSystemId) } | ||
| } | ||
| if ($restrictedBody.Count -gt 0) { | ||
| $uriViewComment = $TssSession.ApiUrl, 'secret-access-requests', 'secrets', $Id, 'view-comment' -join '/' | ||
|
|
||
| $invokeViewCommentParams.Body = $restrictedBody | ConvertTo-Json | ||
| $invokeViewCommentParams.Uri = $uriViewComment | ||
| $invokeViewCommentParams.Method = 'POST' | ||
|
|
||
| if ($PSCmdlet.ShouldProcess("Secret ID: $Id", "$($invokeViewCommentParams.Method) $uriViewComment with: `n$($invokeViewCommentParams.Body)`n")) { | ||
| Write-Verbose "Performing the operation $($invokeViewCommentParams.Method) $uriViewComment with:`n$($invokeViewCommentParams.Body)`n" | ||
| try { | ||
| . $InvokeApi @invokeViewCommentParams >$null | ||
| } catch { | ||
| Write-Warning "Issue adding view comment for Secret [$Id]" | ||
| $err = $_ | ||
| . $ErrorHandling $err | ||
| } | ||
| } | ||
| } | ||
| # Secret Checkout | ||
| $uriCheckout = $TssSession.ApiUrl, 'secrets', $Id, 'check-out' -join '/' | ||
| $invokeCheckoutParams.Uri = $uriCheckout | ||
| $invokeCheckoutParams.Method = 'POST' | ||
| if ($PSCmdlet.ShouldProcess("Secret ID: $Id", "$($invokeCheckoutParams.Method) $uriCheckout")) { | ||
| Write-Verbose "Performing the operation $($invokeCheckoutParams.Method) $uriCheckout" | ||
| try { | ||
| . $InvokeApi @invokeCheckoutParams >$null | ||
| } catch { | ||
| Write-Warning "Issue checking out Secret [$Id]" | ||
| $err = $_ | ||
| . $ErrorHandling $err | ||
| } | ||
| } | ||
| } else { | ||
| Write-Warning "No valid session found" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| BeforeDiscovery { | ||
| $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf | ||
| } | ||
| Describe "$commandName verify parameters" { | ||
| BeforeDiscovery { | ||
| [object[]]$knownParameters = 'TssSession', 'Id', 'Comment', 'TicketNumber', 'TicketSystemId' | ||
| [object[]]$currentParams = ([Management.Automation.CommandMetaData]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function')).Parameters.Keys | ||
| [object[]]$commandDetails = [System.Management.Automation.CommandInfo]$ExecutionContext.SessionState.InvokeCommand.GetCommand($commandName,'Function') | ||
| $unknownParameters = Compare-Object -ReferenceObject $knownParameters -DifferenceObject $currentParams -PassThru | ||
| } | ||
| Context "Verify parameters" -Foreach @{currentParams = $currentParams } { | ||
| It "$commandName should contain <_> parameter" -TestCases $knownParameters { | ||
| $_ -in $currentParams | Should -Be $true | ||
| } | ||
| It "$commandName should not contain parameter: <_>" -TestCases $unknownParameters { | ||
| $_ | Should -BeNullOrEmpty | ||
| } | ||
| } | ||
| } |