From 17f64e15659846b7059ef44556580f70a368cc5a Mon Sep 17 00:00:00 2001 From: Evgeny Poberezkin <2769109+epoberezkin@users.noreply.github.com> Date: Fri, 12 Jan 2024 17:21:57 +0000 Subject: [PATCH] docs: URI schemes (#958) --- protocol/xftp-uri-request.txt | 16 ++++++++++++++++ protocol/xrcp-uri-request.txt | 15 +++++++++++++++ rfcs/2022-12-26-simplex-file-transfer.md | 13 +++++++++++++ 3 files changed, 44 insertions(+) create mode 100644 protocol/xftp-uri-request.txt create mode 100644 protocol/xrcp-uri-request.txt diff --git a/protocol/xftp-uri-request.txt b/protocol/xftp-uri-request.txt new file mode 100644 index 000000000..fe403f6a6 --- /dev/null +++ b/protocol/xftp-uri-request.txt @@ -0,0 +1,16 @@ +Scheme name: xftp + +Status: Provisional + +Applications/protocols that use this scheme name: +This scheme is used for URIs of XFTP (SimpleX File Transfer Protocol) servers, +a client-server protocol for asynchronous file transfer via relays, +preserving file meta-data (including size and name) and content privacy. + +Contact: Evgeny Poberezkin + +Change controller: Evgeny Poberezkin + +References: +The syntax for server URIs in the provisional specification for SimpleX File Transfer Protocol: +https://github.com/simplex-chat/simplexmq/blob/master/rfcs/2022-12-26-simplex-file-transfer.md#server-address-syntax diff --git a/protocol/xrcp-uri-request.txt b/protocol/xrcp-uri-request.txt new file mode 100644 index 000000000..ea1cfc20e --- /dev/null +++ b/protocol/xrcp-uri-request.txt @@ -0,0 +1,15 @@ +Scheme name: xrcp + +Status: Provisional + +Applications/protocols that use this scheme name: +This scheme is used for URIs of controller sessions via SimpleX Remote Control protocol (XRCP), +a protocol for remote access and management of hosts via insecure network. + +Contact: Evgeny Poberezkin + +Change controller: Evgeny Poberezkin + +References: +The syntax for server URIs in the provisional specification for SimpleX File Transfer Protocol: +https://github.com/simplex-chat/simplexmq/blob/master/rfcs/2023-10-25-remote-control.md#session-invitation diff --git a/rfcs/2022-12-26-simplex-file-transfer.md b/rfcs/2022-12-26-simplex-file-transfer.md index 9ca7a99d9..a833505f1 100644 --- a/rfcs/2022-12-26-simplex-file-transfer.md +++ b/rfcs/2022-12-26-simplex-file-transfer.md @@ -149,6 +149,19 @@ parts: This file description is sent to all recipients via normal messages, split to 15780 byte chunks if needed. +### Server address syntax + +The server address is a URI with the following format: + +```abnf +xftpServerURI = %s"xftp://" xftpServer +xftpServer = serverIdentity "@" srvHost [":" port] +srvHost = ; RFC1123, RFC5891 +port = 1*DIGIT +serverIdentity = base64url +base64url = ; RFC4648, section 5 +``` + ### Receiving file Having received the description, the recipient will: