Merge pull request #125 from Snow-Shell/proxy-support

Proxy support

Author: gdbarron

CHANGELOG.md

@@ -1,3 +1,6 @@
+## v2.1
+- Add proxy support to `New-ServiceNowSession`, [#97](https://github.com/Snow-Shell/servicenow-powershell/issues/97).
+
 ## v2.0
 - Although still in the module for backward compatibility, `Set-ServiceNowAuth` is being replaced with `New-ServiceNowSession`.  With this comes OAuth support, removal of global variables, and much more folks have asked for.  The ability to provide credentials directly to functions has been retained for this release, but will be deprecated in a future release in favor of using `New-ServiceNowSession`.
 - Support for different api versions.  `Set-ServiceNowAuth` will continue to use v1 of the api, but `New-ServiceNowSession` defaults to the latest.  Check out the `-ApiVersion` parameter of `New-ServiceNowSession`.

ServiceNow/Private/Get-ServiceNowAuth.ps1

@@ -36,15 +36,27 @@ function Get-ServiceNowAuth {
         } else {
             $hashOut.Credential = $ServiceNowSession.Credential
         }
+
+        if ( $ServiceNowSession.Proxy ) {
+            $hashOut.Proxy = $ServiceNowSession.Proxy
+            if ( $ServiceNowSession.ProxyCredential ) {
+                $hashOut.ProxyCredential = $ServiceNowSession.ProxyCredential
+            } else {
+                $hashOut.ProxyUseDefaultCredentials = $true
+            }
+        }
+
     } elseif ( $Credential -and $ServiceNowURL ) {
         Write-Warning -Message 'This authentication path, providing URL and credential directly, will be deprecated in a future release.  Please use New-ServiceNowSession.'
         $hashOut.Uri = 'https://{0}/api/now/v1' -f $ServiceNowURL
         $hashOut.Credential = $Credential
+
     } elseif ( $Connection ) {
         $SecurePassword = ConvertTo-SecureString $Connection.Password -AsPlainText -Force
         $Credential = New-Object System.Management.Automation.PSCredential ($Connection.Username, $SecurePassword)
         $hashOut.Credential = $Credential
         $hashOut.Uri = 'https://{0}/api/now/v1' -f $Connection.ServiceNowUri
+
     } else {
         throw "Exception:  You must do one of the following to authenticate: `n 1. Call the New-ServiceNowSession cmdlet `n 2. Pass in an Azure Automation connection object `n 3. Pass in an endpoint and credential"
     }

ServiceNow/Public/New-ServiceNowSession.ps1

@@ -20,6 +20,12 @@ Required for OAuth.  Credential where the username is the Client ID and the pass
 .PARAMETER AccessToken
 Provide the access token directly if obtained outside of this module.
 
+.PARAMETER Proxy
+Use a proxy server for the request, rather than connecting directly.  Provide the full url.
+
+.PARAMETER ProxyCredential
+Credential of user who can access Proxy.  If not provided, the current user will be used.
+
 .PARAMETER ApiVersion
 Specific API version to use.  The default is the latest.
 
@@ -43,6 +49,10 @@ Create a session with an existing access token and save it to a script-scoped va
 $session = New-ServiceNowSession -Url tenant.domain.com -Credential $mycred -ClientCredential $myClientCred -PassThru
 Create a session using OAuth and save it as a local variable to be provided to functions directly
 
+.EXAMPLE
+New-ServiceNowSession -Url tenant.domain.com -Credential $mycred -Proxy http://1.2.3.4
+Create a session utilizing a proxy to connect
+
 .INPUTS
 None
 
@@ -64,15 +74,29 @@ function New-ServiceNowSession {
 
         [Parameter(Mandatory, ParameterSetName = 'BasicAuth')]
         [Parameter(Mandatory, ParameterSetName = 'OAuth')]
+        [Parameter(Mandatory, ParameterSetName = 'BasicAuthProxy')]
+        [Parameter(Mandatory, ParameterSetName = 'OAuthProxy')]
         [Alias('Credentials')]
         [System.Management.Automation.PSCredential] $Credential,
 
         [Parameter(Mandatory, ParameterSetName = 'OAuth')]
+        [Parameter(Mandatory, ParameterSetName = 'OAuthProxy')]
         [System.Management.Automation.PSCredential] $ClientCredential,
 
         [Parameter(Mandatory, ParameterSetName = 'AccessToken')]
+        [Parameter(Mandatory, ParameterSetName = 'AccessTokenProxy')]
         [string] $AccessToken,
 
+        [Parameter(Mandatory, ParameterSetName = 'BasicAuthProxy')]
+        [Parameter(Mandatory, ParameterSetName = 'OAuthProxy')]
+        [Parameter(Mandatory, ParameterSetName = 'AccessTokenProxy')]
+        [string] $Proxy,
+
+        [Parameter(ParameterSetName = 'BasicAuthProxy')]
+        [Parameter(ParameterSetName = 'OAuthProxy')]
+        [Parameter(ParameterSetName = 'AccessTokenProxy')]
+        [System.Management.Automation.PSCredential] $ProxyCredential,
+
         [Parameter()]
         [int] $ApiVersion,
 
@@ -93,8 +117,15 @@ function New-ServiceNowSession {
         BaseUri = ('https://{0}/api/now{1}' -f $Url, $version)
     }
 
-    switch ($PSCmdLet.ParameterSetName) {
-        'OAuth' {
+    if ( $PSBoundParameters.ContainsKey('Proxy') ) {
+        $newSession.Add('Proxy', $Proxy)
+        if ( $PSBoundParameters.ContainsKey('ProxyCredential') ) {
+            $newSession.Add('ProxyCredential', $ProxyCredential)
+        }
+    }
+
+    switch -Wildcard ($PSCmdLet.ParameterSetName) {
+        'OAuth*' {
             $params = @{
                 Uri    = 'https://{0}/oauth_token.do' -f $Url
                 Body   = @{
@@ -107,19 +138,29 @@ function New-ServiceNowSession {
                 Method = 'Post'
             }
 
+            # need to add this manually here, in addition to above, since we're making a rest call before our session is created
+            if ( $PSBoundParameters.ContainsKey('Proxy') ) {
+                $params.Add('Proxy', $Proxy)
+                if ( $PSBoundParameters.ContainsKey('ProxyCredential') ) {
+                    $params.Add('ProxyCredential', $ProxyCredential)
+                } else {
+                    $params.Add('ProxyUseDefaultCredentials', $true)
+                }
+            }
+
             $token = Invoke-RestMethod @params
             $newSession.Add('AccessToken', $token.access_token)
             $newSession.Add('RefreshToken', $token.refresh_token)
         }
-        'AccessToken' {
+
+        'AccessToken*' {
             $newSession.Add('AccessToken', $AccessToken)
         }
-        'BasicAuth' {
+
+        'BasicAuth*' {
             $newSession.Add('Credential', $Credential)
         }
-        'SSO' {
 
-        }
         Default {
 
         }

ServiceNow/ServiceNow.psd1

@@ -5,7 +5,7 @@
 RootModule = 'ServiceNow.psm1'
 
 # Version number of this module.
-ModuleVersion = '2.0.0'
+ModuleVersion = '2.1.0'
 
 # ID used to uniquely identify this module
 GUID = 'b90d67da-f8d0-4406-ad74-89d169cd0633'