An open API service indexing awesome lists of open source software.

https://github.com/source-c/usm

Universal Secrets Manager (hopefully - cross-platform)
https://github.com/source-c/usm

age fyne-app golang-application password-manager privacy-enhancing-technologies

Last synced: 5 months ago
JSON representation

Universal Secrets Manager (hopefully - cross-platform)

Awesome Lists containing this project

README

          


usm

# USM - Simple, modern and privacy-focused Open Source secrets manager

USM is a secrets manager designed to offer a secure and user-friendly solution for managing your digital data across multiple platforms, featuring modern encryption, making it an ideal tool for both personal and professional use.

It is written in Go and uses [Fyne](https://github.com/fyne-io/fyne) as UI toolkit and [age](https://github.com/FiloSottile/age) as encryption library.

## Warning

**This software is work in progress, and didn't went through a full security audit.**

**Do not expect it to be bug free and do not rely on it for any type of security.**

## Main features

* Cross platform application (linux, macOS, Windows, BSD ...) with a single codebase
* Desktop, Mobile and CLI application with a single binary
* Minimal direct dependencies
* Agent to handle SSH keys and CLI sessions
* Open source: code can be audited
* Audit passwords against data breaches
* TOTP support
* Password import/export

### Later goals

* Syncronization across instances
* Web application (however, this is highly debatable)
* Passwords management and generation enhancements

## Installation

### Development version

To try the development version or help with testing:

```
git clone https://github.com/source-c/usm.git usm-go
cd usm-go
make help
make clean && make generate-mocks && make check && make build
make generate-integrations

```

## Documentation

- [Configuration Management](docs/configuration.md) - Versioned configuration system using Viracochan
- [Desktop Integrations](docs/integrations.md) - Desktop integration file generation for Linux and macOS

## How it works - cryptography details

### Vault initialization

One or more vaults can be initialized to store secrets and identities.

When the vault is initialized user will be prompt for a vault name and password.
An [age](https://github.com/FiloSottile/age) key is generated and it is encrypted using an age Scrypt recipient with the provided password and saved on disk (key.age)
The X25519 identity and its recipient from the key file are used to decrypt and encrypt the vault data.
Each item is stored separately on disk so that the content can be decrypted manually using the age tool, if needed.
All the items' metadata are encrypted and stored into the vault.age file so that no information is in clear text.

### Random password

Random password are derived reading byte-by-byte the block of randomness from a [HKDF](https://pkg.go.dev/golang.org/x/crypto/hkdf) cryptographic key derivation function that uses the age key as secret. Printable characters that match the desired password rule (uppercase, lowercase, symbols and digits) are then included in the generated password.

### Custom password

Where a generated password is not applicable a custom password can be specified.

### Vault structure

Vault internally is organized hierarchically like:
```
- vault
├── login
| └── www.example.com
| └── my.site.com
├── password
| └── mypassword
└── note
└── mysecretnote
```

where login, password and note are the USM items, see the dedicated section for details.

### Items

Items are special templates aim to help the identity management.

Currently, the following items are available:

- login
- note
- password
- ssh_key

## Threat model

The threat model of USM assumes _there are no attackers on your local machine_.

## Contribute

Contributions are welcome! Please feel free to submit a Pull Request.

## Credits

### Libraries and Tools
- [age](https://github.com/FiloSottile/age) for the encryption library
- [Fyne](https://github.com/fyne-io/fyne) for the UI toolkit
- [Tabler icons](https://tabler.io/icons) for the icons

### Inspiration
Thanks to these Open Source password managers that inspired the USM project:

- [gopass](https://github.com/gopasspw/gopass)
- [lesspass](https://github.com/lesspass/lesspass)
- [pass](https://www.passwordstore.org/)
- [passage](https://github.com/FiloSottile/passage)
- [passgo](https://github.com/ejcx/passgo)

This project was originally heavily inspired by [Paw](https://github.com/lucor/paw) by Luca Corbo, but has since evolved into USM with a distinct architecture, UX and branding.

## License

MIT License only - meaning you are only the one who decides what to do next. There is no intention to make this project anyhow commercial.