HttpRequestExtensions Class
Namespace: Nucleus.Extensions
Assembly: Nucleus.Extensions.dll
Api Key signature extensions.
Fields
AUTHORIZATION_SCHEME
Scheme name for the authorization header used to send the request signature.
Methods
GenerateSignature (HttpRequestMessage, String) Method
GenerateSignature (HttpRequestMessage request, String secret)
Generate a HMAC signature string
Parameters
| Name | Type |
|---|---|
| request | System.Net.Http.HttpRequestMessage |
| secret | String |
GenerateSignature (HttpRequest, Guid, String) Method
GenerateSignature (HttpRequest request, Guid accessKey, String secret)
Generate a signature for an incoming request in order to compare it.
Parameters
| Name | Type |
|---|---|
| request | Microsoft.AspNetCore.Http.HttpRequest |
| accessKey | Guid |
| secret | String |
IsSigned (HttpRequest, Guid) Method
IsSigned (HttpRequest request, Guid accessKey)
Return whether an incoming request has a API key signature
Parameters
| Name | Type |
|---|---|
| request | Microsoft.AspNetCore.Http.HttpRequest |
| accessKey | ref Guid |
IsSigned (HttpRequest, Guid, String, String) Method
IsSigned (HttpRequest request, Guid accessKey, String signature, String reason)
Validate request headers from an incoming request..
Parameters
| Name | Type |
|---|---|
| request | Microsoft.AspNetCore.Http.HttpRequest |
| accessKey | ref Guid |
| signature | ref String |
| reason | ref String |
IsValid (HttpRequest, String, String) Method
IsValid (HttpRequest request, String secret, String reason)
Validate request headers and check that the request signature matches a signature generated using the same data and stored secret on the server.
Parameters
| Name | Type |
|---|---|
| request | Microsoft.AspNetCore.Http.HttpRequest |
| secret | String |
| reason | ref String |
PercentEncode (String) Method
PercentEncode (String parameter)
Percent-encode the value using "Amazon rules": alphanumeric and -_.~ characters are written as-is, and all other values are percent-encoded.
Parameters
| Name | Type |
|---|---|
| parameter | String |
Sign (HttpRequestMessage, Guid, String) Method
Sign (HttpRequestMessage request, Guid accessKey, String secret)
Add a signature to the specified HttpRequestMessage
Parameters
| Name | Type |
|---|---|
| request | System.Net.Http.HttpRequestMessage |
| accessKey | Guid |
| secret | String |