docs: update references to SecureJoin protocols

This commit is contained in:
link2xt
2024-04-20 13:22:31 +00:00
committed by holger krekel
parent 242547f1e9
commit 406031773b
6 changed files with 8 additions and 11 deletions

View File

@@ -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; * the Verified-Group-Invite protocol is offered in the QR code;
* works for protected groups as well as for normal groups. * works for protected groups as well as for normal groups.
* If set to 0, the Setup-Contact protocol is offered in the QR code. * 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. * for details about both protocols.
* @return The text that should go to the QR code, * @return The text that should go to the QR code,
* On errors, an empty QR code is returned, NULL is never returned. * 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. * Subsequent calls of dc_join_securejoin() will abort previous, unfinished handshakes.
* *
* See https://securejoin.readthedocs.io/en/latest/new.html * See https://securejoin.delta.chat/ for details about both protocols.
* for details about both protocols.
* *
* @memberof dc_context_t * @memberof dc_context_t
* @param context The context object. * @param context The context object.

View File

@@ -690,8 +690,7 @@ impl CommandApi {
/// the Verified-Group-Invite protocol is offered in the QR code; /// the Verified-Group-Invite protocol is offered in the QR code;
/// works for protected groups as well as for normal groups. /// works for protected groups as well as for normal groups.
/// If not set, the Setup-Contact protocol is offered in the QR code. /// If not set, 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.
/// for details about both protocols.
/// ///
/// return format: `[code, svg]` /// return format: `[code, svg]`
async fn get_chat_securejoin_qr_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. /// Subsequent calls of `secure_join()` will abort previous, unfinished handshakes.
/// ///
/// See https://securejoin.readthedocs.io/en/latest/new.html /// See https://securejoin.delta.chat/ for details about both protocols.
/// for details about both protocols.
/// ///
/// **qr**: The text of the scanned QR code. Typically, the same string as given /// **qr**: The text of the scanned QR code. Typically, the same string as given
/// to `check_qr()`. /// to `check_qr()`.

View File

@@ -244,7 +244,7 @@ class Account:
The function returns immediately and the handshake runs in background, sending The function returns immediately and the handshake runs in background, sending
and receiving several messages. and receiving several messages.
Subsequent calls of `secure_join()` will abort previous, unfinished handshakes. 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. :param qrdata: The text of the scanned QR code.
""" """

View File

@@ -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 anyhow::{bail, Context as _, Error, Result};
use percent_encoding::{utf8_percent_encode, AsciiSet, NON_ALPHANUMERIC}; use percent_encoding::{utf8_percent_encode, AsciiSet, NON_ALPHANUMERIC};

View File

@@ -2,7 +2,7 @@
//! //!
//! Functions to read/write token from/to the database. A token is any string associated with a key. //! 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 anyhow::Result;
use deltachat_derive::{FromSql, ToSql}; use deltachat_derive::{FromSql, ToSql};

View File

@@ -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/)) 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 [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 [openpgp4fpr]: https://metacode.biz/openpgp/openpgp4fpr
[Autodiscover]: https://learn.microsoft.com/en-us/exchange/autodiscover-service-for-exchange-2013 [Autodiscover]: https://learn.microsoft.com/en-us/exchange/autodiscover-service-for-exchange-2013
[XEP-0392]: https://xmpp.org/extensions/xep-0392.html [XEP-0392]: https://xmpp.org/extensions/xep-0392.html