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

#![feature(test)]
//! A Proxy Protocol Parser written in Rust using nom.

use nom::branch::alt;

use crate::error::ParseError;
use crate::model::ParseResult;

/// Parsers for the binary representation of HAProxy's proxy protocol header.
mod binary;

/// Parsers for the text representation of HAProxy's proxy protocol header.
mod text;

/// Types representing both text and binary versions of HAProxy's proxy protocol header.
pub mod model;

/// The error type used by the parsers.
pub mod error;

/// Parses a version 1 header of HAProxy's proxy protocol.
///
/// # Examples
/// Partial
/// ```rust
/// assert!(ppp::parse_v1_header(b"PROXY TCP4 255.255.255.255 255.255.255.255 65535 65535").unwrap_err().is_incomplete());
/// ```
///
/// Unknown
/// ```rust
/// assert_eq!(ppp::parse_v1_header(b"PROXY UNKNOWN\r\n"), Ok((&[][..], ppp::model::Header::unknown())));
/// ```
///
/// TCP4
/// ```rust
/// assert_eq!(ppp::parse_v1_header(b"PROXY TCP4 255.255.255.255 255.255.255.255 65535 65535\r\nHello, World!"), Ok((&b"Hello, World!"[..], ppp::model:: Header::version_1(
///            ([255, 255, 255, 255], [255, 255, 255, 255], 65535, 65535).into(),
///        ))));
/// ```
///
/// TCP6
/// ```rust
/// assert_eq!(ppp::parse_v1_header(b"PROXY TCP6 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff 65535 65535\r\nHi!"), Ok((&b"Hi!"[..], ppp::model:: Header::version_1(
///            (
///                 [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF],
///                 [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF],
///                 65535,
///                 65535
///             ).into()
///        ))));
/// ```
pub fn parse_v1_header(input: &[u8]) -> ParseResult<&[u8]> {
    text::parse_v1_header(input).map_err(ParseError::from)
}

/// Parse the first 16 bytes of the protocol header; the only required payload.
/// The 12 byte signature and 4 bytes used to describe the connection and header information.
///
/// # Examples
/// TCP over IPv6 with some TLVs
/// ```rust
/// let mut input: Vec<u8> = Vec::new();
///
/// input.extend_from_slice(b"\r\n\r\n\0\r\nQUIT\n");
/// input.push(0x21);
/// input.push(0x21);
/// input.extend(&[0, 45]);
/// input.extend(&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]);
/// input.extend(&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xF1]);
/// input.extend(&[0, 80]);
/// input.extend(&[1, 187]);
/// input.extend(&[1, 0, 1, 5]);
/// input.extend(&[2, 0, 2, 5, 5]);
/// input.extend(&[1, 1, 1]);
///
/// assert_eq!(ppp::parse_v2_header(&input[..]), Ok((&[1, 1, 1][..], ppp::model::Header::new(
///     ppp::model::Version::Two,
///     ppp::model::Command::Proxy,
///     ppp::model::Protocol::Stream,
///     vec![ppp::model::Tlv::new(1, vec![5]), ppp::model::Tlv::new(2, vec![5, 5])],
///     (
///         [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF],
///         [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFF1],
///         80,
///         443
///     ).into(),
/// ))))
/// ```
///
/// UDP over IPv4 with some TLVs
/// ```rust
/// let mut input: Vec<u8> = Vec::new();
///
/// input.extend_from_slice(b"\r\n\r\n\0\r\nQUIT\n");
/// input.push(0x20);
/// input.push(0x12);
/// input.extend(&[0, 21]);
/// input.extend(&[127, 0, 0, 1]);
/// input.extend(&[192, 168, 1, 1]);
/// input.extend(&[0, 80]);
/// input.extend(&[1, 187]);
/// input.extend(&[1, 0, 1, 5]);
/// input.extend(&[2, 0, 2, 5, 5]);
/// input.extend(&[1, 2, 3, 4, 5]);
///
/// assert_eq!(ppp::parse_v2_header(&input[..]), Ok((&[1, 2, 3, 4, 5][..], ppp::model::Header::new(
///     ppp::model::Version::Two,
///     ppp::model::Command::Local,
///     ppp::model::Protocol::Datagram,
///     vec![ppp::model::Tlv::new(1, vec![5]), ppp::model::Tlv::new(2, vec![5, 5])],
///     ([127, 0, 0, 1], [192, 168, 1, 1], 80, 443).into(),
/// ))))
/// ```
///
/// Stream over Unix with some TLVs
/// ```rust
/// let mut input: Vec<u8> = Vec::new();
///
/// input.extend_from_slice(b"\r\n\r\n\0\r\nQUIT\n");
/// input.push(0x20);
/// input.push(0x31);
/// input.extend(&[0, 225]);
/// input.extend(&[0xFFu8; 108][..]);
/// input.extend(&[0xAAu8; 108][..]);
/// input.extend(&[1, 0, 1, 5]);
/// input.extend(&[2, 0, 2, 5, 5]);
/// input.extend(&[1, 2, 3, 4, 5]);
///
/// assert_eq!(ppp::parse_v2_header(&input[..]), Ok((&[1, 2, 3, 4, 5][..], ppp::model::Header::new(
///     ppp::model::Version::Two,
///     ppp::model::Command::Local,
///     ppp::model::Protocol::Stream,
///     vec![ppp::model::Tlv::new(1, vec![5]), ppp::model::Tlv::new(2, vec![5, 5])],
///     ([0xFFFFFFFFu32; 27], [0xAAAAAAAAu32; 27]).into(),
/// ))))
/// ```
///
/// Unspecified protocol over IPv6 with some TLVs
/// ```rust
/// let mut input: Vec<u8> = Vec::new();
///
/// input.extend_from_slice(b"\r\n\r\n\0\r\nQUIT\n");
/// input.push(0x21);
/// input.push(0x20);
/// input.extend(&[0, 41]);
/// input.extend(&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]);
/// input.extend(&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xF1]);
/// input.extend(&[1, 0, 1, 5]);
/// input.extend(&[2, 0, 2, 5, 5]);
/// input.extend(&[42]);
///
/// assert_eq!(ppp::parse_v2_header(&input[..]), Ok((&[42][..], ppp::model::Header::new(
///     ppp::model::Version::Two,
///     ppp::model::Command::Proxy,
///     ppp::model::Protocol::Unspecified,
///     vec![ppp::model::Tlv::new(1, vec![5]), ppp::model::Tlv::new(2, vec![5, 5])],
///     (
///         [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF],
///         [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFF1]
///     ).into()
/// ))))
/// ```
pub fn parse_v2_header(input: &[u8]) -> ParseResult<&[u8]> {
    binary::parse_v2_header(input).map_err(ParseError::from)
}

