Загрузка данных


ПРИЛОЖЕНИЕ

РУКОВОДСТВЬ ПОЛЬЗОВАТЕЛЯ

Настоящее руководство пользователя разработано в соответствии с ГОСТ Р 59795–2021, ГОСТ 34.201–2020 и ГОСТ Р ИСО/МЭК 15910–2002. Оно предназначено для пользователей программного модуля аутентификации DiplomaAuth, созданного в рамках дипломной работы. Документ содержит информацию о назначении модуля, системных требованиях, инструкциях по установке, эксплуатации и устранению возможных неисправностей.

---

1. НАЗНАЧЕНИЕ ПРОГРАММНОГО МОДУЛЯ

Программный модуль DiplomaAuth реализует беспарольную аутентификацию пользователей веб-приложений с использованием стандарта FIDO2/WebAuthn (биометрические датчики, внешние USB/NFC-ключи) и резервный механизм одноразовых паролей TOTP. Модуль предназначен для встраивания в корпоративные системы, интернет-банкинг, государственные порталы и образовательные платформы с целью повышения уровня безопасности учётных записей.

1.1. Целевая аудитория

Руководство адресовано администраторам информационных систем, а также конечным пользователям, которые будут проходить аутентификацию с помощью модуля. Предполагается базовый уровень владения компьютером и веб-браузером.

1.2. Системные требования

Серверная часть (развёртывание модуля)

Компонент Минимальные требования Рекомендуемые требования
Операционная система Ubuntu 20.04 / Windows Server 2019 Ubuntu 22.04 / Windows Server 2022
Процессор 2 ядра, 2 ГГц 4 ядра, 3 ГГц и выше
Оперативная память 4 ГБ 8 ГБ и более
Свободное дисковое пространство 2 ГБ 5 ГБ
Среда выполнения Python 3.11+ Python 3.12+
База данных PostgreSQL 14 / SQLite PostgreSQL 15
Веб-сервер Nginx 1.22 (опционально) Nginx 1.24 + SSL-сертификат

Клиентская часть (требования к устройству пользователя)

· Современный браузер: Google Chrome (≥ 120), Microsoft Edge (≥ 120), Mozilla Firefox (≥ 121), Safari (≥ 17) или Samsung Internet (≥ 23).
· Поддержка WebAuthn: для входа по биометрии требуется совместимый аутентификатор:
  · Windows: Windows Hello (лицо, отпечаток или PIN).
  · macOS: Touch ID.
  · iOS/iPadOS: Face ID или Touch ID.
  · Android: датчик отпечатков пальцев.
· Для использования внешних ключей (YubiKey, Google Titan) необходим свободный порт USB или NFC.

1.3. Установка и настройка

1.3.1. Установка серверной части

1. Скачайте архив с исходным кодом модуля DiplomaAuth.
2. Установите интерпретатор Python 3.11 или новее.
3. Установите зависимости из файла requirements.txt:
   ```bash
   pip install -r requirements.txt
   ```
4. Настройте базу данных: создайте базу PostgreSQL или используйте SQLite. Пример конфигурации в файле .env:
   ```
   DATABASE_URL=postgresql://user:password@localhost/diploma_auth
   RP_ID=example.com
   RP_NAME=DiplomaAuth
   ORIGIN=https://example.com
   TOTP_ENCRYPTION_KEY=сгенерированный_ключ
   ```
5. Выполните миграцию базы данных:
   ```bash
   python -c "from app.database import engine, Base; Base.metadata.create_all(bind=engine)"
   ```
6. Запустите сервер:
   ```bash
   uvicorn app.main:app --host 0.0.0.0 --port 8000
   ```
7. При необходимости настройте обратный прокси (Nginx) для поддержки HTTPS (обязательно для работы WebAuthn в публичных сетях).

1.3.2. Подготовка к использованию (для конечного пользователя)

Для регистрации в системе необходимо:

· Иметь учётную запись, созданную администратором.
· На устройстве должен быть настроен биометрический вход (PIN, отпечаток или Face ID).
· При использовании внешнего ключа (YubiKey) – подключите его к компьютеру или смартфону.

---

2. ИСПОЛЬЗОВАНИЕ МОДУЛЯ

2.1. Запуск веб-интерфейса

Откройте браузер и перейдите по адресу, где развёрнут модуль (например, https://auth.example.com). Появится главная страница с формами Регистрация и Вход.

2.2. Регистрация нового аутентификатора

1. В поле «Регистрация» введите ваше имя пользователя (логин).
2. Нажмите кнопку «Зарегистрироваться (WebAuthn)».
3. Браузер запросит разрешение на создание ключа доступа. В зависимости от операционной системы появится окно:
   · Windows: Windows Hello – введите PIN, используйте отпечаток паль
[Ссылка]
Example Domain
http://example.com