💾 Archived View for betahowto.duckdns.org › gemini_protocol captured on 2024-02-05 at 09:28:18. Gemini links have been rewritten to link to archived content

-=-=-=-=-=-=-

Gemini (протокол)

Gemini - сетевой протокол прикладного уровня, являющийся наследником протокола Gopher.

Ориентирован на минимализм и приватность, поскольку исключает использование таких технологий как сжатие, Cookies и JavaScript;

формат передаваемых данных ограничен текстом или бинарными данными, обязательной является подпись TLS.

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

В виду своих характеристик, Gemini будет интересен тем, кого не устраивает "раздутость" современного протокола HTTP, а также подойдёт для пользователей командной строки, E-ink планшетов.

Терминология

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

Gemini space - экосистема Gemini, подобно термину "Fediverse" для федеративной тематики
Capsule - капсула, веб-сайт - название протокола отсылается к тематике космической программы, поэтому в сети многие ресурсы наследуют концепцию в своих названиях
Gemlog - блог, персональная страница, фид профиля

Разметка

Gemtext

Текстовые ресурсы gemtext - это обычный текст (MIME text/gemini) опционально содержащий мета-теги в начале каждой строки:


# h1
## h2
### h3
=> ссылка
> цитата

	элемент списка

исходный код

Некоторые браузеры поддерживают разметку inline:



	bold*

_underline_

В разметке gemini не используются декоративные технологии вроде CSS, при этом задача отрисовки ресурса выполняется на стороне браузера и полностью делегирована клиенту.

Gemfeed

