Browse Source

add MIT license

forest johnson 2 years ago
parent
commit
bdf23dcaa3
2 changed files with 27 additions and 8 deletions
  1. 15 0
      LICENSE
  2. 12 8
      ReadMe.md

+ 15 - 0
LICENSE

@ -0,0 +1,15 @@
1
Copyright 2017 Forest Johnson
2
3
Permission is hereby granted, free of charge,
4
to any person obtaining a copy of this software and associated documentation files (the "Software"),
5
to deal in the Software without restriction, including without limitation the rights to
6
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
7
and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
8
9
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10
11
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
12
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
13
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
14
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
15
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 12 - 8
ReadMe.md

@ -11,14 +11,6 @@ This is a Golang / HTML5  / vanilla JavaScript web-application which stores encr
11 11
12 12
![screenshot](screenshot.png)
13 13
14
## Encryption Key User Interface
15
16
You are allowed to use whatever seed you want for your 256 bit AES key. If you pick a weak seed and get hacked, that is your fault. The application warned you about it. It was even red, bold and underlined!
17
18
The application includes an HMAC/mouse-movement based entropy generator to create a secure key encoded in base 10,000. It will appear as a collection of a few english words/phrases. An example:
19
20
`bedrooms confirmation decor generic wondering temperatures bm retreat beer`
21
22 14
## Security
23 15
24 16
First and foremost, the application is easy to audit since it has only one dependency: sjcl.js, AKA the Stanford JavaScript Crypto Library.
@ -36,3 +28,15 @@ It was designed that way to strengthen the claim that "everything it sends out f
36 28
 It uses a naive approach to keep all 3 data stores in sync: When writing, it will attempt to write to all 3 and tolerate failures. When reading, it will compare the `lastUpdated` timestamps on all versions that it received, and if they don't match, it will issue a `PUT` with the most up-to-date version.
37 29
38 30
 That means if you happen to make conflicting changes, there is no real conflict resolution. The latest one wins.
31
32
 ## Encryption Key User Interface Disclaimer
33
34
 You are allowed to use whatever seed you want for your 256 bit AES key. If you pick a weak seed and get hacked, that is your fault. The application warned you about it. It was even red, bold and underlined!
35
36
 The application includes an HMAC/mouse-movement based entropy generator to create a secure key encoded in base 10,000. It will appear as a collection of a few english words/phrases. An example:
37
38
 `bedrooms confirmation decor generic wondering temperatures bm retreat beer`
39
40
 ## License
41
42
 This software is provided "AS-IS" under the MIT license. For more information see the `LICENSE` file.