reqsign_core/
signer.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use crate::{Context, Error, ProvideCredential, Result, SignRequest, SigningCredential};
19use std::any::type_name;
20use std::sync::{Arc, Mutex};
21use std::time::Duration;
22
23/// Signer is the main struct used to sign the request.
24#[derive(Clone, Debug)]
25pub struct Signer<K: SigningCredential> {
26    ctx: Context,
27    loader: Arc<dyn ProvideCredential<Credential = K>>,
28    builder: Arc<dyn SignRequest<Credential = K>>,
29    credential: Arc<Mutex<Option<K>>>,
30}
31
32impl<K: SigningCredential> Signer<K> {
33    /// Create a new signer.
34    pub fn new(
35        ctx: Context,
36        loader: impl ProvideCredential<Credential = K>,
37        builder: impl SignRequest<Credential = K>,
38    ) -> Self {
39        Self {
40            ctx,
41
42            loader: Arc::new(loader),
43            builder: Arc::new(builder),
44            credential: Arc::new(Mutex::new(None)),
45        }
46    }
47
48    /// Replace the context while keeping credential provider and request signer.
49    pub fn with_context(mut self, ctx: Context) -> Self {
50        self.ctx = ctx;
51        self
52    }
53
54    /// Replace the credential provider while keeping context and request signer.
55    pub fn with_credential_provider(
56        mut self,
57        provider: impl ProvideCredential<Credential = K>,
58    ) -> Self {
59        self.loader = Arc::new(provider);
60        self.credential = Arc::new(Mutex::new(None)); // Clear cached credential
61        self
62    }
63
64    /// Replace the request signer while keeping context and credential provider.
65    pub fn with_request_signer(mut self, signer: impl SignRequest<Credential = K>) -> Self {
66        self.builder = Arc::new(signer);
67        self
68    }
69
70    /// Signing request.
71    pub async fn sign(
72        &self,
73        req: &mut http::request::Parts,
74        expires_in: Option<Duration>,
75    ) -> Result<()> {
76        let credential = self.credential.lock().expect("lock poisoned").clone();
77        let credential = if credential.is_valid() {
78            credential
79        } else {
80            let ctx = self.loader.provide_credential(&self.ctx).await?;
81            *self.credential.lock().expect("lock poisoned") = ctx.clone();
82            ctx
83        };
84
85        let credential_ref = credential.as_ref().ok_or_else(|| {
86            Error::credential_invalid("failed to load signing credential")
87                .with_context(format!("credential_type: {}", type_name::<K>()))
88        })?;
89
90        self.builder
91            .sign_request(&self.ctx, req, Some(credential_ref), expires_in)
92            .await
93    }
94}
reqsign_core/signer.rs

reqsign_core/
signer.rs
