Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gamote/cert127
There is no place like 127.0.0.1 🏠
https://github.com/gamote/cert127
127 cert127 certificate development https local makecert mkcert ssl tls trusted
Last synced: 8 days ago
JSON representation
There is no place like 127.0.0.1 🏠
- Host: GitHub
- URL: https://github.com/gamote/cert127
- Owner: Gamote
- License: other
- Created: 2022-11-17T14:20:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-15T09:50:26.000Z (almost 2 years ago)
- Last Synced: 2024-10-04T17:36:48.931Z (about 1 month ago)
- Topics: 127, cert127, certificate, development, https, local, makecert, mkcert, ssl, tls, trusted
- Language: TypeScript
- Homepage:
- Size: 19.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# cert127
[](https://www.npmjs.com/package/cert127) [](https://www.npmjs.com/package/cert127) [](https://github.com/Gamote/cert127/blob/main/LICENSE)
Small utility to generate **🔒 trusted** self-signed certificates for local development.
## Prerequisites
This package requires `mkcert` to be installed on your system. Please follow the [installation instructions](https://github.com/FiloSottile/mkcert#installation) for your platform.
## Installation
```shell
# With Yarn
yarn add cert127
# or with npm
npm i cert127
```
## Usage
```ts
import cert127 from 'cert127';
const { key, cert } = await cert127();
```
## Example
Let's create a quick Fastify server with the listening socket configured for TLS:
```ts
import cert127 from 'cert127';
import Fastify from 'fastify';
/**
* Run the server!
*/
const start = async () => {
const fastify = Fastify({ https: await cert127() });
fastify.get('/secure', (req, reply) =>
reply.send("There is no place like 127.0.0.1 🏠"));
await fastify.listen({ port: 3000 });
};
void start();
```
Now you can open [https://localhost:3000/secure](https://localhost:3000/secure) in your browser and see:
> There is no place like 127.0.0.1 🏠
> **IMPORTANT: This will not work on production, as it is meant only for local development.**
## ✨ Roadmap
- [ ] Try to include the `mkcert` binary in the package, so that it can be used without installing it on the system. (check `node-pre-gyp`)
- [ ] Make it a class, so we offer more ways to retrieve the cert
- [ ] Add a check to see if `mkcert` is installed and if not, install it
- [ ] Make sure that `mkcert` was initialized: `mkcert -install`
- [ ] Add a check to see if the certificate is already created and ask the user if they want to overwrite it
- [ ] Add more options for customizations (e.g. hosts, expiration time etc.)
- [ ] Add a way to revoke the certificate
- [ ] Add a way to check if the certificate is valid
- [ ] Allow creating multiple certificates
- [ ] Add tests
- [ ] Add CI/CD
- [ ] Add ESLint and Prettier
- [ ] Add sync method