docs: document key/value entries

This commit is contained in:
thePR0M3TH3AN
2025-07-07 18:37:13 -04:00
parent af4f6f88fc
commit 8e60fdc6c2
2 changed files with 18 additions and 1 deletions

View File

@@ -277,6 +277,7 @@ SeedPass supports storing more than just passwords and 2FA secrets. You can also
When you retrieve one of these entries, SeedPass can display QR codes for the
keys. The `npub` is wrapped in the `nostr:` URI scheme so any client can scan
it, while the `nsec` QR is shown only after a security warning.
- **Key/Value** store a simple key and value for miscellaneous secrets or configuration data.
The table below summarizes the extra fields stored for each entry type. Every
entry includes a `label`, while only password entries track a `url`.
@@ -289,6 +290,7 @@ entry includes a `label`, while only password entries track a `url`.
| Seed Phrase | `index`, `word_count` *(mnemonic regenerated; never stored)*, `archived`, optional `notes` |
| PGP Key | `index`, `key_type`, `archived`, optional `user_id`, optional `notes` |
| Nostr Key Pair| `index`, `archived`, optional `notes` |
| Key/Value | `value`, `archived`, optional `notes`, optional `custom_fields` |
### Managing Multiple Seeds

View File

@@ -88,7 +88,7 @@ Each entry is stored within `seedpass_entries_db.json.enc` under the `entries` d
- **username** (`string`, optional): Username associated with the entry.
- **url** (`string`, optional): Website or service URL.
- **archived** (`boolean`): Marks the entry as archived when `true`.
- **type** (`string`): The entry type (`password`, `totp`, `ssh`, `seed`, `pgp`, `nostr`, `note`).
- **type** (`string`): The entry type (`password`, `totp`, `ssh`, `seed`, `pgp`, `nostr`, `note`, `key_value`).
- **kind** (`string`): Synonym for `type` kept for backward compatibility.
- **notes** (`string`): Free-form notes.
- **custom_fields** (`array`, optional): Additional user-defined fields.
@@ -236,6 +236,21 @@ Each entry is stored within `seedpass_entries_db.json.enc` under the `entries` d
}
```
#### 7. Key/Value
```json
{
"entry_num": 6,
"fingerprint": "a1b2c3d4",
"kind": "key_value",
"data": {
"key": "api_key",
"value": "<encrypted_value>"
},
"timestamp": "2024-04-27T12:40:56Z"
}
```
---
## Handling `kind` Types and Extensibility