CertificateAuthority Class

The class represents Certification Authority (CA) object and contains related properties and methods.

Definition

Namespace: PKI.CertificateServices
Assembly: SysadminsLV.PKI.Win (in SysadminsLV.PKI.Win.dll) Version: 4.0.1.0 (4.0.1.0)
C#
public class CertificateAuthority
Inheritance
Object    CertificateAuthority

Constructors

CertificateAuthority(String)Initializes a new instance of the CertificateAuthority class
Obsolete.
CertificateAuthority(String, String)Initializes a new instance of the CertificateAuthority class
Obsolete.

Properties

BaseCRL Gets the most recent Base CRL object.
Obsolete.
Certificate Gets the most recent CA certificate.
ComputerName Gets the host fully qualified domain name (FQDN) of the server where Certification Authority is installed.
ConfigString Gets the configuration string of the Certification Authority in a form: ComputerName\SanitizedName.
DeltaCRL Gets the most recent Delta CRL. If CA server is not configured to use Delta CRLs, the property is empty.
Obsolete.
DisplayName Gets the display name of the Certification Authority (sanitized characters are decoded to textual characters).
DistinguishedName Gets the LDAP path of the Certification Authority in Active Directory. This property is set to Null for Standalone CAs.
EnrollmentEndpoints Gets a collection of Certification Authority's web services enrollment endpoints.
EnrollmentServiceURI Gets or sets an array of Certification Authority's web services URI.
Obsolete.
IsAccessible Gets accessibility status for Certification Authority. Returns True if Certification Authority is online and management interfaces are accessible, otherwise False.

This property does not indicate whether remote registry is available or not. Refer to RegistryOnline property to determine remote registry availability.

IsEnterprise Indicates whether the Certification Authority is Enterprise CA (True) or Standalone CA (True).
IsRoot Indicates whether the Certification Authority is root (True) or subordinate CA (True).
Name Gets the common name of the Certification Authority in a sanitized form as specified in MS-WCCE §3.1.1.4.1.1.
OperatingSystem Gets operating system of the server which runs Certification Authority role.
RegistryOnline Gets remote registry accessibility status for Certification Authority. Returns True if Certification Authority if remote registry is accessible, otherwise False.

This property does not indicate whether management interfaces are available or not. Refer to IsAccessible property to determine management interface availability.

ServiceStatus Gets the status of the CertSvc service.
SetupStatus Gets the status of the current CA installation.

This property is set to Unknown if RegistryOnline property is False.

Type Gets the type of the Certification Authority. The value can be one of the following types:
  • Enterprise Root
  • Enterprise Subordinate
  • Standalone Root
  • Standalone Subordinate
  • Undefined (if CA type cannot be recognized).
  • Unknown (if CA server is offline)

Methods

Connect Connects to a specified Certification Authority server. This method allows you to connect to either Standalone CA or Enterprise CA.
EnumEnterpriseCAs Enumerates registered in Certification Authorities from the current Active Directory forest.
Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetBaseCRL Returns the most recent version of Base CRL.
GetCACerts Returns all CA certificates.
GetCAExchangeCertificate Retrieves the most recent 'CA Exchange' certificate. If the certificate does not exist, the method will instruct CA server to generate or enroll a new one.
GetDbReader Returns an instance of ADCS database reader.
GetDeltaCRL Returns the most recent version of Delta CRL. If Certification Authority is not configured for Delta CRL, the method returns null.
GetHashCode
(Inherited from Object)
GetMyRoles Returns all roles granted on the CA to the caller.
GetSecurityDescriptor Gets the access control list (ACL) for the current Certification Authority.
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
Ping Attempts to check Certification Authority's management interfaces availability.
Obsolete.
Ping(String) Attempts to check specified Certification Authority's management interfaces availability.
PingAdmin Gets the availability and accessibility of ADCS Certification Authority administration and management RPC/DCOM interface.
PingRequest Gets the availability and accessibility of ADCS Certification Authority request RPC/DCOM interface.
PublishCRL This method publishes certificate revocation lists (CRLs) for a certification authority (CA).

The PublishCRL method publishes a CRL based on the CA's current certificate, as well as CRLs based on any CA certificates that have been renewed and are not yet expired.

Restart Restarts a current Certification Authority instance. This method restarts 'certsvc' service.
Restart(String) Restarts a specified Certification Authority service. This method restarts 'certsvc' service.
Start Starts Certification Authority service.
Start(String) Starts Certification Authority service on a specified server.
Stop Stops Certification Authority service.
Stop(String) Stops Certification Authority service on a specified server.
ToString
(Inherited from Object)
UpdateEnrollmentServiceUri Updates Enrollment Services URLs in the Active Directory.

See Also