Interface IHttpRedirectBinding

Namespace

ComponentSpace.Saml2.Bindings.Redirect

Assembly

ComponentSpace.Saml2.dll

Supports the HTTP Redirect binding.

public interface IHttpRedirectBinding

Remarks

Refer to the Bindings for the OASIS Security Assertion Markup Language (SAML) V2.0 specification for further details.

Methods

IsValid()

Indicates whether the current HTTP request is valid for the binding.

bool IsValid()

Returns

bool

true if the current HTTP request is valid for the binding; otherwise false.

ReceiveMessageAsync(AsymmetricAlgorithm)

Receives a SAML message.

Task<ReceiveResult> ReceiveMessageAsync(AsymmetricAlgorithm key = null)

Parameters

key AsymmetricAlgorithm

The key to verify the signature or null if no signature is to be verified.

Returns

Task<ReceiveResult>

A task that represents the operation and returns the HTTP Redirect result.

Exceptions

SamlBindingException

Thrown if the SAML message cannot be received.

SendMessageAsync(string, string, bool, string, AsymmetricAlgorithm, string)

Sends a SAML message.

Task SendMessageAsync(string url, string message, bool isResponse, string relayState = null, AsymmetricAlgorithm key = null, string signatureAlgorithm = null)

Parameters

url string

The URL to receive the SAML message.

message string

The SAML message XML.

isResponse bool

The flag indicating whether a SAML request or response.

relayState string

The relay state or null if none.

key AsymmetricAlgorithm

The key to generate the signature or null if no signature is to be generated.

signatureAlgorithm string

The signature algorithm or null to default to http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

Returns

Task

A task that represents the operation.

Exceptions

SamlBindingException

Thrown if the SAML message cannot be sent.

VerifySignatureAsync(AsymmetricAlgorithm)

Verifies the signature.

Task<bool> VerifySignatureAsync(AsymmetricAlgorithm key)

Parameters

key AsymmetricAlgorithm

The key to verify the signature.

Returns

Task<bool>

A task that represents the operation and returns true if the signature verifies; otherwise false

Exceptions

SamlSignatureException

Thrown if the signature verification fails.