Show / Hide Table of Contents

Class CertificateManager

The certificate manager manages X.509 certificates.

Inheritance
System.Object
CertificateManager
Implements
ICertificateManager
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ComponentSpace.Saml2.Certificates
Assembly: ComponentSpace.Saml2.dll
Syntax
public class CertificateManager : ICertificateManager

Constructors

CertificateManager(ICertificateLoader, CertificateValidators, ILoggerFactory)

Initializes a new instance of the CertificateManager class.

Declaration
public CertificateManager(ICertificateLoader certificateLoader, CertificateValidators certificateValidators, ILoggerFactory loggerFactory)
Parameters
Type Name Description
ICertificateLoader certificateLoader

The certificate loader.

CertificateValidators certificateValidators

The certificate validators.

Microsoft.Extensions.Logging.ILoggerFactory loggerFactory

The logger factory.

Methods

GetLocalIdentityProviderEncryptionCertificatesAsync(LocalIdentityProviderConfiguration, PartnerServiceProviderConfiguration)

Gets the local identity provider X.509 encryption certificates.

Declaration
public Task<IList<X509Certificate2>> GetLocalIdentityProviderEncryptionCertificatesAsync(LocalIdentityProviderConfiguration localIdentityProviderConfiguration, PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)
Parameters
Type Name Description
LocalIdentityProviderConfiguration localIdentityProviderConfiguration

The local identity provider configuration.

PartnerServiceProviderConfiguration partnerServiceProviderConfiguration

The partner service provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the local identity provider X.509 encryption certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetLocalIdentityProviderSignatureCertificatesAsync(LocalIdentityProviderConfiguration, PartnerServiceProviderConfiguration)

Gets the local identity provider X.509 signature certificates.

Declaration
public Task<IList<X509Certificate2>> GetLocalIdentityProviderSignatureCertificatesAsync(LocalIdentityProviderConfiguration localIdentityProviderConfiguration, PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)
Parameters
Type Name Description
LocalIdentityProviderConfiguration localIdentityProviderConfiguration

The local identity provider configuration.

PartnerServiceProviderConfiguration partnerServiceProviderConfiguration

The partner service provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the local identity provider X.509 signature certificates.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetLocalServiceProviderEncryptionCertificatesAsync(LocalServiceProviderConfiguration, PartnerIdentityProviderConfiguration)

Gets the local service provider X.509 encryption certificates.

Declaration
public Task<IList<X509Certificate2>> GetLocalServiceProviderEncryptionCertificatesAsync(LocalServiceProviderConfiguration localServiceProviderConfiguration, PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)
Parameters
Type Name Description
LocalServiceProviderConfiguration localServiceProviderConfiguration

The local service provider configuration.

PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration

The partner identity provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the local service provider X.509 encryption certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetLocalServiceProviderSignatureCertificatesAsync(LocalServiceProviderConfiguration, PartnerIdentityProviderConfiguration)

Gets the local service provider X.509 signature certificates.

Declaration
public Task<IList<X509Certificate2>> GetLocalServiceProviderSignatureCertificatesAsync(LocalServiceProviderConfiguration localServiceProviderConfiguration, PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)
Parameters
Type Name Description
LocalServiceProviderConfiguration localServiceProviderConfiguration

The local service provider configuration.

PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration

The partner identity provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the local service provider X.509 signature certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetPartnerIdentityProviderEncryptionCertificatesAsync(PartnerIdentityProviderConfiguration)

Gets the partner identity provider X.509 encryption certificates.

Declaration
public Task<IList<X509Certificate2>> GetPartnerIdentityProviderEncryptionCertificatesAsync(PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)
Parameters
Type Name Description
PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration

The partner identity provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the partner identity provider X.509 encryption certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetPartnerIdentityProviderSignatureCertificatesAsync(PartnerIdentityProviderConfiguration)

Gets the partner identity provider X.509 signature certificates.

Declaration
public Task<IList<X509Certificate2>> GetPartnerIdentityProviderSignatureCertificatesAsync(PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration)
Parameters
Type Name Description
PartnerIdentityProviderConfiguration partnerIdentityProviderConfiguration

The partner identity provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the partner identity provider X.509 signature certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetPartnerServiceProviderEncryptionCertificatesAsync(PartnerServiceProviderConfiguration)

Gets the partner service provider X.509 encryption certificates.

Declaration
public Task<IList<X509Certificate2>> GetPartnerServiceProviderEncryptionCertificatesAsync(PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)
Parameters
Type Name Description
PartnerServiceProviderConfiguration partnerServiceProviderConfiguration

The partner service provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the partner service provider X.509 encryption certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

GetPartnerServiceProviderSignatureCertificatesAsync(PartnerServiceProviderConfiguration)

Gets the partner service provider X.509 signature certificates.

Declaration
public Task<IList<X509Certificate2>> GetPartnerServiceProviderSignatureCertificatesAsync(PartnerServiceProviderConfiguration partnerServiceProviderConfiguration)
Parameters
Type Name Description
PartnerServiceProviderConfiguration partnerServiceProviderConfiguration

The partner service provider configuration.

Returns
Type Description
System.Threading.Tasks.Task<System.Collections.Generic.IList<System.Security.Cryptography.X509Certificates.X509Certificate2>>

A task that represents the operation and returns the partner service provider X.509 signature certificates or null if none.

Exceptions
Type Condition
SamlException

Thrown when the X.509 certificates cannot be retrieved.

Implements

ICertificateManager
In This Article
Back to top Copyright © ComponentSpace Pty Ltd 2017-2022. All rights reserved.