wive-wireguard-autoconf: A Shell repository from shvchk

Скрипт настройки клиента WireGuard для роутеров на базе прошивки Wive-NG-HQ

1. Подготовка

1.1. Термины

Текстовый терминал (текстовая консоль): программа для работы с текстовым интерфейсом, через которую текстовые программы принимают и выводят информацию. Далее просто "терминал".
Оболочка командной строки (шелл): программа, которая выполняет текстовые команды.
SSH: безопасный способ подключения к удалённому устройству и выполнения команд на нём.
WireGuard: один из способов (протоколов) организации VPN. Относительно новый, но популярный из-за простоты и производительности.

1.2. Работа в терминале и шелле

Этот подраздел можно пропустить (кроме замечания по поводу ошибки в Windows 10 внизу) и вернуться только в случае возникновения затруднений.

Работа в терминале и шелле

В Windows предустановлен терминал и шелл Windows PowerShell. В Windows 11 также предустановлен более современный терминал: Терминал Windows / Windows Terminal (его можно установить и в Windows 10). Запустить терминал можно, нажав правой кнопкой мыши по кнопке Пуск > Терминал Windows или Windows Terminal (в Windows 10 — Windows PowerShell) или найдя его в меню Пуск по одному указанных выше названий. Терминал также можно запустить в определённой папке в Проводнике, кликнув правой кнопкой мыши по свободному месту в нужной папке (в Windows 10 — с зажатым Shift) > Открыть в терминале (в Windows 10 — Открыть окно PowerShell здесь).

Роутер работает на Linux, там другой шелл, но описанные ниже принципы работы универсальны.

В терминал можно вставить текст из буфера обмена (например, команду) по нажатию правой кнопки мыши. Выделенный в терминале текст можно скопировать в буфер обмена также по нажатию правой кнопки мыши.

Курсор ввода перемещается стрелками ← →. Зажатие Ctrl позволяет переместить курсор не на 1 символ, а на 1 слово. Home перемещает курсор в начало строки, End — в конец. Backspace удаляет символ перед курсором, Delete — после.

Стрелками ↑ ↓ можно перемещаться по истории команд: ↑ покажет предыдущую команду, ↓ — более позднюю (при наличии).

Текущая папка отображается слева от строки для ввода команд. Например, PS C:\Users\X> означает, что мы находимся в папке C:\Users\X.

При вводе команд и названий файлов / папок Tab производит автодополнение. Например, для файла hello-world.txt в текущей папке достаточно ввести первые несколько букв (скажем, hell) и нажать Tab — терминал автоматически дополнит имя. В случае наличия нескольких команд / названий с введёнными первыми буквами, последовательные нажатия Tab будут выводить их по очереди, так что если не подошёл вариант автодополнения, просто нажми Tab снова.

Перейти в другую папку можно командой cd путь/к/папке. Например, cd c:/users/x. В Linux разделителем папок в пути является / (слэш), в Windows — по умолчанию \ (обрантый слэш, бэкслэш), но можно использовать и / (слэш). Регистр символов в названиях команд, папок и файлов важен в Linux (т.е. файл test.txt и Test.txt — разные файлы), в Windows не важен. Для папок / файлов, находящихся в текущей папке, путь к ней можно опустить и писать только путь относительно неё. Текущая папка в относительном пути также может быть обозначена . (обычно это не требуется, но может встретиться при автодополнении). Пути с пробелами лучше заключать в кавычки.

Выполнение длительной команды можно прервать, нажав Ctrl + C. Команда exit завершит работу шелла (и закроет окно терминала, если шелл был в нём единственным).

⚠️ Windows PowerShell в Windows 10 содержит ошибку, иногда не позволяющую вводить заглавные буквы. Для её исправления нужно обновить модуль PSReadLine.

Обновление PSReadLine

Запусти терминал от имени администратора
Обнови модуль PSReadLine:
```
install-module psreadline -force
```
В случае запроса на установку поставщика NuGet согласись, ответив Y
После завершения установки выполни команду exit для выхода из шелла и терминала
При следующем запуске терминала шелл запросит подтверждение на запуск нового модуля. Согласись, ответив A.

1.3. Установка клиента SSH

В современных версиях Windows SSH клиент предустановлен. Чтобы удостовериться в этом, нажми Пуск > Параметры > Приложения > Дополнительные компоненты > введи SSH в поле поиска

Если найден компонент Клиент OpenSSH, значит, он уже установлен и дополнительных действий не требуется
Если компонент Клиент OpenSSH не найден, нажми вверху Добавить компонент, найди Клиент OpenSSH, отметь его галочкой и нажми Установить

2. Настройка WireGuard соединения на роутере

Клиент WireGuard на роутере будет подключаться к серверу WireGuard в интернете. Для подключения к серверу WireGuard обычно используется конфигурационный файл. Его устройство для этой инструкции не важно, необходимо лишь его наличие, но если интересно, см. скрытый раздел ниже.

Подробнее о конфигурационном файле WireGuard

Используется конфигурационный файл в формате INI:

[Раздел]
Параметр = значение

Содержание его примерно следующее (ниже разберём):

[Interface]
Address = 10.10.10.11/32
PrivateKey = QMZwEV/dfa5ZpTfcVv3T6mSu5/Jw3yUEhlB9er75928=

[Peer]
PublicKey = 2t8EW0DTKafCpnQTAi7xoOH4qOUljp9COLTtKIR+wD4=
Endpoint = 12.34.56.78:51820
AllowedIPs = 0.0.0.0/0

В разделе [Interface] находятся сведения о нашем устройстве (т.е. в нашем случае о клиенте):

Address — адрес в VPN-сети. Может быть указано несколько через запятую.
PrivateKey — ключ, заканчивается символом =

В разделе [Peer] находятся сведения об удалённом устройстве, с которым мы устанавливаем VPN-соединение (т.е. в нашем случае о сервере):

PublicKey — ключ, заканчивается символом =
Endpoint — адрес и порт для подключения в формате адрес:порт
AllowedIPs — адреса, с которыми можно обмениваться данными через это соединение. Может быть указано несколько через запятую.

Заметь, значения не содержат пробелов.

Значения этих параметров могут понадобиться для ручной настройки WireGuard соединения на роутере. В конфигурационном файле могут быть и другие параметры, но они как правило опциональны и далее не потребуются.

Для подключения к роутеру будем использовать SSH. Для доступа по SSH используются те же данные (адрес, логин и пароль), что и для входа в веб-интерфейс.