openid-client 1.0.0-alpha.7

OpenID client for Rust
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

use std::error::Error as StdError;
use std::fmt::{Display, Formatter, Result as FmtResult};

use serde::Deserialize;

/// The return type of the methods used in this library
pub type OidcReturn<T> = Result<T, OpenIdError>;

/// # StandardBodyError
/// Error that is returned from the OpenID Server
/// - [Error Response](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2.1)
#[derive(Debug, Deserialize)]
pub struct StandardBodyError {
    /// Short title of the error
    pub error: String,
    /// Description of the error
    pub error_description: Option<String>,
    /// Error uri
    pub error_uri: Option<String>,
}

/// # Error
/// General Error returned when anything unexpected happens
#[derive(Debug)]
pub struct Error {
    /// Error Message
    pub message: String,
}

/// # ClientError
/// Error related to the Client response expectations
#[derive(Debug)]
pub struct ClientError {
    /// Error Message
    pub message: String,
}

/// # OpenIdError
/// Error returned for all things related to `openid_client`
#[derive(Debug)]
pub enum OpenIdError {
    /// [Error]
    Error(Error),
    /// [ClientError]
    ClientError(ClientError),
    /// [StandardBodyError]
    OPError(StandardBodyError),
}

impl Display for OpenIdError {
    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
        match self {
            OpenIdError::Error(err) => write!(f, "Error: {}", err.message),
            OpenIdError::ClientError(err) => write!(f, "Client error: {}", err.message),
            OpenIdError::OPError(err) => write!(
                f,
                "OpenId server error: {}, description {:?}",
                err.error, err.error_description
            ),
        }
    }
}

impl StdError for OpenIdError {}

impl OpenIdError {
    pub(crate) fn new_error(message: impl Into<String>) -> OpenIdError {
        OpenIdError::Error(Error {
            message: message.into(),
        })
    }

    pub(crate) fn new_client_error(message: impl Into<String>) -> OpenIdError {
        OpenIdError::ClientError(ClientError {
            message: message.into(),
        })
    }

    pub(crate) fn new_op_error(
        error: impl Into<String>,
        error_description: Option<String>,
        error_uri: Option<String>,
    ) -> OpenIdError {
        OpenIdError::OPError(StandardBodyError {
            error: error.into(),
            error_description,
            error_uri,
        })
    }
}