Init README.md files

This commit is contained in:
xdrm-brackets 2017-01-19 08:25:16 +01:00
parent b1beeef4e3
commit 70abfb55ea
3 changed files with 58 additions and 0 deletions

18
clone/REAMDE.md Normal file
View File

@ -0,0 +1,18 @@
CLONING utilities
-----------------
This folder contains necessary utilities in order to clone and setup new _SATS_ using any micro-SD card.
###### 1. Kernel image
> `image.tar.gz` is the base kernel image to burn to each _SATS_.
###### 2. Clone script
> `./clone` is the main script that will :
1. Format the device
2. Extract image into it
3. Generate a pair of ecdsa:521 keys for SSH and append the server's `authorized_keys` file
4. Set up the WiFi configuration
5. Update _SATS_' `authorized_keys` file to create key-only access (for maintenance).

View File

@ -16,6 +16,8 @@ sudo umount $1;
# [2] format to fat # [2] format to fat
sudo mkdosfs -n "SATS"-I $1; sudo mkdosfs -n "SATS"-I $1;
# [3] manage partition layout
....;
# [3] Extract files # # [3] Extract files #

38
ssl/README.md Normal file
View File

@ -0,0 +1,38 @@
SSL utilities
-------------
This folder contain `/bin/sh` openssl utilities.
###### 1. key pair generation (ecdsa:521)
`./keygen`
> Generates a pair of ecdsa:521 keys.
###### 2. file signature generation
`./sign {file_in} {signature_out}`
> Generates a signed signature `{signature_out}` of the file `{file_in}` with the private key created by `./keygen`.
###### 3. file signature validator
`./check {file_in} {signature_in}`
> Checks the file `{file_in}` by the given signature `{signature_in}` with the public key created by `./keygen`.
###### 4. file encryption
`./encrypt {file_in} {encrypted_out}`
> Encrypts the file `{file_in}` into the file `{decrypted_out}` with **AES-256-CBC** using the typed password.
###### 5. file decryption
`./decrypt {encrypted_in} {decrypted_out}`
> Decrypts the file `{file_in}` into the file `{decrypted_out}` with **AES-256-CBC** using the typed password.