passman/README.md

99 lines
3.2 KiB
Markdown
Raw Normal View History

2016-10-08 02:31:07 +08:00
#Currently in BETA
#Passman
2016-10-08 04:08:00 +08:00
2016-10-08 06:41:35 +08:00
[![Build Status](https://travis-ci.org/nextcloud/passman.svg?branch=master)](https://travis-ci.org/nextcloud/passman)
2017-01-12 04:39:10 +08:00
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/749bb288c9fd4592a73056549d44a85e)](https://www.codacy.com/app/brantje/passman?utm_source=github.com&utm_medium=referral&utm_content=nextcloud/passman&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/749bb288c9fd4592a73056549d44a85e)](https://www.codacy.com/app/brantje/passman?utm_source=github.com&utm_medium=referral&utm_content=nextcloud/passman&utm_campaign=Badge_Coverage)
2016-10-08 06:41:35 +08:00
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nextcloud/passman/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nextcloud/passman/?branch=master)
2016-10-08 04:08:00 +08:00
2016-10-17 01:35:22 +08:00
Passman is a full featured password manager.
Features:
- Vaults
2016-10-17 01:35:22 +08:00
- Vault key is never sent to the server
- Credentials are stored with 256 bit AES
- Ability to add custom fields to credentials
2016-10-17 01:35:22 +08:00
- Built-in OTP(One Time Password) generator
- Password analyzer
2016-10-17 01:35:22 +08:00
- Share passwords internally and via link in a secure manner.
2016-10-13 04:24:08 +08:00
- Import from various password managers:
- KeePass
- LastPass
- DashLane
- ZOHO
2016-10-17 01:35:22 +08:00
- Clipperz.is
2016-10-13 05:06:11 +08:00
For a demo of this app visit [https://demo.passman.cc](https://demo.passman.cc)
2016-12-22 21:12:02 +08:00
2016-10-10 00:35:34 +08:00
## Tested on
2016-12-22 00:47:04 +08:00
- NextCloud 10 / 11
2016-10-10 00:35:34 +08:00
- ownCloud 9.1+
2016-10-14 21:49:08 +08:00
## Supported databases
2016-10-17 01:35:22 +08:00
- SQL Lite*
- MySQL / MariaDB*
2016-10-14 21:49:08 +08:00
*Tested on travis
2016-10-17 01:35:22 +08:00
Untested databases:
2016-10-14 21:49:08 +08:00
- pgsql
##Screenshots
![Logged in to vault](http://i.imgur.com/ciShQZg.png)
2016-09-09 23:36:35 +08:00
![Credential selected](http://i.imgur.com/3tENldT.png)
2016-09-09 23:36:35 +08:00
![Edit credential](http://i.imgur.com/Iwm3hUe.png)
![Password tool](http://i.imgur.com/ZYkN70r.png)
For more screenshots: [Click here](http://imgur.com/a/giKVt)
2017-01-12 01:09:10 +08:00
## Encryption (server side)
All passwords are encrypted client side AND server side.
This means that if you move to another server you have to backup the following from config.php
- `passwordsalt`
- `secret`
2016-10-01 03:58:26 +08:00
## Code reviews
If you have any improvements regarding our code.
Please do the following
- Clone us
- Make your edits
- Add your name to the contributors
- Send a PR
Or if you're feeling lazy, create an issue, and we'll think about it.
2016-10-20 16:34:01 +08:00
## Docker
To run passman with docker you can use `docker run -p 8080:80 -p 8443:443 brantje/passman`
2016-10-25 04:52:40 +08:00
To use your own SSL cert mount them as below
2016-10-20 16:34:01 +08:00
Example:
2016-10-25 04:52:40 +08:00
`docker run -p 8080:80 -p 8443:443 -v /directory/cert.pem:/data/ssl/cert.pem -v /directory/cert.key:/data/ssl/cert.key brantje/passman`
2016-10-01 03:58:26 +08:00
## Development
2016-10-20 00:08:27 +08:00
Passman uses a single `.js` file for the templates. This gives the benefit that we don't need to request every template with XHR.
For CSS we use SASS so you need ruby and sass installed.
`templates.js` and the CSS are built with `grunt`.
To watch for changes use `grunt watch`
To run the unit tests install phpunit globally, and setup the environment variables on the `launch_phpunit.sh` script then just run that script, any arguments passed to this script will be forwarded to phpunit.
## Main developers
- Brantje
- Animalillo
## Contributors
Add yours when creating a pull request!
- None
2016-10-01 01:12:00 +08:00
## FAQ
2016-10-01 01:12:13 +08:00
**Are you adding something to check if malicious code is executing on the browser?**
No, because malicious code could edit the functions that check for malicious code.