pubky 0.10.0-alpha.0

Pubky SDK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use pubky_common::capabilities::Capabilities;
use url::Url;

use super::{
    DeepLinkParseError,
    query_params::{append_signin_params, parse_capabilities, parse_relay, parse_secret},
    typed_deep_link::{DeepLinkIntent, DeepLinkParams, TypedDeepLink},
};

/// Intent marker for legacy signin deep links.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SigninIntent;

impl DeepLinkIntent for SigninIntent {
    const NAME: &'static str = "signin";
}

/// Typed parameters for legacy signin deep links.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SigninParams {
    /// Capabilities requested by the app.
    pub capabilities: Capabilities,
    /// Base HTTP relay URL.
    pub relay: Url,
    /// Secret used to derive the encrypted relay channel.
    pub secret: [u8; 32],
}

impl DeepLinkParams for SigninParams {
    fn parse(url: &Url) -> Result<Self, DeepLinkParseError> {
        Ok(Self {
            capabilities: parse_capabilities(url)?,
            relay: parse_relay(url)?,
            secret: parse_secret(url)?,
        })
    }

    fn append_query_pairs(&self, url: &mut Url) {
        append_signin_params(url, &self.capabilities, &self.relay, &self.secret);
    }
}

/// A deep link for signing into a Pubky homeserver via the legacy cookie flow.
pub type SigninDeepLink = TypedDeepLink<SigninIntent, SigninParams>;

#[cfg(test)]
mod tests {
    use super::*;
    use crate::actors::auth::deep_links::DeepLinkScheme;

    #[test]
    fn parses_signin_deep_link() {
        let deep_link: SigninDeepLink = "pubkyauth://signin?caps=/pub/pubky.app/:rw&relay=https://httprelay.pubky.app/inbox/&secret=kqnceEMgrNQM_xi06oQXjA3cJHX_RQmw1BY6JE1bse8"
            .parse()
            .unwrap();

        assert_eq!(deep_link.scheme(), DeepLinkScheme::PubkyAuth);
        assert_eq!(deep_link.intent(), "signin");
        assert_eq!(
            deep_link.params().capabilities.to_string(),
            "/pub/pubky.app/:rw"
        );
        assert_eq!(
            deep_link.params().relay.as_str(),
            "https://httprelay.pubky.app/inbox/"
        );
    }

    #[test]
    fn parses_signin_deep_link_with_extra_query_params() {
        let deep_link: SigninDeepLink = "pubkyauth://signin?caps=/pub/pubky.app/:rw&relay=https://httprelay.pubky.app/inbox/&secret=kqnceEMgrNQM_xi06oQXjA3cJHX_RQmw1BY6JE1bse8&cid=franky.pubky.app&cpk=not-a-public-key"
            .parse()
            .unwrap();

        assert_eq!(deep_link.intent(), "signin");
    }

    #[test]
    fn creates_signin_deep_link_from_params() {
        let capabilities = Capabilities::builder()
            .read_write("/")
            .read("/test")
            .finish();
        let relay = Url::parse("https://httprelay.pubky.app/inbox/").unwrap();
        let secret = [123; 32];
        let deep_link = SigninDeepLink::new(
            DeepLinkScheme::PubkyAuth,
            SigninParams {
                capabilities,
                relay,
                secret,
            },
        );
        let parsed_again = SigninDeepLink::parse_url(&deep_link.to_url()).unwrap();

        assert_eq!(parsed_again, deep_link);
    }

    #[test]
    fn rejects_missing_secret() {
        let error = "pubkyauth://signin?caps=/:rw&relay=https://httprelay.pubky.app/inbox/"
            .parse::<SigninDeepLink>()
            .unwrap_err();

        assert!(matches!(
            error,
            DeepLinkParseError::MissingQueryParameter("secret")
        ));
    }

    #[test]
    fn rejects_wrong_intent() {
        let error = "pubkyauth://signup?caps=/:rw&relay=https://httprelay.pubky.app/inbox/&secret=kqnceEMgrNQM_xi06oQXjA3cJHX_RQmw1BY6JE1bse8"
            .parse::<SigninDeepLink>()
            .unwrap_err();

        assert!(matches!(error, DeepLinkParseError::InvalidIntent("signin")));
    }
}