Class PartnerProviderConfiguration

The partner provider configuration is configuration common to partner identity providers and service providers.

Inheritance
System.Object
Entity
ProviderConfiguration
PartnerProviderConfiguration
PartnerIdentityProviderConfiguration
PartnerServiceProviderConfiguration
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.Configuration
Assembly: ComponentSpace.Saml2.dll
Syntax
public abstract class PartnerProviderConfiguration : ProviderConfiguration

Constructors

PartnerProviderConfiguration()

Constructs a partner provider configuration.

Declaration
public PartnerProviderConfiguration()

PartnerProviderConfiguration(XmlElement)

Constructs a partner provider configuration from XML.

Declaration
public PartnerProviderConfiguration(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The partner provider configuration XML.

Properties

AuthnContext

Gets or sets the authentication context.

Declaration
public string AuthnContext { get; set; }
Property Value
Type Description
System.String

The authentication context.

ClockSkew

Gets or sets the clock skew. The clock skew allows for differences between local and partner computer clocks when checking time intervals.

The default time span is 3 minutes.

Declaration
public TimeSpan ClockSkew { get; set; }
Property Value
Type Description
System.TimeSpan

The clock skew.

DataEncryptionMethod

Gets or sets the XML encryption data encryption algorithm.

The default algorithm is http://www.w3.org/2001/04/xmlenc#aes256-cbc.

Declaration
public string DataEncryptionMethod { get; set; }
Property Value
Type Description
System.String

The XML encryption data encryption algorithm.

DigestMethod

Gets or sets the XML signature digest algorithm.

The default algorithm is http://www.w3.org/2001/04/xmlenc#sha256.

Declaration
public string DigestMethod { get; set; }
Property Value
Type Description
System.String

The XML signature digest algorithm.

DisableClearAllSessionsOnLogout

Gets or sets the flag indicating whether all sessions to a partner provider should be cleared upon logout.

Declaration
public bool DisableClearAllSessionsOnLogout { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating indicating whether all sessions to a partner provider should be cleared upon logout.

DisableDestinationCheck

Gets or sets the flag indicating whether the destination is checked.

Declaration
public bool DisableDestinationCheck { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether the destination is checked.

DisableInboundLogout

Gets or sets the flag indicating whether to disable inbound logout.

Declaration
public bool DisableInboundLogout { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether to disable inbound logout.

DisableInResponseToCheck

Gets or sets the flag indicating whether the InResponseTo is checked.

Declaration
public bool DisableInResponseToCheck { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether the InResponseTo is checked.

DisableLogoutResponseStatusCheck

Gets or sets the flag indicating whether the logout response status is checked.

Declaration
public bool DisableLogoutResponseStatusCheck { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether the logout response status is checked.

DisableOutboundLogout

Gets or sets the flag indicating whether to disable outbound logout.

Declaration
public bool DisableOutboundLogout { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether to disable outbound logout.

DisablePendingLogoutCheck

Gets or sets the flag indicating whether a logout is pending is checked.

Declaration
public bool DisablePendingLogoutCheck { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether a logout is pending is checked.

EnableSha1Support

Gets or sets the flag indicating whether SHA-1 support is enabled.

Declaration
public bool EnableSha1Support { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether SHA-1 support is enabled.

EncryptLogoutNameID

Gets or sets the flag indicating whether to encrypt the Name ID in the logout request.

Declaration
public bool EncryptLogoutNameID { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether to encrypt the Name ID in the logout request.

IssuerFormat

Gets or sets the issuer format.

The default issuer format is not explicitly specified.

Declaration
public string IssuerFormat { get; set; }
Property Value
Type Description
System.String

The issuer format.

KeyEncryptionDigestMethod

Gets or sets the XML encryption key encryption digest algorithm.

Declaration
public string KeyEncryptionDigestMethod { get; set; }
Property Value
Type Description
System.String

The XML encryption key encryption digest algorithm.

KeyEncryptionMaskGenerationFunction

Gets or sets the XML encryption key encryption mask generation function.

Declaration
public string KeyEncryptionMaskGenerationFunction { get; set; }
Property Value
Type Description
System.String

The XML encryption key encryption mask generation function.

KeyEncryptionMethod

Gets or sets the XML encryption key encryption algorithm.

The default algorithm is http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p.

Declaration
public string KeyEncryptionMethod { get; set; }
Property Value
Type Description
System.String

The XML encryption key encryption algorithm.

LogoutRequestLifeTime

Gets or sets the logout request lifetime.

The default time span is 3 minutes.

Declaration
public TimeSpan LogoutRequestLifeTime { get; set; }
Property Value
Type Description
System.TimeSpan

The logout request lifetime.

NameIDFormat

Gets or sets the name identifier format.

The default name identifier format is urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.

Declaration
public string NameIDFormat { get; set; }
Property Value
Type Description
System.String

The name identifier format.

PartnerCertificates

Gets or sets the partner certificates.

Declaration
public IList<CertificateConfiguration> PartnerCertificates { get; set; }
Property Value
Type Description
System.Collections.Generic.IList<CertificateConfiguration>

The partner certificates.

SignatureMethod

Gets or sets the XML signature algorithm.

The default algorithm is http://www.w3.org/2001/04/xmldsig-more#rsa-sha256.

Declaration
public string SignatureMethod { get; set; }
Property Value
Type Description
System.String

The XML signature algorithm.

SignLogoutRequest

Gets or sets the flag indicating whether to sign sent logout responses.

The default is true.

Declaration
public bool SignLogoutRequest { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether to sign sent logout responses.

SignLogoutResponse

Gets or sets the flag indicating whether to sign sent logout responses.

The default is true.

Declaration
public bool SignLogoutResponse { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether to sign sent logout responses.

SingleLogoutServiceBinding

Gets or sets the partner provider's single logout service binding.

The default binding is urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect.

Declaration
public string SingleLogoutServiceBinding { get; set; }
Property Value
Type Description
System.String

The partner provider's single logout service binding.

SingleLogoutServiceResponseUrl

Gets or sets the partner provider's single logout service response URL.

Declaration
public string SingleLogoutServiceResponseUrl { get; set; }
Property Value
Type Description
System.String

The partner provider's single logout service response URL.

SingleLogoutServiceUrl

Gets or sets the partner provider's single logout service URL.

Declaration
public string SingleLogoutServiceUrl { get; set; }
Property Value
Type Description
System.String

The partner provider's single logout service URL.

UseEmbeddedCertificate

Gets or sets the flag to indicate whether to use embedded certificates.

Declaration
public bool UseEmbeddedCertificate { get; set; }
Property Value
Type Description
System.Boolean

The flag to indicate whether to use embedded certificates.

WantDigestMethod

Gets or sets the XML signature digest algorithm expected from the partner provider.

If not specified then any algorithm is accepted.

Declaration
public string WantDigestMethod { get; set; }
Property Value
Type Description
System.String

The expected XML signature digest algorithm or null if none..

WantLogoutRequestSigned

Gets or sets the flag indicating whether received logout requests should be signed.

The default is true.

Declaration
public bool WantLogoutRequestSigned { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether received logout requests should be signed.

WantLogoutResponseSigned

Gets or sets the flag indicating whether received logout responses should be signed.

The default is true.

Declaration
public bool WantLogoutResponseSigned { get; set; }
Property Value
Type Description
System.Boolean

The flag indicating whether received logout responses should be signed.

WantSignatureMethod

Gets or sets the XML signature algorithm expected from the partner provider.

If not specified then any algorithm is accepted.

Declaration
public string WantSignatureMethod { get; set; }
Property Value
Type Description
System.String

The expected XML signature algorithm or null if none..

Methods

ToXml(XmlElement)

Serializes the partner provider configuration to XML.

Declaration
public override void ToXml(XmlElement xmlElement)
Parameters
Type Name Description
System.Xml.XmlElement xmlElement

The XML element.
Overrides