hive-client 0.0.6

A Rust client for interfacing with Hive smart home systems.
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

use crate::client::authentication::ChallengeRequest;
use aws_cognito_srp::SrpError;
use aws_sdk_cognitoidentityprovider::error::SdkError;
use thiserror::Error;

#[derive(Error, Debug)]
#[error(transparent)]
#[non_exhaustive]
/// Errors that can occur while trying to communicate with the Hive Authentication servers.
pub enum AuthenticationError {
    #[error("The session token was not found in the response")]
    /// No Access Token was issued in the response from the Hive authentication servers.
    InvalidAccessToken,

    #[error("The presented challenge is not supported. Challenge was: {0}")]
    /// The challenge presented by the Hive authentication servers is not supported by this crate.
    UnsupportedChallenge(String),

    #[error(transparent)]
    /// The request to begin the authentication flow failed.
    LoginFailed(
        #[from]
        SdkError<aws_sdk_cognitoidentityprovider::operation::initiate_auth::InitiateAuthError>,
    ),

    #[error(transparent)]
    /// The request to respond to a challenge during the authentication flow failed.
    ChallengeFailed(
        #[from]
        SdkError<aws_sdk_cognitoidentityprovider::operation::respond_to_auth_challenge::RespondToAuthChallengeError>,
    ),

    #[error("The challenge was not handled correctly")]
    /// A parameter which was expected to be present in the challenge was not found.
    MissingChallengeParameter(String),

    #[error("An error occurred while trying to authenticate the user")]
    /// An error occured while trying to complete the [Secure Remote Password (SRP)](https://github.com/ryanmab/aws-cognito-srp) authentication challenges.
    SrpFailed(
        #[from]
        SrpError,
    ),

    #[error("A challenge was requested")]
    /// A challenge was requested by the Hive authentication servers which requires manual intervention.
    ///
    /// For example, a SMS MFA code was sent to the user's phone number.
    NextChallenge(ChallengeRequest),

    /// The request to confirm the device (to make it a [`crate::authentication::TrustedDevice`]) failed.
    DeviceConfirmationError(
        #[from]
        DeviceConfirmationError
    ),

    #[error("There is currently no valid authentication in progress")]
    /// There is no authentication flow currently in progress, and the user is not logged in.
    NoAuthenticationInProgress,
}

#[derive(Error, Debug)]
#[error(transparent)]
/// Errors that can occur while trying to refresh an existing authentication.
pub enum RefreshError {
    #[error(
        "The request to refresh the authentication tokens failed as the access token could not be validated"
    )]
    /// The request to refresh the authentication tokens failed as the access token could
    /// not be validated.
    InvalidAccessToken,

    #[error("The request to refresh the authentication tokens failed")]
    /// The request to refresh the authentication tokens failed.
    RequestFailed(String),

    #[error("There is currently no valid authentication in progress")]
    /// There is no authentication flow currently in progress, and the user is not logged in.
    NotLoggedIn,
}

#[derive(Error, Debug)]
#[error(transparent)]
/// Errors that can occur while trying to confirm a device in order to
/// make it a [`crate::authentication::TrustedDevice`].
pub enum DeviceConfirmationError {
    #[error(transparent)]
    /// The request to confirm the device failed.
    ConfirmationFailed(
        #[from]
        SdkError<aws_sdk_cognitoidentityprovider::operation::confirm_device::ConfirmDeviceError>,
    ),

    #[error(transparent)]
    /// The request to update the device status failed.
    StatusUpdateFailed(
        #[from]
        SdkError<aws_sdk_cognitoidentityprovider::operation::update_device_status::UpdateDeviceStatusError>,
    ),

    #[error("The device being confirmed is already tracked")]
    /// The device being confirmed is already tracked, meaning no confirmation is needed.
    DeviceAlreadyTracked,
}