openid 0.23.0

OpenID Connect & Discovery client library using async / await.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

/*!
OAuth 2.0 providers.
*/
use std::sync::LazyLock;

use url::Url;

/// Microsoft OpenID Connect.
///
/// See [Microsoft identity platform and OpenID Connect protocol](https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-protocols-oidc)
#[cfg(any(feature = "microsoft", doc))]
pub mod microsoft;

/// OAuth 2.0 providers.
pub trait Provider {
    /// The authorization endpoint URI.
    ///
    /// See [RFC 6749, section 3.1](http://tools.ietf.org/html/rfc6749#section-3.1).
    fn auth_uri(&self) -> &Url;

    /// The token endpoint URI.
    ///
    /// See [RFC 6749, section 3.2](http://tools.ietf.org/html/rfc6749#section-3.2).
    fn token_uri(&self) -> &Url;

    /// Provider requires credentials via request body.
    ///
    /// Although not recommended by the RFC, some providers require `client_id`
    /// and `client_secret` as part of the request body.
    ///
    /// See [RFC 6749, section 2.3.1](http://tools.ietf.org/html/rfc6749#section-2.3.1).
    fn credentials_in_body(&self) -> bool {
        false
    }
}

/// Google OAuth 2.0 providers.
///
/// See [Using OAuth 2.0 to Access Google
/// APIs](https://developers.google.com/identity/protocols/OAuth2).
pub mod google {
    use std::sync::LazyLock;

    use url::Url;

    use super::Provider;

    /// Signals the server to return the authorization code by prompting the
    /// user to copy and paste.
    ///
    /// See [Choosing a redirect URI][uri].
    ///
    /// [uri]: https://developers.google.com/identity/protocols/OAuth2InstalledApp#choosingredirecturi
    pub const REDIRECT_URI_OOB: &str = "urn:ietf:wg:oauth:2.0:oob";

    /// Signals the server to return the authorization code in the page title.
    ///
    /// See [Choosing a redirect URI][uri].
    ///
    /// [uri]: https://developers.google.com/identity/protocols/OAuth2InstalledApp#choosingredirecturi
    pub const REDIRECT_URI_OOB_AUTO: &str = "urn:ietf:wg:oauth:2.0:oob:auto";

    static AUTH_URI: LazyLock<Url> =
        LazyLock::new(|| Url::parse("https://accounts.google.com/o/oauth2/v2/auth").unwrap());
    static TOKEN_URI: LazyLock<Url> =
        LazyLock::new(|| Url::parse("https://www.googleapis.com/oauth2/v4/token").unwrap());

    /// Google OAuth 2.0 provider for web applications.
    ///
    /// See [Using OAuth 2.0 for Web Server
    /// Applications](https://developers.google.com/identity/protocols/OAuth2WebServer).
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct Web;
    impl Provider for Web {
        fn auth_uri(&self) -> &Url {
            &AUTH_URI
        }
        fn token_uri(&self) -> &Url {
            &TOKEN_URI
        }
    }

    /// Google OAuth 2.0 provider for installed applications.
    ///
    /// See [Using OAuth 2.0 for Installed
    /// Applications](https://developers.google.com/identity/protocols/OAuth2InstalledApp).
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct Installed;
    impl Provider for Installed {
        fn auth_uri(&self) -> &Url {
            &AUTH_URI
        }
        fn token_uri(&self) -> &Url {
            &TOKEN_URI
        }
    }
}

/// GitHub OAuth 2.0 provider.
///
/// See [OAuth, GitHub Developer Guide](https://developer.github.com/v3/oauth/).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct GitHub;
impl Provider for GitHub {
    fn auth_uri(&self) -> &Url {
        static GITHUB_AUTH_URI: LazyLock<Url> =
            LazyLock::new(|| Url::parse("https://github.com/login/oauth/authorize").unwrap());
        &GITHUB_AUTH_URI
    }
    fn token_uri(&self) -> &Url {
        static GITHUB_TOKEN_URI: LazyLock<Url> =
            LazyLock::new(|| Url::parse("https://github.com/login/oauth/access_token").unwrap());
        &GITHUB_TOKEN_URI
    }
}

/// Imgur OAuth 2.0 provider.
///
/// See [OAuth 2.0, Imgur](https://api.imgur.com/oauth2).
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Imgur;
impl Provider for Imgur {
    fn auth_uri(&self) -> &Url {
        static IMGUR_AUTH_URI: LazyLock<Url> =
            LazyLock::new(|| Url::parse("https://api.imgur.com/oauth2/authorize").unwrap());
        &IMGUR_AUTH_URI
    }
    fn token_uri(&self) -> &Url {
        static IMGUR_TOKEN_URI: LazyLock<Url> =
            LazyLock::new(|| Url::parse("https://api.imgur.com/oauth2/token").unwrap());
        &IMGUR_TOKEN_URI
    }
}

#[test]
fn google_urls() {
    let prov = google::Web;
    prov.auth_uri();
    prov.token_uri();
    let prov = google::Installed;
    prov.auth_uri();
    prov.token_uri();
}

#[test]
fn github_urls() {
    let prov = GitHub;
    prov.auth_uri();
    prov.token_uri();
}

#[test]
fn imgur_urls() {
    let prov = Imgur;
    prov.auth_uri();
    prov.token_uri();
}