scanii 1.1.0

Minimal-dependency Rust SDK for the Scanii content security API
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

use serde::Deserialize;
use std::collections::HashMap;

/// Result of a synchronous file scan returned by [`crate::ScaniiClient::process`]
/// and [`crate::ScaniiClient::retrieve`].
///
/// `findings` is always populated — empty when the content is clean.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiProcessingResult {
    /// Resource id assigned by the API.
    pub id: String,

    /// Detection findings, e.g. `content.malicious.local-test-file`. Empty when clean.
    #[serde(default)]
    pub findings: Vec<String>,

    /// SHA-1 checksum of the uploaded content, when reported.
    #[serde(default)]
    pub checksum: Option<String>,

    /// Size of the uploaded content in bytes, when reported.
    #[serde(default)]
    pub content_length: Option<u64>,

    /// MIME type detected by the API, when reported.
    #[serde(default)]
    pub content_type: Option<String>,

    /// Caller-supplied metadata echoed back by the API.
    #[serde(default)]
    pub metadata: HashMap<String, String>,

    /// Server-side creation timestamp (ISO 8601), when reported.
    #[serde(default)]
    pub creation_date: Option<String>,

    /// Server-supplied error message — populated only when the API set one.
    #[serde(default)]
    pub error: Option<String>,

    /// `X-Scanii-Request-Id` response header, populated by the client after deserialization.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client after deserialization.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client after deserialization.
    #[serde(skip)]
    pub resource_location: Option<String>,
}

/// Result of an asynchronous scan submission returned by
/// [`crate::ScaniiClient::process_async`] and [`crate::ScaniiClient::fetch`].
///
/// The actual scan result is fetched later via [`crate::ScaniiClient::retrieve`]
/// or delivered to the supplied `callback` URL.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiPendingResult {
    /// Resource id assigned by the API; pass to `retrieve` to read the result.
    pub id: String,

    /// `X-Scanii-Request-Id` response header, populated by the client.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client.
    #[serde(skip)]
    pub resource_location: Option<String>,
}

/// Short-lived auth token returned by [`crate::ScaniiClient::create_auth_token`]
/// and [`crate::ScaniiClient::retrieve_auth_token`].
///
/// Pass `id` to [`crate::ScaniiClientBuilder::token`] to authenticate using the
/// token instead of API key + secret.
///
/// See <https://scanii.github.io/openapi/v22/>.
#[derive(Debug, Clone, Deserialize, Default)]
pub struct ScaniiAuthToken {
    /// Token id — opaque string used as the auth credential.
    pub id: String,

    /// Server-side creation timestamp (ISO 8601), when reported.
    #[serde(default)]
    pub creation_date: Option<String>,

    /// Token expiry timestamp (ISO 8601), when reported.
    #[serde(default)]
    pub expiration_date: Option<String>,

    /// `X-Scanii-Request-Id` response header, populated by the client.
    #[serde(skip)]
    pub request_id: Option<String>,

    /// `X-Scanii-Host-Id` response header, populated by the client.
    #[serde(skip)]
    pub host_id: Option<String>,

    /// `Location` response header, populated by the client.
    #[serde(skip)]
    pub resource_location: Option<String>,
}