Class MetadataImporter

Imports SAML metadata into the SAML configuration.

Inheritance

System.Object

MetadataImporter

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 static class MetadataImporter

Methods

Import(EntitiesDescriptor, SAMLConfiguration, String)

Imports the SAML identity and service provider metadata entities descriptor by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void Import(EntitiesDescriptor entitiesDescriptor, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
EntitiesDescriptor	entitiesDescriptor	The SAML metadata entities descriptor.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

Import(EntityDescriptor, SAMLConfiguration, String)

Imports the SAML identity and service provider metadata entity descriptor by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void Import(EntityDescriptor entityDescriptor, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
EntityDescriptor	entityDescriptor	The SAML metadata entity descriptor.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

Import(XmlElement, SAMLConfiguration, String)

Imports the SAML metadata XML by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void Import(XmlElement xmlElement, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
System.Xml.XmlElement	xmlElement	The SAML metadata XML.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

ImportFile(String, SAMLConfiguration, String)

Imports the SAML metadata file by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void ImportFile(string fileName, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
System.String	fileName	The SAML metadata file
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

ImportIdentityProviders(EntitiesDescriptor, SAMLConfiguration, String)

Imports the SAML identity provider metadata entity descriptor by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void ImportIdentityProviders(EntitiesDescriptor entitiesDescriptor, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
EntitiesDescriptor	entitiesDescriptor	The SAML metadata entities descriptor.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

ImportIdentityProviders(EntitiesDescriptor, String)

Imports the SAML identity provider metadata entity descriptor.

Declaration

public static IList<PartnerIdentityProviderConfiguration> ImportIdentityProviders(EntitiesDescriptor entitiesDescriptor, string certificateFolder)

Parameters

Type	Name	Description
EntitiesDescriptor	entitiesDescriptor	The SAML metadata entities descriptor.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

Returns

Type	Description
System.Collections.Generic.IList<PartnerIdentityProviderConfiguration>	The list of partner identity provider configurations.

ImportIdentityProviders(EntityDescriptor, SAMLConfiguration, String)

Imports the SAML identity provider metadata entity descriptor by updating the SAML configuration.

Declaration

public static void ImportIdentityProviders(EntityDescriptor entityDescriptor, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
EntityDescriptor	entityDescriptor	The SAML metadata entity descriptor.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

ImportIdentityProviders(EntityDescriptor, String)

Imports the SAML identity provider metadata entity descriptor.

Declaration

public static IList<PartnerIdentityProviderConfiguration> ImportIdentityProviders(EntityDescriptor entityDescriptor, string certificateFolder)

Parameters

Type	Name	Description
EntityDescriptor	entityDescriptor	The SAML metadata entity descriptor.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

Returns

Type	Description
System.Collections.Generic.IList<PartnerIdentityProviderConfiguration>	The list of partner identity provider configurations.

ImportServiceProviders(EntitiesDescriptor, SAMLConfiguration, String)

Imports the SAML service provider metadata entity descriptor by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void ImportServiceProviders(EntitiesDescriptor entitiesDescriptor, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
EntitiesDescriptor	entitiesDescriptor	The SAML metadata entities descriptor.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

ImportServiceProviders(EntitiesDescriptor, String)

Imports the SAML service provider metadata entity descriptor.

Declaration

public static IList<PartnerServiceProviderConfiguration> ImportServiceProviders(EntitiesDescriptor entitiesDescriptor, string certificateFolder)

Parameters

Type	Name	Description
EntitiesDescriptor	entitiesDescriptor	The SAML metadata entities descriptor.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

Returns

Type	Description
System.Collections.Generic.IList<PartnerServiceProviderConfiguration>	The list of partner service provider configurations.

ImportServiceProviders(EntityDescriptor, SAMLConfiguration, String)

Imports the SAML service provider metadata entity descriptor by updating the SAML configuration and retrieving the X.509 certificates.

Declaration

public static void ImportServiceProviders(EntityDescriptor entityDescriptor, SAMLConfiguration samlConfiguration, string certificateFolder)

Parameters

Type	Name	Description
EntityDescriptor	entityDescriptor	The SAML metadata entity descriptor.
SAMLConfiguration	samlConfiguration	The SAML configuration to be updated.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

ImportServiceProviders(EntityDescriptor, String)

Imports the SAML service provider metadata entity descriptor.

Declaration

public static IList<PartnerServiceProviderConfiguration> ImportServiceProviders(EntityDescriptor entityDescriptor, string certificateFolder)

Parameters

Type	Name	Description
EntityDescriptor	entityDescriptor	The SAML metadata entity descriptor.
System.String	certificateFolder	The folder to save certificates files to or null if certificates are to be saved as strings.

Returns

Type	Description
System.Collections.Generic.IList<PartnerServiceProviderConfiguration>	The list of partner service provider configurations.

SaveCertificate(X509Certificate2, String)

Saves the X.509 certificate to the specified file.

Declaration

public static void SaveCertificate(X509Certificate2 x509Certificate, string fileName)

Parameters

Type	Name	Description
System.Security.Cryptography.X509Certificates.X509Certificate2	x509Certificate	The X.509 certificate.
System.String	fileName	The file name.