-
-
Notifications
You must be signed in to change notification settings - Fork 6.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[powershell-experimental] : http signature authentication implementat…
…ion (#6176) * ValidatePattern having double quote(") throws exception on running Build.ps1 * fix tab with space * [powershell-experimental] : http signature auth * fix the tab issue Co-authored-by: Ghufran Zahidi <gzahidi@cisco.com>
- Loading branch information
Showing
4 changed files
with
559 additions
and
1 deletion.
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
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
162 changes: 162 additions & 0 deletions
162
...openapi-generator/src/main/resources/powershell-experimental/http_signature_auth.mustache
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,162 @@ | ||
| {{>partial_header}} | ||
| <# | ||
| .SYNOPSIS | ||
| Get the API key Id and API key file path. | ||
|
|
||
| .DESCRIPTION | ||
| Get the API key Id and API key file path. If no api prefix is provided then it use default api key prefix 'Signature' | ||
| .OUTPUTS | ||
| PSCustomObject : This contains APIKeyId, APIKeyFilePath, APIKeyPrefix | ||
| #> | ||
| function Get-{{{apiNamePrefix}}}APIKeyInfo { | ||
| $ApiKeysList = $Script:Configuration['ApiKey'] | ||
| $ApiKeyPrefixList = $Script:Configuration['ApiKeyPrefix'] | ||
| $apiPrefix = "Signature" | ||
| if ($null -eq $ApiKeysList -or $ApiKeysList.Count -eq 0) { | ||
| throw "Unable to reterieve the api key details" | ||
| } | ||
|
|
||
| if ($null -eq $ApiKeyPrefixList -or $ApiKeyPrefixList.Count -eq 0) { | ||
| Write-Verbose "Unable to reterieve the api key prefix details,setting it to default ""Signature""" | ||
| } | ||
|
|
||
| foreach ($item in $ApiKeysList.GetEnumerator()) { | ||
| if (![string]::IsNullOrEmpty($item.Name)) { | ||
| if (Test-Path -Path $item.Value) { | ||
| $apiKey = $item.Value | ||
| $apikeyId = $item.Name | ||
| break; | ||
| } | ||
| else { | ||
| throw "API key file path does not exist." | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if ($ApiKeyPrefixList.ContainsKey($apikeyId)) { | ||
| $apiPrefix = ApiKeyPrefixList[$apikeyId] | ||
| } | ||
|
|
||
| if ($apikeyId -and $apiKey -and $apiPrefix) { | ||
| $result = New-Object -Type PSCustomObject -Property @{ | ||
| ApiKeyId = $apikeyId; | ||
| ApiKeyFilePath = $apiKey | ||
| ApiKeyPrefix = $apiPrefix | ||
| } | ||
| } | ||
| else { | ||
| return $null | ||
| } | ||
| return $result | ||
| } | ||
|
|
||
| <# | ||
| .SYNOPSIS | ||
| Gets the headers for http signed auth. | ||
|
|
||
| .DESCRIPTION | ||
| Gets the headers for the http signed auth. It use (targetpath), date, host and body digest to create authorization header. | ||
| .PARAMETER Method | ||
| Http method | ||
| .PARAMETER UriBuilder | ||
| UriBuilder for url and query parameter | ||
| .PARAMETER Body | ||
| Request body | ||
| .OUTPUTS | ||
| Hashtable | ||
| #> | ||
| function Get-{{{apiNamePrefix}}}HttpSignedHeader { | ||
| param( | ||
| [string]$Method, | ||
| [System.UriBuilder]$UriBuilder, | ||
| [string]$Body | ||
| ) | ||
| #Hash table to store singed headers | ||
| $HttpSignedHeader = @{} | ||
| $TargetHost = $UriBuilder.Host | ||
|
|
||
| #Check for Authentication type | ||
| $apiKeyInfo = Get-{{{apiNamePrefix}}}APIKeyInfo | ||
| if ($null -eq $apiKeyInfo) { | ||
| throw "Unable to reterieve the api key info " | ||
| } | ||
|
|
||
| #get the body digest | ||
| $bodyHash = Get-{{{apiNamePrefix}}}StringHash -String $Body | ||
| $Digest = [String]::Format("SHA-256={0}", [Convert]::ToBase64String($bodyHash)) | ||
|
|
||
| #get the date in UTC | ||
| $dateTime = Get-Date | ||
| $currentDate = $dateTime.ToUniversalTime().ToString("r") | ||
|
|
||
| $requestTargetPath = [string]::Format("{0} {1}{2}",$Method.ToLower(),$UriBuilder.Path.ToLower(),$UriBuilder.Query) | ||
| $h_requestTarget = [string]::Format("(request-target): {0}",$requestTargetPath) | ||
| $h_cdate = [string]::Format("date: {0}",$currentDate) | ||
| $h_digest = [string]::Format("digest: {0}",$Digest) | ||
| $h_targetHost = [string]::Format("host: {0}",$TargetHost) | ||
|
|
||
| $stringToSign = [String]::Format("{0}`n{1}`n{2}`n{3}", | ||
| $h_requestTarget,$h_cdate, | ||
| $h_targetHost,$h_digest) | ||
|
|
||
| $hashedString = Get-{{{apiNamePrefix}}}StringHash -String $stringToSign | ||
| $signedHeader = Get-{{{apiNamePrefix}}}RSASHA256SignedString -APIKeyFilePath $apiKeyInfo.ApiKeyFilePath -DataToSign $hashedString | ||
| $authorizationHeader = [string]::Format("{0} keyId=""{1}"",algorithm=""rsa-sha256"",headers=""(request-target) date host digest"",signature=""{2}""", | ||
| $apiKeyInfo.ApiKeyPrefix, $apiKeyInfo.ApiKeyId, $signedHeader) | ||
|
|
||
| $HttpSignedHeader["Date"] = $currentDate | ||
| $HttpSignedHeader["Host"] = $TargetHost | ||
| $HttpSignedHeader["Content-Type"] = "application/json" | ||
| $HttpSignedHeader["Digest"] = $Digest | ||
| $HttpSignedHeader["Authorization"] = $authorizationHeader | ||
| return $HttpSignedHeader | ||
| } | ||
|
|
||
| <# | ||
| .SYNOPSIS | ||
| Gets the headers for http signed auth. | ||
|
|
||
| .DESCRIPTION | ||
| Gets the headers for the http signed auth. It use (targetpath), date, host and body digest to create authorization header. | ||
| .PARAMETER APIKeyFilePath | ||
| Specify the API key file path | ||
| .PARAMETER DataToSign | ||
| Specify the data to sign | ||
| .OUTPUTS | ||
| String | ||
| #> | ||
| function Get-{{{apiNamePrefix}}}RSASHA256SignedString { | ||
| Param( | ||
| [string]$APIKeyFilePath, | ||
| [byte[]]$DataToSign | ||
| ) | ||
| try { | ||
| $rsa_provider_path = Join-Path -Path $PSScriptRoot -ChildPath "{{{apiNamePrefix}}}RSAEncryptionProvider.cs" | ||
| $rsa_provider_sourceCode = Get-Content -Path $rsa_provider_path -Raw | ||
| Add-Type -TypeDefinition $rsa_provider_sourceCode | ||
| $signed_string = [RSAEncryption.RSAEncryptionProvider]::GetRSASignb64encode($APIKeyFilePath, $DataToSign) | ||
| if ($null -eq $signed_string) { | ||
| throw "Unable to sign the header using the API key" | ||
| } | ||
| return $signed_string | ||
| } | ||
| catch { | ||
| throw $_ | ||
| } | ||
| } | ||
| <# | ||
| .Synopsis | ||
| Gets the hash of string. | ||
| .Description | ||
| Gets the hash of string | ||
| .Outputs | ||
| String | ||
| #> | ||
| Function Get-{{{apiNamePrefix}}}StringHash([String] $String, $HashName = "SHA256") { | ||
| $hashAlogrithm = [System.Security.Cryptography.HashAlgorithm]::Create($HashName) | ||
| $hashAlogrithm.ComputeHash([System.Text.Encoding]::UTF8.GetBytes($String)) | ||
| } |
Oops, something went wrong.