summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAhmed Abdelhalim <[email protected]>2026-07-23 13:38:40 +0200
committerAhmed Abdelhalim <[email protected]>2026-07-23 13:38:40 +0200
commit2248311cdb359e8e31995b0b0711133c71f526c1 (patch)
treed277d7f6ad57c1a61e292c7a0ec814ed640afcb8
parent70bd9496580bdbb7646d1b3b42aaf9152c9357d4 (diff)
Update README to include install/restore GPG
-rw-r--r--README.md84
1 files changed, 71 insertions, 13 deletions
diff --git a/README.md b/README.md
index 7d916c1..8766770 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# Installation:
+# Password Store with OTP using SmartCard
+
+## Installation
```bash
# MacOS
@@ -20,21 +22,77 @@ pass Personal/reddit
pass otp Personal/reddit
```
-----
-
## Mobile Setup
-[Install the pass app from the app store ](https://mssun.github.io/passforios/)
+
+[Install the pass app from the app store](https://mssun.github.io/passforios/)
Configure the app settings as follow:
+
+ General
- * Remember PGP Key Passphrase (ON)
- * Remember Git Credential Passphrase (ON)
- * Show Folders (ON)
- * Hide OTP Fields (ON)
+ + Remember PGP Key Passphrase (ON)
+ + Remember Git Credential Passphrase (ON)
+ + Show Folders (ON)
+ + Hide OTP Fields (ON)
+ Password Repository
- * Git URL: `https://github.com/a14m/.pass.git`
- * Username: `a14m`
- * Authentication Method: password
- * Generate a token at https://github.com/settings/tokens (with all `repo` permissions)
- * Paste the token into the mobile app
+ + Git URL: `https://github.com/a14m/.pass.git`
+ + Username: `a14m`
+ + Authentication Method: password
+ + Generate a token at [github tokens](https://github.com/settings/tokens)
+(with all `repo` permissions)
+ + Paste the token into the mobile app
+
+----
+
+## SmartCard Setup
+
+### Install Tails
+
++ Download [tails](https://tails.net/install/index.en.html)
++ Format a USB
++ Unmount disk (on MacOS ex. `diskutil unmountDisk /dev/diskX`)
++ Create bootable image from iso
+`sudo dd if=/path/to/tails.img of=/dev/diskX bs=4M status=progress`
++ Boot the `tails` live image from a bootable USB
+
+### Setup GPG SmartCard
+
+```bash
+```
+
+### Restore GPG on SmartCard
+
+```bash
+# Restore GPG keys from backup
+zbarcam -1 --raw > key.asc
+
+# Import the GPG key on smartcard
+gpg --import key.asc
+gpg --edit-key --expert <KEY_ID>
+gpg> trust
+gpg> keytocard
+Really move the primary key? (y/N) y
+Please select where to store the key:
+ (1) Signature key
+ (2) Encryption key
+ (3) Authentication key
+Your selection? 1
+...
+gpg> key 1
+gpg> keytocard
+Please select where to store the key:
+ (2) Encryption key
+ (3) Authentication key
+Your selection? 2
+...
+gpg> key 1
+gpg> key 2
+gpg> keytocard
+Please select where to store the key:
+ (3) Authentication key
+Your selection? 3
+...
+gpg> save
+gpg> quit
+Save changes? (y/N) y
+```