docs
This commit is contained in:
parent
13e67f0be2
commit
553921b27a
57
DOCS.md
57
DOCS.md
@ -1,5 +1,10 @@
|
|||||||
# Документация на VIPRE-CRYPTOR
|
# Документация на VIPRE-CRYPTOR
|
||||||
- [Установка](#установка)
|
- [Установка](#установка)
|
||||||
|
- [Шифрование](#шифрование)
|
||||||
|
- [Регестрация ключа](#регестрация-ключа)
|
||||||
|
- [Создание пользователя и шифрование](#создание-пользователя-и-шифрование)
|
||||||
|
- [Чтение данных пользователя и расшифровка](#чтение-данных-пользователя-и-расшифровка)
|
||||||
|
- [Опции команды](#опции-команды)
|
||||||
## Установка
|
## Установка
|
||||||
Зависимости для компиляции:
|
Зависимости для компиляции:
|
||||||
- GCC
|
- GCC
|
||||||
@ -8,6 +13,58 @@
|
|||||||
|
|
||||||
Установка:
|
Установка:
|
||||||
```bash
|
```bash
|
||||||
|
# Скачиваем программу:
|
||||||
cd ~
|
cd ~
|
||||||
git clone https://gitlabor.ru/German/vipre-cryptor.git
|
git clone https://gitlabor.ru/German/vipre-cryptor.git
|
||||||
cd vipre-cryptor
|
cd vipre-cryptor
|
||||||
|
# Компилируем:
|
||||||
|
make clear
|
||||||
|
make
|
||||||
|
# Устанавливаем (или обновляем):
|
||||||
|
make update
|
||||||
|
# Проверяем (должно вывести версию):
|
||||||
|
vipre-cryptor --version
|
||||||
|
```
|
||||||
|
## Шифрование
|
||||||
|
Для шифрования программа требует создать локального пользователя, зарегестрировать электронный ключ и привязать к пользователю зашифрованный ключом файл.
|
||||||
|
## Регестрация ключа
|
||||||
|
Ключ можно создать с помощью OpenSSL:
|
||||||
|
```bash
|
||||||
|
# Создание ключа с помощью OpenSSL
|
||||||
|
openssl rand -base64 30
|
||||||
|
```
|
||||||
|
Также можно самому придумать ключ, но он, скорее всего, будет небезопастным.
|
||||||
|
Чтобы зарегестрировать ключ, нужно выполнить команду:
|
||||||
|
```bash
|
||||||
|
# Чтобы зарегестрировать ключ, нужно выполнить команду:
|
||||||
|
vipre-cryptor --sig ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig
|
||||||
|
```
|
||||||
|
Данная команда запросит ваш ключ и запишет его в файл **ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig** особым образом.
|
||||||
|
## Создание пользователя и шифрование
|
||||||
|
Создание пользователя и шифрование файла выглядит следующим образом:
|
||||||
|
```bash
|
||||||
|
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --create-user ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-input ФАЙЛ_ДЛЯ_ШИФРОВАНИЯ
|
||||||
|
```
|
||||||
|
Данная команда запросит логин и пароль нового пользователя.
|
||||||
|
## Чтение данных пользователя и расшифровка
|
||||||
|
Для чтения данных необходимо выполнить команду:
|
||||||
|
```bash
|
||||||
|
vipre-cryptor ИМЯ_ФАЙЛА_С_КЛЮЧОМ.sig --user-data ИМЯ_ПОЛЬЗОВАТЕЛЯ.bin --file-out ФАЙЛ_РАСШИФРОВАННЫХ_ДАННЫХ
|
||||||
|
```
|
||||||
|
Данная команда запросит логин и пароль пользователя.
|
||||||
|
## Опции команды
|
||||||
|
Доступны опции:
|
||||||
|
- **--help**
|
||||||
|
- **--version**
|
||||||
|
- **--user-data**
|
||||||
|
- **--create-user**
|
||||||
|
- **--sig**
|
||||||
|
- **--file-input**
|
||||||
|
- **--file-out**
|
||||||
|
|
||||||
|
Все опции можно сокращать до одного знака, например:
|
||||||
|
```ini
|
||||||
|
# Опции "--file-input" "--file-out" можно сократить до "--file" или просто "-f"
|
||||||
|
"--help" - "-h"
|
||||||
|
"--version" - "-v"
|
||||||
|
```
|
||||||
5
Makefile
5
Makefile
@ -30,7 +30,7 @@ INSTALL_NAME=/usr/local/bin/vipre-cryptor
|
|||||||
MODE=chmod +x
|
MODE=chmod +x
|
||||||
RUN_OF=./
|
RUN_OF=./
|
||||||
|
|
||||||
.PHONY: clear run install uninstall
|
.PHONY: clear run install uninstall update
|
||||||
|
|
||||||
$(OUTPUT_NAME): $(INPUT_NAME)
|
$(OUTPUT_NAME): $(INPUT_NAME)
|
||||||
$(CC) $(OPTIONS) $(INPUT_NAME) -o $(OUTPUT_NAME)
|
$(CC) $(OPTIONS) $(INPUT_NAME) -o $(OUTPUT_NAME)
|
||||||
@ -43,3 +43,6 @@ install:
|
|||||||
$(COPY) $(OUTPUT_NAME) $(INSTALL_NAME)
|
$(COPY) $(OUTPUT_NAME) $(INSTALL_NAME)
|
||||||
uninstall:
|
uninstall:
|
||||||
$(REMOVE) $(INSTALL_NAME)
|
$(REMOVE) $(INSTALL_NAME)
|
||||||
|
update:
|
||||||
|
$(REMOVE) -f $(INSTALL_NAME)
|
||||||
|
$(COPY) $(OUTPUT_NAME) $(INSTALL_NAME)
|
||||||
|
|||||||
BIN
vipre-cryptor
BIN
vipre-cryptor
Binary file not shown.
@ -28,7 +28,7 @@
|
|||||||
#include <limits.h>
|
#include <limits.h>
|
||||||
#include <string.h>
|
#include <string.h>
|
||||||
|
|
||||||
#define VERSION "0.9.2"
|
#define VERSION "1.0"
|
||||||
#define ERROR_FILE_OUT "unnamed_out_file.csv"
|
#define ERROR_FILE_OUT "unnamed_out_file.csv"
|
||||||
|
|
||||||
#define bool unsigned char
|
#define bool unsigned char
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user