From 65047cfe182dab0a27497b4b96993ae962fb8e4b Mon Sep 17 00:00:00 2001 From: Max Goedjen Date: Wed, 11 Mar 2020 22:45:07 -0700 Subject: [PATCH] Update README.md --- README.md | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50e638b..258a500 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,34 @@ -# secretive +# Secretive -An app for storing an managing SSH keys in the Secure Enclave and Smart Cards. +Secretive is an app for storing and managing SSH keys in the Secure Enclave. Heavily inspired by https://github.com/sekey/sekey -![Screenshot of Secretive](.github/readme/app.png) +Screenshot of Secretive + +## Why? + +### Safer Storage + +The most common setup for SSH keys is just keeping them on disk, guarded by proper permissions. This is fine in most cases, but it's not super hard for malicious users or malware to copy your private key. If you store your keys in the Secure Enclave, it's impossible to export them, by design. + +### Access Control + +If your Mac has a Secure Enclave, it also has support for strong biometric access controls like Touch ID. You can configure your key so that they require Touch ID (or Watch) authentication before they're accessed. + +Screenshot of Secretive authenticating with Touch ID + +### Notifications + +Secretive also notifies you whenever your keys are acceessed, so you're never caught off guard. + +Screenshot of Secretive notifying the user + +### Support for Smart Cards Too! + +For Macs without Secure Enclaves, you can configure a Smart Card (such as a YubiKey) and use it for signing as well. + +## Getting Started + +### Security Considerations + +For the moment, you must build Secretive from source. For an app like this, it's critical that you trust that the app you're running is the app whose source you've checked out. To this end, Secretive has no third party dependecies, and is designed to be easy for you to audit for exploits.