FluentCertificates 0.9.1

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package FluentCertificates --version 0.9.1
NuGet\Install-Package FluentCertificates -Version 0.9.1
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="FluentCertificates" Version="0.9.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FluentCertificates --version 0.9.1
#r "nuget: FluentCertificates, 0.9.1"
#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 FluentCertificates as a Cake Addin
#addin nuget:?package=FluentCertificates&version=0.9.1

// Install FluentCertificates as a Cake Tool
#tool nuget:?package=FluentCertificates&version=0.9.1

📖 FluentCertificates Overview

⚠️ Note: while version numbers are v0.x.y, this software is under initial development and there'll be breaking-changes in its API from version to version.

NuGet Build & Publish GitHub license

FluentCertificates is a library using the Immutable Fluent Builder pattern for easily creating, finding and exporting certificates. Makes it simple to generate your own certificate chains, or just stand-alone self-signed certificates.

This project is published in several NuGet packages:

Unfortunately documentation is incomplete. You may find more examples within the project's unit tests.

CertificateBuilder examples

CertificateBuilder requires the FluentCertificates.Builder package and is found under the FluentCertificates namespace.

The absolute minimum needed to create a certificate (although it may not be a very useful one):

using var cert = new CertificateBuilder().Create();

Create a CertificateSigningRequest for signing, exporting and passing to a 3rd party CA:

//A public & private keypair must be created first, outside of the CertificateBuilder, otherwise you'd have no way to retrieve the private-key used for the new CertificateSigningRequest object
using var keys = RSA.Create();

//Creating a CertificateSigningRequest
var csr = new CertificateBuilder()
    .SetUsage(CertificateUsage.Server)
    .SetSubject(b => b.SetCommonName("*.fake.domain"))
    .SetDnsNames("*.fake.domain", "fake.domain")
    .SetKeyPair(keys)
    .CreateCertificateSigningRequest();

//The CertificateRequest object is accessible here:
var certRequest = csr.CertificateRequest;

//CSR can be exported to a string
Console.WriteLine(csr.ToPemString());

//Or to a file or StringWriter instance
csr.ExportAsPem("csr.pem");

Build a self-signed web server certificate:

//Using a fluent style
using var cert = new CertificateBuilder()
    .SetUsage(CertificateUsage.Server)
    .SetFriendlyName("Example self-signed web-server certificate")
    .SetSubject(b => b.SetCommonName("*.fake.domain"))
    .SetDnsNames("*.fake.domain", "fake.domain")
    .SetNotAfter(DateTimeOffset.UtcNow.AddMonths(1))
    .Create();

//And just to demonstrate using object initializers (I'll use fluent style from now on though)
using var builder = new CertificateBuilder() {
    Usage = CertificateUsage.Server,
    FriendlyName = "Example self-signed web-server certificate",
    Subject = new X500NameBuilder().SetCommonName("*.fake.domain"),
    DnsNames = new[] { "*.fake.domain", "fake.domain" },
    NotAfter = DateTimeOffset.UtcNow.AddMonths(1)
};
var cert = builder.Create();

Build a CA (certificate authority):

//A CA's expiry date must be later than that of any certificates it will issue
using var issuer = new CertificateBuilder()
    .SetUsage(CertificateUsage.CA)
    .SetFriendlyName("Example root CA")
    .SetSubject(b => b.SetCommonName("Example root CA"))
    .SetNotAfter(DateTimeOffset.UtcNow.AddYears(100))
    .Create();

Build a client-auth certificate signed by a CA:

//Note: the 'issuer' certificate used must have a private-key attached in order to sign this new certificate
using var cert = new CertificateBuilder()
    .SetUsage(CertificateUsage.Client)
    .SetFriendlyName("Example client-auth certificate")
    .SetSubject(b => b.SetCommonName("User: Michael"))
    .SetNotAfter(DateTimeOffset.UtcNow.AddYears(1))
    .SetIssuer(issuer)
    .Create();

Advanced: Build a certificate with customized extensions:

using var cert = new CertificateBuilder()
    .SetFriendlyName("Example certificate with customized extensions")
    .SetSubject(b => b.SetCommonName("Example certificate with customized extensions"))
    .AddExtension(new X509BasicConstraintsExtension(false, false, 0, true))
    .AddExtension(new X509KeyUsageExtension(X509KeyUsageFlags.DigitalSignature | X509KeyUsageFlags.KeyEncipherment | X509KeyUsageFlags.DataEncipherment, true))
    .AddExtension(new X509EnhancedKeyUsageExtension(new OidCollection { new(KeyPurposeID.AnyExtendedKeyUsage.Id) }, false))
    .SetIssuer(issuer)
    .Create();

CertificateFinder examples

CertificateFinder requires the FluentCertificates.Finder package and is found under the FluentCertificates namespace.

TODO: document this


X500NameBuilder examples

X500NameBuilder requires the FluentCertificates.Builder package and is found under the FluentCertificates namespace.

TODO: document this; see unit tests for more examples


X509Certificate2 extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

TODO: document these; see unit tests for more examples

Extension-Method Description
BuildChain
ExportAsCert
ExportAsPkcs12
ExportAsPkcs7
ExportAsPem
ToPemString
ToBase64String
GetPrivateKey
GetSignatureData
GetToBeSignedData
IsValidNow
IsValid
IsSelfSigned
IsIssuedBy

