Class HTTPArtifactBinding

Supports the HTTP artifact binding.

Inheritance

System.Object

HTTPArtifactBinding

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: ComponentSpace.SAML2.Bindings

Assembly: ComponentSpace.Saml2.dll

Syntax

public static class HTTPArtifactBinding

Remarks

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

Methods

ReceiveArtifactInForm(HttpRequestBase, out HTTPArtifact, out String)

Receives the SAML artifact and optional relay state data from the form's hidden controls.

Declaration

public static void ReceiveArtifactInForm(HttpRequestBase httpRequest, out HTTPArtifact artifact, out string relayState)

Parameters

Type	Name	Description
System.Web.HttpRequestBase	httpRequest	The HTTP request containing the posted form.
HTTPArtifact	artifact	The returned SAML artifact.
System.String	relayState	The returned relay state or null if none.

Exceptions

Type	Condition
SAMLBindingException	Thrown when the receive fails.

ReceiveArtifactInForm(HttpRequestBase, out String, out String)

Receives the SAML artifact and optional relay state data from the form's hidden controls.

Declaration

public static void ReceiveArtifactInForm(HttpRequestBase httpRequest, out string artifact, out string relayState)

Parameters

Type	Name	Description
System.Web.HttpRequestBase	httpRequest	The HTTP request containing the posted form.
System.String	artifact	The returned SAML artifact.
System.String	relayState	The returned relay state or null if none.

Exceptions

Type	Condition
SAMLBindingException	Thrown when the receive fails.

ReceiveArtifactInQueryString(HttpRequestBase, out HTTPArtifact, out String)

Receives the SAML artifact and optional relay state by extracting them from the query string.

Declaration

public static void ReceiveArtifactInQueryString(HttpRequestBase httpRequest, out HTTPArtifact artifact, out string relayState)

Parameters

Type	Name	Description
System.Web.HttpRequestBase	httpRequest	The HTTP request containing the query string.
HTTPArtifact	artifact	The returned SAML artifact.
System.String	relayState	The returned relay state or null if none.

Exceptions

Type	Condition
SAMLBindingException	Thrown when the receive fails.

ReceiveArtifactInQueryString(HttpRequestBase, out String, out String)

Receives the SAML artifact and optional relay state by extracting them from the query string.

Declaration

public static void ReceiveArtifactInQueryString(HttpRequestBase httpRequest, out string artifact, out string relayState)

Parameters

Type	Name	Description
System.Web.HttpRequestBase	httpRequest	The HTTP request containing the query string.
System.String	artifact	The returned SAML artifact.
System.String	relayState	The returned relay state or null if none.

Exceptions

Type	Condition
SAMLBindingException	Thrown when the receive fails.

SendArtifactInForm(HttpResponseBase, String, HTTPArtifact, String)

Sends the SAML artifact and optional relay state data as hidden controls in a posted form.

Declaration

public static void SendArtifactInForm(HttpResponseBase httpResponse, string targetURL, HTTPArtifact artifact, string relayState)

Parameters

Type	Name	Description
System.Web.HttpResponseBase	httpResponse	The HTTP response that will return the form to post.
System.String	targetURL	The target URL for the posted form.
HTTPArtifact	artifact	The SAML artifact.
System.String	relayState	The relay state or null if none.

Exceptions

Type	Condition
SAMLBindingException	Thrown when the send fails.

SendArtifactInQueryString(HttpResponseBase, String, HTTPArtifact, String)

Sends the SAML artifact and optional relay state data as query string parameters in an HTTP redirect.

Declaration

public static void SendArtifactInQueryString(HttpResponseBase httpResponse, string redirectURL, HTTPArtifact artifact, string relayState)

Parameters

Type	Name	Description
System.Web.HttpResponseBase	httpResponse	The HTTP response used to perform the redirect.
System.String	redirectURL	The redirect URL.
HTTPArtifact	artifact	The SAML artifact.
System.String	relayState	The relay state or null if none.

Exceptions

Type	Condition
SAMLBindingException	Thrown when the send fails.

See Also

SAMLIdentifiers.BindingURIs