splinter 0.6.14

Splinter is a privacy-focused platform for distributed applications that provides a blockchain-inspired networking environment for communication and transactions between organizations.
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

// Copyright 2018-2022 Cargill Incorporated
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Memory-backed InflightOAuthRequestStore implementation.

use std::sync::{Arc, Mutex};
use std::time::Duration;

use crate::collections::TtlMap;
use crate::error::{ConstraintViolationError, ConstraintViolationType, InternalError};
use crate::oauth::PendingAuthorization;

use super::{InflightOAuthRequestStore, InflightOAuthRequestStoreError};

/// The amount of time before a pending authorization expires and a new request must be made
const PENDING_AUTHORIZATION_EXPIRATION_SECS: u64 = 3600; // 1 hour

/// A memory-backed implementation of InflightOAuthRequestStore.
///
/// Values in this store expire after an hour.
#[derive(Clone)]
pub struct MemoryInflightOAuthRequestStore {
    pending_authorizations: Arc<Mutex<TtlMap<String, PendingAuthorization>>>,
}

impl MemoryInflightOAuthRequestStore {
    /// Constructs a new instance.
    pub fn new() -> Self {
        Self {
            pending_authorizations: Arc::new(Mutex::new(TtlMap::new(Duration::from_secs(
                PENDING_AUTHORIZATION_EXPIRATION_SECS,
            )))),
        }
    }
}

impl Default for MemoryInflightOAuthRequestStore {
    fn default() -> Self {
        Self::new()
    }
}

impl InflightOAuthRequestStore for MemoryInflightOAuthRequestStore {
    fn insert_request(
        &self,
        request_id: String,
        pending_authorization: PendingAuthorization,
    ) -> Result<(), InflightOAuthRequestStoreError> {
        let mut inner = self.pending_authorizations.lock().map_err(|_| {
            InternalError::with_message("pending authorizations lock was poisoned".into())
        })?;

        if !inner.contains_key(&request_id) {
            inner.insert(request_id, pending_authorization);
            Ok(())
        } else {
            Err(InflightOAuthRequestStoreError::ConstraintViolation(
                ConstraintViolationError::with_violation_type(ConstraintViolationType::Unique),
            ))
        }
    }

    fn remove_request(
        &self,
        request_id: &str,
    ) -> Result<Option<PendingAuthorization>, InflightOAuthRequestStoreError> {
        Ok(self
            .pending_authorizations
            .lock()
            .map_err(|_| {
                InternalError::with_message("pending authorizations lock was poisoned".into())
            })?
            .remove(request_id))
    }

    fn clone_box(&self) -> Box<dyn InflightOAuthRequestStore> {
        Box::new(self.clone())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use crate::oauth::store::tests::{
        test_duplicate_id_insert, test_request_store_insert_and_remove,
    };

    #[test]
    fn memory_insert_request_and_remove() {
        let inflight_request_store = MemoryInflightOAuthRequestStore::new();
        test_request_store_insert_and_remove(&inflight_request_store);
    }

    #[test]
    fn memory_duplicate_id_insert() {
        let inflight_request_store = MemoryInflightOAuthRequestStore::new();
        test_duplicate_id_insert(&inflight_request_store);
    }
}