functions/New-TssSession.ps1
|
function New-TssSession { <# .SYNOPSIS Create new session .DESCRIPTION Create a new TssSession for working with a Secret Server .EXAMPLE PS C:\> $cred = [PSCredential]::new('apiuser',(ConvertTo-SecureString -String "Fancy%$#Passwod" -AsPlainText -Force)) PS C:\> New-TssSession -SecretServer https://ssvault.com/SecretServer -Credential $cred A PSCredential is created for the apiuser account. The internal TssSession is updated upon successful authentication, and then output to the console. .EXAMPLE PS C:\> $token = .\tss.exe -kd c:\secretserver\module_testing\ -cd c:\secretserver\module_testing PS C:\> $tssSession = New-TssSession -SecretServer https://ssvault.com/SecretServer -AccessToken $token A token is requested via Client SDK (after proper init has been done) TssSession object is created with minimum properties required by the module. Note that this use case, SessionRefresh and SessionExpire are not supported .EXAMPLE PS C:\> New-TssSession -SecretServer https://ssvault.com/SecretServer -Credential (Get-Credential apiuser) -Raw A prompt to enter the password for the apiuser is given by PowerShell. Upon successful authentication the response from the oauth2/token endpoint is output to the console. .EXAMPLE PS C:\> $session = nts https://ssvault.com/SecretServer $secretCred Utilize alias for New-TssSession, nts, to create the session object .EXAMPLE PS C:\> $session = nts https://ssvault.com/SecretServer $secretCred Utilize alias for New-TssSession, nts, to create the session object .OUTPUTS TssSession. #> [cmdletbinding(SupportsShouldProcess)] param( # Secret Server URL [Parameter(ParameterSetName = 'New',Mandatory)] [Parameter(ParameterSetName = 'tss', Mandatory)] [Alias('Server')] [uri] $SecretServer, # Specify a Secret Server user account. [Parameter(ParameterSetName = 'New')] [PSCredential] [Management.Automation.CredentialAttribute()] $Credential, # Specify Access Token # Bypasses requesting a token from Secret Server [Parameter(ParameterSetName = 'tss')] $AccessToken, # Raw output from the endpoint will be returned. [Parameter(ParameterSetName = 'New')] [switch] $Raw ) begin { $invokeParams = . $GetInvokeTssParams $PSBoundParameters $newTssParams = . $GetNewTssParams $PSBoundParameters } process { if (-not $newTssParams['AccessToken']) { if ($newTssParams.Contains('SecretServer')) { $uri = $SecretServer, "oauth2/token" -join '/' } $postContent = [Ordered]@{ } if ($newTssParams.Contains('Credential')) { $postContent.username = $Credential.UserName $postContent.password = $Credential.GetNetworkCredential().Password $postContent.grant_type = 'password' } $invokeParams.Uri = $Uri $invokeParams.Body = $postContent $invokeParams.Method = 'POST' if (-not $PSCmdlet.ShouldProcess("POST $uri")) { return } try { $restResponse = Invoke-TssRestApi @invokeParams -Property @{SecretServer = $SecretServer } } catch { Write-Warning "Issue authenticating to [$SecretServer]" $err = $_.ErrorDetails.Message Write-Error $err } if ($newTssParams['Raw']) { return $restResponse } else { [TssSession]@{ SecretServer = $restResponse.SecretServer AccessToken = $restResponse.access_token RefreshToken = $restResponse.refresh_token ExpiresIn = $restResponse.expires_in TokenType = $restResponse.token_type StartTime = [datetime]::Now TimeOfDeath = [datetime]::Now.Add([timespan]::FromSeconds($restResponse.expires_in)) } } } if ($newTssParams['SecretServer'] -and $newTssParams['AccessToken']) { [TssSession]@{ SecretServer = $SecretServer AccessToken = $AccessToken StartTime = [datetime]::Now ExternalToken = $true } } } } |