mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-08 07:18:47 +00:00
docs: add entry type summary and custom field info
This commit is contained in:
@@ -31,6 +31,7 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No
|
|||||||
- [Usage](#usage)
|
- [Usage](#usage)
|
||||||
- [Running the Application](#running-the-application)
|
- [Running the Application](#running-the-application)
|
||||||
- [Managing Multiple Seeds](#managing-multiple-seeds)
|
- [Managing Multiple Seeds](#managing-multiple-seeds)
|
||||||
|
- [Additional Entry Types](#additional-entry-types)
|
||||||
- [Security Considerations](#security-considerations)
|
- [Security Considerations](#security-considerations)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
@@ -256,6 +257,14 @@ When **Secret Mode** is enabled, SeedPass copies retrieved passwords directly to
|
|||||||
2. Choose how many seconds to keep passwords on the clipboard.
|
2. Choose how many seconds to keep passwords on the clipboard.
|
||||||
3. Retrieve an entry and SeedPass will confirm the password was copied.
|
3. Retrieve an entry and SeedPass will confirm the password was copied.
|
||||||
|
|
||||||
|
### Additional Entry Types
|
||||||
|
|
||||||
|
SeedPass supports storing more than just passwords and 2FA secrets. You can also create entries for:
|
||||||
|
- **SSH Key** – deterministically derive an Ed25519 key pair for servers or git hosting platforms.
|
||||||
|
- **Seed Phrase** – generate a BIP-39 mnemonic and keep it encrypted until needed.
|
||||||
|
- **PGP Key** – derive an OpenPGP key pair from your master seed.
|
||||||
|
- **Nostr Key Pair** – store the index used to derive an `npub`/`nsec` pair for Nostr clients.
|
||||||
|
|
||||||
|
|
||||||
### Managing Multiple Seeds
|
### Managing Multiple Seeds
|
||||||
|
|
||||||
|
@@ -87,12 +87,13 @@ Each SeedPass entry is stored as an individual JSON file, promoting isolated man
|
|||||||
|
|
||||||
- **fingerprint** (`string`): A unique identifier generated from the seed associated with the entry. This fingerprint ensures that each seed's data is isolated and securely managed.
|
- **fingerprint** (`string`): A unique identifier generated from the seed associated with the entry. This fingerprint ensures that each seed's data is isolated and securely managed.
|
||||||
|
|
||||||
- **kind** (`string`): Specifies the type of entry. Initial kinds include:
|
- **kind** (`string`): Specifies the type of entry. Supported kinds include:
|
||||||
- `generated_password`
|
- `password`
|
||||||
- `stored_password`
|
- `totp`
|
||||||
- `managed_user`
|
- `ssh`
|
||||||
- `12_word_seed`
|
- `seed`
|
||||||
- `nostr_keys`
|
- `pgp`
|
||||||
|
- `nostr`
|
||||||
- `note`
|
- `note`
|
||||||
|
|
||||||
- **data** (`object`): Contains fields specific to the `kind`. This allows for extensibility as new kinds are introduced.
|
- **data** (`object`): Contains fields specific to the `kind`. This allows for extensibility as new kinds are introduced.
|
||||||
@@ -104,6 +105,17 @@ Each SeedPass entry is stored as an individual JSON file, promoting isolated man
|
|||||||
- **updated_at** (`string`): ISO 8601 format timestamp of the last update.
|
- **updated_at** (`string`): ISO 8601 format timestamp of the last update.
|
||||||
- **checksum** (`string`): A checksum value to ensure data integrity.
|
- **checksum** (`string`): A checksum value to ensure data integrity.
|
||||||
|
|
||||||
|
- **custom_fields** (`array`, optional): A list of user-defined name/value pairs
|
||||||
|
to store extra information.
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"custom_fields": [
|
||||||
|
{"name": "account_id", "value": "123"},
|
||||||
|
{"name": "recovery_hint", "value": "mother's maiden name"}
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
### Example Entries
|
### Example Entries
|
||||||
|
|
||||||
#### 1. Generated Password
|
#### 1. Generated Password
|
||||||
@@ -121,6 +133,9 @@ Each SeedPass entry is stored as an individual JSON file, promoting isolated man
|
|||||||
"url": "https://example.com",
|
"url": "https://example.com",
|
||||||
"password": "<encrypted_password>"
|
"password": "<encrypted_password>"
|
||||||
},
|
},
|
||||||
|
"custom_fields": [
|
||||||
|
{"name": "department", "value": "finance"}
|
||||||
|
],
|
||||||
"timestamp": "2024-04-27T12:34:56Z",
|
"timestamp": "2024-04-27T12:34:56Z",
|
||||||
"metadata": {
|
"metadata": {
|
||||||
"created_at": "2024-04-27T12:34:56Z",
|
"created_at": "2024-04-27T12:34:56Z",
|
||||||
|
Reference in New Issue
Block a user