Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mvmaasakkers/certificates

An opinionated helper for generating tls certificates
https://github.com/mvmaasakkers/certificates

Last synced: about 2 months ago
JSON representation

An opinionated helper for generating tls certificates

Host: GitHub
URL: https://github.com/mvmaasakkers/certificates
Owner: mvmaasakkers
License: mit
Created: 2019-03-04T07:20:36.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2022-12-27T15:55:28.000Z (almost 2 years ago)
Last Synced: 2024-07-31T20:52:50.756Z (4 months ago)
Language: Go
Homepage:
Size: 117 KB
Stars: 38
Watchers: 2
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-go - certificates - An opinionated tool for generating tls certificates. (Security / HTTP Clients)
zero-alloc-awesome-go - certificates - An opinionated tool for generating tls certificates. (Security / HTTP Clients)
awesome-go-extra - certificates - 03-04T07:20:36Z|2022-04-29T07:25:05Z| (Security / HTTP Clients)

README

# Certificates helper

[![MIT license](http://img.shields.io/badge/license-MIT-brightgreen.svg)](http://opensource.org/licenses/MIT)
[![GoDoc](https://godoc.org/github.com/mvmaasakkers/certificates?status.svg)](https://godoc.org/github.com/mvmaasakkers/certificates)
[![Go Report Card](https://goreportcard.com/badge/github.com/mvmaasakkers/certificates)](https://goreportcard.com/report/github.com/mvmaasakkers/certificates)
[![CodeFactor](https://www.codefactor.io/repository/github/mvmaasakkers/certificates/badge)](https://www.codefactor.io/repository/github/mvmaasakkers/certificates)
[![Coverage Status](https://coveralls.io/repos/github/mvmaasakkers/certificates/badge.svg?branch=master)](https://coveralls.io/github/mvmaasakkers/certificates?branch=master)
[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)

This is an opinionated helper for generating tls certificates.
It outputs only in PEM format but this enables you easily generate certificate
chains for MA TLS.

## cert package

The cert package can be used directly in your application without the need of the command
line interface, underlying database layer or external dependencies. This way certificate
generation can be easily embedded.

Documentation can be found [here](https://godoc.org/github.com/mvmaasakkers/certificates/cert).

# CLI Tool

## Installation

Currently you can use it by building it locally, checking the [releases](https://github.com/mvmaasakkers/certificates/releases) or with docker:

`docker run mvmaasakkers/certificates cert gen-ca --cn=*.test.domain --stdout`

## Usage

### Generate a CA set

You can generate a CA set by using the generate-ca subcommand like the following example:

`certificates cert gen-ca --cn=*.test.domain --stdout`

This will output the key and certificate directly to stdout like this (parts are omitted for readability):

```
-----BEGIN RSA PRIVATE KEY-----
MIIJJwIBAAKCAgEA0txN/brNlBcGrU8mAxL8V19pS1dWEVVTF82LDahI7FMsPPkM
sg5iBCLwYJhnVRPucUmcGC1NyljCy/yW0Cbwl5aNWozAfEkiUpWsukn/ZcMuXvac
qsPRK0Xswbr305NDRnlphoeutyzXAhW2P4FQGCwSfx/Mlaezphc7AreLKg==
-----END RSA PRIVATE KEY-----

-----BEGIN CERTIFICATE-----
MIIE3zCCAsegAwIBAgIFANHEYb4wDQYJKoZIhvcNAQELBQAwDzENMAsGA1UEAxME
P9g8SpNaf6jNS0ULG8+DJ7dwdHes7IWA0BtjDkur4Ya+ey/FwowgMeEnc/h10Adc
az7b
-----END CERTIFICATE-----

```

By default the certificates are written to files `ca.key` and `ca.crt`.

### Generate a certificate

This needs a pregenerated CA certificate and key (see "Generate a CA set").

To generate a signed certificate pair you can use the following example:

`certificates cert gen --cn=local.test.domain --stdout`

This will output the key and certificate directly to stdout like this (parts are omitted for readability):

```
-----BEGIN RSA PRIVATE KEY-----
MIIJFAIBAAKCAf0Z7/5ZYgOo4gHfAPAPN0vKWEVJ5D97wvnYUq00DcaRPCZZopXl
XUcctgAb3kw27ohTm31KnVEnN8ibeUg2fz+LO/xYVvhD2BMkoe1gk/2JAogPUi1l
jWjI7fuKGwlyHimeYnUx1ADRlShBgHGr
-----END RSA PRIVATE KEY-----

```

By default a file (file.db) database is created to keep track of unique certificate serialnumbers.
This is advised only for dev and test environments. The CA database can be one of the following flavours of sql: mysql,
postgresql or mssql.

To change key generation bitsize use the `--bitsize` flag (default is 4096, options are 2048 and 4096).

To use a pre-existing csr to use during the generation give the path to the csr file using the `--csr` flag.

## Development setup

This module uses [Go modules](https://github.com/golang/go/wiki/Modules) for dependency management.
To run:

- `go run main.go`

And this will output:

```bash
NAME:
Certificates - An opinionated TLS certificate generator.

USAGE:
main [global options] command [command options] [arguments...]

VERSION:
v...

DESCRIPTION:
An opinionated TLS certificate generator.

COMMANDS:
certificate, cert certificate commands
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--help, -h show help
--version, -v print the version
```

## License
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmvmaasakkers%2Fcertificates.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmvmaasakkers%2Fcertificates?ref=badge_large)