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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
//! Parsing errors
//!
//! # Error philosophy
//!
//! We don't spend a huge amount of effort producing precise and informative errors.
//!
//! We report:
//!
//! * A line number in the document where the error occurred.
//! For a problem with an item keyword line, that line is reported.
//! For an Object, a line somewhere in or just after the object is reported.
//!
//! * The expected keyword of a missing item.
//!
//! * The struct field name of a missing or invalid argument.
//!
//! * The file name (might be a nominal file name)
//!
//! * What kind of document we were trying to parse.
//!
//! We do not report:
//!
//! * Column numbers or byte offsets.
//!
//! * Any more details of the error for syntactically invalid arguments,
//! bad base64 or bad binary data, etc. (eg we discard the `FromStr::Err`)
//!
//! This saves a good deal of work.
use super::*;
/// Error encountered when parsing a document, including its location
#[derive(Error, Clone, Debug, Eq, PartialEq)]
#[error("failed to parse network document, type {doctype}: {file}:{lno}: {problem}")]
#[non_exhaustive]
pub struct ParseError {
/// What the problem was
#[source]
pub problem: ErrorProblem,
/// The document type, from `NetdocParseable::doctype_for_error`
pub doctype: &'static str,
/// Where the document came from, in human-readable form, filename or `<...>`
pub file: String,
/// Line number
pub lno: usize,
}
/// Problem found when parsing a document
///
/// Just the nature of the problem, including possibly which field or argument
/// if that's necessary to disambiguate, but not including location in the document.
///
/// We are quite minimal:
/// we do not report the `Display` of argument parse errors, for example.
#[derive(Error, Copy, Clone, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum ErrorProblem {
/// Empty document
#[error("empty document")]
EmptyDocument,
/// Wrong document type
#[error("wrong document type")]
WrongDocumentType,
/// Multiple top-level documents
#[error("multiple top-level documents")]
MultipleDocuments,
/// Item missing required base64-encoded Object
#[error("item missing required base64-encoded Object")]
MissingObject,
/// Item repeated when not allowed
#[error("item repeated when not allowed")]
ItemRepeated,
/// Item forbidden (in this kind of document or location)
#[error("item forbidden (in this kind of document or location)")]
ItemForbidden,
/// Item repeated when not allowed
#[error("item repeated when not allowed")]
ItemMisplacedAfterSignature,
/// Document contains nul byte
#[error("document contains nul byte")]
NulByte,
/// Item keyword line starts with whitespace
#[error("item keyword line starts with whitespace")]
KeywordLineStartsWithWhitespace,
/// No keyword when item keyword line expected
#[error("no keyword when item keyword line expected")]
MissingKeyword,
/// No keyword when item keyword line expected
#[error("no keyword when item keyword line expected")]
InvalidKeyword(#[from] keyword::InvalidKeyword),
/// Missing item {keyword}
#[error("missing item {keyword}")]
MissingItem {
/// Keyword for item that was missing
keyword: &'static str,
},
/// Missing argument {field}
#[error("missing argument {field}")]
MissingArgument {
/// Field name for argument that was missing
field: &'static str,
},
/// Invalid value for argument {field}
#[error("invalid value for argument {field}")]
InvalidArgument {
/// Field name for argument that had invalid value
field: &'static str,
},
/// Unexpected additional argument(s)
#[error("too many arguments")]
UnexpectedArgument,
/// Base64-encoded Object footer not found
#[error("base64-encoded Object footer not found")]
ObjectMissingFooter,
/// Base64-encoded Object END label does not match BEGIN
#[error("base64-encoded Object END label does not match BEGIN")]
ObjectMismatchedLabels,
/// Base64-encoded Object END label does not match BEGIN
#[error("base64-encoded Object label is not as expected")]
ObjectIncorrectLabel,
/// Base64-encoded Object has incorrectly formatted delimiter lines
#[error("base64-encoded Object has incorrectly formatted delimiter lines")]
InvalidObjectDelimiters,
/// Base64-encoded Object found where none expected
#[error("base64-encoded Object found where none expected")]
ObjectUnexpected,
/// Base64-encoded Object contains invalid base64
#[error("base64-encoded Object contains invalid base64")]
ObjectInvalidBase64,
/// Base64-encoded Object contains valid base64 specifying invalid data
#[error("base64-encoded Object contains invalid data")]
ObjectInvalidData,
/// Other parsing proble
#[error("other problem: {0}")]
Other(&'static str),
}
/// Error from signature verification (and timeliness check)
#[derive(Error, Debug, Clone, Copy)]
#[non_exhaustive]
pub enum VerifyFailed {
/// Signature verification failed
#[error("netdoc signature verification failed")]
VerifyFailed,
/// Document is too new - clock skew?
#[error("document is too new - clock skew?")]
TooNew,
/// Document is too old
#[error("document is too old")]
TooOld,
/// Document not signed by the right testator (or too few known testators)
#[error("document not signed by the right testator (or too few known testators)")]
InsufficientTrustedSigners,
/// document has inconsistent content
#[error("document has inconsistent content")]
Inconsistent,
/// Something else is wrong
#[error("document has uncategorised problem found during verification")]
Other,
}
impl From<signature::Error> for VerifyFailed {
fn from(_: signature::Error) -> VerifyFailed {
VerifyFailed::VerifyFailed
}
}
|
