commit 1465499ea7d9cd1b5b6610e7dd47cce7b7f8f08a · zbrox.com/jacquard

+58 -41

README.md

···

       2
       2
        
       

     

       3
       3
        
       A suite of Rust crates for the AT Protocol.

     

       4
       4
        
       

     

       5
       5
       -
       [![Crates.io](https://img.shields.io/crates/v/jacquard.svg)](https://crates.io/crates/jacquard) [![Documentation](https://docs.rs/jacquard/badge.svg)](https://docs.rs/jacquard) [![License](https://img.shields.io/crates/l/jacquard.svg)](./LICENSE)

     

       5
       5
       +
       ## Goals and Features

     

       6
       6
        
       

     

       7
       7
       -
       ## Goals

     

       8
       8
       -
       

     

       9
       9
       -
       - Validated, spec-compliant, easy to work with, and performant baseline types (including typed at:// uris)

     

       7
       7
       +
       - Validated, spec-compliant, easy to work with, and performant baseline types

     

       10
       8
        
       - Batteries-included, but easily replaceable batteries.

     

       11
       11
       -
         - Easy to extend with custom lexicons

     

       9
       9
       +
          - Easy to extend with custom lexicons

     

       10
       10
       +
          - Straightforward OAuth

     

       11
       11
       +
          - stateless options (or options where you handle the state) for rolling your own

     

       12
       12
       +
          - all the building blocks of the convenient abstractions are available

     

       12
       13
        
       - lexicon Value type for working with unknown atproto data (dag-cbor or json)

     

       13
       14
        
       - order of magnitude less boilerplate than some existing crates

     

       14
       14
       -
         - either the codegen produces code that's easy to work with, or there are good handwritten wrappers

     

       15
       15
       -
       - didDoc type with helper methods for getting handles, multikey, and PDS endpoint

     

       16
       15
        
       - use as much or as little from the crates as you need

     

       17
       16
        
       

     

       18
       18
       -
       

     

       19
       17
        
       ## Example

     

       20
       18
        
       

     

       21
       21
       -
       Dead simple API client. Logs in with an app password and prints the latest 5 posts from your timeline.

     

       19
       19
       +
       Dead simple API client. Logs in with OAuth and prints the latest 5 posts from your timeline.

     

       22
       20
        
       

     

       23
       21
        
       ```rust

     

       24
       24
       -
       use std::sync::Arc;

     

       22
       22
       +
       // Note: this requires the `loopback` feature enabled (it is currently by default)

     

       25
       23
        
       use clap::Parser;

     

       26
       24
        
       use jacquard::CowStr;

     

       27
       25
        
       use jacquard::api::app_bsky::feed::get_timeline::GetTimeline;

     

       28
       28
       -
       use jacquard::client::credential_session::{CredentialSession, SessionKey};

     

       29
       29
       -
       use jacquard::client::{AtpSession, FileAuthStore, MemorySessionStore};

     

       30
       30
       -
       use jacquard::identity::PublicResolver as JacquardResolver;

     

       26
       26
       +
       use jacquard::client::{Agent, FileAuthStore};

     

       27
       27
       +
       use jacquard::oauth::atproto::AtprotoClientMetadata;

     

       28
       28
       +
       use jacquard::oauth::client::OAuthClient;

     

       29
       29
       +
       use jacquard::oauth::loopback::LoopbackConfig;

     

       30
       30
       +
       use jacquard::oauth::scopes::Scope;

     

       31
       31
       +
       use jacquard::types::xrpc::XrpcClient;

     

       31
       32
        
       use miette::IntoDiagnostic;

     

       32
       33
        
       

     

       33
       34
        
       #[derive(Parser, Debug)]

     

       34
       34
       -
       #[command(author, version, about = "Jacquard - AT Protocol client demo")]

     

       35
       35
       +
       #[command(author, version, about = "Jacquard - OAuth (DPoP) loopback demo")]

     

       35
       36
        
       struct Args {

     

       36
       36
       -
           /// Username/handle (e.g., alice.bsky.social) or DID

     

       37
       37
       -
           #[arg(short, long)]

     

       38
       38
       -
           username: CowStr<'static>,

     

       39
       39
       -
           /// App password

     

       40
       40
       -
           #[arg(short, long)]

     

       41
       41
       -
           password: CowStr<'static>,

     

       37
       37
       +
           /// Handle (e.g., alice.bsky.social), DID, or PDS URL

     

       38
       38
       +
           input: CowStr<'static>,

     

       39
       39
       +
       

     

       40
       40
       +
           /// Path to auth store file (will be created if missing)

     

       41
       41
       +
           #[arg(long, default_value = "/tmp/jacquard-oauth-session.json")]

     

       42
       42
       +
           store: String,

     

       42
       43
        
       }

     

       43
       44
        
       

     

       44
       45
        
       #[tokio::main]

     

       45
       46
        
       async fn main() -> miette::Result<()> {

     

       46
       47
        
           let args = Args::parse();

     

       47
       48
        
       

     

       48
       48
       -
           // Resolver + storage

     

       49
       49
       -
           let resolver = Arc::new(JacquardResolver::default());

     

       50
       50
       -
           let store: Arc<MemorySessionStore<SessionKey, AtpSession>> = Arc::new(Default::default());

     

       51
       51
       -
           let client = Arc::new(resolver.clone());

     

       52
       52
       -
           let session = CredentialSession::new(store, client);

     

       49
       49
       +
           // File-backed auth store for testing

     

       50
       50
       +
           let store = FileAuthStore::new(&args.store);

     

       51
       51
       +
           let client_data = jacquard_oauth::session::ClientData {

     

       52
       52
       +
               keyset: None,

     

       53
       53
       +
               // Default sets normal localhost redirect URIs and "atproto transition:generic" scopes.

     

       54
       54
       +
               // The localhost helper will ensure you have at least "atproto" and will fix urls

     

       55
       55
       +
               config: AtprotoClientMetadata::default_localhost()

     

       56
       56
       +
           };

     

       53
       57
        
       

     

       54
       54
       -
           // Login (resolves PDS automatically) and persist as (did, "session")

     

       55
       55
       -
           session

     

       56
       56
       -
               .login(args.username.clone(), args.password.clone(), None, None, None)

     

       57
       57
       -
               .await

     

       58
       58
       -
               .into_diagnostic()?;

     

       59
       59
       -
       

     

       60
       60
       -
           // Fetch timeline

     

       61
       61
       -
           let timeline = session

     

       62
       62
       -
               .clone()

     

       63
       63
       -
               .send(GetTimeline::new().limit(5).build())

     

       64
       64
       -
               .await

     

       65
       65
       -
               .into_diagnostic()?

     

       66
       66
       -
               .into_output()

     

       67
       67
       -
               .into_diagnostic()?;

     

       68
       68
       -
       

     

       69
       69
       -
           println!("\ntimeline ({} posts):", timeline.feed.len());

     

       58
       58
       +
           // Build an OAuth client

     

       59
       59
       +
           let oauth = OAuthClient::new(store, client_data);

     

       60
       60
       +
           // Authenticate with a PDS, using a loopback server to handle the callback flow

     

       61
       61
       +
           let session = oauth

     

       62
       62
       +
               .login_with_local_server(

     

       63
       63
       +
                   args.input.clone(),

     

       64
       64
       +
                   Default::default(),

     

       65
       65
       +
                   LoopbackConfig::default(),

     

       66
       66
       +
               )

     

       67
       67
       +
               .await?;

     

       68
       68
       +
           // Wrap in Agent and fetch the timeline

     

       69
       69
       +
           let agent: Agent<_> = Agent::from(session);

     

       70
       70
       +
           let timeline = agent

     

       71
       71
       +
               .send(&GetTimeline::new().limit(5).build())

     

       72
       72
       +
               .await?

     

       73
       73
       +
               .into_output()?;

     

       70
       74
        
           for (i, post) in timeline.feed.iter().enumerate() {

     

       71
       75
        
               println!("\n{}. by {}", i + 1, post.post.author.handle);

     

       72
       76
        
               println!(

     
···

       77
       81
        
       

     

       78
       82
        
           Ok(())

     

       79
       83
        
       }

     

       84
       84
       +
       

     

       80
       85
        
       ```

     

       81
       86
        
       

     

       87
       87
       +
       ## Component crates

     

       88
       88
       +
       

     

       89
       89
       +
       Jacquard is broken up into several crates for modularity. The correct one to use is generally `jacquard` itself, as it re-exports the others.

     

       90
       90
       +
       - `jacquard`: Main crate [![Crates.io](https://img.shields.io/crates/v/jacquard.svg)](https://crates.io/crates/jacquard) [![Documentation](https://docs.rs/jacquard/badge.svg)](https://docs.rs/jacquard)

     

       91
       91
       +
       - `jacquard-api`: Autogenerated API bindings [![Crates.io](https://img.shields.io/crates/v/jacquard-api.svg)](https://crates.io/crates/jacquard-api) [![Documentation](https://docs.rs/jacquard-api/badge.svg)](https://docs.rs/jacquard-api)

     

       92
       92
       +
       - `jacquard-oauth`: atproto OAuth implementation [![Crates.io](https://img.shields.io/crates/v/jacquard-oauth.svg)](https://crates.io/crates/jacquard-oauth) [![Documentation](https://docs.rs/jacquard-oauth/badge.svg)](https://docs.rs/jacquard-oauth)

     

       93
       93
       +
       - `jacquard-identity`: Identity resolution [![Crates.io](https://img.shields.io/crates/v/jacquard-identity.svg)](https://crates.io/crates/jacquard-identity) [![Documentation](https://docs.rs/jacquard-identity/badge.svg)](https://docs.rs/jacquard-identity)

     

       94
       94
       +
       - `jacquard-lexicon`: Lexicon parsing and code generation [![Crates.io](https://img.shields.io/crates/v/jacquard-lexicon.svg)](https://crates.io/crates/jacquard-lexicon) [![Documentation](https://docs.rs/jacquard-lexicon/badge.svg)](https://docs.rs/jacquard-lexicon)

     

       95
       95
       +
       - `jacquard-derive`: Derive macros for lexicon types [![Crates.io](https://img.shields.io/crates/v/jacquard-derive.svg)](https://crates.io/crates/jacquard-derive) [![Documentation](https://docs.rs/jacquard-derive/badge.svg)](https://docs.rs/jacquard-derive)

     

       96
       96
       +
       

     

       82
       97
        
       ## Development

     

       83
       98
        
       

     

       84
       99
        
       This repo uses [Flakes](https://nixos.asia/en/flakes) from the get-go.

     
···

       95
       110
        
       ```

     

       96
       111
        
       

     

       97
       112
        
       There's also a [`justfile`](https://just.systems/) for Makefile-esque commands to be run inside of the devShell, and you can generally `cargo ...` or `just ...` whatever just fine if you don't want to use Nix and have the prerequisites installed.

     

       113
       113
       +
       

     

       114
       114
       +
       [![License](https://img.shields.io/crates/l/jacquard.svg)](./LICENSE)

crates/jacquard-oauth/src/atproto.rs

···

       105
       105
        
               }

     

       106
       106
        
           }

     

       107
       107
        
       

     

       108
       108
       +
           pub fn default_localhost() -> Self {

     

       109
       109
       +
               Self::new_localhost(

     

       110
       110
       +
                   None,

     

       111
       111
       +
                   Some(Scope::parse_multiple("atproto transition:generic").unwrap()),

     

       112
       112
       +
               )

     

       113
       113
       +
           }

     

       114
       114
       +
       

     

       108
       115
        
           pub fn new_localhost(

     

       109
       116
        
               mut redirect_uris: Option<Vec<Url>>,

     

       110
       117
        
               scopes: Option<Vec<Scope<'m>>>,

+176 -176

crates/jacquard-oauth/src/request.rs

···

       141
       141
        
           }

     

       142
       142
        
       }

     

       143
       143
        
       

     

       144
       144
       -
       #[cfg(test)]

     

       145
       145
       -
       mod tests {

     

       146
       146
       -
           use super::*;

     

       147
       147
       -
           use crate::types::{OAuthAuthorizationServerMetadata, OAuthClientMetadata};

     

       148
       148
       -
           use bytes::Bytes;

     

       149
       149
       -
           use http::{Response as HttpResponse, StatusCode};

     

       150
       150
       -
           use jacquard_common::http_client::HttpClient;

     

       151
       151
       -
           use jacquard_identity::resolver::IdentityResolver;

     

       152
       152
       -
           use std::sync::Arc;

     

       153
       153
       -
           use tokio::sync::Mutex;

     

       154
       154
       -
       

     

       155
       155
       -
           #[derive(Clone, Default)]

     

       156
       156
       -
           struct MockClient {

     

       157
       157
       -
               resp: Arc<Mutex<Option<HttpResponse<Vec<u8>>>>>,

     

       158
       158
       -
           }

     

       159
       159
       -
       

     

       160
       160
       -
           impl HttpClient for MockClient {

     

       161
       161
       -
               type Error = std::convert::Infallible;

     

       162
       162
       -
               fn send_http(

     

       163
       163
       -
                   &self,

     

       164
       164
       -
                   _request: http::Request<Vec<u8>>,

     

       165
       165
       -
               ) -> impl core::future::Future<

     

       166
       166
       -
                   Output = core::result::Result<http::Response<Vec<u8>>, Self::Error>,

     

       167
       167
       -
               > + Send {

     

       168
       168
       -
                   let resp = self.resp.clone();

     

       169
       169
       -
                   async move { Ok(resp.lock().await.take().unwrap()) }

     

       170
       170
       -
               }

     

       171
       171
       -
           }

     

       172
       172
       -
       

     

       173
       173
       -
           // IdentityResolver methods won't be called in these tests; provide stubs.

     

       174
       174
       -
           #[async_trait::async_trait]

     

       175
       175
       -
           impl IdentityResolver for MockClient {

     

       176
       176
       -
               fn options(&self) -> &jacquard_identity::resolver::ResolverOptions {

     

       177
       177
       -
                   use std::sync::LazyLock;

     

       178
       178
       -
                   static OPTS: LazyLock<jacquard_identity::resolver::ResolverOptions> =

     

       179
       179
       -
                       LazyLock::new(|| jacquard_identity::resolver::ResolverOptions::default());

     

       180
       180
       -
                   &OPTS

     

       181
       181
       -
               }

     

       182
       182
       -
               async fn resolve_handle(

     

       183
       183
       -
                   &self,

     

       184
       184
       -
                   _handle: &jacquard_common::types::string::Handle<'_>,

     

       185
       185
       -
               ) -> std::result::Result<

     

       186
       186
       -
                   jacquard_common::types::string::Did<'static>,

     

       187
       187
       -
                   jacquard_identity::resolver::IdentityError,

     

       188
       188
       -
               > {

     

       189
       189
       -
                   Ok(jacquard_common::types::string::Did::new_static("did:plc:alice").unwrap())

     

       190
       190
       -
               }

     

       191
       191
       -
               async fn resolve_did_doc(

     

       192
       192
       -
                   &self,

     

       193
       193
       -
                   _did: &jacquard_common::types::string::Did<'_>,

     

       194
       194
       -
               ) -> std::result::Result<

     

       195
       195
       -
                   jacquard_identity::resolver::DidDocResponse,

     

       196
       196
       -
                   jacquard_identity::resolver::IdentityError,

     

       197
       197
       -
               > {

     

       198
       198
       -
                   let doc = serde_json::json!({

     

       199
       199
       -
                       "id": "did:plc:alice",

     

       200
       200
       -
                       "service": [{

     

       201
       201
       -
                           "id": "#pds",

     

       202
       202
       -
                           "type": "AtprotoPersonalDataServer",

     

       203
       203
       -
                           "serviceEndpoint": "https://pds"

     

       204
       204
       -
                       }]

     

       205
       205
       -
                   });

     

       206
       206
       -
                   let buf = Bytes::from(serde_json::to_vec(&doc).unwrap());

     

       207
       207
       -
                   Ok(jacquard_identity::resolver::DidDocResponse {

     

       208
       208
       -
                       buffer: buf,

     

       209
       209
       -
                       status: StatusCode::OK,

     

       210
       210
       -
                       requested: None,

     

       211
       211
       -
                   })

     

       212
       212
       -
               }

     

       213
       213
       -
           }

     

       214
       214
       -
       

     

       215
       215
       -
           // Allow using DPoP helpers on MockClient

     

       216
       216
       -
           impl crate::dpop::DpopExt for MockClient {}

     

       217
       217
       -
           impl crate::resolver::OAuthResolver for MockClient {}

     

       218
       218
       -
       

     

       219
       219
       -
           fn base_metadata() -> OAuthMetadata {

     

       220
       220
       -
               let mut server = OAuthAuthorizationServerMetadata::default();

     

       221
       221
       -
               server.issuer = CowStr::from("https://issuer");

     

       222
       222
       -
               server.authorization_endpoint = CowStr::from("https://issuer/authorize");

     

       223
       223
       -
               server.token_endpoint = CowStr::from("https://issuer/token");

     

       224
       224
       -
               OAuthMetadata {

     

       225
       225
       -
                   server_metadata: server,

     

       226
       226
       -
                   client_metadata: OAuthClientMetadata {

     

       227
       227
       -
                       client_id: url::Url::parse("https://client").unwrap(),

     

       228
       228
       -
                       client_uri: None,

     

       229
       229
       -
                       redirect_uris: vec![url::Url::parse("https://client/cb").unwrap()],

     

       230
       230
       -
                       scope: Some(CowStr::from("atproto")),

     

       231
       231
       -
                       grant_types: None,

     

       232
       232
       -
                       token_endpoint_auth_method: Some(CowStr::from("none")),

     

       233
       233
       -
                       dpop_bound_access_tokens: None,

     

       234
       234
       -
                       jwks_uri: None,

     

       235
       235
       -
                       jwks: None,

     

       236
       236
       -
                       token_endpoint_auth_signing_alg: None,

     

       237
       237
       -
                   },

     

       238
       238
       -
                   keyset: None,

     

       239
       239
       -
               }

     

       240
       240
       -
           }

     

       241
       241
       -
       

     

       242
       242
       -
           #[tokio::test]

     

       243
       243
       -
           async fn par_missing_endpoint() {

     

       244
       244
       -
               let mut meta = base_metadata();

     

       245
       245
       -
               meta.server_metadata.require_pushed_authorization_requests = Some(true);

     

       246
       246
       -
               meta.server_metadata.pushed_authorization_request_endpoint = None;

     

       247
       247
       -
               // require_pushed_authorization_requests is true and no endpoint

     

       248
       248
       -
               let err = super::par(&MockClient::default(), None, None, &meta)

     

       249
       249
       -
                   .await

     

       250
       250
       -
                   .unwrap_err();

     

       251
       251
       -
               match err {

     

       252
       252
       -
                   RequestError::NoEndpoint(name) => {

     

       253
       253
       -
                       assert_eq!(name.as_ref(), "pushed_authorization_request");

     

       254
       254
       -
                   }

     

       255
       255
       -
                   other => panic!("unexpected: {other:?}"),

     

       256
       256
       -
               }

     

       257
       257
       -
           }

     

       258
       258
       -
       

     

       259
       259
       -
           #[tokio::test]

     

       260
       260
       -
           async fn refresh_no_refresh_token() {

     

       261
       261
       -
               let client = MockClient::default();

     

       262
       262
       -
               let meta = base_metadata();

     

       263
       263
       -
               let session = ClientSessionData {

     

       264
       264
       -
                   account_did: jacquard_common::types::string::Did::new_static("did:plc:alice").unwrap(),

     

       265
       265
       -
                   session_id: CowStr::from("state"),

     

       266
       266
       -
                   host_url: url::Url::parse("https://pds").unwrap(),

     

       267
       267
       -
                   authserver_url: url::Url::parse("https://issuer").unwrap(),

     

       268
       268
       -
                   authserver_token_endpoint: CowStr::from("https://issuer/token"),

     

       269
       269
       -
                   authserver_revocation_endpoint: None,

     

       270
       270
       -
                   scopes: vec![],

     

       271
       271
       -
                   dpop_data: DpopClientData {

     

       272
       272
       -
                       dpop_key: crate::utils::generate_key(&[CowStr::from("ES256")]).unwrap(),

     

       273
       273
       -
                       dpop_authserver_nonce: CowStr::from(""),

     

       274
       274
       -
                       dpop_host_nonce: CowStr::from(""),

     

       275
       275
       -
                   },

     

       276
       276
       -
                   token_set: crate::types::TokenSet {

     

       277
       277
       -
                       iss: CowStr::from("https://issuer"),

     

       278
       278
       -
                       sub: jacquard_common::types::string::Did::new_static("did:plc:alice").unwrap(),

     

       279
       279
       -
                       aud: CowStr::from("https://pds"),

     

       280
       280
       -
                       scope: None,

     

       281
       281
       -
                       refresh_token: None,

     

       282
       282
       -
                       access_token: CowStr::from("abc"),

     

       283
       283
       -
                       token_type: crate::types::OAuthTokenType::DPoP,

     

       284
       284
       -
                       expires_at: None,

     

       285
       285
       -
                   },

     

       286
       286
       -
               };

     

       287
       287
       -
               let err = super::refresh(&client, session, &meta).await.unwrap_err();

     

       288
       288
       -
               matches!(err, RequestError::NoRefreshToken);

     

       289
       289
       -
           }

     

       290
       290
       -
       

     

       291
       291
       -
           #[tokio::test]

     

       292
       292
       -
           async fn exchange_code_missing_sub() {

     

       293
       293
       -
               let client = MockClient::default();

     

       294
       294
       -
               // set mock HTTP response body: token response without `sub`

     

       295
       295
       -
               *client.resp.lock().await = Some(

     

       296
       296
       -
                   HttpResponse::builder()

     

       297
       297
       -
                       .status(StatusCode::OK)

     

       298
       298
       -
                       .body(

     

       299
       299
       -
                           serde_json::to_vec(&serde_json::json!({

     

       300
       300
       -
                               "access_token":"tok",

     

       301
       301
       -
                               "token_type":"DPoP",

     

       302
       302
       -
                               "expires_in": 3600

     

       303
       303
       -
                           }))

     

       304
       304
       -
                           .unwrap(),

     

       305
       305
       -
                       )

     

       306
       306
       -
                       .unwrap(),

     

       307
       307
       -
               );

     

       308
       308
       -
               let meta = base_metadata();

     

       309
       309
       -
               let mut dpop = DpopReqData {

     

       310
       310
       -
                   dpop_key: crate::utils::generate_key(&[CowStr::from("ES256")]).unwrap(),

     

       311
       311
       -
                   dpop_authserver_nonce: None,

     

       312
       312
       -
               };

     

       313
       313
       -
               let err = super::exchange_code(&client, &mut dpop, "abc", "verifier", &meta)

     

       314
       314
       -
                   .await

     

       315
       315
       -
                   .unwrap_err();

     

       316
       316
       -
               matches!(err, RequestError::TokenVerification);

     

       317
       317
       -
           }

     

       318
       318
       -
       }

     

       319
       319
       -
       

     

       320
       144
        
       #[derive(Debug, Serialize)]

     

       321
       145
        
       pub struct RequestPayload<'a, T>

     

       322
       146
        
       where

     
···

       735
       559
        
       

     

       736
       560
        
           Err(RequestError::UnsupportedAuthMethod)

     

       737
       561
        
       }

     

       562
       562
       +
       

     

       563
       563
       +
       #[cfg(test)]

     

       564
       564
       +
       mod tests {

     

       565
       565
       +
           use super::*;

     

       566
       566
       +
           use crate::types::{OAuthAuthorizationServerMetadata, OAuthClientMetadata};

     

       567
       567
       +
           use bytes::Bytes;

     

       568
       568
       +
           use http::{Response as HttpResponse, StatusCode};

     

       569
       569
       +
           use jacquard_common::http_client::HttpClient;

     

       570
       570
       +
           use jacquard_identity::resolver::IdentityResolver;

     

       571
       571
       +
           use std::sync::Arc;

     

       572
       572
       +
           use tokio::sync::Mutex;

     

       573
       573
       +
       

     

       574
       574
       +
           #[derive(Clone, Default)]

     

       575
       575
       +
           struct MockClient {

     

       576
       576
       +
               resp: Arc<Mutex<Option<HttpResponse<Vec<u8>>>>>,

     

       577
       577
       +
           }

     

       578
       578
       +
       

     

       579
       579
       +
           impl HttpClient for MockClient {

     

       580
       580
       +
               type Error = std::convert::Infallible;

     

       581
       581
       +
               fn send_http(

     

       582
       582
       +
                   &self,

     

       583
       583
       +
                   _request: http::Request<Vec<u8>>,

     

       584
       584
       +
               ) -> impl core::future::Future<

     

       585
       585
       +
                   Output = core::result::Result<http::Response<Vec<u8>>, Self::Error>,

     

       586
       586
       +
               > + Send {

     

       587
       587
       +
                   let resp = self.resp.clone();

     

       588
       588
       +
                   async move { Ok(resp.lock().await.take().unwrap()) }

     

       589
       589
       +
               }

     

       590
       590
       +
           }

     

       591
       591
       +
       

     

       592
       592
       +
           // IdentityResolver methods won't be called in these tests; provide stubs.

     

       593
       593
       +
           #[async_trait::async_trait]

     

       594
       594
       +
           impl IdentityResolver for MockClient {

     

       595
       595
       +
               fn options(&self) -> &jacquard_identity::resolver::ResolverOptions {

     

       596
       596
       +
                   use std::sync::LazyLock;

     

       597
       597
       +
                   static OPTS: LazyLock<jacquard_identity::resolver::ResolverOptions> =

     

       598
       598
       +
                       LazyLock::new(|| jacquard_identity::resolver::ResolverOptions::default());

     

       599
       599
       +
                   &OPTS

     

       600
       600
       +
               }

     

       601
       601
       +
               async fn resolve_handle(

     

       602
       602
       +
                   &self,

     

       603
       603
       +
                   _handle: &jacquard_common::types::string::Handle<'_>,

     

       604
       604
       +
               ) -> std::result::Result<

     

       605
       605
       +
                   jacquard_common::types::string::Did<'static>,

     

       606
       606
       +
                   jacquard_identity::resolver::IdentityError,

     

       607
       607
       +
               > {

     

       608
       608
       +
                   Ok(jacquard_common::types::string::Did::new_static("did:plc:alice").unwrap())

     

       609
       609
       +
               }

     

       610
       610
       +
               async fn resolve_did_doc(

     

       611
       611
       +
                   &self,

     

       612
       612
       +
                   _did: &jacquard_common::types::string::Did<'_>,

     

       613
       613
       +
               ) -> std::result::Result<

     

       614
       614
       +
                   jacquard_identity::resolver::DidDocResponse,

     

       615
       615
       +
                   jacquard_identity::resolver::IdentityError,

     

       616
       616
       +
               > {

     

       617
       617
       +
                   let doc = serde_json::json!({

     

       618
       618
       +
                       "id": "did:plc:alice",

     

       619
       619
       +
                       "service": [{

     

       620
       620
       +
                           "id": "#pds",

     

       621
       621
       +
                           "type": "AtprotoPersonalDataServer",

     

       622
       622
       +
                           "serviceEndpoint": "https://pds"

     

       623
       623
       +
                       }]

     

       624
       624
       +
                   });

     

       625
       625
       +
                   let buf = Bytes::from(serde_json::to_vec(&doc).unwrap());

     

       626
       626
       +
                   Ok(jacquard_identity::resolver::DidDocResponse {

     

       627
       627
       +
                       buffer: buf,

     

       628
       628
       +
                       status: StatusCode::OK,

     

       629
       629
       +
                       requested: None,

     

       630
       630
       +
                   })

     

       631
       631
       +
               }

     

       632
       632
       +
           }

     

       633
       633
       +
       

     

       634
       634
       +
           // Allow using DPoP helpers on MockClient

     

       635
       635
       +
           impl crate::dpop::DpopExt for MockClient {}

     

       636
       636
       +
           impl crate::resolver::OAuthResolver for MockClient {}

     

       637
       637
       +
       

     

       638
       638
       +
           fn base_metadata() -> OAuthMetadata {

     

       639
       639
       +
               let mut server = OAuthAuthorizationServerMetadata::default();

     

       640
       640
       +
               server.issuer = CowStr::from("https://issuer");

     

       641
       641
       +
               server.authorization_endpoint = CowStr::from("https://issuer/authorize");

     

       642
       642
       +
               server.token_endpoint = CowStr::from("https://issuer/token");

     

       643
       643
       +
               OAuthMetadata {

     

       644
       644
       +
                   server_metadata: server,

     

       645
       645
       +
                   client_metadata: OAuthClientMetadata {

     

       646
       646
       +
                       client_id: url::Url::parse("https://client").unwrap(),

     

       647
       647
       +
                       client_uri: None,

     

       648
       648
       +
                       redirect_uris: vec![url::Url::parse("https://client/cb").unwrap()],

     

       649
       649
       +
                       scope: Some(CowStr::from("atproto")),

     

       650
       650
       +
                       grant_types: None,

     

       651
       651
       +
                       token_endpoint_auth_method: Some(CowStr::from("none")),

     

       652
       652
       +
                       dpop_bound_access_tokens: None,

     

       653
       653
       +
                       jwks_uri: None,

     

       654
       654
       +
                       jwks: None,

     

       655
       655
       +
                       token_endpoint_auth_signing_alg: None,

     

       656
       656
       +
                   },

     

       657
       657
       +
                   keyset: None,

     

       658
       658
       +
               }

     

       659
       659
       +
           }

     

       660
       660
       +
       

     

       661
       661
       +
           #[tokio::test]

     

       662
       662
       +
           async fn par_missing_endpoint() {

     

       663
       663
       +
               let mut meta = base_metadata();

     

       664
       664
       +
               meta.server_metadata.require_pushed_authorization_requests = Some(true);

     

       665
       665
       +
               meta.server_metadata.pushed_authorization_request_endpoint = None;

     

       666
       666
       +
               // require_pushed_authorization_requests is true and no endpoint

     

       667
       667
       +
               let err = super::par(&MockClient::default(), None, None, &meta)

     

       668
       668
       +
                   .await

     

       669
       669
       +
                   .unwrap_err();

     

       670
       670
       +
               match err {

     

       671
       671
       +
                   RequestError::NoEndpoint(name) => {

     

       672
       672
       +
                       assert_eq!(name.as_ref(), "pushed_authorization_request");

     

       673
       673
       +
                   }

     

       674
       674
       +
                   other => panic!("unexpected: {other:?}"),

     

       675
       675
       +
               }

     

       676
       676
       +
           }

     

       677
       677
       +
       

     

       678
       678
       +
           #[tokio::test]

     

       679
       679
       +
           async fn refresh_no_refresh_token() {

     

       680
       680
       +
               let client = MockClient::default();

     

       681
       681
       +
               let meta = base_metadata();

     

       682
       682
       +
               let session = ClientSessionData {

     

       683
       683
       +
                   account_did: jacquard_common::types::string::Did::new_static("did:plc:alice").unwrap(),

     

       684
       684
       +
                   session_id: CowStr::from("state"),

     

       685
       685
       +
                   host_url: url::Url::parse("https://pds").unwrap(),

     

       686
       686
       +
                   authserver_url: url::Url::parse("https://issuer").unwrap(),

     

       687
       687
       +
                   authserver_token_endpoint: CowStr::from("https://issuer/token"),

     

       688
       688
       +
                   authserver_revocation_endpoint: None,

     

       689
       689
       +
                   scopes: vec![],

     

       690
       690
       +
                   dpop_data: DpopClientData {

     

       691
       691
       +
                       dpop_key: crate::utils::generate_key(&[CowStr::from("ES256")]).unwrap(),

     

       692
       692
       +
                       dpop_authserver_nonce: CowStr::from(""),

     

       693
       693
       +
                       dpop_host_nonce: CowStr::from(""),

     

       694
       694
       +
                   },

     

       695
       695
       +
                   token_set: crate::types::TokenSet {

     

       696
       696
       +
                       iss: CowStr::from("https://issuer"),

     

       697
       697
       +
                       sub: jacquard_common::types::string::Did::new_static("did:plc:alice").unwrap(),

     

       698
       698
       +
                       aud: CowStr::from("https://pds"),

     

       699
       699
       +
                       scope: None,

     

       700
       700
       +
                       refresh_token: None,

     

       701
       701
       +
                       access_token: CowStr::from("abc"),

     

       702
       702
       +
                       token_type: crate::types::OAuthTokenType::DPoP,

     

       703
       703
       +
                       expires_at: None,

     

       704
       704
       +
                   },

     

       705
       705
       +
               };

     

       706
       706
       +
               let err = super::refresh(&client, session, &meta).await.unwrap_err();

     

       707
       707
       +
               matches!(err, RequestError::NoRefreshToken);

     

       708
       708
       +
           }

     

       709
       709
       +
       

     

       710
       710
       +
           #[tokio::test]

     

       711
       711
       +
           async fn exchange_code_missing_sub() {

     

       712
       712
       +
               let client = MockClient::default();

     

       713
       713
       +
               // set mock HTTP response body: token response without `sub`

     

       714
       714
       +
               *client.resp.lock().await = Some(

     

       715
       715
       +
                   HttpResponse::builder()

     

       716
       716
       +
                       .status(StatusCode::OK)

     

       717
       717
       +
                       .body(

     

       718
       718
       +
                           serde_json::to_vec(&serde_json::json!({

     

       719
       719
       +
                               "access_token":"tok",

     

       720
       720
       +
                               "token_type":"DPoP",

     

       721
       721
       +
                               "expires_in": 3600

     

       722
       722
       +
                           }))

     

       723
       723
       +
                           .unwrap(),

     

       724
       724
       +
                       )

     

       725
       725
       +
                       .unwrap(),

     

       726
       726
       +
               );

     

       727
       727
       +
               let meta = base_metadata();

     

       728
       728
       +
               let mut dpop = DpopReqData {

     

       729
       729
       +
                   dpop_key: crate::utils::generate_key(&[CowStr::from("ES256")]).unwrap(),

     

       730
       730
       +
                   dpop_authserver_nonce: None,

     

       731
       731
       +
               };

     

       732
       732
       +
               let err = super::exchange_code(&client, &mut dpop, "abc", "verifier", &meta)

     

       733
       733
       +
                   .await

     

       734
       734
       +
                   .unwrap_err();

     

       735
       735
       +
               matches!(err, RequestError::TokenVerification);

     

       736
       736
       +
           }

     

       737
       737
       +
       }

+2 -2

crates/jacquard-oauth/src/scopes.rs

···

       1
       1
       -
       //! AT Protocol OAuth scopes module

     

       2
       2
       -
       //! Derived from https://tangled.org/@smokesignal.events/atproto-identity-rs/raw/main/crates/atproto-oauth/src/scopes.rs

     

       1
       1
       +
       //! AT Protocol OAuth scopes

     

       2
       2
       +
       //! Derived from <https://tangled.org/@smokesignal.events/atproto-identity-rs/raw/main/crates/atproto-oauth/src/scopes.rs>

     

       3
       3
        
       //!

     

       4
       4
        
       //! This module provides comprehensive support for AT Protocol OAuth scopes,

     

       5
       5
        
       //! including parsing, serialization, normalization, and permission checking.

+58 -52

crates/jacquard/src/lib.rs

···

       3
       3
        
       //! A suite of Rust crates for the AT Protocol.

     

       4
       4
        
       //!

     

       5
       5
        
       //!

     

       6
       6
       -
       //! ## Goals

     

       6
       6
       +
       //! ## Goals and Features

     

       7
       7
        
       //!

     

       8
       8
       -
       //! - Validated, spec-compliant, easy to work with, and performant baseline types (including typed at:// uris)

     

       8
       8
       +
       //! - Validated, spec-compliant, easy to work with, and performant baseline types

     

       9
       9
        
       //! - Batteries-included, but easily replaceable batteries.

     

       10
       10
        
       //!   - Easy to extend with custom lexicons

     

       11
       11
       +
       //!   - Straightforward OAuth

     

       12
       12
       +
       //!   - stateless options (or options where you handle the state) for rolling your own

     

       13
       13
       +
       //!   - all the building blocks of the convenient abstractions are available

     

       11
       14
        
       //! - lexicon Value type for working with unknown atproto data (dag-cbor or json)

     

       12
       15
        
       //! - order of magnitude less boilerplate than some existing crates

     

       13
       13
       -
       //!   - either the codegen produces code that's easy to work with, or there are good handwritten wrappers

     

       14
       14
       -
       //! - didDoc type with helper methods for getting handles, multikey, and PDS endpoint

     

       15
       16
        
       //! - use as much or as little from the crates as you need

     

       17
       17
       +
       //!

     

       16
       18
        
       //!

     

       17
       19
        
       //!

     

       18
       20
        
       //! ## Example

     

       19
       21
        
       //!

     

       20
       20
       -
       //! Dead simple API client: login with an app password, then fetch the latest 5 posts.

     

       22
       22
       +
       //! Dead simple API client: login with OAuth, then fetch the latest 5 posts.

     

       21
       23
        
       //!

     

       22
       24
        
       //! ```no_run

     

       23
       25
        
       //! # use clap::Parser;

     

       24
       26
        
       //! # use jacquard::CowStr;

     

       25
       25
       -
       //! use std::sync::Arc;

     

       26
       27
        
       //! use jacquard::api::app_bsky::feed::get_timeline::GetTimeline;

     

       27
       28
        
       //! use jacquard::client::credential_session::{CredentialSession, SessionKey};

     

       28
       28
       -
       //! use jacquard::client::{AtpSession, FileAuthStore, MemorySessionStore};

     

       29
       29
       -
       //! use jacquard::identity::PublicResolver as JacquardResolver;

     

       29
       29
       +
       //! use jacquard::client::{Agent, FileAuthStore};

     

       30
       30
       +
       //! use jacquard::oauth::atproto::AtprotoClientMetadata;

     

       31
       31
       +
       //! use jacquard::oauth::client::OAuthClient;

     

       30
       32
        
       //! use jacquard::types::xrpc::XrpcClient;

     

       33
       33
       +
       //! # #[cfg(feature = "loopback")]

     

       34
       34
       +
       //! use jacquard::oauth::loopback::LoopbackConfig;

     

       31
       35
        
       //! # use miette::IntoDiagnostic;

     

       32
       36
        
       //!

     

       33
       37
        
       //! # #[derive(Parser, Debug)]

     

       34
       34
       -
       //! # #[command(author, version, about = "Jacquard - AT Protocol client demo")]

     

       38
       38
       +
       //! # #[command(author, version, about = "Jacquard - OAuth (DPoP) loopback demo")]

     

       35
       39
        
       //! # struct Args {

     

       36
       36
       -
       //! #     /// Username/handle (e.g., alice.bsky.social) or DID

     

       37
       37
       -
       //! #     #[arg(short, long)]

     

       38
       38
       -
       //! #     username: CowStr<'static>,

     

       40
       40
       +
       //! #     /// Handle (e.g., alice.bsky.social), DID, or PDS URL

     

       41
       41
       +
       //! #     input: CowStr<'static>,

     

       39
       42
        
       //! #

     

       40
       40
       -
       //! #     /// App password

     

       41
       41
       -
       //! #     #[arg(short, long)]

     

       42
       42
       -
       //! #     password: CowStr<'static>,

     

       43
       43
       +
       //! #     /// Path to auth store file (will be created if missing)

     

       44
       44
       +
       //! #     #[arg(long, default_value = "/tmp/jacquard-oauth-session.json")]

     

       45
       45
       +
       //! #     store: String,

     

       43
       46
        
       //! # }

     

       44
       44
       -
       //!

     

       47
       47
       +
       //! #

     

       45
       48
        
       //! #[tokio::main]

     

       46
       49
        
       //! async fn main() -> miette::Result<()> {

     

       47
       50
        
       //!     let args = Args::parse();

     

       48
       48
       -
       //!     // Resolver + storage

     

       49
       49
       -
       //!     let resolver = Arc::new(JacquardResolver::default());

     

       50
       50
       -
       //!     let store: Arc<MemorySessionStore<SessionKey, AtpSession>> = Arc::new(Default::default());

     

       51
       51
       -
       //!     let client = Arc::new(resolver.clone());

     

       52
       52
       -
       //!     // Create session object with implicit public appview endpoint until login/restore

     

       53
       53
       -
       //!     let session = CredentialSession::new(store, client);

     

       54
       54
       -
       //!     // Log in (resolves PDS automatically) and persist as (did, "session")

     

       55
       55
       -
       //!     session

     

       56
       56
       -
       //!         .login(args.username.clone(), args.password.clone(), None, None, None)

     

       57
       57
       -
       //!         .await

     

       58
       58
       -
       //!         .into_diagnostic()?;

     

       59
       59
       -
       //!     // Fetch timeline

     

       60
       60
       -
       //!     let timeline = session

     

       51
       51
       +
       //!

     

       52
       52
       +
       //!     // File-backed auth store shared by OAuthClient and session registry

     

       53
       53
       +
       //!     let store = FileAuthStore::new(&args.store);

     

       54
       54
       +
       //!     let client_data = jacquard_oauth::session::ClientData {

     

       55
       55
       +
       //!         keyset: None,

     

       56
       56
       +
       //!         // Default sets normal localhost redirect URIs and "atproto transition:generic" scopes.

     

       57
       57
       +
       //!         // The localhost helper will ensure you have at least "atproto" and will fix urls

     

       58
       58
       +
       //!         config: AtprotoClientMetadata::default_localhost(),

     

       59
       59
       +
       //!     };

     

       60
       60
       +
       //!

     

       61
       61
       +
       //!     // Build an OAuth client (this is reusable, and can create multiple sessions)

     

       62
       62
       +
       //!     let oauth = OAuthClient::new(store, client_data);

     

       63
       63
       +
       //!     // Authenticate with a PDS, using a loopback server to handle the callback flow

     

       64
       64
       +
       //! #   #[cfg(feature = "loopback")]

     

       65
       65
       +
       //!     let session = oauth

     

       66
       66
       +
       //!        .login_with_local_server(

     

       67
       67
       +
       //!            args.input.clone(),

     

       68
       68
       +
       //!            Default::default(),

     

       69
       69
       +
       //!            LoopbackConfig::default(),

     

       70
       70
       +
       //!        )

     

       71
       71
       +
       //!        .await?;

     

       72
       72
       +
       //! #   #[cfg(not(feature = "loopback"))]

     

       73
       73
       +
       //! #   compile_error!("loopback feature must be enabled to run this example");

     

       74
       74
       +
       //!     // Wrap in Agent and fetch the timeline

     

       75
       75
       +
       //!     let agent: Agent<_> = Agent::from(session);

     

       76
       76
       +
       //!     let timeline = agent

     

       61
       77
        
       //!         .send(&GetTimeline::new().limit(5).build())

     

       62
       62
       -
       //!         .await

     

       63
       63
       -
       //!         .into_diagnostic()?

     

       64
       64
       -
       //!         .into_output()

     

       65
       65
       -
       //!         .into_diagnostic()?;

     

       66
       66
       -
       //!     println!("timeline ({} posts):", timeline.feed.len());

     

       78
       78
       +
       //!         .await?

     

       79
       79
       +
       //!         .into_output()?;

     

       67
       80
        
       //!     for (i, post) in timeline.feed.iter().enumerate() {

     

       68
       68
       -
       //!         println!("{}. by {}", i + 1, post.post.author.handle);

     

       81
       81
       +
       //!         println!("\n{}. by {}", i + 1, post.post.author.handle);

     

       82
       82
       +
       //!         println!(

     

       83
       83
       +
       //!             "   {}",

     

       84
       84
       +
       //!             serde_json::to_string_pretty(&post.post.record).into_diagnostic()?

     

       85
       85
       +
       //!         );

     

       69
       86
        
       //!     }

     

       70
       87
        
       //!     Ok(())

     

       71
       71
       -
       //! }

     

       88
       88
       +
       //!}

     

       72
       89
        
       //! ```

     

       73
       90
        
       //!

     

       74
       91
        
       //! ## Client options:

     
···

       102
       119
        
       //!   }

     

       103
       120
        
       //!   ```

     

       104
       121
        
       //! - Stateful client (app-password): `CredentialSession<S, T>` where `S: SessionStore<(Did, CowStr), AtpSession>` and

     

       105
       105
       -
       //!   `T: IdentityResolver + HttpClient + XrpcExt`. It auto-attaches Authorization, refreshes on expiry, and updates the

     

       122
       122
       +
       //!   `T: IdentityResolver + HttpClient`. It auto-attaches bearer authorization, refreshes on expiry, and updates the

     

       106
       123
        
       //!   base endpoint to the user's PDS on login/restore.

     

       124
       124
       +
       //! - Stateful client (OAuth): `OAuthClient<S, T>` and `OAuthSession<S, T>` where `S: ClientAuthStore` and

     

       125
       125
       +
       //!   `T: OAuthResolver + HttpClient`. The client is used to authenticate, returning a session which handles authentication and token refresh internally.

     

       126
       126
       +
       //! - `Agent<A: AgentSession>` Session abstracts over the above two options. Currently it is a thin wrapper, but this will be the thing that gets all the convenience helpers.

     

       107
       127
        
       //!

     

       108
       128
        
       //! Per-request overrides (stateless)

     

       109
       129
        
       //! ```no_run

     
···

       135
       155
        
       //!     Ok(())

     

       136
       156
        
       //! }

     

       137
       157
        
       //! ```

     

       138
       138
       -
       //!

     

       139
       139
       -
       //! Token storage:

     

       140
       140
       -
       //! - Use `MemorySessionStore<SessionKey, AtpSession>` for ephemeral sessions and tests.

     

       141
       141
       -
       //! - For persistence, wrap the file store: `FileAuthStore::new(path)` implements SessionStore for app-password sessions

     

       142
       142
       -
       //!   and OAuth `ClientAuthStore` (unified on-disk map).

     

       143
       143
       -
       //!   ```no_run

     

       144
       144
       -
       //!   use std::sync::Arc;

     

       145
       145
       -
       //!   use jacquard::client::credential_session::{CredentialSession, SessionKey};

     

       146
       146
       -
       //!   use jacquard::client::{AtpSession, FileAuthStore};

     

       147
       147
       -
       //!   use jacquard::identity::PublicResolver;

     

       148
       148
       -
       //!   let store = Arc::new(FileAuthStore::new("/tmp/jacquard-session.json"));

     

       149
       149
       -
       //!   let client = Arc::new(PublicResolver::default());

     

       150
       150
       -
       //!   let session = CredentialSession::new(store, client);

     

       151
       151
       -
       //!   ```

     

       152
       152
       -
       //!

     

       153
       158
        
       

     

       154
       159
        
       #![warn(missing_docs)]

     

       155
       160
        
       

     
···

       167
       172
        
       pub use jacquard_derive::*;

     

       168
       173
        
       

     

       169
       174
        
       pub use jacquard_identity as identity;

     

       175
       175
       +
       pub use jacquard_oauth as oauth;

+35 -16

crates/jacquard/src/main.rs

···

       1
       1
        
       use clap::Parser;

     

       2
       2
        
       use jacquard::CowStr;

     

       3
       3
       +
       use jacquard::api::app_bsky::feed::get_timeline::GetTimeline;

     

       3
       4
        
       use jacquard::client::{Agent, FileAuthStore};

     

       5
       5
       +
       use jacquard::oauth::atproto::AtprotoClientMetadata;

     

       6
       6
       +
       use jacquard::oauth::client::OAuthClient;

     

       7
       7
       +
       #[cfg(feature = "loopback")]

     

       8
       8
       +
       use jacquard::oauth::loopback::LoopbackConfig;

     

       4
       9
        
       use jacquard::types::xrpc::XrpcClient;

     

       5
       5
       -
       use jacquard_api::app_bsky::feed::get_timeline::GetTimeline;

     

       6
       6
       -
       use jacquard_oauth::atproto::AtprotoClientMetadata;

     

       7
       7
       -
       use jacquard_oauth::client::OAuthClient;

     

       8
       8
       -
       #[cfg(feature = "loopback")]

     

       9
       9
       -
       use jacquard_oauth::loopback::LoopbackConfig;

     

       10
       10
       -
       use jacquard_oauth::scopes::Scope;

     

       10
       10
       +
       #[cfg(not(feature = "loopback"))]

     

       11
       11
       +
       use jacquard_oauth::types::AuthorizeOptions;

     

       11
       12
        
       use miette::IntoDiagnostic;

     

       12
       13
        
       

     

       13
       14
        
       #[derive(Parser, Debug)]

     
···

       25
       26
        
       async fn main() -> miette::Result<()> {

     

       26
       27
        
           let args = Args::parse();

     

       27
       28
        
       

     

       28
       28
       -
           // File-backed auth store shared by OAuthClient and session registry

     

       29
       29
       +
           // File-backed auth store for testing

     

       29
       30
        
           let store = FileAuthStore::new(&args.store);

     

       30
       31
        
       

     

       31
       32
        
           // Minimal localhost client metadata (redirect_uris get set by loopback helper)

     

       32
       33
        
           let client_data = jacquard_oauth::session::ClientData {

     

       33
       34
        
               keyset: None,

     

       34
       34
       -
               // scopes: include atproto; redirect_uris will be populated by the loopback helper

     

       35
       35
       -
               config: AtprotoClientMetadata::new_localhost(None, Some(vec![Scope::Atproto])),

     

       35
       35
       +
               // Default sets normal localhost redirect URIs and "atproto transition:generic" scopes.

     

       36
       36
       +
               // The localhost helper will ensure you have at least "atproto" and will fix urls

     

       37
       37
       +
               config: AtprotoClientMetadata::default_localhost(),

     

       36
       38
        
           };

     

       37
       39
        
       

     

       38
       38
       -
           // Build an OAuth client and run loopback flow

     

       40
       40
       +
           // Build an OAuth client

     

       39
       41
        
           let oauth = OAuthClient::new(store, client_data);

     

       40
       42
        
       

     

       41
       43
        
           #[cfg(feature = "loopback")]

     

       44
       44
       +
           // Authenticate with a PDS, using a loopback server to handle the callback flow

     

       42
       45
        
           let session = oauth

     

       43
       46
        
               .login_with_local_server(

     

       44
       47
        
                   args.input.clone(),

     

       45
       48
        
                   Default::default(),

     

       46
       49
        
                   LoopbackConfig::default(),

     

       47
       50
        
               )

     

       48
       48
       -
               .await

     

       49
       49
       -
               .into_diagnostic()?;

     

       51
       51
       +
               .await?;

     

       50
       52
        
       

     

       51
       53
        
           #[cfg(not(feature = "loopback"))]

     

       52
       52
       -
           compile_error!("loopback feature must be enabled to run this example");

     

       54
       54
       +
           let session = {

     

       55
       55
       +
               use std::io::{BufRead, Write, stdin, stdout};

     

       56
       56
       +
       

     

       57
       57
       +
               let auth_url = oauth

     

       58
       58
       +
                   .start_auth(args.input, AuthorizeOptions::default())

     

       59
       59
       +
                   .await?;

     

       60
       60
       +
       

     

       61
       61
       +
               println!("To authenticate with your PDS, visit:\n{}\n", auth_url);

     

       62
       62
       +
               print!("\nPaste the callback url here:");

     

       63
       63
       +
               stdout().lock().flush().into_diagnostic()?;

     

       64
       64
       +
               let mut url = String::new();

     

       65
       65
       +
               stdin().lock().read_line(&mut url).into_diagnostic()?;

     

       66
       66
       +
       

     

       67
       67
       +
               let uri = url.trim().parse::<http::Uri>().into_diagnostic()?;

     

       68
       68
       +
               let params =

     

       69
       69
       +
                   serde_html_form::from_str(uri.query().ok_or(miette::miette!("invalid callback url"))?)

     

       70
       70
       +
                       .into_diagnostic()?;

     

       71
       71
       +
               oauth.callback(params).await?

     

       72
       72
       +
           };

     

       53
       73
        
       

     

       54
       54
       -
           // Wrap in Agent and call a simple resource endpoint

     

       74
       74
       +
           // Wrap in Agent and fetch the timeline

     

       55
       75
        
           let agent: Agent<_> = Agent::from(session);

     

       56
       76
        
           let timeline = agent

     

       57
       77
        
               .send(&GetTimeline::new().limit(5).build())

     

       58
       58
       -
               .await

     

       59
       59
       -
               .into_diagnostic()?

     

       78
       78
       +
               .await?

     

       60
       79
        
               .into_output()?;

     

       61
       80
        
           for (i, post) in timeline.feed.iter().enumerate() {

     

       62
       81
        
               println!("\n{}. by {}", i + 1, post.post.author.handle);