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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
//! Parsing for Auth Results using Logos

use logos::{Lexer, Logos};

use crate::alloc_yes::AuthenticationResults;
use crate::auth::{SmtpAuthResult, SmtpAuthResultCode};
use crate::dkim::{DkimResult, DkimResultCode};
use crate::error::AuthResultsError;
use crate::iprev::{IpRevResult, IpRevResultCode};
use crate::spf::{SpfResult, SpfResultCode};

use crate::alloc_yes::UnknownResult;

mod comment;
mod host_version;
mod policy;
mod ptypes;
mod reason;
mod unknown;
mod version;

use comment::{parse_comment, CommentToken};
use host_version::{parse_host_version, HostVersionToken};
use policy::{parse_policy, PolicyToken};
use ptypes::{parse_ptype_properties, PtypeToken};
use reason::{parse_reason, ReasonToken};
use unknown::{parse_unknown, UnknownToken};
use version::{parse_version, VersionToken};

#[cfg(feature = "mail_parser")]
use mail_parser::HeaderValue;

impl<'hdr> TryFrom<AuthResultToken<'hdr>> for SmtpAuthResultCode {
    type Error = AuthResultsError<'hdr>;

    fn try_from(token: AuthResultToken<'hdr>) -> Result<Self, Self::Error> {
        let res = match token {
            AuthResultToken::NoneNone => Self::NoneSmtp,
            AuthResultToken::Pass => Self::Pass,
            AuthResultToken::Fail => Self::Fail,
            AuthResultToken::TempError => Self::TempError,
            AuthResultToken::PermError => Self::PermError,
            _ => return Err(AuthResultsError::InvalidSmtpAuthResult("".to_string())),
        };
        Ok(res)
    }
}

impl<'hdr> TryFrom<AuthResultToken<'hdr>> for DkimResultCode {
    type Error = AuthResultsError<'hdr>;

    fn try_from(token: AuthResultToken<'hdr>) -> Result<Self, Self::Error> {
        let res = match token {
            AuthResultToken::NoneNone => Self::NoneDkim,
            AuthResultToken::Pass => Self::Pass,
            AuthResultToken::Fail => Self::Fail,
            AuthResultToken::Policy => Self::Policy,
            AuthResultToken::Neutral => Self::Neutral,
            AuthResultToken::TempError => Self::TempError,
            AuthResultToken::PermError => Self::PermError,
            _ => return Err(AuthResultsError::InvalidDkimResult("".to_string())),
        };
        Ok(res)
    }
}

impl<'hdr> TryFrom<AuthResultToken<'hdr>> for SpfResultCode {
    type Error = AuthResultsError<'hdr>;

    fn try_from(token: AuthResultToken<'_>) -> Result<Self, Self::Error> {
        let res = match token {
            AuthResultToken::NoneNone => Self::NoneSpf,
            AuthResultToken::Pass => Self::Pass,
            AuthResultToken::Fail => Self::Fail,
            AuthResultToken::SoftFail => Self::SoftFail,
            AuthResultToken::Policy => Self::Policy,
            AuthResultToken::Neutral => Self::Neutral,
            AuthResultToken::TempError => Self::TempError,
            AuthResultToken::PermError => Self::PermError,
            _ => return Err(AuthResultsError::InvalidSpfResult("".to_string())),
        };
        Ok(res)
    }
}

impl<'hdr> TryFrom<AuthResultToken<'hdr>> for IpRevResultCode {
    type Error = AuthResultsError<'hdr>;

    fn try_from(token: AuthResultToken<'_>) -> Result<Self, Self::Error> {
        let res = match token {
            AuthResultToken::Pass => Self::Pass,
            AuthResultToken::Fail => Self::Fail,
            AuthResultToken::TempError => Self::TempError,
            AuthResultToken::PermError => Self::PermError,
            _ => return Err(AuthResultsError::InvalidIpRevResult("".to_string())),
        };
        Ok(res)
    }
}

