From 5ed0a922899556deaf435b4fb0ca3450a9de05ab Mon Sep 17 00:00:00 2001 From: Tom Deseyn Date: Mon, 3 Aug 2026 20:45:06 +0200 Subject: [PATCH] Update README and add MIT license. --- .github/FUNDING.yml | 1 + LICENSE | 21 +++++++++++++++++++++ README.md | 16 +++++++++++++--- 3 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 LICENSE diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..0f35af7 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: tmds diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2ef94de --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Tom Deseyn + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index f13e182..1b3325d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,20 @@ [![NuGet](https://img.shields.io/nuget/v/linux-dev-certs.svg)](https://www.nuget.org/packages/linux-dev-certs) +[![NuGet Downloads](https://img.shields.io/nuget/dt/linux-dev-certs)](https://www.nuget.org/packages/linux-dev-certs) +[![License](https://img.shields.io/github/license/tmds/linux-dev-certs)](https://github.com/tmds/linux-dev-certs/blob/main/LICENSE) + +# linux-dev-certs The .NET `dotnet dev-certs` command that is part of the .NET SDK supports generating a development certificate on Linux [to some extent](https://learn.microsoft.com/en-us/aspnet/core/security/enforcing-ssl#linux-specific-considerations). This repo contains a .NET tool that supports additional distributions. Because the tool uses a CA-signed development certificate, the local HTTPS endpoint is trusted by a broader part of the system (browsers, tools, ...). -# Using +### Sponsoring + +linux-dev-certs is open source and free to use under the MIT license. If your organization depends on it, please consider [sponsoring its maintenance](https://github.com/sponsors/tmds). + +This isn't a support contract or a license fee — the source stays open and the rules stay simple. Sponsoring is a small, predictable way to help sustain the work that goes into bug fixes, security updates, and new features. + +## Using **note** the tool uses `sudo` to update the system CA store and install required system tools. @@ -17,7 +27,7 @@ You can add the `--no-deps` argument to stop the tool from installing system too If you get an error saying _Could not execute because the specified command or file was not found._, try adding the .NET tools folder to PATH: `PATH=$PATH:~/.dotnet/tools`. -# Supported distros +## Supported distros - Fedora and derived (RHEL, AlmaLinux, ...) - Debian and derived (Ubuntu, ...) @@ -31,6 +41,6 @@ Limitations: - Ubuntu browsers are packaged as snaps. Snaps do not use system certificates. If the user uses a snap-based Firefox, the CA certificate is added to its certificate store. Other browsers are (currently) not configured. - On gentoo, binary versions of browsers do not support system certificates. If the user uses a binary-based Firefox/LibreWolf, the CA certificate is added to its certificate store. Other browsers are (currently) not configured. -# How it works +## How it works To work across a range of distro applications, the tool generates a CA certificate which is added to the system store. This CA certificate is used to create an ASP.NET Core developer certificate that will be picked up by ASP.NET Core. The private key of the CA certificate is not stored and therefore it can not be used to sign additional certificates.