0.0.2 • Published 6 years ago

nisiu v0.0.2

Weekly downloads
-
License
MIT
Repository
-
Last release
6 years ago

Build Status

NPM version NPM downloads MIT License

nisiu is a completely free password manager configurable with your own firebase account.

General info

Nisiu was designed only for a personal use but it can be customized in order to be used by your friends and your family with a few steps.

Goals

  • ✅ Built to let you own and manage your passwords
  • ✅ Designed only for modern browsers
  • ✅ It's available online with no additional installation
  • ✅ It stores your data on firebase and you can set up easily your own private DB instance via env credentials
  • It's secure, it uses the AES algorithm for all the stored data by default
  • Google as authentication system
  • ✅ Completely open source under MIT license

Caveats

  • ❌ Doesn't work on old browser that do not support ES2017 javascript features
  • ❌ It's a clientside application so it needs javascript to be enabled
  • ❌ It doesn't work offline yet

Configuration

Google Account Creation

Make sure to have a google account. If you don't have any just create one

Firebase API Creation

You will need to set your own firebase credentials in the .env file. To do so you need to create an new project using the firebase console

  1. Click on the add project button
  2. Click on the "Add Firebase to your web app" button
  3. Replace the app credentials in the .env file

Build step

Once you have done all the steps above you are ready to start using nisiu. The last step is needed to build again the app using your new credentials.

  1. Install the npm dependencies npm i
  2. Run make build
  3. Open index.html with any modern browser and voilà!

Setup your DB Rules

With firebase you can easily control you application DB whitelisting the users that can read and write from it.

Easy rules

A simple way to configure your DB is to add the following rules via firebase console

{
  "rules": {
    "$user": {
      ".read": "auth.uid === $user",
      ".write": "auth.uid === $user"
    }
  }
}

More info about firebase database rules

Strict rules

You can enhance the security of your nisiu database using complexer rules like:

{
  "rules": {
    "$user": {
      ".read": "auth.uid === $user && root.child('whitelist').hasChild(auth.uid)",
      ".write": "auth.uid === $user && root.child('whitelist').hasChild(auth.uid)",
      "passwords": {
        "$id": {
          ".validate": "newData.child('value').isString() && newData.child('value').val().length > 0"
        }
      },
      "key": {
        ".validate": "newData.isString() && newData.val().length >= 64"
      },
    },
    "whitelist": {
      ".read": false,
      ".write": false
    }
  }
}

With the rules above only users belonging to the "whitelist" will be able to use your application

TODO

  • Whitelist users
  • Add a rock solid unit test
  • Improve async UI events with inline loaders and animations
  • Add import vs export feature via drag and drop
  • PWA enhancements
  • Add favicon