/// A parser that can handle both version 1 and version 2 of the proxy protocol header.
///
/// # Examples
/// Partial
/// ```rust
/// assert!(ppp::parse_header(b"\r\n").unwrap_err().is_incomplete());
/// ```
///
/// Version 1 TCP4
/// ```rust
/// assert_eq!(ppp::parse_header(b"PROXY TCP4 255.255.255.255 255.255.255.255 65535 65535\r\nHi!"), Ok((&b"Hi!"[..], ppp::model:: Header::version_1(
///            ([255, 255, 255, 255], [255, 255, 255, 255], 65535, 65535).into(),
///        ))));
/// ```
///
/// Version 2 TCP over IPv6 with some TLVs
/// ```rust
/// let mut input: Vec<u8> = Vec::new();
///
/// input.extend_from_slice(b"\r\n\r\n\0\r\nQUIT\n");
/// input.push(0x21);
/// input.push(0x21);
/// input.extend(&[0, 45]);
/// input.extend(&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]);
/// input.extend(&[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xF1]);
/// input.extend(&[0, 80]);
/// input.extend(&[1, 187]);
/// input.extend(&[1, 0, 1, 5]);
/// input.extend(&[2, 0, 2, 5, 5]);
/// input.extend(&[42]);
///
/// assert_eq!(ppp::parse_v2_header(&input[..]), Ok((&[42][..], ppp::model::Header::new(
///     ppp::model::Version::Two,
///     ppp::model::Command::Proxy,
///     ppp::model::Protocol::Stream,
///     vec![ppp::model::Tlv::new(1, vec![5]), ppp::model::Tlv::new(2, vec![5, 5])],
///     (
///         [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF],
///         [0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFF1],
///         80,
///         443
///     ).into(),
/// ))))
/// ```
pub fn parse_header(input: &[u8]) -> ParseResult<&[u8]> {
    alt((binary::parse_v2_header, text::parse_v1_header))(input).map_err(ParseError::from)
}