Metadata-Version: 2.4
Name: passmate
Version: 0.4
Summary: A simple password manager with synchronization
Author-email: Tobias Kaiser <mail@tb-kaiser.de>
License: Apache License
        Version 2.0, January 2004
        http://www.apache.org/licenses/
        
        TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
        1. Definitions.
        
        "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
        
        "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
        
        "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
        
        "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
        
        "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
        
        "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
        
        "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
        
        "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
        
        "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
        
        "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
        
        2. Grant of Copyright License.
        
        Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
        
        3. Grant of Patent License.
        
        Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
        
        4. Redistribution.
        
        You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
        
            You must give any other recipients of the Work or Derivative Works a copy of this License; and
            You must cause any modified files to carry prominent notices stating that You changed the files; and
            You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
            If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
        
        You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
        
        5. Submission of Contributions.
        
        Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
        
        6. Trademarks.
        
        This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
        
        7. Disclaimer of Warranty.
        
        Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
        
        8. Limitation of Liability.
        
        In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
        
        9. Accepting Warranty or Additional Liability.
        
        While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
        
        END OF TERMS AND CONDITIONS
        
Project-URL: Source, https://github.com/TobiasKaiser/passmate
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: scrypt>=0.8.6
Requires-Dist: prompt-toolkit>=3.0.9
Requires-Dist: toml>=0.10.0
Requires-Dist: jsonschema>=3.2.0
Dynamic: license-file

