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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

// 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.

use std::error::Error;
use std::fmt;

use jsonwebtoken::errors::{Error as JWTError, ErrorKind};

use crate::rest_api::secrets::SecretManagerError;

/// Error for TokenIssuer
#[derive(Debug)]
pub enum TokenIssuerError {
    /// Returned when the TokenIssuer fails to encode a Token
    EncodingError(Box<dyn Error>),
    /// Returned when the TokenIssuer fails to get a valid secret
    SecretError(Box<dyn Error>),
}

impl Error for TokenIssuerError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            TokenIssuerError::EncodingError(err) => Some(&**err),
            TokenIssuerError::SecretError(err) => Some(&**err),
        }
    }
}

impl fmt::Display for TokenIssuerError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            TokenIssuerError::EncodingError(ref s) => write!(f, "failed to issue token: {}", s),
            TokenIssuerError::SecretError(ref s) => write!(f, "failed to fetch secret: {}", s),
        }
    }
}

impl From<JWTError> for TokenIssuerError {
    fn from(err: JWTError) -> TokenIssuerError {
        TokenIssuerError::EncodingError(Box::new(err))
    }
}

impl From<SecretManagerError> for TokenIssuerError {
    fn from(err: SecretManagerError) -> TokenIssuerError {
        TokenIssuerError::SecretError(Box::new(err))
    }
}

/// Error for ClaimsBuilder
#[derive(Debug)]
pub enum ClaimsBuildError {
    /// Returned if a required field is missing
    MissingRequiredField(String),
    /// Returned if a invalid value was provided to the builder
    InvalidValue(String),
}

impl Error for ClaimsBuildError {}

impl fmt::Display for ClaimsBuildError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            ClaimsBuildError::MissingRequiredField(ref s) => {
                write!(f, "failed to build claim: {}", s)
            }
            ClaimsBuildError::InvalidValue(ref s) => write!(f, "failed to build claim: {}", s),
        }
    }
}

/// Error for token validation
#[derive(Debug)]
pub enum TokenValidationError {
    /// Returned when validation fails
    ValidationError(Box<dyn Error>),
    /// Returned when the claims in the token are invalid
    InvalidClaim(String),
}

impl Error for TokenValidationError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        match self {
            TokenValidationError::ValidationError(err) => Some(&**err),
            TokenValidationError::InvalidClaim(_) => None,
        }
    }
}

impl fmt::Display for TokenValidationError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        match *self {
            TokenValidationError::ValidationError(ref s) => {
                write!(f, "failed to validate claim: {}", s)
            }
            TokenValidationError::InvalidClaim(ref s) => write!(f, "claim is invalid: {}", s),
        }
    }
}

impl From<JWTError> for TokenValidationError {
    fn from(err: JWTError) -> TokenValidationError {
        match err.kind() {
            ErrorKind::InvalidToken => {
                TokenValidationError::InvalidClaim("Token is not valid JWT".to_string())
            }
            ErrorKind::InvalidSignature => {
                TokenValidationError::InvalidClaim("Token signature is not valid".to_string())
            }
            ErrorKind::InvalidAlgorithmName => {
                TokenValidationError::InvalidClaim("Provided algorithm is not valid".to_string())
            }
            ErrorKind::ExpiredSignature => {
                TokenValidationError::InvalidClaim("The token has expired".to_string())
            }
            ErrorKind::InvalidIssuer => {
                TokenValidationError::InvalidClaim("The token has an invalid issuer".to_string())
            }
            ErrorKind::InvalidAudience => {
                TokenValidationError::InvalidClaim("The token has an invalid audience".to_string())
            }
            ErrorKind::InvalidSubject => {
                TokenValidationError::InvalidClaim("The token has an invalid subject".to_string())
            }
            ErrorKind::ImmatureSignature => {
                TokenValidationError::InvalidClaim("The token is not valid yet".to_string())
            }
            ErrorKind::InvalidAlgorithm => {
                TokenValidationError::InvalidClaim("Provided algorithm is not valid".to_string())
            }

            ErrorKind::InvalidEcdsaKey => TokenValidationError::ValidationError(Box::new(err)),
            ErrorKind::InvalidRsaKey => TokenValidationError::ValidationError(Box::new(err)),
            _ => TokenValidationError::ValidationError(Box::new(err)),
        }
    }
}