GithubHelp home page GithubHelp logo

fluidtrends / cassi Goto Github PK

View Code? Open in Web Editor NEW
10.0 12.0 4.0 797 KB

Cryptographic Asymmetric Secure Storage Infrastructure

License: MIT License

TypeScript 100.00%
bcrypt assymetric-security security sha256 aes-encryption encryption password-manager

cassi's Introduction

Cassi

Cryptographic Asymmetric Secure Storage Infrastructure

Manage your secure data in password-protected, encrypted file-based vaults

Getting Started

There's really nothing to getting Cassi up and running, other than selecting a root directory for your vault storage and setting a password for each vault. Have a look at how easy it is to create a Cassi Vault:

// Import Cassi
const cassi = require('cassi')

// Create a new vault instance
const vault = new cassi.Vault({ name: 'my-vault' })

// Create the vault with password 'hello'
vault.create('hello')
      .then(({ vault, mnemonic }) => {
        // Good stuff, enjoy your new vault
        // Store the mnemonic somewhere safe
      })
      .catch((error) => {
        // Something happened and the vault could not be created
      })

Documentation

Cassi is very well documented and all objects, options, fields and functions are well explained and they all include examples.

Read the full documentation for detailed instructions on how to create, lock, unlock vaults and how to read and write sensitive data.

Read The Docs

Contributing

We'd be glad to have you join us as an Cassi Contributor. Get started by reading our Contributor Guide.

Read The Contributor Guide

Dependencies

Cassi makes use of the following libraries:

  • lowdb - for storage
  • fs-extra - for file management
  • uuid - for generating ids
  • bip38 - for encrypting the machine secret
  • bip39 - for generating mnemonics
  • bitcoinjs-lib - for generating keys
  • keytar - for working with the system keychain
  • wif - for decoding machine secrets

License

Cassi is licensed under the MIT License.

Sponsors

Cassi is sponsored by Fluid Trends and is part of the Fluid Trends Open Source Lab.

If you'd like to co-sponsor this project, please email your co-sponsorship request to team at fluidtrends.com

cassi's People

Contributors

idancali avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.