SwiftNIO SSH

Этот проект содержит поддержку SSH с использованием SwiftNIO.

Что такое SwiftNIO SSH?

SwiftNIO SSH — это программная реализация SSH: то есть набор API, позволяющих программистам создавать конечные точки, работающие по протоколу SSH. Важно отметить, что это скорее аналог libssh2, нежели openssh. SwiftNIO SSH не предоставляет готовых к использованию в продакшене SSH-клиентов и серверов, а вместо этого предлагает строительные блоки для создания таких клиентов и серверов.

Существует несколько причин для создания программной реализации SSH. Одна из них — уникальное отношение SSH к интерактивности пользователя. Технические пользователи привыкли взаимодействовать с SSH интерактивно: либо для выполнения команд на удалённых машинах, либо для запуска интерактивных оболочек. Возможность программно отвечать на такие запросы открывает интересные альтернативные способы взаимодействия. В качестве примеров можно привести Twisted's Manhole, который использует программную реализацию SSH под названием conch для предоставления интерактивного интерпретатора Python внутри работающего Python-сервера, или ssh-chat — SSH-сервер, который предоставляет чат-комнату вместо обычной функциональности SSH-оболочки. Также можно представить инновационные применения для пересылки TCP.

Ещё одна веская причина для создания программной реализации SSH — это то, что сервисам часто требуется взаимодействовать с другими сервисами путём выполнения команд. Хотя Process решает эту задачу для локального сценария, иногда команды нужно выполнять удалённо. Хотя Process может запустить клиент ssh как дочерний процесс для выполнения такого вызова, зачастую гораздо проще напрямую вызывать SSH. Это и является целевым сценарием использования libssh2. SwiftNIO SSH предоставляет эквивалент сетевого и криптографического уровня libssh2, позволяя мотивированным пользователям управлять SSH-сессиями напрямую из Swift-сервисов.

Последние версии SwiftNIO SSH поддерживают Swift 5.9 и новее. Минимальные поддерживаемые версии Swift для разных релизов SwiftNIO SSH указаны ниже:

SwiftNIO SSH	Минимальная версия Swift
0.0.0 ..< 0.3.0	5.1
0.3.0 ..< 0.4.0	5.2
0.4.0 ..< 0.5.0	5.4
0.5.0 ..< 0.6.2	5.5.2
0.6.2 ..< 0.9.0	5.6
0.9.0 ..< 0.9.2	5.8
0.9.2 ..< 0.10.0	5.9
0.10.0 ... 0.12.0	5.10
0.12.0 ..< 0.13.0	6.0
0.13.0 ..<	6.1

Что поддерживает SwiftNIO SSH?

SwiftNIO SSH поддерживает SSHv2 со следующим набором функций:

• Все возможности сессионных каналов, включая запросы shell и exec
• Прямая и обратная пересылка TCP-портов
• Только современные криптографические примитивы: Ed25519 и ECDSA по основным кривым NIST (P256, P384, P521) для асимметричной криптографии, AES-GCM для симметричной криптографии, x25519 для обмена ключами
• Аутентификация пользователя по паролю и с помощью открытого ключа
• Поддержка всех платформ, поддерживаемых SwiftNIO и Swift Crypto

Как использовать SwiftNIO SSH?

SwiftNIO SSH предоставляет обработчик канала SwiftNIO — NIOSSHHandler. Этот обработчик реализует основную часть протокола SSH напрямую. Ожидается, что пользователи не будут генерировать SSH-сообщения вручную: вместо этого они взаимодействуют с NIOSSHHandler через дочерние каналы и делегаты.

SSH — это мультиплексированный протокол: каждое SSH-соединение делится на несколько двунаправленных каналов связи, которые, как несложно догадаться, называются каналами. SwiftNIO SSH отражает такую структуру, используя абстракцию «дочернего канала». Когда удалённая сторона создаёт новый SSH-канал, SwiftNIO SSH создаёт новый NIO-канал (Channel), который используется для представления всего трафика на этом SSH-канале. Внутри этого дочернего Channel все события строго упорядочены относительно друг друга, однако события в разных Channel могут свободно чередоваться реализацией.

Активное SSH-соединение выглядит следующим образом:

┌ ─ NIO Channel ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┐

│     ┌────────────────────────────────┐    │
      │                                │
│     │                                │    │
      │                                │
│     │                                │    │
      │                                │
│     │         NIOSSHHandler          │───────────────────────┐
│     │                                │    │                  │
      │                                │                       │
│     │                                │    │                  │
      │                                │                       │
│     └────────────────────────────────┘    │                  │
                                                               │
└ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ┘                  │
                                                               │
                                                               │
                                                               │
                                                               │
                                                               ▼
                     ┌── SSH Child Channel ─────────────────────────────────────────────────────────────┐
                     │                                                                                  │
                     │   ┌────────────────────────────────┐      ┌────────────────────────────────┐     ├───┐
                     │   │                                │      │                                │     │   │
                     │   │                                │      │                                │     │   ├───┐
                     │   │                                │      │                                │     │   │   │
                     │   │                                │      │                                │     │   │   │
                     │   │          User Handler          │      │          User Handler          │     │   │   │
                     │   │                                │      │                                │     │   │   │
                     │   │                                │      │                                │     │   │   │
                     │   │                                │      │                                │     │   │   │
                     │   │                                │      │                                │     │   │   │
                     │   └────────────────────────────────┘      └────────────────────────────────┘     │   │   │
                     │                                                                                  │   │   │
                     └───┬──────────────────────────────────────────────────────────────────────────────┘   │   │
                         │                                                                                  │   │
                         └───┬──────────────────────────────────────────────────────────────────────────────┘   │
                             │                                                                                  │
                             └──────────────────────────────────────────────────────────────────────────────────┘

SSH-канал вызывается с указанием типа канала. NIOSSH поддерживает три типа: session, directTCPIP и forwardedTCPIP. Наиболее распространённый тип — session: он используется для представления вызова программы, будь то конкретная именованная программа или оболочка. Два других типа связаны с пересылкой TCP-портов и будут рассмотрены позже.