From b8d2b9198a9cd5bcffabed42b61579b6da090225 Mon Sep 17 00:00:00 2001 From: CupIvan Date: Wed, 9 May 2018 14:39:18 +0300 Subject: [PATCH] =?UTF-8?q?=D0=BD=D0=B0=D0=B1=D1=80=D0=BE=D1=81=D0=BE?= =?UTF-8?q?=D0=BA=20API?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- API.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 86 insertions(+) create mode 100644 API.md diff --git a/API.md b/API.md new file mode 100644 index 0000000..18941f7 --- /dev/null +++ b/API.md @@ -0,0 +1,86 @@ +P2P-мессенджер. Протокол обмена +=============================== + +## Структура сети: +Связь между узлами - точка-точка + +GUI - Сервер ==== Сервер - GUI + +GUI - примитивная программа под Linux/Window/Android, которая умеет отображать сообщения и обмениваться с сервером. +Сервер - как правило сидит на localhost, принимает сообщения от GUI и переправляет на другой сервер. +В Windows/Linux GUI и серверная часть могут быть объединены. +Разделение GUI и Сервера позволяет также отправлять сообщения тем, кто оффлайн (например сервер крутится на роутере и он всё время online). +На сервере также хранится история переписки. + +У сервера есть список контактов (друзей), в формате: +``` +{ + "адрес1": {nick: "", last_online: "", last_connect: "", can_resend: 1, key: "", other_info:... } + ... +} +``` +Поле адрес - это адрес сервера, куда отправляем. Может быть как ipv4, так и ipv6 адрес в сети cjdns. + + +## Протокол обмена +Обмен сообщениями ведётся по GET/POST http протоколу в формате JSON, что позволяет делать GUI прямо в браузере. +При любой успешной отправке данных обновляем поле last_connect у контакта. +Во всех сообщениях нужно указывать ключ, если он не подойдёт - то сообщение отбрасывается. + +1. Добавление в друзья +Используется, чтобы установить связь с контактом. Для этого запрашиваем у него ключ доступа, предварительно отправив свой. +``` +{action: "handshake", key: "пароль"} +``` +ответ +``` +{status: 1} +``` +Когда один отправил запрос - то второй может отправить свой ключ и тогда сервера смогут общаться друг с другом. + +2. Отправка сообщения: +``` +{action:"send", from: "адрес", to: "адрес", message: "сообщение", timestamp: "время", enctype: "", key: "" } +``` +ответ: +``` +{status: 1} +``` +Сообщение может быть зашифровано, метод шифрования в поле enctype. +Если нет ответа, то сохраняем сообщение у себя в истории, чтобы потом переотправить. +`status==1` - доставлено, другой - недоставлено (помечаем как недоставлено + +3. Пинг - проверка онлайн +Если прошло время больше чем last_connect + 1 минута, от отправляем запрос +``` +{action: "ping"} +``` +ответ: +``` +{action: "pong"} +``` + +4. Если у нас есть сообщения для адреса и он онлайн (last_connect < 1 минуты), то передаём их +Если для этого адрес в базе есть недоставленные сообщения, то отправляем такой запрос: +``` +{action: "history", messages:[{},{},{}...]} +``` +ответ +``` +{status:[1,1,1,0,1]} +``` +В ответ приходит массив с 1 или 0. Если 1 - сообщение сохранено успешно, 0 - ошибка и его нужно потом переотправить. + +5. Отправить сообщение для другого абонента (это нужно чтобы отправлять тем, кто в offline) +Если человек, которому мы отправляем сообщение offline - то во-первых оно сохраняется у себя на сервере, для последующей отправки. +Во-вторых, можно попросить какого-то друга его переотправить. Для этого выбираем случайно несколько друзей из списка контактов, у которых can_resend == 1 и отправляем им запрос. +Для ретрансляции можно также использовать свой сервер в интернете, нужно просто его добавить в контакты. +``` +{action: "resend", ...} +``` +Параметры такие же как и для send +ответ +``` +{status: 1} +``` +Если status: 0 - то эта нода не желает пересылать сообщения и ей повторно отправлять не нужно.