#[derive(Debug, Logos)]
#[logos(skip r"[ \t\r\n]+")]
pub enum AuthResultToken<'hdr> {
    #[token("auth", priority = 200)]
    Auth,
    #[token("dkim", priority = 200)]
    Dkim,
    #[token("spf", priority = 200)]
    Spf,
    #[token("iprev", priority = 200)]
    IpRev,

    #[token("/", priority = 200)]
    ForwardSlash,

    #[token("=", priority = 200)]
    Equal,

    #[token("none", priority = 100)]
    NoneNone,
    #[token("softfail", priority = 100)]
    SoftFail,
    #[token("fail", priority = 100)]
    Fail,
    #[token("neutral", priority = 100)]
    Neutral,
    #[token("pass", priority = 100)]
    Pass,
    #[token("temperror", priority = 100)]
    TempError,
    #[token("permerror", priority = 100)]
    PermError,

    #[token("reason", priority = 50)]
    Reason,

    #[token("policy", priority = 50)]
    Policy,

    #[token("(", priority = 200)]
    CommentStart,

    #[regex("[a-z-_]+", |lex| lex.slice(), priority = 10)]
    OtherAlphaDash(&'hdr str),

    SuperDumbPlaceholder(&'hdr str),
}

#[derive(Clone, Debug, PartialEq)]
enum Stage {
    WantHost,
    SawHost,
    WantIdentifier,

    /// auth = ..
    WantAuthEqual,
    WantAuthResult,

    /// spf = ...
    WantSpfEqual,
    WantSpfResult,

    // dkim = ...
    WantDkimEqual,
    WantDkimResult,

    // iprev = ...
    WantIpRevEqual,
    WantIpRevResult,
}

// State machine helpers
impl Stage {
    // Is the current stage expecting resultset status
    fn is_cur_expect_resultset_want(&self) -> bool {
        matches!(
            self,
            Self::WantAuthResult
                | Self::WantSpfResult
                | Self::WantDkimResult
                | Self::WantIpRevResult
        )
    }
    // Is the current stage expecting '=' equal for a result set
    fn is_cur_expect_resultset_equal(&self) -> bool {
        matches!(
            self,
            Self::WantAuthEqual | Self::WantSpfEqual | Self::WantDkimEqual | Self::WantIpRevEqual
        )
    }
    // Reflect the relevant Result for given WantEqual
    fn equal_to_result(&mut self) -> bool {
        let new_stage = match self {
            Stage::WantAuthEqual => Stage::WantAuthResult,
            Stage::WantSpfEqual => Stage::WantSpfResult,
            Stage::WantDkimEqual => Stage::WantDkimResult,
            Stage::WantIpRevEqual => Stage::WantIpRevResult,
            _ => return false,
        };
        *self = new_stage;
        true
    }
}

#[derive(Clone, Debug)]
enum ParseCurrentResultChoice<'hdr> {
    SmtpAuth(SmtpAuthResult<'hdr>),
    Spf(SpfResult<'hdr>),
    Dkim(DkimResult<'hdr>),
    IpRev(IpRevResult<'hdr>),
}

impl<'hdr> ParseCurrentResultChoice<'hdr> {
    fn set_reason(&mut self, reason: &'hdr str) {
        if let ParseCurrentResultChoice::Dkim(ref mut dkim_res) = self {
            dkim_res.reason = Some(reason);
        }
    }
}

#[derive(Clone, Debug, Default)]
struct ParseCurrentResultCode<'hdr> {
    result: Option<ParseCurrentResultChoice<'hdr>>,
}

fn assign_result_code<'hdr>(
    token: AuthResultToken<'hdr>,
    stage: Stage,
    cur_res: &mut ParseCurrentResultCode<'hdr>,
) -> Result<(), AuthResultsError<'hdr>> {
    let mut new_res: ParseCurrentResultCode<'hdr> = ParseCurrentResultCode::default();

    match stage {
        Stage::WantAuthResult => {
            let code = SmtpAuthResultCode::try_from(token)?;
            let smtp_auth_result = SmtpAuthResult {
                code,
                ..Default::default()
            };
            new_res.result = Some(ParseCurrentResultChoice::SmtpAuth(smtp_auth_result));
            *cur_res = new_res;
            Ok(())
        }
        Stage::WantSpfResult => {
            let code = SpfResultCode::try_from(token)?;
            let spf_result = SpfResult {
                code,
                ..Default::default()
            };
            new_res.result = Some(ParseCurrentResultChoice::Spf(spf_result));
            *cur_res = new_res;
            Ok(())
        }
        Stage::WantDkimResult => {
            let code = DkimResultCode::try_from(token)?;
            let dkim_result = DkimResult {
                code,
                ..Default::default()
            };
            new_res.result = Some(ParseCurrentResultChoice::Dkim(dkim_result));
            *cur_res = new_res;
            Ok(())
        }
        Stage::WantIpRevResult => {
            let code = IpRevResultCode::try_from(token)?;
            let iprev_result = IpRevResult {
                code,
                ..Default::default()
            };
            new_res.result = Some(ParseCurrentResultChoice::IpRev(iprev_result));
            *cur_res = new_res;
            Ok(())
        }
        _ => Err(AuthResultsError::InvalidResultStage),
    }
}

impl<'hdr> From<&'hdr HeaderValue<'hdr>> for AuthenticationResults<'hdr> {
    fn from(hval: &'hdr HeaderValue<'hdr>) -> Self {
        let mut res = Self {
            raw: hval.as_text(),
            ..Default::default()
        };

        let text = match hval.as_text() {
            None => {
                res.errors.push(AuthResultsError::NoHeader);
                return res;
            }
            Some(text) => text,
        };

        let mut host_lexer = HostVersionToken::lexer(text);

        let host = match parse_host_version(&mut host_lexer) {
            Ok(host) => host,
            Err(e) => {
                res.errors.push(e);
                return res;
            }
        };

        let mut lexer: Lexer<'hdr, AuthResultToken<'hdr>> = host_lexer.morph();
        res.host = Some(host);

        let mut stage = Stage::WantIdentifier;
        let mut cur_res = ParseCurrentResultCode::default();

        let mut raw_part_start = 0;

        while let Some(token) = lexer.next() {
            match token {
                Ok(AuthResultToken::NoneNone) if stage == Stage::WantIdentifier => {
                    res.none_done = true;
                }
                Ok(AuthResultToken::Auth) if stage == Stage::WantIdentifier => {
                    stage = Stage::WantAuthEqual;
                    raw_part_start = lexer.span().start;
                }
                Ok(AuthResultToken::Spf) if stage == Stage::WantIdentifier => {
                    stage = Stage::WantSpfEqual;
                    raw_part_start = lexer.span().start;
                }
                Ok(AuthResultToken::Dkim) if stage == Stage::WantIdentifier => {
                    stage = Stage::WantDkimEqual;
                    raw_part_start = lexer.span().start;
                }
                Ok(AuthResultToken::IpRev) if stage == Stage::WantIdentifier => {
                    stage = Stage::WantIpRevEqual;
                    raw_part_start = lexer.span().start;
                }
                Ok(AuthResultToken::Equal) if stage.is_cur_expect_resultset_equal() => {
                    stage.equal_to_result();
                }
                // TODO: This is not handled atm - it's cursed.
                Ok(AuthResultToken::Policy) => {
                    let mut policy_lexer: Lexer<'hdr, PolicyToken<'hdr>> = lexer.morph();
                    let _policy = match parse_policy(&mut policy_lexer) {
                        Ok(policy) => policy,
                        Err(e) => {
                            res.errors.push(e);
                            break;
                        }
                    };
                    lexer = policy_lexer.morph();
                }
                Ok(
                    AuthResultToken::Pass
                    | AuthResultToken::Fail
                    | AuthResultToken::TempError
                    | AuthResultToken::PermError
                    | AuthResultToken::SoftFail
                    | AuthResultToken::NoneNone
                    | AuthResultToken::Neutral,
                ) if stage.is_cur_expect_resultset_want() => {
                    if let Err(e) = assign_result_code(
                        token.expect("BUG: Matched err?!"),
                        stage.clone(),
                        &mut cur_res,
                    ) {
                        res.errors.push(e);
                        break;
                    }

                    let lexer_end = lexer.span().end;
                    let mut ptype_lexer = PtypeToken::lexer(lexer.remainder());

                    let raw_part_end =
                        match parse_ptype_properties(&mut ptype_lexer, &mut cur_res.result) {
                            Err(e) => {
                                res.errors.push(e);
                                break;
                            }
                            Ok(raw_part_end) => raw_part_end,
                        };

                    lexer.bump(ptype_lexer.span().end);

                    stage = Stage::WantIdentifier;
                    match cur_res.result {
                        Some(ParseCurrentResultChoice::Dkim(mut dkim_res)) => {
                            dkim_res.raw =
                                Some(&lexer.source()[raw_part_start..lexer_end + raw_part_end]);
                            res.dkim_result.push(dkim_res)
                        }
                        Some(ParseCurrentResultChoice::IpRev(mut iprev_res)) => {
                            iprev_res.raw =
                                Some(&lexer.source()[raw_part_start..lexer_end + raw_part_end]);
                            res.iprev_result.push(iprev_res)
                        }
                        Some(ParseCurrentResultChoice::Spf(mut spf_res)) => {
                            spf_res.raw =
                                Some(&lexer.source()[raw_part_start..lexer_end + raw_part_end]);
                            res.spf_result.push(spf_res)
                        }
                        Some(ParseCurrentResultChoice::SmtpAuth(mut auth_res)) => {
                            auth_res.raw =
                                Some(&lexer.source()[raw_part_start..lexer_end + raw_part_end]);
                            res.smtp_auth_result.push(auth_res)
                        }
                        _ => {
                            res.errors
                                .push(AuthResultsError::ParseCurrentPushNotImplemented);
                            break;
                        }
                    }
                    cur_res = ParseCurrentResultCode::default();
                }
                Ok(AuthResultToken::ForwardSlash) => {
                    let mut version_lexer = VersionToken::lexer(lexer.remainder());

                    // TODO: Care about version ?
                    let _version_res = match parse_version(&mut version_lexer) {
                        Ok(version) => version,
                        Err(e) => {
                            res.errors.push(e);
                            break;
                        }
                    };
                    lexer.bump(version_lexer.span().end);
                }
                Ok(AuthResultToken::CommentStart) => {
                    let mut comment_lexer: Lexer<'hdr, CommentToken<'hdr>> = lexer.morph();
                    match parse_comment(&mut comment_lexer) {
                        Ok(_comment) => {} // TODO: keep comments?
                        Err(e) => {
                            res.errors.push(e);
                            break;
                        }
                    }
                    lexer = comment_lexer.morph();
                }
                // unknown/unsupported methods encontered, parse them as "unknown" until ";" (consuming it)
                Ok(AuthResultToken::OtherAlphaDash(_)) if stage == Stage::WantIdentifier => {
                    let start = lexer.span().start;
                    let mut unknown_lexer: Lexer<'hdr, UnknownToken<'hdr>> = lexer.morph();
                    match parse_unknown(&mut unknown_lexer) {
                        Ok(raw_end) => {
                            let raw_str = &unknown_lexer.source()[start..raw_end];
                            res.unknown_result.push(UnknownResult { raw: raw_str });
                        }
                        Err(e) => {
                            res.errors.push(e);
                            break;
                        }
                    }
                    lexer = unknown_lexer.morph();
                }
                // TODO: OtherAlphaDash for Stage::WantResult
                _ => {
                    let cut_slice = &lexer.source()[lexer.span().start..];
                    let cut_span = &lexer.source()[lexer.span().start..lexer.span().end];

                    let detail = crate::error::ParsingDetail {
                        component: "parse_ptypes_properties",
                        span_start: lexer.span().start,
                        span_end: lexer.span().end,
                        source: lexer.source(),
                        clipped_span: cut_span,
                        clipped_remaining: cut_slice,
                    };

                    res.errors.push(AuthResultsError::ParsingDetailed(detail));
                    break;
                }
            }
        }
        res
    }
}