kriptopter/README.md

60 lines
1.8 KiB
Markdown

# Kriptopter
mini web app to use WebCrypto
## Install
```
git clone https://git.p2p.legal/dig/kriptopter
```
## Build
Build a single-page-app, embedding local ressources into 1 html file:
```javascript
node konstrui app.html kriptopter
```
## Usage
### Standalone
Open the file `kriptopter` in a browser.
_(Tested only under Iron/Chromium 63.0.3300.0 and Firefox 60.0.2.6730, please do the test in other browser and submit an issue, with a minimum stack trace, if you want to help )_
> Note on Firefox: you have to activate web components disabled by default in `about:config`, you need to set `dom.webcomponents.customelements.enabled` and `dom.webcomponents.shadowdom.enabled` to `true` for the app to work.
### Bookmarklet
To compile the app to be used as `javascript:` url in a bookmark, some characters need to be escaped,
you can use `kompilo.js` with nodejs:
```javascript
node kompilo
```
it will generate a `kriptoptlet` file containing the text to copy/paste in a new bookmark's url part.
Or you can use the online version (not secure):
```
javascript: win=window.open('','','titlebar=no,location=no'); fetch('https://git.p2p.legal/dig/kriptopter/raw/master/kriptopter').then(res=>res.text()).then(app=>win.document.write(app) ))
```
## Roadmap
- [ ] Implement WebCrypto
- [x] Simple password **(1.0.0)**
- [ ] Assymetric keypair
- [ ] Choose algorythm
- [~] WebCrypto spec **(1.5.0)**
- [ ] External algorythms
- [ ] Key derivation
- [x] Encrypt / decrypt **(1.0.0)**
- [ ] Signature
- [ ] Different input
- [x] Text (1.0.0)
- [x] File read/save **(1.5.0)**
- [ ] File drag n drop
- [x] External page content **(1.5.0)**
- [ ] App format
- [x] Single page webapp **(1.0.0)**
- [x] Bookmarklet **(1.2.0)**
- [ ] Browser extension + local electron app