# Passmate — A simple, secure password manager with multi-device synchronization

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Passmate on PyPI](https://img.shields.io/pypi/v/passmate.svg)](https://pypi.python.org/pypi/passmate)

Passmate is a command-line password manager that keeps your passwords encrypted and synchronized across multiple devices using a shared folder (like [Syncthing](https://syncthing.net/), Dropbox or any cloud storage).

[✨ Features](#features) | [📦 Installation](#installation) | [🚀 Quick Start](#quick-start) | [📖 Usage](#usage) | [🔧 Configuration](#configuration) | [🔄 Multi-Device Synchronization](#multi-device-synchronization) | [🔐 Security](#security) | [🔨 Development](#development) | [🔗 Links](#links)

## Features

* 🔒 **Strong Encryption**: All databases encrypted with scrypt. By using a single-file database, metadata leakage is minimzed.
* 🔄 **Automatic Sync**: Conflict-free synchronization across devices
* 💻 **Interactive Shell**: User-friendly command-line interface with tab completion
* 🌳 **Hierarchical Organization**: Organize passwords in folder-like paths
* 🎲 **Password Generator**: Built-in cryptographically strong password generator
* 🔍 **Smart Search**: Case-insensitive filtering across all records

## Installation

Using pip:

```bash
pip install passmate
```

From source:

```bash
git clone https://github.com/TobiasKaiser/passmate.git
cd passmate
pip3 install .
```

## Quick Start

Simply run:

```bash
passmate
```

If this is your first time, passmate will automatically create a new encrypted database at `~/.local/share/passmate/local.pmdb` and prompt you to set a master passphrase.

For subsequent uses, just run `passmate` again and enter your passphrase.

## Usage

### Interactive Shell Commands

Once in the shell, you can use these commands:

**Managing Records**

```
new work/email/gmail          Create a new record
open work/email/gmail         Open an existing record
rename work/email/google      Rename current record
del                           Delete current record
close                         Close current record
```

**Editing Fields**

```
set username                  Set a field value
set password                  Set password field
gen password                  Generate secure password
unset password                Remove a field
show                          Display all fields
```

**Navigation & Organization**

```
ls                            List all records
ls gmail                      Search for records matching "gmail"
```

**Synchronization**

```
sync                          Sync with other devices
change_passphrase             Change master passphrase
```

**Other**

```
exit                          Exit passmate
```

### Example Session

```
passmate> new work/email/gmail
Record "work/email/gmail" created.

passmate:work/email/gmail> set username
Value: myemail@gmail.com

passmate:work/email/gmail> gen password
Template: Aaaaaaaaaaaaaa5
Settings: 15 characters including a-z, A-Z, 0-9
Generated password: xK9mPqR2nFwLyJa

passmate:work/email/gmail> show
username: myemail@gmail.com
password: xK9mPqR2nFwLyJa

passmate:work/email/gmail> close
passmate> exit
```

## Configuration

Default configuration file: `~/.local/share/passmate/config.toml`

```toml
primary_db = "~/.local/share/passmate/local.pmdb"
shared_folder = "~/.local/share/passmate/sync/"
host_id = "laptop"
template_preset = "Aaaaaaaaaaaaaa5"
```

### Configuration Options

* **primary_db**: Path to your encrypted password database
* **shared_folder**: Path to folder for synchronization (e.g., Dropbox folder)
* **host_id**: Unique identifier for this device (defaults to hostname)
* **template_preset**: Default template used by `gen` for new fields

### Default Paths

Under Linux, passmate uses the following default paths:

| Path | Purpose | How to change |
|------|---------|---------------|
| `~/.local/share/passmate/config.toml` | Configuration file | Pass custom path as command line argument |
| `~/.local/share/passmate/local.pmdb` | Primary database | Change `primary_db` in config file |
| `~/.local/share/passmate/sync/` | Shared folder for sync | Change `shared_folder` in config file |

## Multi-Device Synchronization

Passmate uses a conflict-free synchronization strategy based on timestamps (Last-Write-Wins strategy). To synchronize your database across multiple systems, use a file/folder synchronization tool of your choice to sync the shared folder.

### Synchronization Tools

Passmate works with any file synchronization mechanism. Popular options include:

* **[Syncthing](https://syncthing.net/)** - Decentralized file synchronization
* **[Unison](https://www.cis.upenn.edu/~bcpierce/unison/)** - File synchronization tool
* **Network filesystems** - NFS, SMB, [sshfs](https://github.com/libfuse/sshfs)
* **Cloud services** - Dropbox, [NextCloud](https://nextcloud.com/)/WebDAV, or similar

### Setup Instructions

1. **On Device 1:**

   ```bash
   passmate
   ```

2. **Configure shared folder** (edit `~/.local/share/passmate/config.toml`):

   ```toml
   shared_folder = "~/Dropbox/passmate/"
   host_id = "laptop"
   ```

3. **In the shell, run sync:**

   ```
   passmate> sync
   ```

4. **On Device 2:**

   Copy the configuration and set a different host_id:

   ```toml
   shared_folder = "~/Dropbox/passmate/"
   host_id = "desktop"
   ```

5. **On Device 2, start passmate:**

   ```bash
   passmate
   ```

   It will create a new database, then sync to pull data from Device 1.

**Master passphrase in multi-device setup:** If you use the same master passphrase on all devices, synchronization will be seamless. If different passphrases are used on different hosts, you will be prompted to enter the remote host's passphrase during synchronization. When changing your passphrase, you must do so on each device individually.

### How Sync Works

* Each device writes a sync copy to the shared folder.
* When you run `sync`, passmate reads all sync copies and merges changes.
* Conflicts are resolved automatically using modification timestamps.
* All changes are encrypted with your master passphrase.

## Security

* All databases are encrypted using the [**scrypt**](https://www.tarsnap.com/scrypt.html) key derivation function (maxtime=1.0s, maxmem=16MB).
* Data is padded to 4KB increments to reduce metadata leakage.
* Password generation uses Python's `secrets` module (CSPRNG).

## Development

There are some rudimentary tests:

```bash
pytest-3 .
```

To build the package's .whl and .tar.gz files, run:

```bash
python3 -m build
```

### Database Format

Passmate stores password data as a JSON object encrypted using [scrypt's container format](https://github.com/Tarsnap/scrypt/blob/master/FORMAT). The container uses AES256-CTR encryption and HMAC-SHA256 for integrity verification.

**Data Model:**
* Each password record contains metadata fields (currently just "path") and user data fields (e.g., "password", "username")
* Records are identified by random unique IDs (not exposed to users)
* Each field is stored as a tuple: `[domain, field_name, field_value, modification_time]`
* The database keeps a complete modification history using UNIX timestamps

**Example JSON Structure:**

```json
{
  "version": 2,
  "purpose": "primary",
  "records": {
    "a1b2c3d4e5f6": [
      ["meta", "path", "work/email/gmail", 1234567890],
      ["user", "username", "user@example.com", 1234567891],
      ["user", "password", "SecurePass123", 1234567892]
    ]
  }
}
```

In this example:
* `version` must be 2 (current format version)
* `purpose` is either "primary" or "sync_copy"
* `records` contains all password entries, keyed by random record IDs
* Each field tuple has: domain ("meta" or "user"), field name, field value, and UNIX timestamp

**Conflict Resolution:**
* When databases from different devices are merged, field tuples are combined using set union
* The most recent modification (by timestamp) determines the current value for each field
* This enables automatic conflict-free merging across devices

**File Locking:**
* Primary database files use fcntl.lockf to prevent concurrent access
* A separate lock file ensures only one process can open the database at a time

**Database Purposes:**
* `primary`: The main database file that can be directly opened and modified
* `sync_copy`: Read-only synchronization copies written to the shared folder for other devices to merge

## Links

* **Source Code**: https://github.com/TobiasKaiser/passmate
