implement dclogin scheme

CHANGELOG.md

@@ -7,6 +7,9 @@
 - jsonrpc: add `MessageNotificationInfo` & `messageGetNotificationInfo()` #3614
 - jsonrpc: add `chat_get_neighboring_media` function #3610
 
+### Added
+- `dclogin:` scheme to allow configuration from a qr code (data inside qrcode, contrary to `dcaccount:` which points to an api to create an account) #3541
+
 ### Changes
 - truncate incoming messages by lines instead of just length #3480
 - emit separate `DC_EVENT_MSGS_CHANGED` for each expired message,

deltachat-ffi/deltachat.h

@@ -468,10 +468,10 @@ int             dc_set_stock_translation(dc_context_t* context, uint32_t stock_i
 /**
  * Set configuration values from a QR code.
  * Before this function is called, dc_check_qr() should confirm the type of the
- * QR code is DC_QR_ACCOUNT or DC_QR_WEBRTC_INSTANCE.
+ * QR code is DC_QR_ACCOUNT, DC_QR_LOGIN or DC_QR_WEBRTC_INSTANCE.
  *
  * Internally, the function will call dc_set_config() with the appropriate keys,
- * e.g. `addr` and `mail_pw` for DC_QR_ACCOUNT
+ * e.g. `addr` and `mail_pw` for DC_QR_ACCOUNT and DC_QR_LOGIN
  * or `webrtc_instance` for DC_QR_WEBRTC_INSTANCE.
  *
  * @memberof dc_context_t
@@ -2270,6 +2270,7 @@ void            dc_stop_ongoing_process      (dc_context_t* context);
 #define         DC_QR_WITHDRAW_VERIFYGROUP   502 // text1=groupname
 #define         DC_QR_REVIVE_VERIFYCONTACT   510
 #define         DC_QR_REVIVE_VERIFYGROUP     512 // text1=groupname
+#define         DC_QR_LOGIN                  520 // text1=email_address
 
 /**
  * Check a scanned QR code.
@@ -2342,6 +2343,10 @@ void            dc_stop_ongoing_process      (dc_context_t* context);
  *   ask the user if they want to revive the withdrawn group-invite code;
  *   if so, call dc_set_config_from_qr().
  *
+ * - DC_QR_LOGIN with dc_lot_t::text1=email_address:
+ *   ask the user if they want to login with the email_address,
+ *   if so, call dc_set_config_from_qr() and then dc_configure().
+ *
  * @memberof dc_context_t
  * @param context The context object.
  * @param qr The text of the scanned QR code.

deltachat-ffi/src/lot.rs

@@ -58,6 +58,7 @@ impl Lot {
                 Qr::WithdrawVerifyGroup { grpname, .. } => Some(grpname),
                 Qr::ReviveVerifyContact { .. } => None,
                 Qr::ReviveVerifyGroup { grpname, .. } => Some(grpname),
+                Qr::Login { address, .. } => Some(address),
             },
             Self::Error(err) => Some(err),
         }
@@ -108,6 +109,7 @@ impl Lot {
                 Qr::WithdrawVerifyGroup { .. } => LotState::QrWithdrawVerifyGroup,
                 Qr::ReviveVerifyContact { .. } => LotState::QrReviveVerifyContact,
                 Qr::ReviveVerifyGroup { .. } => LotState::QrReviveVerifyGroup,
+                Qr::Login { .. } => LotState::QrLogin,
             },
             Self::Error(_err) => LotState::QrError,
         }
@@ -131,6 +133,7 @@ impl Lot {
                 Qr::WithdrawVerifyGroup { .. } => Default::default(),
                 Qr::ReviveVerifyContact { contact_id, .. } => contact_id.to_u32(),
                 Qr::ReviveVerifyGroup { .. } => Default::default(),
+                Qr::Login { .. } => Default::default(),
             },
             Self::Error(_) => Default::default(),
         }
@@ -195,6 +198,9 @@ pub enum LotState {
     /// text1=groupname
     QrReviveVerifyGroup = 512,
 
+    /// text1=email_address
+    QrLogin = 520,
+
     // Message States
     MsgInFresh = 10,
     MsgInNoticed = 13,

deltachat-jsonrpc/src/api/types/mod.rs

@@ -94,6 +94,9 @@ pub enum QrObject {
         invitenumber: String,
         authcode: String,
     },
+    Login {
+        address: String,
+    },
 }
 
 impl From<Qr> for QrObject {
@@ -224,6 +227,7 @@ impl From<Qr> for QrObject {
                     authcode,
                 }
             }
+            Qr::Login { address, .. } => QrObject::Login { address },
         }
     }
 }

deltachat-jsonrpc/typescript/generated/types.ts

@@ -3,7 +3,7 @@
 export type U32=number;
 export type Account=(({"type":"Configured";}&{"id":U32;"displayName":(string|null);"addr":(string|null);"profileImage":(string|null);"color":string;})|({"type":"Unconfigured";}&{"id":U32;}));
 export type ProviderInfo={"beforeLoginHint":string;"overviewPage":string;"status":U32;};
-export type Qr=(({"type":"askVerifyContact";}&{"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"askVerifyGroup";}&{"grpname":string;"grpid":string;"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"fprOk";}&{"contact_id":U32;})|({"type":"fprMismatch";}&{"contact_id":(U32|null);})|({"type":"fprWithoutAddr";}&{"fingerprint":string;})|({"type":"account";}&{"domain":string;})|({"type":"webrtcInstance";}&{"domain":string;"instance_pattern":string;})|({"type":"addr";}&{"contact_id":U32;"draft":(string|null);})|({"type":"url";}&{"url":string;})|({"type":"text";}&{"text":string;})|({"type":"withdrawVerifyContact";}&{"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"withdrawVerifyGroup";}&{"grpname":string;"grpid":string;"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"reviveVerifyContact";}&{"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"reviveVerifyGroup";}&{"grpname":string;"grpid":string;"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;}));
+export type Qr=(({"type":"askVerifyContact";}&{"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"askVerifyGroup";}&{"grpname":string;"grpid":string;"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"fprOk";}&{"contact_id":U32;})|({"type":"fprMismatch";}&{"contact_id":(U32|null);})|({"type":"fprWithoutAddr";}&{"fingerprint":string;})|({"type":"account";}&{"domain":string;})|({"type":"webrtcInstance";}&{"domain":string;"instance_pattern":string;})|({"type":"addr";}&{"contact_id":U32;"draft":(string|null);})|({"type":"url";}&{"url":string;})|({"type":"text";}&{"text":string;})|({"type":"withdrawVerifyContact";}&{"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"withdrawVerifyGroup";}&{"grpname":string;"grpid":string;"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"reviveVerifyContact";}&{"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"reviveVerifyGroup";}&{"grpname":string;"grpid":string;"contact_id":U32;"fingerprint":string;"invitenumber":string;"authcode":string;})|({"type":"login";}&{"address":string;}));
 export type Usize=number;
 export type ChatListEntry=[U32,U32];
 export type I64=number;

node/constants.js

@@ -103,6 +103,7 @@ module.exports = {
   DC_QR_FPR_MISMATCH: 220,
   DC_QR_FPR_OK: 210,
   DC_QR_FPR_WITHOUT_ADDR: 230,
+  DC_QR_LOGIN: 520,
   DC_QR_REVIVE_VERIFYCONTACT: 510,
   DC_QR_REVIVE_VERIFYGROUP: 512,
   DC_QR_TEXT: 330,

node/lib/constants.ts

@@ -103,6 +103,7 @@ export enum C {
   DC_QR_FPR_MISMATCH = 220,
   DC_QR_FPR_OK = 210,
   DC_QR_FPR_WITHOUT_ADDR = 230,
+  DC_QR_LOGIN = 520,
   DC_QR_REVIVE_VERIFYCONTACT = 510,
   DC_QR_REVIVE_VERIFYGROUP = 512,
   DC_QR_TEXT = 330,

src/login_param.rs

@@ -15,7 +15,7 @@ use crate::constants::{DC_LP_AUTH_FLAGS, DC_LP_AUTH_NORMAL, DC_LP_AUTH_OAUTH2};
 use crate::provider::{get_provider_by_id, Provider};
 use crate::{context::Context, provider::Socket};
 
-#[derive(Copy, Clone, Debug, Display, FromPrimitive, PartialEq, Eq)]
+#[derive(Copy, Clone, Debug, Display, FromPrimitive, ToPrimitive, PartialEq, Eq)]
 #[repr(u32)]
 #[strum(serialize_all = "snake_case")]
 pub enum CertificateChecks {

src/qr.rs

@@ -1,5 +1,8 @@
 //! # QR code module.
 
+mod dclogin_scheme;
+pub use dclogin_scheme::LoginOptions;
+
 use anyhow::{anyhow, bail, ensure, Context as _, Error, Result};
 use once_cell::sync::Lazy;
 use percent_encoding::percent_decode_str;
@@ -17,8 +20,11 @@ use crate::peerstate::Peerstate;
 use crate::tools::time;
 use crate::{token, EventType};
 
+use self::dclogin_scheme::configure_from_login_qr;
+
 const OPENPGP4FPR_SCHEME: &str = "OPENPGP4FPR:"; // yes: uppercase
 const DCACCOUNT_SCHEME: &str = "DCACCOUNT:";
+pub(super) const DCLOGIN_SCHEME: &str = "DCLOGIN:";
 const DCWEBRTC_SCHEME: &str = "DCWEBRTC:";
 const MAILTO_SCHEME: &str = "mailto:";
 const MATMSG_SCHEME: &str = "MATMSG:";
@@ -97,6 +103,10 @@ pub enum Qr {
         invitenumber: String,
         authcode: String,
     },
+    Login {
+        address: String,
+        options: LoginOptions,
+    },
 }
 
 fn starts_with_ignore_case(string: &str, pattern: &str) -> bool {
@@ -115,6 +125,8 @@ pub async fn check_qr(context: &Context, qr: &str) -> Result<Qr> {
             .context("failed to decode OPENPGP4FPR QR code")?
     } else if starts_with_ignore_case(qr, DCACCOUNT_SCHEME) {
         decode_account(qr)?
+    } else if starts_with_ignore_case(qr, DCLOGIN_SCHEME) {
+        dclogin_scheme::decode_login(qr)?
     } else if starts_with_ignore_case(qr, DCWEBRTC_SCHEME) {
         decode_webrtc_instance(context, qr)?
     } else if qr.starts_with(MAILTO_SCHEME) {
@@ -462,6 +474,9 @@ pub async fn set_config_from_qr(context: &Context, qr: &str) -> Result<()> {
             context.sync_qr_code_tokens(chat_id).await?;
             context.send_sync_msg().await?;
         }
+        Qr::Login { address, options } => {
+            configure_from_login_qr(context, &address, options).await?
+        }
         _ => bail!("qr code {:?} does not contain config", qr),
     }
 
@@ -1024,6 +1039,103 @@ mod tests {
         Ok(())
     }
 
+    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+    async fn test_decode_and_apply_dclogin() -> Result<()> {
+        let ctx = TestContext::new().await;
+
+        let result = check_qr(&ctx.ctx, "dclogin:usename+extension@host?p=1234&v=1").await?;
+        if let Qr::Login { address, options } = result {
+            assert_eq!(address, "usename+extension@host".to_owned());
+
+            if let LoginOptions::V1 { mail_pw, .. } = options {
+                assert_eq!(mail_pw, "1234".to_owned());
+            } else {
+                bail!("wrong type")
+            }
+        } else {
+            bail!("wrong type")
+        }
+
+        assert!(ctx.ctx.get_config(Config::Addr).await?.is_none());
+        assert!(ctx.ctx.get_config(Config::MailPw).await?.is_none());
+
+        set_config_from_qr(&ctx.ctx, "dclogin:username+extension@host?p=1234&v=1").await?;
+        assert_eq!(
+            ctx.ctx.get_config(Config::Addr).await?,
+            Some("username+extension@host".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::MailPw).await?,
+            Some("1234".to_owned())
+        );
+
+        Ok(())
+    }
+
+    #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
+    async fn test_decode_and_apply_dclogin_advanced_options() -> Result<()> {
+        let ctx = TestContext::new().await;
+        set_config_from_qr(&ctx.ctx, "dclogin:username+extension@host?p=1234&spw=4321&sh=send.host&sp=7273&su=SendUser&ih=host.tld&ip=4343&iu=user&ipw=password&is=ssl&ic=1&sc=3&ss=plain&v=1").await?;
+        assert_eq!(
+            ctx.ctx.get_config(Config::Addr).await?,
+            Some("username+extension@host".to_owned())
+        );
+
+        // `p=1234` is ignored, because `ipw=password` is set
+
+        assert_eq!(
+            ctx.ctx.get_config(Config::MailServer).await?,
+            Some("host.tld".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::MailPort).await?,
+            Some("4343".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::MailUser).await?,
+            Some("user".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::MailPw).await?,
+            Some("password".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::MailSecurity).await?,
+            Some("1".to_owned()) // ssl
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::ImapCertificateChecks).await?,
+            Some("1".to_owned())
+        );
+
+        assert_eq!(
+            ctx.ctx.get_config(Config::SendPw).await?,
+            Some("4321".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::SendServer).await?,
+            Some("send.host".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::SendPort).await?,
+            Some("7273".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::SendUser).await?,
+            Some("SendUser".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::SmtpCertificateChecks).await?,
+            Some("3".to_owned())
+        );
+        assert_eq!(
+            ctx.ctx.get_config(Config::SendSecurity).await?,
+            Some("3".to_owned()) // plain
+        );
+
+        Ok(())
+    }
+
     #[tokio::test(flavor = "multi_thread", worker_threads = 2)]
     async fn test_decode_account() -> Result<()> {
         let ctx = TestContext::new().await;