fluidattacks_core_git/
errors.rs

1use std::io;
2use std::path::PathBuf;
3use std::process::ExitStatus;
4use std::time::Duration;
5
6/// A file call failed at `path`; `source` keeps the errno.
7#[derive(Debug, thiserror::Error)]
8#[error("{action} {}: {source}", path.display())]
9pub struct FileError {
10    pub action: &'static str,
11    pub path: PathBuf,
12    #[source]
13    pub source: io::Error,
14}
15
16/// Removing the symlinks or the out-of-scope files failed.
17#[derive(Debug, thiserror::Error)]
18pub enum PruneError {
19    #[error(transparent)]
20    File(#[from] FileError),
21    /// The git that lists the out-of-scope files failed.
22    #[error(transparent)]
23    Git(#[from] GitCallError),
24}
25
26/// Why `reset_repo` failed.
27#[derive(Debug, thiserror::Error)]
28pub enum ResetError {
29    /// `git reset --hard` failed, as it does for a path that is not the root.
30    #[error(transparent)]
31    Git(#[from] GitCallError),
32    #[error(transparent)]
33    Symlinks(#[from] FileError),
34}
35
36/// Why an `HttpsAccess` could not be built, worded as the python worded it.
37#[derive(Debug, PartialEq, Eq, thiserror::Error)]
38pub enum HttpsAccessError {
39    /// git reads a credential line by line: a line break could add a field, a nul cuts it short.
40    #[error("Invalid credentials: a line break or a nul byte")]
41    CredentialLineBreak,
42    #[error("expected an http or https url")]
43    NotHttp,
44    /// The url stays out of the message: it may carry a user and password.
45    #[error("Invalid url: its host or port could not be parsed")]
46    Unparsable,
47    #[error("expected an https credential")]
48    NotHttpsCredential,
49}
50
51/// Why `clone_to_temp` failed, by the step that failed.
52#[derive(Debug, thiserror::Error)]
53pub enum CloneError {
54    #[error(transparent)]
55    Access(#[from] HttpsAccessError),
56    #[error(transparent)]
57    Git(#[from] GitCallError),
58    /// The mirror cloned but its `.info.json` could not be written, so the clone was removed.
59    #[error(transparent)]
60    Info(#[from] FileError),
61    #[error(transparent)]
62    SshKey(#[from] SshKeyError),
63    #[error(transparent)]
64    Sts(#[from] StsError),
65}
66
67/// Why the SSH key could not be handed to git.
68#[derive(Debug, thiserror::Error)]
69pub enum SshKeyError {
70    #[error("the SSH key is not base64: {0}")]
71    Decode(#[from] base64::DecodeError),
72    #[error("the SSH key could not be written: {0}")]
73    File(#[source] io::Error),
74    #[error("the SSH key path cannot be quoted for the shell: {0}")]
75    Path(#[from] shlex::QuoteError),
76}
77
78/// Why an ls-remote over ssh could not ask; a refusal or a timeout is an answer, not this.
79#[derive(Debug, thiserror::Error)]
80pub enum LsRemoteError {
81    #[error(transparent)]
82    SshKey(#[from] SshKeyError),
83    #[error(transparent)]
84    Git(#[from] GitCallError),
85}
86
87/// Why `validate_ssh_host` refused a url.
88#[derive(Debug, thiserror::Error)]
89pub enum SshHostError {
90    /// Not one of the ssh forms integrates stores, or a host past the DNS limits.
91    #[error("Invalid ssh url: expected user@host:path or ssh://user@host[:port]/path")]
92    Malformed,
93    #[error("Could not resolve the hostname {host}: {source}")]
94    Unresolved {
95        host: String,
96        #[source]
97        source: io::Error,
98    },
99    #[error("No IP addresses resolved for hostname: {host}")]
100    NoAddresses { host: String },
101    #[error("SSH host validation failed for {host}: {reason}")]
102    Local {
103        host: String,
104        reason: crate::local_address::LocalAddress,
105    },
106}
107
108/// Why no session came out of STS for a role.
109#[derive(Debug, thiserror::Error)]
110pub enum StsError {
111    /// STS answered with an error, as it does for a role that does not trust us.
112    #[error("STS refused the role {arn}: {code}: {message}")]
113    Refused {
114        arn: String,
115        code: String,
116        message: String,
117    },
118    /// No answer came: no network, no local credentials or a timeout.
119    #[error("STS could not be asked for the role {arn}: {reason}")]
120    Unreachable { arn: String, reason: String },
121    #[error("STS answered the role {arn} without credentials")]
122    NoCredentials { arn: String },
123}
124
125#[derive(Debug, thiserror::Error)]
126pub enum GitCallError {
127    #[error("git {command} could not start: {source}")]
128    NotStarted {
129        command: &'static str,
130        source: io::Error,
131    },
132    #[error("git {command} did not finish within {after:?}")]
133    TimedOut {
134        command: &'static str,
135        after: Duration,
136    },
137    /// git ran and refused, as it does for a missing repository or revision.
138    #[error("git {command} exited with {status}: {stderr}")]
139    Refused {
140        command: &'static str,
141        status: ExitStatus,
142        stderr: String,
143    },
144    /// No process can receive a NUL, so std turns the call down before it starts.
145    #[error("git {command} got an argument with an embedded null byte")]
146    NullByte { command: &'static str },
147    #[error("git {command} printed something unreadable: {reason}")]
148    Malformed {
149        command: &'static str,
150        reason: String,
151    },
152}
153
154/// Why `download_and_extract_repo` failed, by the step that failed.
155#[derive(Debug, thiserror::Error)]
156pub enum DownloadError {
157    /// The parent of the destination or the archive could not be created or
158    /// written.
159    #[error("writing the archive: {0}")]
160    Write(#[source] io::Error),
161    #[error(transparent)]
162    Fetch(#[from] FetchError),
163    #[error(transparent)]
164    Extract(#[from] ExtractError),
165    /// `git reset --hard` did not restore the working tree.
166    #[error(transparent)]
167    Reset(#[from] GitCallError),
168    #[error("pruning the working tree: {0}")]
169    Prune(#[from] PruneError),
170    /// The repository could not take the place of the destination, or the
171    /// work directory beside it could not be made.
172    #[error("placing the repository: {0}")]
173    Place(#[source] io::Error),
174}
175
176/// How the request for the archive failed.
177#[derive(Debug, thiserror::Error)]
178pub enum FetchError {
179    #[error("invalid url {url}: {reason}")]
180    InvalidUrl { url: String, reason: String },
181    #[error("not an http url: {0}")]
182    NonHttpUrl(String),
183    /// DNS, a refused connection or a TLS handshake that failed.
184    #[error("could not connect: {0}")]
185    Connect(#[source] reqwest::Error),
186    #[error("connecting timed out: {0}")]
187    ConnectTimeout(#[source] reqwest::Error),
188    /// The total timeout ran out before the response headers arrived.
189    #[error("no response in time: {0}")]
190    Timeout(#[source] reqwest::Error),
191    /// The server closed the connection before it answered.
192    #[error("the server disconnected: {0}")]
193    Disconnected(#[source] reqwest::Error),
194    /// The socket failed while the request was sent; `errno` is the one of
195    /// the socket call.
196    #[error("the socket failed: {source}")]
197    Socket {
198        reset: bool,
199        errno: Option<i32>,
200        source: reqwest::Error,
201    },
202    #[error("malformed response: {0}")]
203    Malformed(#[source] reqwest::Error),
204    #[error("the server answered {0}")]
205    Status(reqwest::StatusCode),
206    /// The body ended before its length, or the connection broke mid-read.
207    #[error("the body was cut: {0}")]
208    BodyCut(#[source] reqwest::Error),
209    /// The total timeout ran out while the body was read.
210    #[error("the body did not arrive in time: {0}")]
211    BodyTimeout(#[source] reqwest::Error),
212    #[error("the request failed: {0}")]
213    Other(#[source] reqwest::Error),
214}
215
216/// How turning the archive into a repository failed.
217#[derive(Debug, thiserror::Error)]
218pub enum ExtractError {
219    /// The archive is not gzip, its tar or deflate data is broken, or its
220    /// checksum does not match.
221    #[error("corrupt archive: {0}")]
222    Corrupt(#[source] io::Error),
223    /// The gzip stream ends before its trailer.
224    #[error("truncated archive: {0}")]
225    Truncated(#[source] io::Error),
226    /// The archive holds no top directory with a real `.git` directory.
227    #[error("the archive holds no repository: {0}")]
228    NoRepository(String),
229    #[error("extracting the archive: {0}")]
230    Io(#[source] io::Error),
231}
fluidattacks_core_git/errors.rs

fluidattacks_core_git/
errors.rs
