pas_external/
oauth.rs

1use serde::{Deserialize, Serialize};
2use url::Url;
3
4use crate::error::Error;
5use crate::pkce;
6use crate::types::{Ppnum, PpnumId};
7
8const DEFAULT_AUTH_URL: &str = "https://accounts.ppoppo.com/oauth/authorize";
9const DEFAULT_TOKEN_URL: &str = "https://accounts.ppoppo.com/oauth/token";
10const DEFAULT_USERINFO_URL: &str = "https://accounts.ppoppo.com/oauth/userinfo";
11
12/// Ppoppo Accounts `OAuth2` configuration.
13///
14/// Required fields are constructor parameters — no runtime "missing field" errors.
15///
16/// ```rust,ignore
17/// use ppoppo_sdk::OAuthConfig;
18///
19/// let config = OAuthConfig::new("my-client-id", "https://my-app.com/callback".parse()?);
20/// // Optional overrides via chaining:
21/// let config = config
22///     .with_auth_url("https://custom.example.com/authorize".parse()?);
23/// ```
24#[derive(Debug, Clone)]
25#[non_exhaustive]
26pub struct OAuthConfig {
27    pub(crate) client_id: String,
28    pub(crate) auth_url: Url,
29    pub(crate) token_url: Url,
30    pub(crate) userinfo_url: Url,
31    pub(crate) redirect_uri: Url,
32    pub(crate) scopes: Vec<String>,
33}
34
35impl OAuthConfig {
36    /// Create a new OAuth2 configuration.
37    ///
38    /// Required fields are parameters — compile-time enforcement, no `Result`.
39    #[must_use]
40    #[allow(clippy::expect_used)] // Infallible parse — URLs are compile-time constants
41    pub fn new(client_id: impl Into<String>, redirect_uri: Url) -> Self {
42        Self {
43            client_id: client_id.into(),
44            redirect_uri,
45            auth_url: DEFAULT_AUTH_URL.parse().expect("valid default URL"),
46            token_url: DEFAULT_TOKEN_URL.parse().expect("valid default URL"),
47            userinfo_url: DEFAULT_USERINFO_URL.parse().expect("valid default URL"),
48            scopes: vec!["profile".into()],
49        }
50    }
51
52    /// Override the PAS authorization endpoint.
53    #[must_use]
54    pub fn with_auth_url(mut self, url: Url) -> Self {
55        self.auth_url = url;
56        self
57    }
58
59    /// Override the PAS token endpoint.
60    #[must_use]
61    pub fn with_token_url(mut self, url: Url) -> Self {
62        self.token_url = url;
63        self
64    }
65
66    /// Override the PAS userinfo endpoint.
67    #[must_use]
68    pub fn with_userinfo_url(mut self, url: Url) -> Self {
69        self.userinfo_url = url;
70        self
71    }
72
73    /// Override the OAuth2 scopes (default: `["profile"]`).
74    #[must_use]
75    pub fn with_scopes(mut self, scopes: Vec<String>) -> Self {
76        self.scopes = scopes;
77        self
78    }
79
80    /// `OAuth2` client ID.
81    #[must_use]
82    pub fn client_id(&self) -> &str {
83        &self.client_id
84    }
85
86    /// Authorization endpoint URL.
87    #[must_use]
88    pub fn auth_url(&self) -> &Url {
89        &self.auth_url
90    }
91
92    /// Token exchange endpoint URL.
93    #[must_use]
94    pub fn token_url(&self) -> &Url {
95        &self.token_url
96    }
97
98    /// User info endpoint URL.
99    #[must_use]
100    pub fn userinfo_url(&self) -> &Url {
101        &self.userinfo_url
102    }
103
104    /// `OAuth2` redirect URI.
105    #[must_use]
106    pub fn redirect_uri(&self) -> &Url {
107        &self.redirect_uri
108    }
109
110    /// Requested `OAuth2` scopes.
111    #[must_use]
112    pub fn scopes(&self) -> &[String] {
113        &self.scopes
114    }
115}
116
117/// `OAuth2` authorization client for Ppoppo Accounts.
118pub struct AuthClient {
119    config: OAuthConfig,
120    http: reqwest::Client,
121}
122
123/// Authorization URL with PKCE parameters to store in session.
124#[non_exhaustive]
125pub struct AuthorizationRequest {
126    pub url: String,
127    pub state: String,
128    pub code_verifier: String,
129}
130
131/// Token response from PAS token endpoint.
132#[derive(Debug, Clone, Deserialize)]
133#[non_exhaustive]
134pub struct TokenResponse {
135    pub access_token: String,
136    pub token_type: String,
137    #[serde(default)]
138    pub expires_in: Option<u64>,
139    #[serde(default)]
140    pub refresh_token: Option<String>,
141}
142
143/// User info from Ppoppo Accounts userinfo endpoint.
144#[derive(Debug, Clone, Serialize, Deserialize)]
145#[non_exhaustive]
146pub struct UserInfo {
147    pub sub: PpnumId,
148    #[serde(default)]
149    pub email: Option<String>,
150    pub ppnum: Ppnum,
151    #[serde(default)]
152    pub email_verified: Option<bool>,
153    #[serde(default, with = "time::serde::rfc3339::option")]
154    pub created_at: Option<time::OffsetDateTime>,
155    /// Break-glass session_version for this account (#005 spec).
156    ///
157    /// Populated by PAS for Human-entity tokens; `None` for AI agents and
158    /// for accounts that don't carry a human identity. Read by the
159    /// OAuth callback when persisting [`NewSession::sv`][ns] and by
160    /// [`SessionValidator`][svar] on the refresh-and-recheck path.
161    ///
162    /// [ns]: crate::middleware::NewSession
163    /// [svar]: crate::middleware::SessionValidator
164    #[serde(default)]
165    pub session_version: Option<i64>,
166}
167
168impl UserInfo {
169    /// Create a new `UserInfo` with required fields.
170    #[must_use]
171    pub fn new(sub: PpnumId, ppnum: Ppnum) -> Self {
172        Self {
173            sub,
174            ppnum,
175            email: None,
176            email_verified: None,
177            created_at: None,
178            session_version: None,
179        }
180    }
181
182    /// Set the email.
183    #[must_use]
184    pub fn with_email(mut self, email: impl Into<String>) -> Self {
185        self.email = Some(email.into());
186        self
187    }
188
189    /// Set the email_verified flag.
190    #[must_use]
191    pub fn with_email_verified(mut self, verified: bool) -> Self {
192        self.email_verified = Some(verified);
193        self
194    }
195
196    /// Set the break-glass session_version (#005).
197    #[must_use]
198    pub fn with_session_version(mut self, sv: i64) -> Self {
199        self.session_version = Some(sv);
200        self
201    }
202}
203
204impl AuthClient {
205    /// Create a new Ppoppo Accounts auth client.
206    ///
207    /// Returns an error iff `reqwest::Client::builder()` cannot construct a
208    /// client with the configured timeouts (TLS init failure, OS-level
209    /// resource exhaustion). The previous `unwrap_or_default()` path silently
210    /// substituted a no-timeout client, which converted a startup failure
211    /// into a runtime hang on the first PAS call — fail loudly instead.
212    ///
213    /// # Errors
214    ///
215    /// Returns [`Error::Http`] if the underlying HTTP client cannot be built.
216    pub fn try_new(config: OAuthConfig) -> Result<Self, Error> {
217        let builder = reqwest::Client::builder();
218        #[cfg(not(target_arch = "wasm32"))]
219        let builder = builder
220            .timeout(std::time::Duration::from_secs(10))
221            .connect_timeout(std::time::Duration::from_secs(5));
222        Ok(Self {
223            config,
224            http: builder.build()?,
225        })
226    }
227
228    /// Build with a caller-supplied HTTP client.
229    ///
230    /// Use this when sharing a `reqwest::Client` across multiple SDK clients
231    /// for connection-pool reuse, or when you need custom TLS / proxy / timeout
232    /// configuration. This constructor never fails.
233    #[must_use]
234    pub fn with_http_client(config: OAuthConfig, client: reqwest::Client) -> Self {
235        Self {
236            config,
237            http: client,
238        }
239    }
240
241    /// Generate an authorization URL with PKCE parameters.
242    #[must_use]
243    pub fn authorization_url(&self) -> AuthorizationRequest {
244        let state = pkce::generate_state();
245        let code_verifier = pkce::generate_code_verifier();
246        let code_challenge = pkce::generate_code_challenge(&code_verifier);
247        let scope = self.config.scopes.join(" ");
248
249        let mut url = self.config.auth_url.clone();
250        url.query_pairs_mut()
251            .append_pair("response_type", "code")
252            .append_pair("client_id", &self.config.client_id)
253            .append_pair("redirect_uri", self.config.redirect_uri.as_str())
254            .append_pair("state", &state)
255            .append_pair("code_challenge", &code_challenge)
256            .append_pair("code_challenge_method", "S256")
257            .append_pair("scope", &scope);
258
259        AuthorizationRequest {
260            url: url.into(),
261            state,
262            code_verifier,
263        }
264    }
265
266    /// Exchange an authorization code for tokens using PKCE.
267    ///
268    /// # Errors
269    ///
270    /// Returns [`Error::Http`] on network failure, or
271    /// [`Error::OAuth`] if the token endpoint returns an error.
272    pub async fn exchange_code(
273        &self,
274        code: &str,
275        code_verifier: &str,
276    ) -> Result<TokenResponse, Error> {
277        let params = [
278            ("grant_type", "authorization_code"),
279            ("code", code),
280            ("redirect_uri", self.config.redirect_uri.as_str()),
281            ("client_id", self.config.client_id.as_str()),
282            ("code_verifier", code_verifier),
283        ];
284
285        self.send_classified(
286            self.http.post(self.config.token_url.clone()).form(&params),
287        )
288        .await
289        .map_err(|f| f.into_legacy_error("token exchange"))
290    }
291
292    /// The single place in this module that reads HTTP status codes
293    /// from PAS token / userinfo / exchange-code responses. The
294    /// `PasAuthPort` impl methods (`refresh`, `userinfo`) consume the
295    /// resulting [`PasFailure`] directly; the legacy-signature
296    /// inherent method `exchange_code` converts via
297    /// [`PasFailure::into_legacy_error`].
298    ///
299    /// Note: `keyset::fetch_document` performs its own status-reading
300    /// for the well-known keyset document and does not route through
301    /// here. Future RFCs may unify those paths.
302    async fn send_classified<T: serde::de::DeserializeOwned>(
303        &self,
304        request: reqwest::RequestBuilder,
305    ) -> Result<T, crate::pas_port::PasFailure> {
306        use crate::pas_port::PasFailure;
307
308        let response = request
309            .send()
310            .await
311            .map_err(|e| PasFailure::Transport { detail: e.to_string() })?;
312
313        let status = response.status();
314        if status.is_server_error() {
315            let body = response.text().await.unwrap_or_default();
316            return Err(PasFailure::ServerError { status: status.as_u16(), detail: body });
317        }
318        if !status.is_success() {
319            let body = response.text().await.unwrap_or_default();
320            return Err(PasFailure::Rejected { status: status.as_u16(), detail: body });
321        }
322
323        response.json::<T>().await.map_err(|e| PasFailure::Transport {
324            detail: format!("response deserialization failed: {e}"),
325        })
326    }
327}
328
329impl crate::pas_port::PasAuthPort for AuthClient {
330    async fn refresh(
331        &self,
332        refresh_token: &str,
333    ) -> Result<TokenResponse, crate::pas_port::PasFailure> {
334        let params = [
335            ("grant_type", "refresh_token"),
336            ("refresh_token", refresh_token),
337            ("client_id", self.config.client_id.as_str()),
338        ];
339
340        self.send_classified(
341            self.http.post(self.config.token_url.clone()).form(&params),
342        )
343        .await
344    }
345
346    async fn userinfo(
347        &self,
348        access_token: &str,
349    ) -> Result<UserInfo, crate::pas_port::PasFailure> {
350        self.send_classified(
351            self.http
352                .get(self.config.userinfo_url.clone())
353                .bearer_auth(access_token),
354        )
355        .await
356    }
357}
358
359#[cfg(test)]
360#[allow(clippy::unwrap_used)]
361mod tests {
362    use super::*;
363
364    fn test_config() -> OAuthConfig {
365        OAuthConfig::new(
366            "test-client",
367            "https://example.com/callback".parse().unwrap(),
368        )
369    }
370
371    #[test]
372    fn test_authorization_url_contains_pkce() {
373        let client = AuthClient::try_new(test_config()).unwrap();
374        let req = client.authorization_url();
375
376        assert!(req.url.contains("code_challenge="));
377        assert!(req.url.contains("code_challenge_method=S256"));
378        assert!(req.url.contains("state="));
379        assert!(req.url.contains("response_type=code"));
380        assert!(req.url.contains("client_id=test-client"));
381        assert!(!req.code_verifier.is_empty());
382        assert!(!req.state.is_empty());
383    }
384
385    #[test]
386    fn test_authorization_url_unique_per_call() {
387        let client = AuthClient::try_new(test_config()).unwrap();
388        let req1 = client.authorization_url();
389        let req2 = client.authorization_url();
390
391        assert_ne!(req1.state, req2.state);
392        assert_ne!(req1.code_verifier, req2.code_verifier);
393    }
394
395    #[test]
396    fn test_config_constructor() {
397        let config = OAuthConfig::new("my-app", "https://my-app.com/callback".parse().unwrap());
398
399        assert_eq!(config.client_id(), "my-app");
400        assert_eq!(
401            config.redirect_uri().as_str(),
402            "https://my-app.com/callback"
403        );
404        assert_eq!(
405            config.auth_url().as_str(),
406            "https://accounts.ppoppo.com/oauth/authorize"
407        );
408    }
409
410    #[test]
411    fn test_config_with_overrides() {
412        let config = OAuthConfig::new("my-app", "https://my-app.com/callback".parse().unwrap())
413            .with_auth_url("https://custom.example.com/authorize".parse().unwrap())
414            .with_scopes(vec!["profile".into(), "email".into()]);
415
416        assert_eq!(
417            config.auth_url().as_str(),
418            "https://custom.example.com/authorize"
419        );
420        assert_eq!(config.scopes(), &["profile", "email"]);
421    }
422}
pas_external/oauth.rs

pas_external/
oauth.rs
