Readme suggestion explaining private key a little more

Open Beginner friendly
#13 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
swift
Domain
documentation, security

Research direction

Review the README's explanation of the private key generated for the Secure Enclave, starting with the existing private-key section. Clarify that the file references key material held in the chip, explain the loss-of-machine recovery risk, and mention encrypting long-term data to an alternate backup key.

Written by the indexing model from the issue text.

Description

I wasn't entirely sure reading the README if my understanding about the private key generated here was correct.

The private key generated by this plugin has almost no value to an attacker without the original machine, and the biometrics to authenticate with the Secure Enclave. (Thus the whole point of using the Secure Enclave)
(This is very different to a typical private key, at least without a passphrase)

That wasn't clear from the README (to me)

I engaged an LLM to come up with some text that might be more helpful to newcomers (like me) to this project:

The private key file does not contain actual key material — it is a reference (encoding the public key and access control settings) that tells the plugin which key to use inside the Secure Enclave chip. The real cryptographic key never leaves the chip. This means the file is useless without the specific machine it was generated on, but it also means that if that machine is ever lost, stolen, or damaged, any data encrypted only to this key will be permanently inaccessible. Make sure to also encrypt long-term data to an alternate backup key.

I don't know if it is useful for you, but this would have been fantastic for me to read in the README.

Thank you for writing this plugin, it is so useful!!

Cameron

Dominant language
Swift
Stars
251
Forks
9
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from remko/age-plugin-se

All issues in remko/age-plugin-se

Similar issues

More Swift issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.