codeclown / buttercup

:lock: Javascript Password Vault - Multi-Platform Desktop Application

Cross-platform, free and open-source password manager based on NodeJS.

Under Development

Buttercup is currently under heavy development, and updates will be pushed here very frequently. The application is currently in alpha, and should be considered unstable.

Please check buttercup-core for more information on Buttercup’s core module.

Download & Install

Click here to automatically download the latest release for your OS, or checkout the releases page to download different builds and versions.

Encryption & Format

Buttercup uses a delta-system to manage archive changes and save conflicts. The archive, upon saving, is encrypted with AES 256bit CBC mode with a SHA256 HMAC. Encryption is performed once the password has been salted and prepared with PBKDF2 at between 200-250k iterations.

Because security with password storage is of the utmost importance, Buttercup will remain in alpha/beta release mode until some level of professional scrutiny has occurred. It is completely possible that security-related changes will occur, but this is inevitable and we handle every question and criticism with great care when it comes to the safety of using our software.

Development

If you're interested in developing Buttercup:

Install Dependencies & Run

## Install
$ npm install 
# or 
$ yarn

## Run
$ npm run start

Package & Release

Install Dependencies

You will need some extra dependencies to build for different platforms on a single platform. Please refer to this guide and install required software for your platform.

Building libraries before releasing

$ npm run build

Package

To package the app and make installers for all supported platforms:

$ npm run release

This may take a while depending on how fast your computer is. All apps and installers will be in app directory.

To package only for the current platform:

$ npm run package:current

Or for a specific platform:

$ npm run package:mac
$ npm run package:win
$ npm run package:linux

Contributors

Creation

• Sallar (@sallar)
• Perry (@perry_mitchell)

Contributions

• Mohammad Amiri (Brand & Identity) (@pixelvisualize)
• Arash Asghari (Brand & Identity) (@_arashasghari)

We welcome contributions. Please read Contribution Guide before sending a PR.

License

Released under GNU/GPL Version 3