X509Chain extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

TODO: document these

Extension-Method Description
ToCollection
ToEnumerable
ExportAsPkcs7
ExportAsPkcs12
ExportAsPem
ToPemString

X509Certificate2Collection extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

TODO: document these

Extension-Method Description
ToEnumerable
ExportAsPkcs7
ExportAsPkcs12
ExportAsPem
ToPemString

IEnumerable<X509Certificate2> extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

TODO: document these

Extension-Method Description
ToCollection
FilterPrivateKeys
ExportAsPkcs7
ExportAsPkcs12
ExportAsPem
ToPemString

AsymmetricAlgorithm extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

TODO: document these

Extension-Method Description
ToPrivateKeyPemString
ToPublicKeyPemString
ExportAsPrivateKeyPem
ExportAsPublicKeyPem

CertificateRequest extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

Extension-Method Description
ToPemString() Exports the CertificateRequest to a PEM string.
ExportAsPem(string path) Exports the CertificateRequest to the specified PEM file.
ExportAsPem(TextWriter writer) Exports the CertificateRequest in PEM format to the given TextWriter.
ConvertToBouncyCastle() Converts the CertificateRequest to a BouncyCastle Pkcs10CertificationRequest

X509Extension extension-methods

These extension methods require the FluentCertificates.Builder package and are found under the FluentCertificates namespace.

Extension-Method Description
dnExtension.ConvertToBouncyCastle() Converts a DotNet X509Extension to a BouncyCastle X509Extension.
bcExtension.ConvertToDotNet(string oid) Converts a BouncyCastle X509Extension to a DotNet X509Extension. A DotNet X509Extension includes an OID, but a BouncyCastle one doesn't, therefore one must be supplied in the parameters here.
bcExtension.ConvertToDotNet(DerObjectIdentifier oid) Converts a BouncyCastle X509Extension to a DotNet X509Extension. A DotNet X509Extension includes an OID, but a BouncyCastle one doesn't, therefore one must be supplied in the parameters here.
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  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 Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos 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
0.9.2-ci0002 64 2/19/2024
0.9.1 216 8/11/2023
0.9.1-ci0017 123 8/11/2023
0.9.1-ci0007 112 8/11/2023
0.9.1-ci0006 124 8/11/2023
0.9.0 163 8/10/2023
0.8.1-ci0031 113 8/10/2023
0.8.1-ci0028 112 8/2/2023
0.8.1-ci0027 103 8/2/2023
0.8.1-ci0025 116 8/2/2023
0.8.1-ci0020 118 8/1/2023
0.8.1-ci0018 97 8/1/2023
0.8.1-ci0016 106 8/1/2023
0.8.0 433 7/7/2022
0.7.2-ci0010 160 7/7/2022
0.7.2-ci0002 152 7/6/2022
0.7.2-ci0001 133 7/6/2022
0.7.1 383 6/24/2022
0.7.1-ci0001 134 6/24/2022
0.7.0 383 6/24/2022
0.6.1-ci0002 142 6/24/2022
0.6.1-ci0001 125 6/24/2022
0.6.0 379 6/23/2022
0.5.5-ci0009 145 6/23/2022
0.5.5-ci0008 126 6/23/2022
0.5.5-ci0007 136 6/23/2022
0.5.5-ci0006 141 6/23/2022
0.5.5-ci0005 124 6/23/2022
0.5.5-ci0004 145 6/21/2022
0.5.4 375 6/20/2022
0.5.4-ci0002 132 6/20/2022
0.5.3 371 6/20/2022
0.5.3-ci0005 142 6/20/2022
0.5.3-ci0004 133 6/20/2022
0.5.3-ci0003 125 6/20/2022
0.5.2 399 6/18/2022
0.5.2-ci0001 137 6/18/2022
0.5.1 396 6/17/2022
0.5.1-ci0001 140 6/17/2022
0.5.0 383 6/17/2022
0.4.2-ci0022 136 6/17/2022
0.4.2-ci0021 141 6/17/2022
0.4.2-ci0020 132 6/17/2022
0.4.2-ci0018 138 6/17/2022
0.4.2-ci0014 138 6/16/2022
0.4.2-ci0013 143 6/16/2022
0.4.2-ci0012 154 6/16/2022
0.4.2-ci0011 140 6/16/2022
0.4.2-ci0010 124 6/16/2022
0.4.2-ci0009 138 6/16/2022
0.4.2-ci0007 122 6/16/2022
0.4.2-ci0003 145 6/15/2022
0.4.2-ci0002 160 6/15/2022
0.4.2-ci0001 158 6/10/2022
0.4.1 390 6/10/2022
0.4.1-ci0008 124 6/10/2022
0.4.1-ci0007 131 6/10/2022
0.4.1-ci0006 148 6/10/2022
0.4.1-ci0005 149 6/10/2022
0.4.1-ci0004 140 6/10/2022
0.4.1-ci0003 147 6/10/2022
0.4.1-ci0002 144 6/8/2022
0.4.1-ci0001 137 6/8/2022
0.4.0 403 6/2/2022
0.3.3-ci0001 144 6/2/2022
0.3.2 383 6/2/2022
0.3.2-ci0002 148 5/31/2022
0.3.2-ci.1 107 5/30/2022