Поскольку текстовый регламент протокола не подразумевает использование тегов, такие стандарты оповещений как Atom и RSS, без внешних средств интеграции ( https://tildegit.org/solderpunk/gemfeed ), в Gemini неприменимы.

Несмотря на это, нативные подписки возможны - средствами стандарта ( https://geminiprotocol.net/docs/companion/subscription.gmi ) для программной интерпретации изменений документа gemtext.

Говоря проще, протокол сохраняет человеко-понятную структуру документа, при этом позволяет клиентским приложениям отслеживать его обновления.

В браузере Lagrange, подписаться на обновления страницы можно с помощью меню Bookmarks - Subscribe to page... и выбрать соответствующий странице способ (меню подписок: View - Show Feeds)

</WRAP>

Отслеживание по дате

В данном подходе, осуществляется отслеживание по впереди идущей за ссылкой дате, в формате ISO 8601 (Y-m-d), например:

/index.gmi


# Заголовок страницы, выполняет роль заголовка фида

Содержимое параграфа, игнорируется

=> /index.gmi любая ссылка, игнорируется

## Подраздел страницы, игнорируется

Произвольное содержимое подраздела, игнорируется

## Публикации

=> /pub1.gmi 2024-01-28 Ссылка на первую публикацию, отслеживается
=> /pub2.gmi 2024-01-29 Ссылка на вторую публикацию, отслеживается
=> /pub3.gmi Ссылка публикацию, не отслеживается (так как не содержит даты)
=> /pub4.gmi Ссылка публикацию, не отслеживается (так как дата является частью заголовка) 2024-01-30

Таким образом, документ не теряет читаемость для человека и при этом содержит мета-информацию для интерпретатора обновлений.

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

Как заявлено в документации, связано это с временной зоной.

Отслеживание по заголовкам

Альтернативный подход, отслеживающий изменения в заголовках документа

blog.gmi


# Мой блог, заголовок фида

Параграф описания

## Первая публикация, отслеживается

Описание первой публикации

=> /pub1.gmi Читать

## Вторая публикация, отслеживается

Описание второй публикации

=> /pub2.gmi Читать

...

Коды статусов

10-19 - input expected - ожидается ввод - используется например для отправки и получения данных форм
20-29 - success - код 20 аналогичен коду 200 в HTTP
30-39 - redirection - диапазон переадресации, в отправляемом пакете, код обычно сопровождается мета-ссылкой: code + link + \n\r + text
40-49 - temporary failure
50-59 - permanent failure
60-69 - client certificates - в Gemini сертификаты используются для идентификации и авторизации пользователей

Клиент обязан отклонять любой код меньше 10 или больше 69, при этом уведомить пользователя.

В неопределённых случаях, приоритет будет отдан коду с начальным значением диапазона, например, 10 для 11 или 20 для 27.

Обработка запросов

Протокол предусматривает обмен пакетами длиной максимум 1024 байт.

В эту длину необходимо уместить мета информацию пакета и его содержимое - например строку URI или данные пользовательского ввода.

При этом, текстовые данные должны быть закодированы в стандарт RFC 3986 (известный такими функциями, как urlencode).

В какой то степени, это сокращает полезный объём при использовании например кириллицы.

С помощью отправляемых клиенту статусов группы "10", сервер способен запрашивать пользовательский ввод.

Вместо привычных форм, обычно в браузерах Gemini - это всплывающее текстовое окно.

После получения и обработки пакета, сервер возвращает статус "20" или редирект на страницу с кодом "30".

Клиент

Чтобы открыть ресурс с адресом gemini:// необходим специальный браузер, стандартно работающий с портом 1965.

Пользователи GUI, могут начать с популярных Lagrange ( https://gmi.skyjake.fi/lagrange/ ) или Kristall ( https://kristall.random-projects.net/ ).

Специфика

так как большинство клиентов возвращают одно-текстовое строчное поле запроса, добавить новую строку можно комбинацией клавиш Shift+Enter
в протоколе Gemini нет webstorage и cookies, поэтому некоторые интерактивные сайты запрашивают для авторизации сертификат, который также используется для быстрой смены аккаунта
вместо фидов RSS есть встроенные в браузер инструменты отслеживания контента (см. ( /gemini_protocol#gemfeed ))

Сервер

Понятие "сервер" в среде Gemini может быть непривычным для пользователей веб, поскольку вместо прокси Nginx или Apache, этот термин зачастую предусматривает полноценный сервис для конкретной задачи, резервирующий за собой отдельный хост и порт.

В каталоге awesome-gemini ( https://github.com/kr1sp1n/awesome-gemini#servers ) представлено большое количество таких решений.

Например, для запуска простой статики, подойдёт сервер Agate ( https://github.com/mbrubeck/agate ) (Rust).

При этом, название привычного index.html будет зависеть от выбранного сервера, для Agate - это index.gmi

Запуск динамических ресурсов часто предусматривает разработку собственного сокет-сервера для реализации специфики отдельно взятого приложения.

Веб-разработчикам проще понять принцип работы "server-side" на примере нескольких файлов gemini-php ( https://github.com/eapl-gemugami/gemini-php ).

В разработке новых проектов - лучше использовать более актуальне решения, например, из простых - форк библиотеки titan-II ( https://github.com/YGGverse/titan-II ), примеры реализации на базе которой, можно посмотреть в исходном коде geminiapp ( https://github.com/kevachat/geminiapp ) для KevaChat ( /social_media:kevachat ) или проекте зеркала ( https://github.com/YGGverse/betahowto ) данного сайта.

Виртуальные хосты

Чтобы запускать различные сервисы на одном IP (не меняя стандартный порт) следует установить общий прокси-сервер, который будет осуществлять маршрутизацию запросов на соответствующий адрес/интерфейс.

Если для HTTP - это Apache или Nginx, то для протокола Gemini используются похожие решения.

twins

twins ( https://code.rocket9labs.com/tslocum/twins ) - многозадачный сервер с поддержкой реверсивного проксирования, напрсанный на языке Go.

Установка:


go install code.rocketnine.space/tslocum/twins@latest

Пример маршрутизации общего IPv4 адреса доменов first.host.org и second.host.org на разные ресурсы Yggdrasil:

/home/twins/config.yaml


listen: "xx.xx.xx.xx:1965"
hosts:
  first.host.org:
    cert: /home/twins/first.host.org/cert.pem
    key: /home/twins/first.host.org/key.rsa
    paths:
      -
        path: /
        proxy: gemini-insecure://[xxx:xxxx:xxxx:xxxx::xxxx]:1965
  second.host.org:
    cert: /home/twins/second.host.org/cert.pem
    key: /home/twins/second.host.org/key.rsa
    paths:
      -
        path: /
        proxy: gemini-insecure://[xxx:xxxx:xxxx:xxxx::xxxx]:1966

По такому же принципу можно запустить службы на свободных локальных адресах IPv4 или использовать разный порт для каждого сервера.

На целевых (публичных) ресурсах Yggdrasil вместо разных портов, достаточно настроить ( /yggdrasil:subnet_setting ).

Сертификаты в данном примере должны быть сконфигурированы на соответствующий домен, например для first.host.org:


openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem -days 365 -nodes -subj "/CN=first.host.org"

если запись для IPv6 - квадратные скобки в CN не используются

Для запуска указываем путь к бинарному файлу twins и вторым аргументом - путь к файлу конфигурации:


/home/twins/go/bin/twins -config /home/twins/config.yaml

Можно создать сервис:

/etc/systemd/system/twins.service


[Unit]
Description=twins
After=network.target

[Service]
Type=simple
User=twins
Group=twins
WorkingDirectory=/home/twins/
ExecStart=/home/twins/go/bin/twins -config /home/twins/config.yaml
StandardOutput=file:/home/twins/debug.log
StandardError=file:/home/twins/error.log
Restart=on-failure

[Install]
WantedBy=multi-user.target

А также добавить автозапуск:


systemctl daemon-reload
systemctl enable twins
systemctl start twins

Заметки

У сервера twins иногда бывают проблемы с кодировкой кириллических ресурсов, поэтому целевые хосты должны обязательно отдавать кодировку и опционально язык контента в заголовке:


text/gemini; charset=utf-8; lang=ru;

Алиасы

В Yggdrasil часто используются адреса IPv6 в паре с Alfis DNS ( /yggdrasil:dns:alfis ), при этом иногда ресурсы имеют алиас в Интернет.

Чтобы не менять записи DNS, создавать под-домены или запускать отдельные процессы, достаточно использовать общий сервер прокси, запустив twins ( /gemini_protocol#twins ) на уже имеющемся в DNS адресе IP, но испол��зуя порт 1965.

Отдельные ресурсы (серверы) Gemini при этом запускаются на http://[222:a8e4:50cd:55c:788e:b0a5:4e2f:a92c]/yggdrasil:subnet_setting|адресах подсети.

Таким образом, пользователь может заходить на 80 и 1965 порты по прежнему домену или по IP конкретного сервера.

Ресурсы

gemini://geminiprotocol.net - домашняя страница проекта
gemini://geminiprotocol.net/docs/ru/ - документация на русском
gemini://geminispace.info - внутрисетевой поиск
gemini://station.martinrue.com - социальная сеть по типу twitter
gemini://astrobotany.mozz.us - ASCII ботаника

Yggdrasil

В зависимости от поддержки IPv6 отдельно взятым сервером, в большинстве случаев, Gemini штатно и без проблем работает с Yggdrasil.

Единственным моментом является использование TLS поверх уже имеющегося слоя ( в прочем, можно использовать протокол gemini-insecure:// )

Внутрисетевые ресурсы

gemini://[301:23b4:991a:634d::b] - зеркало данного сайта, в рамках проекта β-howto ( https://github.com/YGGverse/betahowto )
gemini://betahowto.ygg - алиас
gemini://betahowto.duckdns.org - интернет-алиас
gemini://[301:23b4:991a:634d::1965] - инстанс KevaChat ( /social_media:kevachat )
gemini://kevachat.ygg - алиас

Ссылки

Официальный сайт ( https://geminiprotocol.net )
Страница на википедии ( https://ru.wikipedia.org/wiki/Gemini_(протокол) )
Каталог программного обеспечения на GitHub ( https://github.com/kr1sp1n/awesome-gemini )
Плагин для DokuWiki ( https://www.dokuwiki.org/plugin:gemini ) | Проект β-howto ( https://github.com/YGGverse/betahowto )