From 406031773bf479ceb80353fbf3bc9d503fb5da50 Mon Sep 17 00:00:00 2001 From: link2xt Date: Sat, 20 Apr 2024 13:22:31 +0000 Subject: [PATCH] docs: update references to SecureJoin protocols --- deltachat-ffi/deltachat.h | 5 ++--- deltachat-jsonrpc/src/api.rs | 6 ++---- deltachat-rpc-client/src/deltachat_rpc_client/account.py | 2 +- src/securejoin.rs | 2 +- src/token.rs | 2 +- standards.md | 2 +- 6 files changed, 8 insertions(+), 11 deletions(-) diff --git a/deltachat-ffi/deltachat.h b/deltachat-ffi/deltachat.h index c0d671046..22f549668 100644 --- a/deltachat-ffi/deltachat.h +++ b/deltachat-ffi/deltachat.h @@ -2604,7 +2604,7 @@ dc_lot_t* dc_check_qr (dc_context_t* context, const char* * the Verified-Group-Invite protocol is offered in the QR code; * works for protected groups as well as for normal groups. * If set to 0, the Setup-Contact protocol is offered in the QR code. - * See https://securejoin.readthedocs.io/en/latest/new.html + * See https://securejoin.delta.chat/ * for details about both protocols. * @return The text that should go to the QR code, * On errors, an empty QR code is returned, NULL is never returned. @@ -2640,8 +2640,7 @@ char* dc_get_securejoin_qr_svg (dc_context_t* context, uint32_ * * Subsequent calls of dc_join_securejoin() will abort previous, unfinished handshakes. * - * See https://securejoin.readthedocs.io/en/latest/new.html - * for details about both protocols. + * See https://securejoin.delta.chat/ for details about both protocols. * * @memberof dc_context_t * @param context The context object. diff --git a/deltachat-jsonrpc/src/api.rs b/deltachat-jsonrpc/src/api.rs index c0c4b783c..42627a4b7 100644 --- a/deltachat-jsonrpc/src/api.rs +++ b/deltachat-jsonrpc/src/api.rs @@ -690,8 +690,7 @@ impl CommandApi { /// the Verified-Group-Invite protocol is offered in the QR code; /// works for protected groups as well as for normal groups. /// If not set, the Setup-Contact protocol is offered in the QR code. - /// See https://securejoin.readthedocs.io/en/latest/new.html - /// for details about both protocols. + /// See https://securejoin.delta.chat/ for details about both protocols. /// /// return format: `[code, svg]` async fn get_chat_securejoin_qr_code_svg( @@ -719,8 +718,7 @@ impl CommandApi { /// /// Subsequent calls of `secure_join()` will abort previous, unfinished handshakes. /// - /// See https://securejoin.readthedocs.io/en/latest/new.html - /// for details about both protocols. + /// See https://securejoin.delta.chat/ for details about both protocols. /// /// **qr**: The text of the scanned QR code. Typically, the same string as given /// to `check_qr()`. diff --git a/deltachat-rpc-client/src/deltachat_rpc_client/account.py b/deltachat-rpc-client/src/deltachat_rpc_client/account.py index e22f4ff7f..061e9134a 100644 --- a/deltachat-rpc-client/src/deltachat_rpc_client/account.py +++ b/deltachat-rpc-client/src/deltachat_rpc_client/account.py @@ -244,7 +244,7 @@ class Account: The function returns immediately and the handshake runs in background, sending and receiving several messages. Subsequent calls of `secure_join()` will abort previous, unfinished handshakes. - See https://securejoin.readthedocs.io/en/latest/new.html for protocol details. + See https://securejoin.delta.chat/ for protocol details. :param qrdata: The text of the scanned QR code. """ diff --git a/src/securejoin.rs b/src/securejoin.rs index dcf3e0074..3976cad85 100644 --- a/src/securejoin.rs +++ b/src/securejoin.rs @@ -1,4 +1,4 @@ -//! Verified contact protocol implementation as [specified by countermitm project](https://securejoin.readthedocs.io/en/latest/new.html#setup-contact-protocol). +//! Implementation of [SecureJoin protocols](https://securejoin.delta.chat/). use anyhow::{bail, Context as _, Error, Result}; use percent_encoding::{utf8_percent_encode, AsciiSet, NON_ALPHANUMERIC}; diff --git a/src/token.rs b/src/token.rs index 6582cdd55..8b47d2326 100644 --- a/src/token.rs +++ b/src/token.rs @@ -2,7 +2,7 @@ //! //! Functions to read/write token from/to the database. A token is any string associated with a key. //! -//! Tokens are used in countermitm verification protocols. +//! Tokens are used in SecureJoin verification protocols. use anyhow::Result; use deltachat_derive::{FromSql, ToSql}; diff --git a/standards.md b/standards.md index 9e68ac1ca..b699a3cc2 100644 --- a/standards.md +++ b/standards.md @@ -29,7 +29,7 @@ Return receipts | Message Disposition Notification (MDN, [RFC 8 Locations | KML ([Open Geospatial Consortium](http://www.opengeospatial.org/standards/kml/), [Google Dev](https://developers.google.com/kml/)) [Autocrypt Level 1]: https://autocrypt.org/level1.html -[securejoin]: https://securejoin.readthedocs.io/en/latest/ +[securejoin]: https://securejoin.delta.chat/ [openpgp4fpr]: https://metacode.biz/openpgp/openpgp4fpr [Autodiscover]: https://learn.microsoft.com/en-us/exchange/autodiscover-service-for-exchange-2013 [XEP-0392]: https://xmpp.org/extensions/xep-0392.html