Update-TssSecret - fixes #169

src/functions/secrets/Update-Secret.ps1

@@ -0,0 +1,132 @@
+function Update-Secret {
+    <#
+    .SYNOPSIS
+    Update a Secret
+
+    .DESCRIPTION
+    Update a Secret
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Update-TssSecret -TssSession $session Id 42 -Slug notes -Value "Test test test"
+
+    Set Notes field on Secret 42 to the value "Test test test"
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Update-TssSecret -TssSession $session -Id 93 -Slug Machine -Value "server2"
+
+    Sets secret 93's field, "Machine", to "server2"
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Update-TssSecret -TssSession $session -Id 1455 -Slug Notes -Value "to be decommissioned" -Comment "updating notes field"
+
+    Sets secret 1455's field, "Notes", to the provided value providing required comment
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Update-TssSecret -TssSession $session -Id 113 -Slug Notes -Clear
+
+    Sets secret 1455's field, "Notes", to an empty value
+
+    .EXAMPLE
+    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
+    Update-TssSecret -TssSession $session -Id 42 -Slug attached-file c:\files\attachment.txt
+
+    Sets the attached-file field on Secret 42 to the attachment.txt (uploads the file to Secret Server)
+
+    .LINK
+    https://thycotic-ps.github.io/thycotic.secretserver/commands/Update-TssSecret
+
+    .LINK
+    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secrets/Update-Secret.ps1
+
+    .NOTES
+    Requires TssSession object returned by New-TssSession
+    #>
+    [cmdletbinding(SupportsShouldProcess, DefaultParameterSetName = 'all')]
+    [OutputType('TssSecret')]
+    param(
+        # TssSession object created by New-TssSession for auth
+        [Parameter(Mandatory,ValueFromPipeline,Position = 0)]
+        [TssSession]
+        $TssSession,
+
+        # Input object obtained via Get-TssSecretStub
+        [Parameter(Mandatory, Position = 1)]
+        [TssSecret]
+        $Secret,
+
+        # Comment to provide for restricted secret (Require Comment is enabled)
+        [Parameter(ParameterSetName = 'restricted')]
+        [string]
+        $Comment,
+
+        # Force check-in of the Secret
+        [Parameter(ParameterSetName = 'restricted')]
+        [switch]
+        $ForceCheckIn,
+
+        # Associated Ticket Number
+        [Parameter(ParameterSetName = 'restricted')]
+        [int]
+        $TicketNumber,
+
+        # Associated Ticket System ID
+        [Parameter(ParameterSetName = 'restricted')]
+        [int]
+        $TicketSystemId
+    )
+    begin {
+        $updateParams = $PSBoundParameters
+        $invokeParams = . $GetInvokeTssParams $TssSession
+
+        $restrictedParamSet = . $ParameterSetParams $PSCmdlet.MyInvocation.MyCommand.Name 'restricted'
+        $restrictedParams = @()
+        foreach ($r in $restrictedParamSet) {
+            if ($updateParams.ContainsKey($r)) {
+                $restrictedParams += $r
+            }
+        }
+    }
+    process {
+        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
+        if ($updateParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
+            . $CheckVersion $TssSession '10.9.0000' $PSCmdlet.MyInvocation
+            $uri = $TssSession.ApiUrl, 'secrets', $secretId -join '/'
+            $invokeParams.Uri = $uri
+            $invokeParams.Method = 'PUT'
+
+            $secretId = $Secret.Id
+            $updateBody = $Secret
+
+            if ($restrictedParams.Count -gt 0) {
+                switch ($updateParams.Keys) {
+                    'Comment' { $updateBody.Add('comment', $Comment) }
+                    'ForceCheckIn' { $updateBody.Add('forceCheckIn', [boolean]$ForceCheckIn) }
+                    'TicketNumber' { $updateBody.Add('ticketNumber', $TicketNumber) }
+                    'TicketSystemId' { $updateBody.Add('ticketSystemId', $TicketSystemId) }
+                }
+            }
+            $invokeParams.Body = $updateBody | ConvertTo-Json -Depth 5
+
+            if ($PSCmdlet.ShouldProcess("Secret ID: $secretId ", "$($invokeParams.Method) $uri with:`n$($invokeParams.Body)`n")) {
+                Write-Verbose "$($invokeParams.Method) $uri with:`n$($invokeParams.Body)`n"
+                try {
+                    $updateResponse = . $InvokeApi @invokeParams
+                } catch {
+                    Write-Warning "Issue setting field $Field on secret [$secretId ]"
+                    $err = $_
+                    . $ErrorHandling $err
+                }
+
+                if ($updateResponse.id -eq $secretId) {
+                    [TssSecret]$updateResponse
+                }
+            }
+        } else {
+            Write-Warning "No valid session found"
+        }
+    }
+}

tests/secrets/Update-Secret.Tests.ps1

@@ -0,0 +1,25 @@
+BeforeDiscovery {
+    $commandName = Split-Path ($PSCommandPath.Replace('.Tests.ps1','')) -Leaf
+    . ([IO.Path]::Combine([string]$PSScriptRoot, '..', 'constants.ps1'))
+}
+Describe "$commandName verify parameters" {
+    BeforeDiscovery {
+        [object[]]$knownParameters = 'TssSession', 'Secret', 'Comment', 'ForceCheckIn', '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
+        }
+    }
+    Context "Command specific details" {
+        It "$commandName should set OutputType to TssSecret" -TestCases $commandDetails {
+            $_.OutputType.Name | Should -Be 'TssSecret'
+        }
+    }
+}