use nom7::bytes::streaming::{tag, take, take_until, take_until1};
use nom7::character::streaming::{alphanumeric1, char};
use nom7::combinator::{all_consuming, cond, eof, map_parser, opt, peek, verify};
-use nom7::error::{make_error, ErrorKind};
+use nom7::error::{make_error, ErrorKind, ParseError};
use nom7::multi::{many1, many_m_n, many_till};
use nom7::number::streaming::{be_i16, be_i32};
use nom7::number::streaming::{be_u16, be_u32, be_u8};
pub const PGSQL_DUMMY_PROTO_MINOR_SSL: u16 = 5679; //0x162f
pub const _PGSQL_DUMMY_PROTO_MINOR_GSSAPI: u16 = 5680; // 0x1630
-fn parse_length(i: &[u8]) -> IResult<&[u8], u32> {
- verify(be_u32, |&x| x >= PGSQL_LENGTH_FIELD)(i)
+#[derive(Debug, PartialEq, Eq)]
+pub enum PgsqlParseError<I> {
+ InvalidLength,
+
+ NomError(I, ErrorKind),
+}
+
+impl<I> ParseError<I> for PgsqlParseError<I> {
+ fn from_error_kind(input: I, kind: ErrorKind) -> Self {
+ PgsqlParseError::NomError(input, kind)
+ }
+
+ fn append(input: I, kind: ErrorKind, _other: Self) -> Self {
+ PgsqlParseError::NomError(input, kind)
+ }
+}
+
+fn parse_length(i: &[u8]) -> IResult<&[u8], u32, PgsqlParseError<&[u8]>> {
+ let res = verify(be_u32::<&[u8], nom7::error::Error<_>>, |&x| {
+ x >= PGSQL_LENGTH_FIELD
+ })(i);
+ match res {
+ Ok(result) => Ok((result.0, result.1)),
+ Err(nom7::Err::Incomplete(needed)) => Err(Err::Incomplete(needed)),
+ Err(_) => Err(Err::Error(PgsqlParseError::InvalidLength)),
+ }
}
#[derive(Debug, PartialEq, Eq)]
// standard_conforming_strings
// (source: PostgreSQL documentation)
// We may be interested, then, in controling this, somehow, to prevent weird things?
-fn pgsql_parse_generic_parameter(i: &[u8]) -> IResult<&[u8], PgsqlParameter> {
+fn pgsql_parse_generic_parameter(i: &[u8]) -> IResult<&[u8], PgsqlParameter, PgsqlParseError<&[u8]>> {
let (i, param_name) = take_until1("\x00")(i)?;
let (i, _) = tag("\x00")(i)?;
let (i, param_value) = take_until("\x00")(i)?;
))
}
-pub fn pgsql_parse_startup_parameters(i: &[u8]) -> IResult<&[u8], PgsqlStartupParameters> {
+pub fn pgsql_parse_startup_parameters(i: &[u8]) -> IResult<&[u8], PgsqlStartupParameters, PgsqlParseError<&[u8]>> {
let (i, mut optional) = opt(terminated(
many1(pgsql_parse_generic_parameter),
tag("\x00"),
fn parse_sasl_initial_response_payload(
i: &[u8],
-) -> IResult<&[u8], (SASLAuthenticationMechanism, u32, Vec<u8>)> {
+) -> IResult<&[u8], (SASLAuthenticationMechanism, u32, Vec<u8>), PgsqlParseError<&[u8]>> {
let (i, sasl_mechanism) = parse_sasl_mechanism(i)?;
let (i, param_length) = be_u32(i)?;
// From RFC 5802 - the client-first-message will always start w/
Ok((i, (sasl_mechanism, param_length, param.to_vec())))
}
-pub fn parse_sasl_initial_response(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+pub fn parse_sasl_initial_response(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'p')(i)?;
let (i, length) = parse_length(i)?;
let (i, payload) = map_parser(
))
}
-pub fn parse_sasl_response(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+pub fn parse_sasl_response(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'p')(i)?;
let (i, length) = parse_length(i)?;
let (i, payload) = take(length - PGSQL_LENGTH_FIELD)(i)?;
Ok((i, resp))
}
-pub fn pgsql_parse_startup_packet(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
- let (i, len) = verify(be_u32, |&x| x >= 8)(i)?;
+pub fn pgsql_parse_startup_packet(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
+ let (i, length) = verify(be_u32, |&x| x >= 8)(i)?;
let (i, proto_major) = peek(be_u16)(i)?;
- let (i, b) = take(len - PGSQL_LENGTH_FIELD)(i)?;
+ let (i, b) = take(length - PGSQL_LENGTH_FIELD)(i)?;
let (_, message) = match proto_major {
1..=3 => {
let (b, proto_major) = be_u16(b)?;
(
b,
PgsqlFEMessage::StartupMessage(StartupPacket {
- length: len,
+ length,
proto_major,
proto_minor,
params,
PGSQL_DUMMY_PROTO_MINOR_SSL => (
b,
PgsqlFEMessage::SSLRequest(DummyStartupPacket {
- length: len,
+ length,
proto_major,
proto_minor,
}),
// Source: https://www.postgresql.org/docs/13/protocol-flow.html#id-1.10.5.7.11, GSSAPI Session Encryption
// Password can be encrypted or in cleartext
-pub fn parse_password_message(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+pub fn parse_password_message(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'p')(i)?;
let (i, length) = parse_length(i)?;
let (i, password) = map_parser(take(length - PGSQL_LENGTH_FIELD), take_until1("\x00"))(i)?;
))
}
-fn parse_simple_query(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+fn parse_simple_query(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'Q')(i)?;
let (i, length) = parse_length(i)?;
let (i, query) = map_parser(take(length - PGSQL_LENGTH_FIELD), take_until1("\x00"))(i)?;
))
}
-fn parse_cancel_request(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+fn parse_cancel_request(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, pid) = be_u32(i)?;
let (i, backend_key) = be_u32(i)?;
Ok((
))
}
-fn parse_terminate_message(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+fn parse_terminate_message(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'X')(i)?;
let (i, length) = parse_length(i)?;
Ok((
}
// Messages that begin with 'p' but are not password ones are not parsed here
-pub fn parse_request(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage> {
+pub fn parse_request(i: &[u8]) -> IResult<&[u8], PgsqlFEMessage, PgsqlParseError<&[u8]>> {
let (i, tag) = peek(be_u8)(i)?;
let (i, message) = match tag {
b'\0' => pgsql_parse_startup_packet(i)?,
Ok((i, message))
}
-fn pgsql_parse_authentication_message<'a>(i: &'a [u8]) -> IResult<&'a [u8], PgsqlBEMessage> {
+fn pgsql_parse_authentication_message<'a>(i: &'a [u8]) -> IResult<&'a [u8], PgsqlBEMessage, PgsqlParseError<&'a [u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'R')(i)?;
let (i, length) = verify(be_u32, |&x| x >= 8)(i)?;
let (i, auth_type) = be_u32(i)?;
Ok((i, message))
}
-fn parse_parameter_status_message(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn parse_parameter_status_message(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'S')(i)?;
let (i, length) = parse_length(i)?;
let (i, param) = map_parser(
))
}
-pub fn parse_ssl_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+pub fn parse_ssl_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, tag) = alt((char('N'), char('S')))(i)?;
Ok((
i,
))
}
-fn parse_backend_key_data_message(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn parse_backend_key_data_message(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'K')(i)?;
let (i, length) = verify(be_u32, |&x| x == 12)(i)?;
let (i, pid) = be_u32(i)?;
))
}
-fn parse_command_complete(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn parse_command_complete(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'C')(i)?;
let (i, length) = parse_length(i)?;
let (i, payload) = map_parser(take(length - PGSQL_LENGTH_FIELD), take_until("\x00"))(i)?;
))
}
-fn parse_ready_for_query(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn parse_ready_for_query(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'Z')(i)?;
let (i, length) = verify(be_u32, |&x| x == 5)(i)?;
let (i, status) = verify(be_u8, |&x| x == b'I' || x == b'T' || x == b'E')(i)?;
))
}
-fn parse_row_field(i: &[u8]) -> IResult<&[u8], RowField> {
+fn parse_row_field(i: &[u8]) -> IResult<&[u8], RowField, PgsqlParseError<&[u8]>> {
let (i, field_name) = take_until1("\x00")(i)?;
let (i, _) = tag("\x00")(i)?;
let (i, table_oid) = be_u32(i)?;
))
}
-pub fn parse_row_description(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+pub fn parse_row_description(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'T')(i)?;
let (i, length) = verify(be_u32, |&x| x > 6)(i)?;
let (i, field_count) = be_u16(i)?;
))
}
-fn parse_data_row_value(i: &[u8]) -> IResult<&[u8], ColumnFieldValue> {
+fn parse_data_row_value(i: &[u8]) -> IResult<&[u8], ColumnFieldValue, PgsqlParseError<&[u8]>> {
let (i, value_length) = be_i32(i)?;
let (i, value) = cond(value_length >= 0, take(value_length as usize))(i)?;
Ok((
// Currently, we don't store the actual DataRow messages, as those could easily become a burden, memory-wise
// We use ConsolidatedDataRow to store info we still want to log: message size.
// Later on, we calculate the number of lines the command actually returned by counting ConsolidatedDataRow messages
-pub fn parse_consolidated_data_row(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+pub fn parse_consolidated_data_row(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'D')(i)?;
let (i, length) = verify(be_u32, |&x| x >= 6)(i)?;
let (i, field_count) = be_u16(i)?;
))
}
-fn parse_sasl_mechanism(i: &[u8]) -> IResult<&[u8], SASLAuthenticationMechanism> {
+fn parse_sasl_mechanism(i: &[u8]) -> IResult<&[u8], SASLAuthenticationMechanism, PgsqlParseError<&[u8]>> {
let res: IResult<_, _, ()> = terminated(tag("SCRAM-SHA-256-PLUS"), tag("\x00"))(i);
if let Ok((i, _)) = res {
return Ok((i, SASLAuthenticationMechanism::ScramSha256Plus));
return Err(Err::Error(make_error(i, ErrorKind::Alt)));
}
-fn parse_sasl_mechanisms(i: &[u8]) -> IResult<&[u8], Vec<SASLAuthenticationMechanism>> {
+fn parse_sasl_mechanisms(i: &[u8]) -> IResult<&[u8], Vec<SASLAuthenticationMechanism>, PgsqlParseError<&[u8]>> {
terminated(many1(parse_sasl_mechanism), tag("\x00"))(i)
}
-pub fn parse_error_response_code(i: &[u8]) -> IResult<&[u8], PgsqlErrorNoticeMessageField> {
+pub fn parse_error_response_code(i: &[u8]) -> IResult<&[u8], PgsqlErrorNoticeMessageField, PgsqlParseError<&[u8]>> {
let (i, _field_type) = char('C')(i)?;
let (i, field_value) = map_parser(take(6_usize), alphanumeric1)(i)?;
Ok((
// Parse an error response with non-localizeable severity message.
// Possible values: ERROR, FATAL, or PANIC
-pub fn parse_error_response_severity(i: &[u8]) -> IResult<&[u8], PgsqlErrorNoticeMessageField> {
+pub fn parse_error_response_severity(i: &[u8]) -> IResult<&[u8], PgsqlErrorNoticeMessageField, PgsqlParseError<&[u8]>> {
let (i, field_type) = char('V')(i)?;
let (i, field_value) = alt((tag("ERROR"), tag("FATAL"), tag("PANIC")))(i)?;
let (i, _) = tag("\x00")(i)?;
// The non-localizable version of Severity field has different values,
// in case of a notice: 'WARNING', 'NOTICE', 'DEBUG', 'INFO' or 'LOG'
-pub fn parse_notice_response_severity(i: &[u8]) -> IResult<&[u8], PgsqlErrorNoticeMessageField> {
+pub fn parse_notice_response_severity(i: &[u8]) -> IResult<&[u8], PgsqlErrorNoticeMessageField, PgsqlParseError<&[u8]>> {
let (i, field_type) = char('V')(i)?;
let (i, field_value) = alt((
tag("WARNING"),
pub fn parse_error_response_field(
i: &[u8], is_err_msg: bool,
-) -> IResult<&[u8], PgsqlErrorNoticeMessageField> {
+) -> IResult<&[u8], PgsqlErrorNoticeMessageField, PgsqlParseError<&[u8]>> {
let (i, field_type) = peek(be_u8)(i)?;
let (i, data) = match field_type {
b'V' => {
pub fn parse_error_notice_fields(
i: &[u8], is_err_msg: bool,
-) -> IResult<&[u8], Vec<PgsqlErrorNoticeMessageField>> {
+) -> IResult<&[u8], Vec<PgsqlErrorNoticeMessageField>, PgsqlParseError<&[u8]>> {
let (i, data) = many_till(|b| parse_error_response_field(b, is_err_msg), tag("\x00"))(i)?;
Ok((i, data.0))
}
-fn pgsql_parse_error_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn pgsql_parse_error_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'E')(i)?;
let (i, length) = verify(be_u32, |&x| x > 10)(i)?;
let (i, message_body) = map_parser(take(length - PGSQL_LENGTH_FIELD), |b| {
))
}
-fn pgsql_parse_notice_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn pgsql_parse_notice_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'N')(i)?;
let (i, length) = verify(be_u32, |&x| x > 10)(i)?;
let (i, message_body) = map_parser(take(length - PGSQL_LENGTH_FIELD), |b| {
))
}
-fn parse_notification_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+fn parse_notification_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, identifier) = verify(be_u8, |&x| x == b'A')(i)?;
// length (u32) + pid (u32) + at least one byte, for we have two str fields
let (i, length) = verify(be_u32, |&x| x > 9)(i)?;
Ok((i, msg))
}
-pub fn pgsql_parse_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage> {
+pub fn pgsql_parse_response(i: &[u8]) -> IResult<&[u8], PgsqlBEMessage, PgsqlParseError<&[u8]>> {
let (i, tag) = peek(be_u8)(i)?;
let (i, message) = match tag {
b'E' => pgsql_parse_error_response(i)?,
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Result should not be an error: {:?}.", err.code);
+ panic!("Result should not be an error: {:?}.", err);
}
Err(Err::Incomplete(_)) => {
panic!("Result should not have been incomplete.");
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?}", needed);
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?}", needed);
}
Err(Err::Error(err)) => {
panic!(
- "Shouldn't be err {:?}, expected Ok(_). Remainder is: {:?} ",
- err.code, err.input
+ "Shouldn't be err {:?}, expected Ok(_).",
+ err
);
}
Err(Err::Incomplete(needed)) => {
Ok((_remainder, _message)) => panic!("Result should not be ok, but incomplete."),
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
assert_eq!(needed, Needed::new(2));
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?}", needed);
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?} ", needed);
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?}", needed);
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?}", needed);
match incomplete_result {
Ok((_remainder, _message)) => panic!("Should not be Ok(_), expected Incomplete!"),
Err(Err::Error(err)) => {
- panic!("Should not be error {:?}, expected Incomplete!", err.code)
+ panic!("Should not be error {:?}, expected Incomplete!", err)
}
Err(Err::Incomplete(needed)) => assert_eq!(needed, Needed::new(16)),
_ => panic!("Unexpected behavior, expected Incomplete."),
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error {:?} expected Ok(_)", err.code)
+ panic!("Shouldn't be error {:?} expected Ok(_)", err)
}
Err(Err::Incomplete(needed)) => {
panic!("shouldn't be incomplete {:?}, expected Ok(_)", needed)
match result_incomplete {
Ok((_remainder, _message)) => panic!("Should not be Ok(_), expected Incomplete!"),
Err(Err::Error(err)) => {
- panic!("Shouldn't be error {:?} expected Incomplete!", err.code)
+ panic!("Shouldn't be error {:?} expected Incomplete!", err)
}
Err(Err::Incomplete(needed)) => {
assert_eq!(needed, Needed::new(62));
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error {:?}, expected Ok(_)", err.code);
+ panic!("Shouldn't be error {:?}, expected Ok(_)", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Shouldn't be incomplete {:?}, expected OK(_)", needed);
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error {:?}, expected Ok(_)", err.code)
+ panic!("Shouldn't be error {:?}, expected Ok(_)", err)
}
Err(Err::Incomplete(needed)) => {
panic!("Shouldn't be incomplete: {:?}, expected Ok(_)", needed)
assert_eq!(message, ok_res);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?} expected Ok(_)", err.code)
+ panic!("Shouldn't be error: {:?} expected Ok(_)", err)
}
Err(Err::Incomplete(needed)) => {
panic!("Shouldn't be incomplete: {:?}, expected Ok(_)", needed)
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be Incomplete! Needed: {:?}", needed);
assert_eq!(message, ok_res);
}
Err(Err::Error(err)) => {
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be incomplete. Needed {:?}", needed);
assert_eq!(remainder.len(), 0);
}
Err(Err::Error(err)) => {
- panic!("Should not be error {:?}", err.code);
+ panic!("Should not be error {:?}", err);
}
Err(Err::Incomplete(needed)) => {
panic!("Should not be incomplete. Needed: {:?}", needed);
panic!("Should not be Incomplete! Needed: {:?}", needed);
}
Err(Err::Error(err)) => {
- println!("Remainder is: {:?}", err.input);
- panic!("Shouldn't be error: {:?}", err.code);
+ panic!("Shouldn't be error: {:?}", err);
}
_ => {
panic!("Unexpected behavior");
);
}
Err(Err::Error(err)) => {
- println!("Unparsed slice: {:?}", err.input);
- panic!("Shouldn't be Error: {:?}, expected Ok()", err.code);
+ panic!("Shouldn't be Error: {:?}, expected Ok()", err);
}
_ => {
panic!("Unexpected behavior, should be Ok()");