Notifications Session Open Group Server

Session Open Group Server

Aperçu

• Source: https://github.com/session-foundation/session-pysogs
• Prise en charge des images: Non
• Prise en charge des pièces jointes: Non
• Limites de caractères des messages:
  • Corps: 32768
• Créer votre URL Apprise

Configuration du Compte

Session est une application de messagerie privée et décentralisée. Un Session Open Group Server (SOGS) héberge des salons communautaires accessibles publiquement. Ce plugin vous permet de publier des messages dans un ou plusieurs salons SOGS en utilisant une identité bot.

Vous avez besoin de deux informations : le server_key (la clé publique du serveur) et un seed (le seed Ed25519 privé de votre bot). Ces deux valeurs sont des chaînes hexadécimales minuscules de 64 caractères.

Étape 1 — Générer un seed pour le bot

L’identité du bot repose sur un seed Ed25519 de 64 caractères hexadécimaux (32 octets aléatoires). Générez-en un en Python :

import os
print(os.urandom(32).hex())
# exemple de sortie : a1b2c3d4e5f6...  (64 caractères hexadécimaux)

Gardez cette valeur secrète — c’est votre seed. Toute personne qui la détient peut publier dans n’importe quel salon auquel votre bot a accès en écriture.

Étape 2 — Trouver le server_key

Chaque instance SOGS publie un server_key Curve25519 de 64 caractères hexadécimaux. Vous le trouverez dans n’importe quel lien d’invitation Session :

https://open.getsession.org/discussion?public_key=a03c383cf63c3c4e...

La valeur de public_key= est le server_key à fournir dans l’URL Apprise.

Étape 3 — Trouver le jeton du salon

Le jeton du salon est le segment de chemin du lien d’invitation ci-dessus (discussion dans l’exemple). Il s’agit d’un identifiant alphanumérique court qui identifie de façon unique le salon sur ce serveur.

Étape 4 — Accorder l’accès en écriture au bot

Un administrateur du serveur doit ajouter la clé publique Ed25519 du bot à la liste des utilisateurs autorisés du salon. La clé publique du bot est dérivée automatiquement de votre seed ; vous pouvez l’afficher avec :

from cryptography.hazmat.primitives.asymmetric.ed25519 import Ed25519PrivateKey
from cryptography.hazmat.primitives.serialization import Encoding, PublicFormat

seed = bytes.fromhex("votre_seed_ici")
key  = Ed25519PrivateKey.from_private_bytes(seed)
print("00" + key.public_key().public_bytes(Encoding.Raw, PublicFormat.Raw).hex())

Syntaxe

La syntaxe valide est la suivante :

• sessions://{public_key}:{seed}@{hostname}/{room}
• sessions://{public_key}:{seed}@{hostname}:{port}/{room}
• sessions://{public_key}:{seed}@{hostname}/{room1}/{room2}
• sogs://{public_key}:{seed}@{hostname}/{room}
• session://{public_key}:{seed}@{hostname}/{room}

Forme par paramètres de requête (utile dans les fichiers de configuration lorsque l’intégration des identifiants dans l’URL est difficile) :

• sessions://{hostname}/{room}?key={public_key}&seed={seed}
• sessions://{hostname}/{room}?public_key={public_key}&seed={seed}

Plusieurs salons peuvent être spécifiés comme segments de chemin supplémentaires ou via ?to= :

• sessions://{public_key}:{seed}@{hostname}?to={room1},{room2}

Détail des Paramètres

Variable	Requis	Description
hostname	Oui	Le nom d’hôte (ou l’adresse IP) du serveur SOGS.
port	Non	Le port du serveur. Par défaut 443 pour sessions:// et 80 pour session://.
key	Oui	La clé publique Curve25519 de 64 caractères hexadécimaux du serveur SOGS (issue du lien d’invitation ?public_key=). Acceptée également sous la forme ?public_key=.
seed	Oui	Le seed Ed25519 de 64 caractères hexadécimaux identifiant le compte bot. Traitez-le comme un mot de passe.
room	Oui	Un ou plusieurs jetons identifiant les salons SOGS dans lesquels publier.
to	Non	Liste de jetons de salons supplémentaires séparés par des virgules (alias pour les segments de chemin de salons).

Paramètres Globaux

