No Description

Travis Campbell 281c560e4a Support installing to system trust store for Arch-based distros (#57) 6 years ago
vendor 26ac5f3539 Switch to modules 🙌 6 years ago
.travis.yml 44af1b6556 Force go stable to workaround travis-ci/gimme#157 6 years ago
AUTHORS c3ffec658a Add LICENSE 6 years ago
CONTRIBUTING.md 5651e29aea Create CONTRIBUTING.md 6 years ago
CONTRIBUTORS c3ffec658a Add LICENSE 6 years ago
LICENSE c3ffec658a Add LICENSE 6 years ago
PATENTS c3ffec658a Add LICENSE 6 years ago
README.md 281c560e4a Support installing to system trust store for Arch-based distros (#57) 6 years ago
cert.go 060fcce2db Put PKCS#12 behind a flag, and check in the vendored dependency 6 years ago
go.mod 26ac5f3539 Switch to modules 🙌 6 years ago
go.sum 26ac5f3539 Switch to modules 🙌 6 years ago
go110min.go bf29b706fc Add a canary file to suggest Go 1.10 is required 6 years ago
main.go 060fcce2db Put PKCS#12 behind a flag, and check in the vendored dependency 6 years ago
truststore_darwin.go 61180c71ad Add support for Firefox Developer Edition 6 years ago
truststore_java.go ae768be874 Support installing into Java's root store (#38) 6 years ago
truststore_linux.go 281c560e4a Support installing to system trust store for Arch-based distros (#57) 6 years ago
truststore_nss.go e5f9c16f8c Offer a less confusing warning about Firefox on Windows 6 years ago
truststore_windows.go e5f9c16f8c Offer a less confusing warning about Firefox on Windows 6 years ago

README.md

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

On macOS, use Homebrew.

brew install mkcert
brew install nss # if you use Firefox

Additionally on macOS, you can also use MacPorts.

sudo port sync
sudo port install mkcert

On Linux, install certutil

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

and install using Linuxbrew.

brew install mkcert
````

You can also build from source (requires Go 1.10+), or use [the pre-built binaries](https://github.com/FiloSottile/mkcert/releases).

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


On Arch Linux you can use your [AUR helper](https://wiki.archlinux.org/index.php/AUR_helpers) to install mkcert from the [PKGBUILD](https://aur.archlinux.org/packages/mkcert/).

yaourt -S mkcert


On Windows, use Chocolatey.

choco install mkcert ```

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

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

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, Arch) or
    • update-ca-certificates (Ubuntu, Debian)
  • 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.


This is not an official Google project, just some code that happens to be owned by Google.