kriptopter/README.md

58 lines
1.6 KiB
Markdown
Raw Normal View History

2018-07-01 19:26:53 +02:00
# Kriptopter
mini web app to use WebCrypto
## Install
```
2018-07-09 03:43:23 +02:00
git clone https://git.p2p.legal/dig/kriptopter
```
2018-07-09 03:25:24 +02:00
## Build
Build a single-page-app, embedding local resseource un 1 html file:
```javascript
node konstrui app.html kriptopter
```
## Usage
### Standalone
2018-07-09 03:25:24 +02:00
Open the file `kriptopter` in a browser.
_(Tested only under Iron/Chromium 63.0.3300.0, please do the test in other browser and submit an issue, with a minimum stack trace, if you want to help )_
### Bookmarklet
2018-07-09 03:25:24 +02:00
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
```
2018-07-09 03:25:24 +02:00
it will generate a `kriptoptlet` file containing the text to copy/paste in a new bookmark's url part.
2018-07-09 03:25:24 +02:00
Or you can use the online vversion (not secure):
2018-07-09 03:42:59 +02:00
```html
2018-07-09 03:25:24 +02:00
<a href="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) ))">bookmarklet online</a>
```
## Roadmap
2018-07-09 03:25:24 +02:00
- [ ] Implement WebCrypto
2018-07-09 03:41:19 +02:00
- [x] Simple password **(1.0.0)**
2018-07-09 03:25:24 +02:00
- [ ] Assymetric keypair
- [ ] Choose algorythm
2018-07-09 03:41:19 +02:00
- [~] WebCrypto spec **(1.5.0)**
2018-07-09 03:25:24 +02:00
- [ ] External algorythms
- [ ] Key derivation
2018-07-09 03:41:19 +02:00
- [x] Encrypt / decrypt **(1.0.0)**
2018-07-09 03:25:24 +02:00
- [ ] Signature
- [ ] Different input
2018-07-09 03:41:19 +02:00
- [x] Text (1.0.0)
- [x] File read/save **(1.5.0)**
2018-07-09 03:25:24 +02:00
- [ ] File drag n drop
2018-07-09 03:41:19 +02:00
- [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