Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Search-TssSecretsByUrl - new command to check which Secret(s) is retu…
…rned for a given URL, endpoint used by WPF
- Loading branch information
Showing
7 changed files
with
285 additions
and
35 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # Search-TssSecretsByUrl | ||
|
|
||
| ## SYNOPSIS | ||
| Search for Secrets that match a URL for Web Password Filler | ||
|
|
||
| ## SYNTAX | ||
|
|
||
| ``` | ||
| Search-TssSecretsByUrl [-TssSession] <Session> [-Url <String>] [<CommonParameters>] | ||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
| Search for Secrets that match a URL for Web Password Filler | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
| ``` | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Search-TssWpfSecretsByUrl -TssSession $session -Url 'https://citibank.com/login' | ||
| ``` | ||
|
|
||
| Return Secrets that match the URL provided | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -TssSession | ||
| TssSession object created by New-TssSession for authentication | ||
|
|
||
| ```yaml | ||
| Type: Session | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: True | ||
| Position: 1 | ||
| Default value: None | ||
| Accept pipeline input: True (ByValue) | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### -Url | ||
| URL to search against | ||
|
|
||
| ```yaml | ||
| Type: String | ||
| Parameter Sets: (All) | ||
| Aliases: | ||
|
|
||
| Required: False | ||
| Position: Named | ||
| Default value: None | ||
| Accept pipeline input: False | ||
| Accept wildcard characters: False | ||
| ``` | ||
|
|
||
| ### CommonParameters | ||
| This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216). | ||
|
|
||
| ## INPUTS | ||
|
|
||
| ## OUTPUTS | ||
|
|
||
| ### Thycotic.PowerShell.SecretExtensions.Secret | ||
| ## NOTES | ||
| Requires TssSession object returned by New-TssSession | ||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [https://thycotic-ps.github.io/thycotic.secretserver/commands/secret-extensions/Search-TssSecretsByUrl](https://thycotic-ps.github.io/thycotic.secretserver/commands/secret-extensions/Search-TssSecretsByUrl) | ||
|
|
||
| [https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-extensions/Search-TssSecretsByUrl.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-extensions/Search-TssSecretsByUrl.ps1) | ||
|
|
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
25 changes: 25 additions & 0 deletions
25
src/Thycotic.SecretServer/classes/secret-extensions/Secret.cs
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,25 @@ | ||
| using System; | ||
| using System.Threading.Tasks; | ||
| using System.Management.Automation; | ||
| using System.Management.Automation.Runspaces; | ||
| using Thycotic.PowerShell.Enums; | ||
|
|
||
| namespace Thycotic.PowerShell.SecretExtensions | ||
| { | ||
| public class Secret | ||
| { | ||
| public bool HasOwnerOrEditAccess { get; set; } | ||
| public int Id { get; set; } | ||
| public bool IsButtonBound { get; set; } | ||
| public bool IsFavoriteSecret { get; set; } | ||
| public bool IsSystemFolder { get; set; } | ||
| public SecretMatchType MatchOrderType { get; set; } | ||
| public string Name { get; set; } | ||
| public string RedirectUrl { get; set; } | ||
| public bool RequireComment { get; set; } | ||
| public int ResultPriority { get; set; } | ||
| public int SecretTypeId { get; set; } | ||
| public string SecretUrl { get; set; } | ||
| public bool ShouldRedirect { get; set; } | ||
| } | ||
| } |
14 changes: 14 additions & 0 deletions
14
src/Thycotic.SecretServer/enums/secret-extensions/SecretMatchType.cs
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,14 @@ | ||
| using System; | ||
| using System.Threading.Tasks; | ||
| using System.Management.Automation; | ||
| using System.Management.Automation.Runspaces; | ||
|
|
||
| namespace Thycotic.PowerShell.Enums | ||
| { | ||
| public enum SecretMatchType | ||
| { | ||
| Loose, | ||
| Partial, | ||
| Exact | ||
| } | ||
| } |
69 changes: 69 additions & 0 deletions
69
src/functions/secret-extensions/Search-TssSecretsByUrl.ps1
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,69 @@ | ||
| function Search-TssSecretsByUrl { | ||
| <# | ||
| .SYNOPSIS | ||
| Search for Secrets that match a URL for Web Password Filler | ||
| .DESCRIPTION | ||
| Search for Secrets that match a URL for Web Password Filler | ||
| .LINK | ||
| https://thycotic-ps.github.io/thycotic.secretserver/commands/secret-extensions/Search-TssSecretsByUrl | ||
| .LINK | ||
| https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-extensions/Search-TssSecretsByUrl.ps1 | ||
| .EXAMPLE | ||
| $session = New-TssSession -SecretServer https://alpha -Credential $ssCred | ||
| Search-TssWpfSecretsByUrl -TssSession $session -Url 'https://citibank.com/login' | ||
| Return Secrets that match the URL provided | ||
| .NOTES | ||
| Requires TssSession object returned by New-TssSession | ||
| #> | ||
| [CmdletBinding()] | ||
| [OutputType('Thycotic.PowerShell.SecretExtensions.Secret')] | ||
| param ( | ||
| # TssSession object created by New-TssSession for authentication | ||
| [Parameter(Mandatory,ValueFromPipeline,Position = 0)] | ||
| [Thycotic.PowerShell.Authentication.Session] | ||
| $TssSession, | ||
|
|
||
| # URL to search against | ||
| [string] | ||
| $Url | ||
| ) | ||
| begin { | ||
| $tssParams = $PSBoundParameters | ||
| $invokeParams = . $GetInvokeApiParams $TssSession | ||
| } | ||
| process { | ||
| Get-TssInvocation $PSCmdlet.MyInvocation | ||
| if ($tssParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) { | ||
| Compare-TssVersion $TssSession '10.9.000064' $PSCmdlet.MyInvocation | ||
| $uri = $TssSession.ApiUrl, 'secret-extensions', 'search-by-url' -join '/' | ||
| $invokeParams.Uri = $uri | ||
| $invokeParams.Method = 'POST' | ||
| $invokeParams.Body = "`"$Url`"" | ||
|
|
||
| Write-Verbose "Performing the operation $($invokeParams.Method) $($invokeParams.Uri) with $($invokeParams.Body)" | ||
| try { | ||
| $apiResponse = Invoke-TssApi @invokeParams | ||
| $restResponse = . $ProcessResponse $apiResponse | ||
| } catch { | ||
| Write-Warning "Issue on search request" | ||
| $err = $_ | ||
| . $ErrorHandling $err | ||
| } | ||
|
|
||
| if ($restResponse.records.Count -le 0 -and $restResponse.records.Length -eq 0) { | ||
| Write-Warning "No records found" | ||
| } | ||
| if ($restResponse.model) { | ||
| [Thycotic.PowerShell.SecretExtensions.Secret[]]$restResponse.model | ||
| } | ||
| } 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,24 @@ | ||
| BeforeDiscovery { | ||
| $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf | ||
| } | ||
| Describe "$commandName verify parameters" { | ||
| BeforeDiscovery { | ||
| [object[]]$knownParameters = 'TssSession', 'Url' | ||
| [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 Thycotic.PowerShell.SecretExtensions.Secret" -TestCases $commandDetails { | ||
| $_.OutputType.Name | Should -Be 'Thycotic.PowerShell.SecretExtensions.Secret' | ||
| } | ||
| } | ||
| } |