🗝️ .NET Keys

A simple .NET library with a collection of common assymetric and symmetric key models.

Show/hide folder structure

.
├── .github
│   └── workflows
├── Devantler.Keys.Age
│   └── Utils
├── Devantler.Keys.Age.Tests
│   ├── AgeKeyTests
│   └── Utils
│       └── DateTimeFormatterTests
└── Devantler.Keys.Core

9 directories

Prerequisites

• .NET

🚀 Getting Started

To get started, you can install the packages from NuGet.

# For the Age key model
dotnet add package Devantler.Keys.Age

If you need to create a new key model, you can install the Core package from NuGet. This package includes the base classes and interfaces for creating new key models.

dotnet add package Devantler.Keys.Core

📝 Usage

The library currently supports the following key models:

• Age

The Age Key Model

The Age key model is a simple key model that represents an Age key. To create a new Age key, you can use the AgeKey class. To create an age key with a current created date, you can construct the AgeKey class with the public and private keys.

string publicKey = "age1wrczv4ll5att0mm8tmp4052z4fadw5zefxvefuqxu8rqtpe47chskk9dgn";
string privateKey = "AGE-SECRET-KEY-1PW4MMMJ9KMZ94C2N2FM3UPLPQPEF8G9QHXP8VX6V6GW3EN9QMSVQX0ATHQ";

var ageKey = new AgeKey(publicKey, privateKey);

If you want to create a new Age key with a specific created date, you can use the AgeKey class with the public and private keys and the created date.

string publicKey = "age1wrczv4ll5att0mm8tmp4052z4fadw5zefxvefuqxu8rqtpe47chskk9dgn";
string privateKey = "AGE-SECRET-KEY-1PW4MMMJ9KMZ94C2N2FM3UPLPQPEF8G9QHXP8VX6V6GW3EN9QMSVQX0ATHQ";
DateTime createdDate = DateTime.UtcNow;

var ageKey = new AgeKey(publicKey, privateKey, createdDate);

And if you want to serialize the Age key, you can use the ToString() method.

string serializedAgeKey = ageKey.ToString();

Console.WriteLine(serializedAgeKey);

// Output:
// # created: 1920-08-18T01:00:00+01:00
// # public key: age1wrczv4ll5att0mm8tmp4052z4fadw5zefxvefuqxu8rqtpe47chskk9dgn
// AGE-SECRET-KEY-1PW4MMMJ9KMZ94C2N2FM3UPLPQPEF8G9QHXP8VX6V6GW3EN9QMSVQX0ATHQ

Note

If you are looking for a library to help generate Age keys you can use the Devantler.AgeCLI library, which embeds the age-keygen binary to generate Age keys to files or in-memory. It also uses the AgeKey class so the generated keys are easy to use in your .NET applications.