shadow

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

<div align = "center"><img src="images/icon.png" width="150" height="150" /></div>

<div align = "center">
  <h1>Shadow.cr - Password Vault</h1>
</div>

<p align="center">
  <a href="https://crystal-lang.org">
    <img src="https://img.shields.io/badge/built%20with-crystal-000000.svg" /></a>
  <a href="https://travis-ci.org/636f7374/shadow.cr">
    <img src="https://api.travis-ci.org/636f7374/shadow.cr.svg" /></a>
  <a href="https://github.com/636f7374/shadow.cr/releases">
    <img src="https://img.shields.io/github/release/636f7374/shadow.cr.svg" /></a>
  <a href="https://github.com/636f7374/shadow.cr/blob/master/license">
  	<img src="https://img.shields.io/github/license/636f7374/shadow.cr.svg"></a>
</p>

<div align = "center"><a href="https://asciinema.org/a/"><img src="images/terminal.png"></a></div>

## Description
* Use [Shield.cr](https://github.com/636f7374/shield.cr) as the password generator.
* Shield generates [One-way security password.](https://en.wikipedia.org/wiki/One-way_compression_function)
* Shadow.cr that never saves any passwords.
* ...

### Features
- [X] Initialize / Destory / Rename / Bind / Move Database File.
- [X] Initialize / Destory Config File.
- [X] Create / Delete / Rename / Summary Tables.
- [X] Create / Delete / Search / Decrypt / Update Row Data.

### RoadMap
- [X] Sign the MasterKey with the Pbkdf2HMAC algorithm.
- [ ] More Design / Features / Stability Improvements.
- [ ] More Spec Tests / Code Comments / Wiki to be added.
- [ ] Shadow.cr Windows / Browser Extension / iOS Support.
- [ ] ...

## Use Shadow

### Used as Shard
Add this to your application's shard.yml:
```yaml
dependencies:
  shadow:
    github: 636f7374/shadow.cr
```

### Installation
```bash
$ git clone https://github.com/636f7374/shadow.cr.git
$ cd shadow.cr && make build && make install
```

## Development
```bash
$ make test
```

## Credit
* [\_Icon::categories/security](https://www.flaticon.com/packs/security-62)
* [Shard::faustinoaq/secrets](https://github.com/faustinoaq/secrets)
* [Shard::benoist/terminal_table.cr](https://github.com/benoist/terminal_table.cr)
* [Shard::crystal-lang/crystal-sqlite3](https://github.com/crystal-lang/crystal-sqlite3)

## Contributors
|Name|Creator|Maintainer|Contributor|
|:---:|:---:|:---:|:---:|
|**[636f7374](https://github.com/636f7374)**|√|√||

## License
* MIT License