Skip to content

Commit 9398e2c

Browse files
committed
Update README and add MIT license.
1 parent d086e17 commit 9398e2c

3 files changed

Lines changed: 35 additions & 3 deletions

File tree

‎.github/FUNDING.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: tmds

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Tom Deseyn
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
11
[![NuGet](https://img.shields.io/nuget/v/linux-dev-certs.svg)](https://www.nuget.org/packages/linux-dev-certs)
2+
[![NuGet Downloads](https://img.shields.io/nuget/dt/linux-dev-certs)](https://www.nuget.org/packages/linux-dev-certs)
3+
[![License](https://img.shields.io/github/license/tmds/linux-dev-certs)](https://github.com/tmds/linux-dev-certs/blob/main/LICENSE)
4+
5+
# linux-dev-certs
26

37
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).
48

59
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, ...).
610

7-
# Using
11+
### Sponsoring
12+
13+
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).
14+
15+
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.
16+
17+
## Using
818

919
**note** the tool uses `sudo` to update the system CA store and install required system tools.
1020

@@ -17,7 +27,7 @@ You can add the `--no-deps` argument to stop the tool from installing system too
1727

1828
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`.
1929

20-
# Supported distros
30+
## Supported distros
2131

2232
- Fedora and derived (RHEL, AlmaLinux, ...)
2333
- Debian and derived (Ubuntu, ...)
@@ -31,6 +41,6 @@ Limitations:
3141
- 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.
3242
- 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.
3343

34-
# How it works
44+
## How it works
3545

3646
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.

0 commit comments

Comments
 (0)