Store SSH keys in the Secure Enclave

Go to file

Jason Garber a543de0737 GitHub Actions updates (#554 ) * Bump actions/add-to-project to v1.0.1 This _might_ address the failed workflow runs dating back to at least the last six months: https://github.com/maxgoedjen/secretive/actions/workflows/add-to-project.yml * Bump actions/upload-artifact to v4 This should get rid of the deprecation notices displayed as annotations beneath each Nightly job run. See: https://github.com/maxgoedjen/secretive/actions/runs/9461831554 * Bump actions/upload-artifact to v4 Similar to `cf25db6`, this should silence some deprecation notices.		2024-06-25 21:08:38 +00:00
.github	GitHub Actions updates (#554 )	2024-06-25 21:08:38 +00:00
Sources	Add Japanese translations (#546 )	2024-04-28 22:33:51 +00:00
.gitignore	Ignore workspace data (#299 )	2022-01-02 00:49:15 +00:00
APP_CONFIG.md	Add in config for nushell (#406 )	2022-08-31 06:32:45 +00:00
CODE_OF_CONDUCT.md	Add CoC	2020-03-14 21:31:45 -07:00
CONTRIBUTING.md	Localizing help pages (#501 )	2024-01-05 20:20:40 +00:00
DESIGN.md	Update GitHub image (#313 )	2022-01-02 06:16:36 +00:00
FAQ.md	Added FAQ item for generating RSA keys (#482 )	2023-08-27 22:20:53 +00:00
LICENSE	Initial commit	2020-02-18 19:34:46 -08:00
LOCALIZING.md	Localization fixes (#507 )	2024-01-12 12:50:52 -08:00
README.md	Update README.md (#453 )	2023-03-13 00:40:52 +00:00
SECURITY.md	Create SECURITY.md (#123 )	2020-07-12 15:14:40 -07:00

README.md

Secretive

Secretive is an app for storing and managing SSH keys in the Secure Enclave. It is inspired by the sekey project, but rewritten in Swift with no external dependencies and with a handy native management app.

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 access controls like Touch ID, or authentication with Apple Watch. You can configure your keys 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 accessed, 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

Installation

Direct Download

You can download the latest release over on the Releases Page

Using Homebrew

brew install secretive

FAQ

There's a FAQ here.

Auditable Build Process

Builds are produced by GitHub Actions with an auditable build and release generation process. Each build has a "Document SHAs" step, which will output SHA checksums for the build produced by the GitHub Action, so you can verify that the source code for a given build corresponds to any given release.

A Note Around Code Signing and Keychains

While Secretive uses the Secure Enclave for key storage, it still relies on Keychain APIs to access them. Keychain restricts reads of keys to the app (and specifically, the bundle ID) that created them. If you build Secretive from source, make sure you are consistent in which bundle ID you use so that the Keychain is able to locate your keys.

Backups and Transfers to New Machines

Because secrets in the Secure Enclave are not exportable, they are not able to be backed up, and you will not be able to transfer them to a new machine. If you get a new Mac, just create a new set of secrets specific to that Mac.

Security

If you discover any vulnerabilities in this project, please notify max.goedjen@gmail.com with the subject containing "SECRETIVE SECURITY."