A simple zero-config tool to make locally trusted development certificates with any names you'd like.
Go to file
2018-08-21 11:09:52 -06:00
vendor Switch to modules 🙌 2018-08-14 02:20:07 -04:00
.travis.yml Force go stable to workaround travis-ci/gimme#157 2018-08-13 00:33:52 -04:00
AUTHORS LICENSE+AUTHORS: follow appropriate company policies 2018-08-21 11:09:52 -06:00
cert.go Put PKCS#12 behind a flag, and check in the vendored dependency 2018-08-12 23:29:13 -04:00
go110min.go Add a canary file to suggest Go 1.10 is required 2018-07-03 17:51:14 -04:00
go.mod Switch to modules 🙌 2018-08-14 02:20:07 -04:00
go.sum Switch to modules 🙌 2018-08-14 02:20:07 -04:00
LICENSE LICENSE+AUTHORS: follow appropriate company policies 2018-08-21 11:09:52 -06:00
main.go Put PKCS#12 behind a flag, and check in the vendored dependency 2018-08-12 23:29:13 -04:00
README.md LICENSE+AUTHORS: follow appropriate company policies 2018-08-21 11:09:52 -06:00
truststore_darwin.go Add support for Firefox Developer Edition 2018-08-12 21:14:07 -04:00
truststore_java.go java: fix paths for Windows and JRE (#54) 2018-08-19 15:56:28 -07:00
truststore_linux.go linux: use unique per-CA names when installing certificates 2018-08-19 19:07:47 -04:00
truststore_nss.go Offer a less confusing warning about Firefox on Windows 2018-08-12 21:47:50 -04:00
truststore_windows.go Offer a less confusing warning about Firefox on Windows 2018-08-12 21:47:50 -04:00

mkcert

mkcert is a simple tool for making locally-trusted development certificates. It requires no configuration.

$ mkcert -install
Created a new local CA at "/Users/filippo/Library/Application Support/mkcert" 💥
The local CA is now installed in the system trust store! ⚡️
The local CA is now installed in the Firefox trust store (requires restart)! 🦊

$ mkcert example.com '*.example.org' myapp.dev localhost 127.0.0.1 ::1
Using the local CA at "/Users/filippo/Library/Application Support/mkcert" ✨

Created a new certificate valid for the following names 📜
 - "example.com"
 - "*.example.org"
 - "myapp.dev"
 - "localhost"
 - "127.0.0.1"
 - "::1"

The certificate is at "./example.com+5.pem" and the key at "./example.com+5-key.pem" ✅

Chrome screenshot

Using certificates from real certificate authorities (CAs) for development can be dangerous or impossible (for hosts like localhost or 127.0.0.1), but self-signed certificates cause trust errors. Managing your own CA is the best solution, but usually involves arcane commands, specialized knowledge and manual steps.

mkcert automatically creates and installs a local CA in the system root store, and generates locally-trusted certificates.

Installation

Warning

: the rootCA-key.pem file that mkcert automatically generates gives complete power to intercept secure requests from your machine. Do not share it.

macOS

On macOS, use Homebrew

brew install mkcert
brew install nss # if you use Firefox

or MacPorts.

sudo port sync
sudo port install mkcert

Linux

On Linux, first install certutil.

sudo apt install libnss3-tools
    -or-
sudo yum install nss-tools
    -or-
sudo pacman -S nss

Then you can install using Linuxbrew

brew install mkcert

or build from source (requires Go 1.10+)

go get -u github.com/FiloSottile/mkcert
$(go env GOPATH)/bin/mkcert

or use the pre-built binaries.

On Arch Linux you can use your AUR helper to install mkcert from the PKGBUILD.

yaourt -S mkcert

Windows

On Windows, use Chocolatey

choco install mkcert

or build from source (requires Go 1.10+), or use the pre-built binaries.

Supported root stores

mkcert supports the following root stores:

  • macOS system store
  • Windows system store
  • Linux variants that provide either
    • update-ca-trust (Fedora, RHEL, CentOS) or
    • update-ca-certificates (Ubuntu, Debian) or
    • trust (Arch)
  • Firefox (macOS and Linux only)
  • Chrome and Chromium
  • Java (when JAVA_HOME is set)

Advanced topics

Mobile devices

For the certificates to be trusted on mobile devices, you will have to install the root CA. It's the rootCA.pem file in the folder printed by mkcert -CAROOT.

On iOS, you can either use AirDrop, email the CA to yourself, or serve it from an HTTP server. After installing it, you must enable full trust in it. Note: earlier versions of mkcert ran into an iOS bug, if you can't see the root in "Certificate Trust Settings" you might have to update mkcert and regenerate the root.

For Android, you will have to install the CA and then enable user roots in the development build of your app. See this StackOverflow answer.

Changing the location of the CA files

The CA certificate and its key are stored in an application data folder in the user home. You usually don't have to worry about it, as installation is automated, but the location is printed by mkcert -CAROOT.

If you want to manage separate CAs, you can use the environment variable $CAROOT to set the folder where mkcert will place and look for the local CA files.

Installing the CA on other systems

Installing in the trust store does not require the CA key, so you can export the CA certificate and use mkcert to install it in other machines.

  • Look for the rootCA.pem file in mkcert -CAROOT
  • copy it to a different machine
  • set $CAROOT to its directory
  • run mkcert -install

Remember that mkcert is meant for development purposes, not production, so it should not be used on end users' machines, and that you should not export or share rootCA-key.pem.