API Documentation

HttpRequestExtensions Class

Namespace: Nucleus.Extensions

Assembly: Nucleus.Extensions.dll

Api Key signature extensions.

Scheme name for the authorization header used to send the request signature.

Sign (HttpRequestMessage request, Guid accessKey, String secret)

Add a signature to the specified HttpRequestMessage

Name	Type
request	System.Net.Http.HttpRequestMessage
accessKey	Guid
secret	String

IsSigned (HttpRequest request, Guid accessKey)

Return whether an incoming request has a API key signature

Name	Type
request	Microsoft.AspNetCore.Http.HttpRequest
accessKey	ref Guid

IsSigned (HttpRequest request, Guid accessKey, String signature, String reason)

Validate request headers from an incoming request..

Name	Type
request	Microsoft.AspNetCore.Http.HttpRequest
accessKey	ref Guid
signature	ref String
reason	ref String

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.

Name	Type
request	Microsoft.AspNetCore.Http.HttpRequest
secret	String
reason	ref String

GenerateSignature (HttpRequestMessage request, String secret)

Generate a HMAC signature string

Name	Type
request	System.Net.Http.HttpRequestMessage
secret	String

GenerateSignature (HttpRequest request, Guid accessKey, String secret)

Generate a signature for an incoming request in order to compare it.

Name	Type
request	Microsoft.AspNetCore.Http.HttpRequest
accessKey	Guid
secret	String

PercentEncode (String parameter)

Percent-encode the value using "Amazon rules": alphanumeric and -_.~ characters are written as-is, and all other values are percent-encoded.

Name	Type
parameter	String