diff --git a/DOCS.md b/DOCS.md index eb961c3..8005f83 100644 --- a/DOCS.md +++ b/DOCS.md @@ -1,5 +1,10 @@ # Документация на VIPRE-CRYPTOR - [Установка](#установка) + - [Шифрование](#шифрование) + - [Регестрация ключа](#регестрация-ключа) + - [Создание пользователя и шифрование](#создание-пользователя-и-шифрование) + - [Чтение данных пользователя и расшифровка](#чтение-данных-пользователя-и-расшифровка) + - [Опции команды](#опции-команды) ## Установка Зависимости для компиляции: - GCC @@ -8,6 +13,58 @@ Установка: ```bash +# Скачиваем программу: cd ~ git clone https://gitlabor.ru/German/vipre-cryptor.git -cd vipre-cryptor \ No newline at end of file +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" +``` \ No newline at end of file diff --git a/Makefile b/Makefile index fd03a8c..60c32c0 100644 --- a/Makefile +++ b/Makefile @@ -30,7 +30,7 @@ INSTALL_NAME=/usr/local/bin/vipre-cryptor MODE=chmod +x RUN_OF=./ -.PHONY: clear run install uninstall +.PHONY: clear run install uninstall update $(OUTPUT_NAME): $(INPUT_NAME) $(CC) $(OPTIONS) $(INPUT_NAME) -o $(OUTPUT_NAME) @@ -43,3 +43,6 @@ install: $(COPY) $(OUTPUT_NAME) $(INSTALL_NAME) uninstall: $(REMOVE) $(INSTALL_NAME) +update: + $(REMOVE) -f $(INSTALL_NAME) + $(COPY) $(OUTPUT_NAME) $(INSTALL_NAME) diff --git a/vipre-cryptor b/vipre-cryptor index c8379eb..932c295 100755 Binary files a/vipre-cryptor and b/vipre-cryptor differ diff --git a/vipre-manager.h b/vipre-manager.h index 86f2c28..b6881cc 100644 --- a/vipre-manager.h +++ b/vipre-manager.h @@ -28,7 +28,7 @@ #include #include -#define VERSION "0.9.2" +#define VERSION "1.0" #define ERROR_FILE_OUT "unnamed_out_file.csv" #define bool unsigned char