Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gianlucaguarini/nisiu
Password manager written in Riot.js
https://github.com/gianlucaguarini/nisiu
Last synced: about 1 month ago
JSON representation
Password manager written in Riot.js
- Host: GitHub
- URL: https://github.com/gianlucaguarini/nisiu
- Owner: GianlucaGuarini
- License: mit
- Created: 2018-03-10T17:19:56.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-06-28T22:57:46.000Z (5 months ago)
- Last Synced: 2024-10-05T11:54:41.357Z (about 2 months ago)
- Language: HTML
- Homepage:
- Size: 2.25 MB
- Stars: 6
- Watchers: 5
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Build Status][travis-image]][travis-url]
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![MIT License][license-image]][license-url]
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](.env)
- ✅ **It's secure**, it uses the [AES algorithm](https://en.wikipedia.org/wiki/Advanced_Encryption_Standard) for all the stored data by default
- ✅ **Google as authentication** system
- ✅ Completely **open source** [under MIT license](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](https://myaccount.google.com/intro). 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](.env). To do so you need to create an new project using the [firebase console](https://console.firebase.google.com/)
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](.env)
## 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
```json
{
"rules": {
"$user": {
".read": "auth.uid === $user",
".write": "auth.uid === $user"
}
}
}
```
[More info about firebase database rules](https://firebase.google.com/docs/reference/security/database)
### Strict rules
You can enhance the security of your nisiu database using complexer rules like:
```json
{
"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
- [x] 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
- [x] PWA enhancements
- [x] Add favicon
[travis-image]: https://img.shields.io/travis/GianlucaGuarini/nisiu.svg?style=flat-square
[travis-url]: https://travis-ci.org/GianlucaGuarini/nisiu
[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[license-url]: LICENSE
[npm-version-image]: http://img.shields.io/npm/v/nisiu.svg?style=flat-square
[npm-downloads-image]: http://img.shields.io/npm/dm/nisiu.svg?style=flat-square
[npm-url]: https://npmjs.org/package/nisiu