safeBox/README.md

53 lines
1.6 KiB
Markdown
Raw Normal View History

2021-02-06 18:17:36 +01:00
# safeBox
A tool to share an archive with important messages in special events.
2021-02-06 18:18:16 +01:00
2021-02-06 18:17:36 +01:00
You can give keys (passwords) to a number of people and have them enter them into the correct order to extract your files
2021-02-15 12:32:04 +01:00
## Creating a safebox:
### 1. Using the SafeBoxEncryptor
2021-02-06 18:18:16 +01:00
2021-02-15 12:32:04 +01:00
You will need to use "encrypt.php" script
2021-02-06 18:18:16 +01:00
2021-02-15 12:32:04 +01:00
(php 7.5, run from cli as `php encrypt.php`)
The script will guide through the creation of a safebox
### 2. Manually
Manually create an archvie following the file specification
#### Archive Creation
##### 1. Create a zip achive named "data.zip"
##### 2. Add the "meta.json" file inside
2021-02-06 18:17:36 +01:00
The file should be structured in this way
2021-02-15 12:32:04 +01:00
###### Example
2021-02-06 18:17:36 +01:00
```JSON
{
2021-02-15 10:59:14 +01:00
"title": "Title",
"author": "Author",
"message": "Lorem ipsum\ndolor sit amet",
"nkeys": 2,
"unixcreated": 1612619383
2021-02-06 18:17:36 +01:00
}
```
2021-02-15 12:32:04 +01:00
###### Keys
2021-02-06 19:22:08 +01:00
|Key|Description|
2021-02-06 18:17:36 +01:00
|-----|-----|
2021-02-06 19:22:08 +01:00
|title|The Title of the archive|
2021-02-06 18:17:36 +01:00
|author|The Author|
|message|A message shown before the key insertion|
|nkeys|The number of keys|
|unixcreated|The UNIX timestamp (seconds) when this archive was created|
2021-02-15 12:32:04 +01:00
##### 3. Create a second zip archive and add the files to be stored
##### 4. Password protect said file with a concatenation of all the keys surrounded by "|"
2021-02-15 10:58:12 +01:00
(password1, password 2 -> |password1|password2|)
2021-02-06 18:18:16 +01:00
2021-02-06 18:17:36 +01:00
When you hand over the keys, remember to tell the index the key occupies in the list, starting from 1
in this case,
1. password1
2. password2
2021-02-15 12:32:04 +01:00
##### 5. Add the second archive to the first archive (step 1)
##### 6. Change the firt archive's (step 1) extension to .sfbx
2021-02-06 18:17:36 +01:00
On opening the file with SafeBox, the metadata will be shown and when all the keys will have been inserted in the correct order, the folder will be extracted