EasyPKIView 1.1.4-beta3

This is a prerelease version of EasyPKIView.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package EasyPKIView --version 1.1.4-beta3                
NuGet\Install-Package EasyPKIView -Version 1.1.4-beta3                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="EasyPKIView" Version="1.1.4-beta3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add EasyPKIView --version 1.1.4-beta3                
#r "nuget: EasyPKIView, 1.1.4-beta3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install EasyPKIView as a Cake Addin
#addin nuget:?package=EasyPKIView&version=1.1.4-beta3&prerelease

// Install EasyPKIView as a Cake Tool
#tool nuget:?package=EasyPKIView&version=1.1.4-beta3&prerelease                

Introducing The EasyPKIView Class Library

Managing a Public Key Infrastructure (PKI), especially in a large, complex environment environment can be incredibly hard. Microsoft provides very few native .NET interfaces for working with its PKI implementation (Active Directory Certificate Services).

EasyPKIView provides a simple interface for inspecting components of your Microsoft PKI environment including:

  • Enterprise Certification Authorities registered in Active Directory
  • Certificate Templates registered in Active Directory
  • Certificate Revocation Lists (CRLs)

Working with Issuing CAs

Let's say you want to generate a list of all the Enterprise CAs in your environment:

using EasyPKIView;

List<ADCertificationAuthority> MyCAs = ADCertificationAuthority.GetAll();

The MyCAs object will contain just about all the metadata you may need about every Issuing CA including:

  • The DNS host name where the CA is installed
  • The full LDAP Distinguished name of the CA
  • The list of certificate templates advertised on the CA
  • The CA Config string (useful for executing certutil or certreq commands and using the ICertAdmin Win32 interface)

You can also pull up a particular CA if you know it's display name:

var MyCA = new ADCertificationAuthority(@"Vandelay Industries Issuing CA 1");

Or by passing in the CA certificate itself:

X509Certificate2 CACert = new X509Certificate2(@"C:\CA.cer");
var MyCA = new ADCertificationAuthority(CACert);

Working with Certificate Templates

Certificate templates act as the framework for how Microsoft Enterprise CAs generate end-entity certificates. They govern the key strength and the key usages asserted on each certificate they're used to model. Thus, it should come as no surprise that it's important to keep track and control over what certificate templates are being used to model certificates in your environment.

Obtaining information about the certificate templates in your AD forest programmatically can be quite challenging since there's no native .NET interface with which to retreive & inspect them. EasyPKIView makes this a borderline trivial task.

To simply generate a list of all certificate templates in your AD forest:

var MyTemplates = ADCertificateTemplate.GetAll();

Each ADCertificateTemplate object will contain metadata about a certificate template, including:

  • Name and Display Name
  • Version
  • LDAP Distinguished Name
  • Minimal Allowed key size
  • The template Oid (if version 2 or higher)
  • The list of key usages and extended key usages included on issued certificates

Let's say you're asked to identify any certificate templates that allow for weak key strength. Linq is your friend:

using System.Linq;
using EasyPKIView;

var WeakTemplates = ADCertificateTemplate.GetAll()
                                         .Where(p => p.MinimumKeySize < 2048)
					 .ToList();

You can narrow your work down further by only focusing on certificate templates that are actually assigned to one or more issuing CA in your AD forest:

var WeakTemplates = ADCertificationAuthority.GetAll()
					    .Select(p => p.Templates)
					    .SelectMany(p => p)
					    .Where(p => p.MinimumKeySize < 2048)
					    .Distinct().ToList();

New for version 1.1.0 is the ability to see the effective Active Directory permissions on a certificate template object. Certificate template permissions are stored as a collection of ADCertificateTemplateAccessRule objects. Each element in the collection represents an AD principal along with its effective permissions on the template.

In the below example, we will iterate through each AD principal that has one or more permissions set on the certificate template, displaying the principal display name & whether it has each permission type:

var AdminTemplate = new ADCertificateTemplate(@"Administrator");
foreach(ADCertificateTemplateAccessRule Rule in AdminTemplate.AccessRules)
{
	Console.WriteLine($"Principal Name: {Rule.Identity}");
	Console.WriteLine($"Has Read Access?: {Rule.Read}");
	Console.WriteLine($"Has Write Access?: {Rule.Write}");
	Console.WriteLine($"Has Full Control?: {Rule.FullControl}");
	Console.WriteLine($"Has Enroll Access?: {Rule.Enroll}");
	Console.WriteLine($"Has Autoenroll Access?: {Rule.AutoEnroll}");

	Console.WriteLine("\r\n----\r\n");
}

Working with Certificate Revocation Lists (CRLs)

EasyPKIView leverages the excellent BouncyCastle library to enable you to pull up the most pertinent information about an indicated CRL. In the current version of the library, this includes:

  • The date the CRL expires
  • The list of certificate serial numbers included in the CRL

The returned collection of revoked certificate serial numbers is expressed as a list of strings. This makes it trivial to compare against, for instance, an X509Certificate2 object.

You can use the CrlReader class to inspect a CRL by passing it in as an already-downloaded file:

using System.IO;
using EasyPKIView;

var MyCRL = new CrlReader(new FileInfo(@"c:\Vandelay.crl"));

or by passing in the URL of the CRL distribution point:

var MyCRL = new CrlReader(@"http://certificates.vandelay.com/crls/Vandelay Industries CA.crl");
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.4-beta4 1,473 7/9/2021
1.1.4-beta3 297 7/9/2021
1.1.4-beta2 273 7/9/2021
1.1.4-beta1 274 7/8/2021
1.1.2 1,509 3/5/2021
1.1.0 487 8/18/2020
1.0.5 446 8/5/2020
1.0.5-beta 316 8/4/2020
1.0.3 473 6/22/2020
1.0.3-beta 326 6/16/2020
1.0.2-beta 330 6/12/2020
1.0.1-beta 394 6/12/2020
1.0.0-beta 380 6/12/2020

Pre-release candidate