Skip to content

Commit

Permalink
Get-SecretHookStub - closes #195
Browse files Browse the repository at this point in the history
  • Loading branch information
wsmelton committed Jun 3, 2021
1 parent 74444c7 commit 34d4683
Show file tree
Hide file tree
Showing 3 changed files with 198 additions and 0 deletions.
101 changes: 101 additions & 0 deletions src/Thycotic.SecretServer.Format.ps1xml
Expand Up @@ -1975,5 +1975,106 @@
</TableControl>
</View>

<!-- TssScriptSummary -->
<View>
<Name>TssScriptSummary</Name>
<ViewSelectedBy>
<TypeName>TssScriptSummary</TypeName>
</ViewSelectedBy>
<TableControl>
<TableHeaders>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
</TableHeaders>
<TableRowEntries>
<TableRowEntry>
<TableColumnItems>
<TableColumnItem>
<PropertyName>ScriptId</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>ScriptType</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>ScriptCategoryName</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Name</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Description</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Active</PropertyName>
</TableColumnItem>
</TableColumnItems>
</TableRowEntry>
</TableRowEntries>
</TableControl>
</View>

<!-- TssScript -->
<View>
<Name>TssScript</Name>
<ViewSelectedBy>
<TypeName>TssScript</TypeName>
</ViewSelectedBy>
<TableControl>
<TableHeaders>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
<TableColumnHeader>
</TableColumnHeader>
</TableHeaders>
<TableRowEntries>
<TableRowEntry>
<TableColumnItems>
<TableColumnItem>
<PropertyName>ScriptId</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>ScriptType</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>ScriptCategoryName</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Name</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Description</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Active</PropertyName>
</TableColumnItem>
<TableColumnItem>
<PropertyName>Script</PropertyName>
</TableColumnItem>
</TableColumnItems>
</TableRowEntry>
</TableRowEntries>
</TableControl>
</View>

</ViewDefinitions>
</Configuration>
73 changes: 73 additions & 0 deletions src/functions/secret-hooks/Get-SecretHookStub.ps1
@@ -0,0 +1,73 @@
function Get-SecretHookStub {
<#
.SYNOPSIS
Get stub for a new Secret Hook
.DESCRIPTION
Get stub for a new Secret Hook
.EXAMPLE
session = New-TssSession -SecretServer https://alpha -Credential ssCred
Get-TssSecretHookStub -TssSession $session -SecretId 391 -ScriptId 6
Get stub for Secret ID 391 and Script 6
.LINK
https://thycotic-ps.github.io/thycotic.secretserver/commands/Get-TssSecretHookStub
.LINK
https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-hooks/Get-SecretHookStub.ps1
.NOTES
Requires TssSession object returned by New-TssSession
#>
[CmdletBinding()]
[OutputType('TssSecretHook')]
param (
# TssSession object created by New-TssSession for auth
[Parameter(Mandatory, ValueFromPipeline, Position = 0)]
[TssSession]
$TssSession,

# Secret ID
[Parameter(Mandatory, ValueFromPipelineByPropertyName)]
[Alias('Id')]
[int[]]
$SecretId,

# Script ID
[Parameter(Mandatory, ValueFromPipelineByPropertyName)]
[int]
$ScriptId
)
begin {
$tssParams = $PSBoundParameters
$invokeParams = . $GetInvokeTssParams $TssSession
}
process {
if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
. $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
foreach ($secret in $SecretId) {
$restResponse = $null
$uri = $TssSession.ApiUrl, 'secret-detail', $secret, 'hook', 'stub', $ScriptId -join '/'
$invokeParams.Uri = $uri
$invokeParams.Method = 'GET'

Write-Verbose "Performing the operation $($invokeParams.Method) $uri"
try {
$restResponse = . $InvokeApi @invokeParams
} catch {
Write-Warning "Issue getting message"
$err = $_
. $ErrorHandling $err
}

if ($restResponse) {
[TssSecretHook]$restResponse
}
}
} else {
Write-Warning 'No valid session found'
}
}
}
24 changes: 24 additions & 0 deletions tests/secret-hooks/Get-SecretHookStub.Tests.ps1
@@ -0,0 +1,24 @@
BeforeDiscovery {
$commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
}
Describe "$commandName verify parameters" {
BeforeDiscovery {
[object[]]$knownParameters = 'TssSession', 'SecretId', 'ScriptId'
[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
}
}
Context "Command specific details" {
It "$commandName should set OutputType to TssSecretHook" -TestCases $commandDetails {
$_.OutputType.Name | Should -Be 'TssSecretHook'
}
}
}

0 comments on commit 34d4683

Please sign in to comment.