Variable	Description
overflow	Ce paramètre peut être défini sur split, truncate ou upstream. Il détermine la manière dont Apprise remet le message que vous lui transmettez. Par défaut, il vaut upstream. 👉 upstream : ne fait aucune modification et transmet le message exactement tel qu’il a été reçu au service. 👉 truncate : veille à ce que le message tienne dans la limite amont documentée par le service. Si plus d’informations sont fournies que la limite définie, l’excédent est tronqué. 👉 split : similaire à truncate, sauf que si le message dépasse la limite amont documentée par le service, il est découpé en plusieurs morceaux plus petits puis envoyés séquentiellement.
format	Ce paramètre peut être défini sur text, html ou markdown. Certains services prennent en charge plusieurs formats de publication du contenu. La valeur par défaut varie selon le service choisi et peut correspondre à l’un de ces trois formats. Vous pouvez facultativement forcer cette option pour vous écarter du comportement par défaut. Si le service ne prend pas en charge plusieurs formats de transmission, ce champ est ignoré.
verify	Les requêtes externes vers des emplacements sécurisés, par exemple via https, utilisent des certificats. Par défaut, Apprise vérifie la validité de ces certificats ; si ce n’est pas le cas, aucune notification n’est envoyée à la source. Dans certains cas, un utilisateur ne dispose pas d’une autorité de certification pour valider la clé ou fait simplement confiance à la source ; dans ce cas, vous pouvez définir ce drapeau sur no. Par défaut, il vaut yes.
redirect	Par défaut, Apprise suit les redirections HTTP (réponses 3xx) émises par le serveur distant, conformément au comportement de la bibliothèque requests sous-jacente. Si vous souhaitez empêcher la transmission des en-têtes personnalisés et des identifiants vers des destinations différentes de l’URL d’origine, définissez cette option sur no. Par défaut, elle vaut yes.
cto	Signifie Socket Connect Timeout. Il s’agit du nombre de secondes pendant lesquelles Requests attend que votre client établisse une connexion avec une machine distante, ce qui correspond à l’appel connect() sur la socket. La valeur par défaut est de 4.0 secondes.
rto	Signifie Socket Read Timeout. Il s’agit du nombre de secondes pendant lesquelles le client attend que le serveur envoie une réponse. La valeur par défaut est de 4.0 secondes.
emojis	Active la prise en charge des emojis, par exemple :+1: qui sera traduit en 👍. Par défaut, cette option vaut no. Remarque : selon la configuration côté serveur, l’administrateur peut désactiver globalement la prise en charge des emojis ; mais par défaut, ce n’est pas le cas.
tz	Identifie le fuseau horaire de la base IANA que vous souhaitez utiliser. Par défaut, celui-ci est détecté à partir de la configuration du serveur qui exécute Apprise. Vous pouvez le définir sur des valeurs comme America/Toronto, ou sur tout autre fuseau correctement formaté correspondant à votre région.
retry	Nombre de tentatives de remise supplémentaires après le premier échec, avant d’abandonner. Accepte un entier compris entre 0 et 10. La valeur par défaut est 0 (aucune nouvelle tentative — une seule tentative est effectuée). Lorsqu’il est combiné avec wait, Apprise marque une pause du nombre de secondes spécifié entre chaque tentative.
wait	Nombre de secondes à attendre entre les nouvelles tentatives. Accepte une valeur décimale comprise entre 0.0 et 20.0 ; les entiers sont automatiquement convertis en virgule flottante. La valeur par défaut est 0.5. Ce paramètre n’est utile que si retry est supérieur à zéro — un service avec retry=0 effectue exactement une tentative, quelle que soit la valeur de wait.
optional	Lorsqu’il est défini sur yes, un échec de remise pour ce service est silencieusement absorbé. L’appel global notify() retourne quand même True même si ce point de terminaison était injoignable, à condition que tous les services requis (non optionnels) du même lot aient réussi. Ce drapeau ne saute pas la remise ni ne contourne la logique de nouvelles tentatives — toutes les tentatives configurées sont effectuées avant que l’échec soit absorbé. Par défaut, il vaut no, ce qui signifie que chaque échec est propagé à l’appelant.

Exemples

Publier une notification dans un salon SOGS public via HTTPS :

# En supposant :
#   {public_key} = a03c383cf63c3c4ead6c4f0a29...  (64 hex, depuis le lien d'invitation)
#   {seed}       = a1b2c3d4e5f6...  (64 hex, votre seed de bot)
#   {hostname}   = open.getsession.org
#   {room}       = discussion

apprise -vv -t "Bonjour" -b "Notification de test depuis Apprise" \
   "sessions://a03c383c...:a1b2c3d4...@open.getsession.org/discussion"

Publier dans deux salons en une seule commande :

apprise -vv -b "Message diffusé" \
   "sessions://a03c383c...:a1b2c3d4...@open.getsession.org/salon1/salon2"

Utiliser le schéma HTTP non chiffré pour un serveur local sans TLS :

apprise -vv -b "Test SOGS local" \
   "session://a03c383c...:a1b2c3d4...@localhost:8080/discussion"

Forme par paramètres de requête (style fichier de configuration) :

apprise -vv -b "Style fichier de configuration" \
   "sessions://open.getsession.org/discussion?key=a03c383c...&seed=a1b2c3d4..."