rfc1939 0.1.0

Parsing RFC 1939 (i.e. POP3) data streams
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

use crate::common::{take_until_crlf, take_until_crlf_consume_crlf, take_until_sp};
use crate::types::command::{Apop, Pass, User};
use nom::{
    bytes::complete::tag, bytes::complete::tag_no_case, combinator::map, sequence::delimited,
    sequence::preceded, sequence::separated_pair, IResult,
};

// ################################################################################
/// USER name
/// Arguments:
///     a string identifying a mailbox (required)
/// Restrictions:
///     a string identifying a mailbox (required)
/// Examples:
///     C: USER frated
// ################################################################################
pub fn user(s: &[u8]) -> Option<User> {
    match user_parser(s) {
        Ok((_, x)) => Some(x),
        Err(_) => None,
    }
}

pub(crate) fn user_parser(s: &[u8]) -> IResult<&[u8], User> {
    map(
        preceded(tag_no_case(b"USER "), take_until_crlf_consume_crlf),
        |name| User { name: name },
    )(s)
}

// ################################################################################
/// PASS string
/// Arguments:
///     a server/mailbox-specific password (required)
/// Restrictions:
///     a string identifying a mailbox (required)
/// Examples:
///     C: USER frated
// ################################################################################
pub fn pass(s: &[u8]) -> Option<Pass> {
    match pass_parser(s) {
        Ok((_, x)) => Some(x),
        Err(_) => None,
    }
}

pub(crate) fn pass_parser(s: &[u8]) -> IResult<&[u8], Pass> {
    map(
        preceded(tag_no_case(b"PASS "), take_until_crlf_consume_crlf),
        |string| Pass { string: string },
    )(s)
}

// ################################################################################
/// APOP name digest
/// Arguments:
///     a string identifying a mailbox and a MD5 digest string
///     (both required)
/// Restrictions:
///     may only be given in the AUTHORIZATION state after the POP3
///     greeting or after an unsuccessful USER or PASS command
/// Examples:
///     C: APOP mrose c4c9334bac560ecc979e58001b3e22fb
// ################################################################################
pub fn apop(s: &[u8]) -> Option<Apop> {
    match apop_parser(s) {
        Ok((_, x)) => Some(x),
        Err(_) => None,
    }
}

pub(crate) fn apop_parser(s: &[u8]) -> IResult<&[u8], Apop> {
    map(
        delimited(
            tag_no_case(b"APOP "),
            separated_pair(take_until_sp, tag(b" "), take_until_crlf),
            tag(b"\r\n"),
        ),
        |(x, y)| Apop { name: x, digest: y },
    )(s)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_user() {
        assert_eq!(user(b"USER name\r\n").unwrap(), User { name: b"name" })
    }

    #[test]
    fn test_pass() {
        assert_eq!(pass(b"PASS pwd\r\n").unwrap(), Pass { string: b"pwd" })
    }

    #[test]
    fn test_apop() {
        assert_eq!(
            apop(b"APOP mrose c4c9334bac560ecc979e58001b3e22fb\r\n").unwrap(),
            Apop {
                name: b"mrose",
                digest: b"c4c9334bac560ecc979e58001b3e22fb"
            }
        )
    }
}