Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webprofusion/anvil
A client implementation for the Automated Certificate Management Environment (ACME) protocol
https://github.com/webprofusion/anvil
acme dotnet
Last synced: 5 days ago
JSON representation
A client implementation for the Automated Certificate Management Environment (ACME) protocol
- Host: GitHub
- URL: https://github.com/webprofusion/anvil
- Owner: webprofusion
- License: mit
- Created: 2020-11-06T06:23:17.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T05:08:17.000Z (about 1 month ago)
- Last Synced: 2024-10-17T16:58:24.216Z (about 1 month ago)
- Topics: acme, dotnet
- Language: C#
- Homepage: https://certifytheweb.com
- Size: 1.78 MB
- Stars: 26
- Watchers: 6
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Anvil
**The project is a fork of https://github.com/fszlin/certes with packaging updates, feature updates and experimental extensions.**
This library is an ACME client implementation primarily used by https://certifytheweb.com and is subject to changes required by that application.
Extended Features:
- ACME ARI (renewal info)
- Certificate chain build does not require installed/embedded root cert
- Optional use of modern PFX cert/key algorithms for OpenSSL 3.x+ compatibility
- Authority token challenges, tkauth-01 and TnAuthList
## Account
Creating new ACME account:
```C#
var acme = new AcmeContext(WellKnownServers.LetsEncryptStagingV2);
var account = await acme.NewAccount("[email protected]", true);
// Save the account key for later use
var pemKey = acme.AccountKey.ToPem();
```
Use an existing ACME account:
```C#
// Load the saved account key
var accountKey = KeyFactory.FromPem(pemKey);
var acme = new AcmeContext(WellKnownServers.LetsEncryptStagingV2, accountKey);
var account = await acme.Account();
```
See [API doc](APIv2.md#accounts) for additional operations.
## Order
Place a wildcard certificate order
*(DNS validation is required for wildcard certificates)*
```C#
var order = await acme.NewOrder(new[] { "*.your.domain.name" });
```
Generate the value for DNS TXT record
```C#
var authz = (await order.Authorizations()).First();
var dnsChallenge = await authz.Dns();
var dnsTxt = acme.AccountKey.DnsTxt(dnsChallenge.Token);
```
Add a DNS TXT record to `_acme-challenge.your.domain.name`
with `dnsTxt` value.
For non-wildcard certificate, HTTP challenge is also available
```C#
var order = await acme.NewOrder(new[] { "your.domain.name" });
```
## Authorization
Get the **token** and **key authorization string**
```C#
var authz = (await order.Authorizations()).First();
var httpChallenge = await authz.Http();
var keyAuthz = httpChallenge.KeyAuthz;
```
Save the **key authorization string** in a text file,
and upload it to `http://your.domain.name/.well-known/acme-challenge/`
## Validate
Ask the ACME server to validate our domain ownership
```C#
await challenge.Validate();
```
## Certificate
Download the certificate once validation is done
```C#
var privateKey = KeyFactory.NewKey(KeyAlgorithm.ES256);
var cert = await order.Generate(new CsrInfo
{
CommonName = "your.domain.name",
}, privateKey);
```
Export full chain certification
```C#
var certPem = cert.ToPem();
```
Export PFX
```C#
var pfxBuilder = cert.ToPfx(privateKey);
var pfx = pfxBuilder.Build("my-cert", "abcd1234");
```