scion_sdk_reqwest_connect_rpc/token_source.rs
1// Copyright 2025 Anapaya Systems
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//! Token source trait for the connect RPC client.
15
16use async_trait::async_trait;
17
18pub mod refresh;
19pub mod static_token;
20
21/// The error type for token sources.
22pub type TokenSourceError = Box<dyn std::error::Error + Sync + Send>;
23
24/// A source for authentication tokens.
25#[async_trait]
26pub trait TokenSource: Send + Sync + 'static {
27 /// Gets a token, possibly refreshing it.
28 async fn get_token(&self) -> Result<String, TokenSourceError>;
29
30 /// Formats the token for use in an `Authorization` header.
31 ///
32 /// The default implementation formats the token as a Bearer token.
33 /// Override this method if a different format is required.
34 fn format_header(&self, token: String) -> String {
35 format!("Bearer {token}")
36 }
37}