|
| 1 | +// Copyright 2021 Datafuse Labs. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +// Note to developers: you can find decent overviews of the protocol at |
| 16 | +// |
| 17 | +// https://github.com/cwarden/mysql-proxy/blob/master/doc/protocol.rst |
| 18 | +// |
| 19 | +// and |
| 20 | +// |
| 21 | +// https://mariadb.com/kb/en/library/clientserver-protocol/ |
| 22 | +// |
| 23 | +// Wireshark also does a pretty good job at parsing the MySQL protocol. |
| 24 | + |
| 25 | +use tokio::io::{duplex, AsyncReadExt}; |
| 26 | + |
| 27 | +use crate::packet_writer::PacketWriter; |
| 28 | +use crate::writers::write_ok_packet; |
| 29 | +use crate::{CapabilityFlags, OkResponse}; |
| 30 | + |
| 31 | +async fn capture_ok_payload(info: &str, capabilities: CapabilityFlags, header: u8) -> Vec<u8> { |
| 32 | + let (mut client, server) = duplex(1024); |
| 33 | + let mut writer = PacketWriter::new(server); |
| 34 | + |
| 35 | + let ok_packet = OkResponse { |
| 36 | + header, |
| 37 | + info: info.to_string(), |
| 38 | + ..Default::default() |
| 39 | + }; |
| 40 | + |
| 41 | + write_ok_packet(&mut writer, capabilities, ok_packet) |
| 42 | + .await |
| 43 | + .expect("write_ok_packet succeeds"); |
| 44 | + |
| 45 | + let mut header_buf = [0u8; 4]; |
| 46 | + client |
| 47 | + .read_exact(&mut header_buf) |
| 48 | + .await |
| 49 | + .expect("payload header available"); |
| 50 | + let payload_len = (header_buf[0] as usize) |
| 51 | + | ((header_buf[1] as usize) << 8) |
| 52 | + | ((header_buf[2] as usize) << 16); |
| 53 | + let mut payload = vec![0u8; payload_len]; |
| 54 | + client |
| 55 | + .read_exact(&mut payload) |
| 56 | + .await |
| 57 | + .expect("payload body available"); |
| 58 | + payload |
| 59 | +} |
| 60 | + |
| 61 | +fn parse_lenenc_int(data: &[u8]) -> (u64, usize) { |
| 62 | + match data[0] { |
| 63 | + 0xFC => { |
| 64 | + let len = u16::from_le_bytes([data[1], data[2]]) as u64; |
| 65 | + (len, 3) |
| 66 | + } |
| 67 | + 0xFD => { |
| 68 | + let len = (data[1] as u64) | ((data[2] as u64) << 8) | ((data[3] as u64) << 16); |
| 69 | + (len, 4) |
| 70 | + } |
| 71 | + 0xFE => { |
| 72 | + let mut buf = [0u8; 8]; |
| 73 | + buf.copy_from_slice(&data[1..9]); |
| 74 | + (u64::from_le_bytes(buf), 9) |
| 75 | + } |
| 76 | + v => (v as u64, 1), |
| 77 | + } |
| 78 | +} |
| 79 | + |
| 80 | +fn consume_ok_prefix(payload: &[u8]) -> (usize, u8, u16, u16) { |
| 81 | + let mut idx = 0; |
| 82 | + let header = payload[idx]; |
| 83 | + idx += 1; |
| 84 | + |
| 85 | + let (affected_rows, consumed) = parse_lenenc_int(&payload[idx..]); |
| 86 | + assert_eq!(affected_rows, 0); |
| 87 | + idx += consumed; |
| 88 | + |
| 89 | + let (last_insert_id, consumed) = parse_lenenc_int(&payload[idx..]); |
| 90 | + assert_eq!(last_insert_id, 0); |
| 91 | + idx += consumed; |
| 92 | + |
| 93 | + let status = u16::from_le_bytes([payload[idx], payload[idx + 1]]); |
| 94 | + idx += 2; |
| 95 | + |
| 96 | + let warnings = u16::from_le_bytes([payload[idx], payload[idx + 1]]); |
| 97 | + idx += 2; |
| 98 | + |
| 99 | + (idx, header, status, warnings) |
| 100 | +} |
| 101 | + |
| 102 | +#[tokio::test] |
| 103 | +async fn ok_packet_info_lenenc_when_session_track() { |
| 104 | + let info = "Read 1 rows, 1.00 B in 0.007 sec."; |
| 105 | + let payload = capture_ok_payload( |
| 106 | + info, |
| 107 | + CapabilityFlags::CLIENT_PROTOCOL_41 | CapabilityFlags::CLIENT_SESSION_TRACK, |
| 108 | + 0x00, |
| 109 | + ) |
| 110 | + .await; |
| 111 | + |
| 112 | + let (mut idx, header, status, warnings) = consume_ok_prefix(&payload); |
| 113 | + assert_eq!(header, 0x00); |
| 114 | + assert_eq!(status, 0); |
| 115 | + assert_eq!(warnings, 0); |
| 116 | + |
| 117 | + let (info_len, consumed) = parse_lenenc_int(&payload[idx..]); |
| 118 | + assert_eq!(info_len as usize, info.len()); |
| 119 | + idx += consumed; |
| 120 | + |
| 121 | + let encoded = &payload[idx..idx + info.len()]; |
| 122 | + assert_eq!(encoded, info.as_bytes()); |
| 123 | +} |
| 124 | + |
| 125 | +#[tokio::test] |
| 126 | +async fn ok_packet_info_lenenc_when_deprecate_eof() { |
| 127 | + let info = "Read 1 rows, 1.00 B in 0.007 sec."; |
| 128 | + let payload = capture_ok_payload( |
| 129 | + info, |
| 130 | + CapabilityFlags::CLIENT_PROTOCOL_41 | CapabilityFlags::CLIENT_DEPRECATE_EOF, |
| 131 | + 0x00, |
| 132 | + ) |
| 133 | + .await; |
| 134 | + |
| 135 | + let (mut idx, header, status, warnings) = consume_ok_prefix(&payload); |
| 136 | + assert_eq!(header, 0x00); |
| 137 | + assert_eq!(status, 0); |
| 138 | + assert_eq!(warnings, 0); |
| 139 | + |
| 140 | + let (info_len, consumed) = parse_lenenc_int(&payload[idx..]); |
| 141 | + assert_eq!(info_len as usize, info.len()); |
| 142 | + idx += consumed; |
| 143 | + |
| 144 | + let encoded = &payload[idx..idx + info.len()]; |
| 145 | + assert_eq!(encoded, info.as_bytes()); |
| 146 | +} |
| 147 | + |
| 148 | +#[tokio::test] |
| 149 | +async fn ok_packet_info_lenenc_when_header_fe() { |
| 150 | + let info = "Read 1 rows, 1.00 B in 0.007 sec."; |
| 151 | + let payload = capture_ok_payload(info, CapabilityFlags::CLIENT_PROTOCOL_41, 0xfe).await; |
| 152 | + |
| 153 | + let (mut idx, header, status, warnings) = consume_ok_prefix(&payload); |
| 154 | + assert_eq!(header, 0xfe); |
| 155 | + assert_eq!(status, 0); |
| 156 | + assert_eq!(warnings, 0); |
| 157 | + |
| 158 | + let (info_len, consumed) = parse_lenenc_int(&payload[idx..]); |
| 159 | + assert_eq!(info_len as usize, info.len()); |
| 160 | + idx += consumed; |
| 161 | + |
| 162 | + let encoded = &payload[idx..idx + info.len()]; |
| 163 | + assert_eq!(encoded, info.as_bytes()); |
| 164 | +} |
| 165 | + |
| 166 | +#[tokio::test] |
| 167 | +async fn ok_packet_info_plain_when_no_flags() { |
| 168 | + let info = "Read 1 rows, 1.00 B in 0.007 sec."; |
| 169 | + let payload = capture_ok_payload(info, CapabilityFlags::CLIENT_PROTOCOL_41, 0x00).await; |
| 170 | + |
| 171 | + let (idx, header, status, warnings) = consume_ok_prefix(&payload); |
| 172 | + assert_eq!(header, 0x00); |
| 173 | + assert_eq!(status, 0); |
| 174 | + assert_eq!(warnings, 0); |
| 175 | + |
| 176 | + let encoded = &payload[idx..]; |
| 177 | + assert_eq!(encoded, info.as_bytes()); |
| 178 | +} |
| 179 | + |
| 180 | +#[tokio::test] |
| 181 | +async fn ok_packet_info_extended_lenenc_with_flags() { |
| 182 | + let info = "x".repeat(300); |
| 183 | + let payload = capture_ok_payload( |
| 184 | + &info, |
| 185 | + CapabilityFlags::CLIENT_PROTOCOL_41 | CapabilityFlags::CLIENT_SESSION_TRACK, |
| 186 | + 0x00, |
| 187 | + ) |
| 188 | + .await; |
| 189 | + |
| 190 | + let (mut idx, header, status, warnings) = consume_ok_prefix(&payload); |
| 191 | + assert_eq!(header, 0x00); |
| 192 | + assert_eq!(status, 0); |
| 193 | + assert_eq!(warnings, 0); |
| 194 | + |
| 195 | + let (info_len, consumed) = parse_lenenc_int(&payload[idx..]); |
| 196 | + assert_eq!(consumed, 3); // expect 0xFC marker with two-byte length |
| 197 | + assert_eq!(payload[idx], 0xFC); |
| 198 | + assert_eq!(info_len as usize, info.len()); |
| 199 | + idx += consumed; |
| 200 | + |
| 201 | + let encoded = &payload[idx..idx + info.len()]; |
| 202 | + assert_eq!(encoded, info.as_bytes()); |
| 203 | +} |
0 commit comments