cf-turnstile 0.2.0

A Rust client for Cloudflare Turnstile
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

//! Error types for the Turnstile API.
use serde::{Deserialize, Serialize};
use thiserror::Error;
// ​​Error codes
// Error code	Description
// missing-input-secret	The secret parameter was not passed.
// invalid-input-secret	The secret parameter was invalid or did not exist.
// missing-input-response	The response parameter was not passed.
// invalid-input-response	The response parameter is invalid or has expired.
// invalid-widget-id	The widget ID extracted from the parsed site secret key was invalid or did not exist.
// invalid-parsed-secret	The secret extracted from the parsed site secret key was invalid.
// bad-request	The request was rejected because it was malformed.
// timeout-or-duplicate	The response parameter has already been validated before.
// internal-error	An internal error happened while validating the response. The request can be retried.

/// Represents a list of errors from the Turnstile API.
#[derive(Debug, Error)]
pub enum TurnstileError {
    /// The error originated from the Turnstile API.
    #[error("Turnstile API error: {0:?}")]
    SiteVerifyError(SiteVerifyErrors),

    /// The error originated from Legacy Hyper.
    #[error("Legacy hyper error: {0:?}")]
    LegacyHyperError(#[from] hyper_util::client::legacy::Error),

    /// The error originated from Hyper.
    #[error("Hyper error: {0:?}")]
    HyperError(#[from] hyper::Error),

    /// The error originated from Serde.
    #[error("Serde error: {0:?}")]
    SerdeError(#[from] serde_json::Error),
}

/// Represents a list of errors from the Turnstile API.
pub type SiteVerifyErrors = Vec<SiteVerifyError>;

/// Represents an error from the Turnstile API.
///
/// <https://developers.cloudflare.com/turnstile/get-started/server-side-validation/#error-codes>
#[derive(Debug, Clone, Error, Deserialize, Serialize)]
pub enum SiteVerifyError {
    /// The secret parameter was not passed.
    #[serde(rename = "missing-input-secret")]
    #[error("The secret parameter was not passed.")]
    MissingInputSecret,

    /// The secret parameter was invalid or did not exist.
    #[serde(rename = "invalid-input-secret")]
    #[error("The secret parameter was invalid or did not exist.")]
    InvalidInputSecret,

    /// The response parameter was not passed.
    #[serde(rename = "missing-input-response")]
    #[error("The response parameter was not passed.")]
    MissingInputResponse,

    /// The response parameter is invalid or has expired.
    #[serde(rename = "invalid-input-response")]
    #[error("The response parameter is invalid or has expired.")]
    InvalidInputResponse,

    /// The widget ID extracted from the parsed site secret key was invalid or did not exist.
    #[serde(rename = "invalid-widget-id")]
    #[error(
        "The widget ID extracted from the parsed site secret key was invalid or did not exist."
    )]
    InvalidWidgetId,

    /// The secret extracted from the parsed site secret key was invalid.
    #[serde(rename = "invalid-parsed-secret")]
    #[error("The secret extracted from the parsed site secret key was invalid.")]
    InvalidParsedSecret,

    /// The request was rejected because it was malformed.
    #[serde(rename = "bad-request")]
    #[error("The request was rejected because it was malformed.")]
    BadRequest,

    /// The response parameter has already been validated before.
    #[serde(rename = "timeout-or-duplicate")]
    #[error("The response parameter has already been validated before.")]
    TimeoutOrDuplicate,

    /// An internal error happened while validating the response. The request can be retried.
    #[serde(rename = "internal-error")]
    #[error(
        "An internal error happened while validating the response. The request can be retried."
    )]
    InternalError,
}