use bytes::{Buf, BufMut, BytesMut}; ///! Implementation of the PostgreSQL server (database) protocol. ///! Here we are pretending to the a Postgres client. use log::{debug, error, info}; use tokio::io::{AsyncReadExt, BufReader}; use tokio::net::{ tcp::{OwnedReadHalf, OwnedWriteHalf}, TcpStream, }; use crate::config::{Address, User}; use crate::constants::*; use crate::errors::Error; use crate::messages::*; use crate::stats::Reporter; use crate::ClientServerMap; /// Server state. pub struct Server { // Server host, e.g. localhost, // port, e.g. 5432, and role, e.g. primary or replica. address: Address, // Buffered read socket. read: BufReader, // Unbuffered write socket (our client code buffers). write: OwnedWriteHalf, // Our server response buffer. We buffer data before we give it to the client. buffer: BytesMut, // Server information the server sent us over on startup. server_info: BytesMut, // Backend id and secret key used for query cancellation. process_id: i32, secret_key: i32, // Is the server inside a transaction or idle. in_transaction: bool, // Is there more data for the client to read. data_available: bool, // Is the server broken? We'll remote it from the pool if so. bad: bool, // Mapping of clients and servers used for query cancellation. client_server_map: ClientServerMap, // Server connected at. connected_at: chrono::naive::NaiveDateTime, // Reports various metrics, e.g. data sent & received. stats: Reporter, } impl Server { /// Pretend to be the Postgres client and connect to the server given host, port and credentials. /// Perform the authentication and return the server in a ready for query state. pub async fn startup( address: &Address, user: &User, database: &str, client_server_map: ClientServerMap, stats: Reporter, ) -> Result { let mut stream = match TcpStream::connect(&format!("{}:{}", &address.host, &address.port)).await { Ok(stream) => stream, Err(err) => { error!("Could not connect to server: {}", err); return Err(Error::SocketError); } }; debug!("Sending StartupMessage"); // Send the startup packet telling the server we're a normal Postgres client. startup(&mut stream, &user.name, database).await?; let mut server_info = BytesMut::new(); let mut process_id: i32 = 0; let mut secret_key: i32 = 0; // We'll be handling multiple packets, but they will all be structured the same. // We'll loop here until this exchange is complete. loop { let code = match stream.read_u8().await { Ok(code) => code as char, Err(_) => return Err(Error::SocketError), }; let len = match stream.read_i32().await { Ok(len) => len, Err(_) => return Err(Error::SocketError), }; debug!("Message: {}", code); match code { // Authentication 'R' => { // Determine which kind of authentication is required, if any. let auth_code = match stream.read_i32().await { Ok(auth_code) => auth_code, Err(_) => return Err(Error::SocketError), }; debug!("Auth: {}", auth_code); match auth_code { MD5_ENCRYPTED_PASSWORD => { // The salt is 4 bytes. // See: https://www.postgresql.org/docs/12/protocol-message-formats.html let mut salt = vec![0u8; 4]; match stream.read_exact(&mut salt).await { Ok(_) => (), Err(_) => return Err(Error::SocketError), }; md5_password(&mut stream, &user.name, &user.password, &salt[..]) .await?; } AUTHENTICATION_SUCCESSFUL => (), _ => { error!("Unsupported authentication mechanism: {}", auth_code); return Err(Error::ServerError); } } } // ErrorResponse 'E' => { let error_code = match stream.read_u8().await { Ok(error_code) => error_code, Err(_) => return Err(Error::SocketError), }; debug!("Error: {}", error_code); match error_code { // No error message is present in the message. MESSAGE_TERMINATOR => (), // An error message will be present. _ => { // Read the error message without the terminating null character. let mut error = vec![0u8; len as usize - 4 - 1]; match stream.read_exact(&mut error).await { Ok(_) => (), Err(_) => return Err(Error::SocketError), }; // TODO: the error message contains multiple fields; we can decode them and // present a prettier message to the user. // See: https://www.postgresql.org/docs/12/protocol-error-fields.html error!("Server error: {}", String::from_utf8_lossy(&error)); } }; return Err(Error::ServerError); } // ParameterStatus 'S' => { let mut param = vec![0u8; len as usize - 4]; match stream.read_exact(&mut param).await { Ok(_) => (), Err(_) => return Err(Error::SocketError), }; // Save the parameter so we can pass it to the client later. // These can be server_encoding, client_encoding, server timezone, Postgres version, // and many more interesting things we should know about the Postgres server we are talking to. server_info.put_u8(b'S'); server_info.put_i32(len); server_info.put_slice(¶m[..]); } // BackendKeyData 'K' => { // The frontend must save these values if it wishes to be able to issue CancelRequest messages later. // See: https://www.postgresql.org/docs/12/protocol-message-formats.html process_id = match stream.read_i32().await { Ok(id) => id, Err(_) => return Err(Error::SocketError), }; secret_key = match stream.read_i32().await { Ok(id) => id, Err(_) => return Err(Error::SocketError), }; } // ReadyForQuery 'Z' => { let mut idle = vec![0u8; len as usize - 4]; match stream.read_exact(&mut idle).await { Ok(_) => (), Err(_) => return Err(Error::SocketError), }; // This is the last step in the client-server connection setup, // and indicates the server is ready for to query it. let (read, write) = stream.into_split(); return Ok(Server { address: address.clone(), read: BufReader::new(read), write: write, buffer: BytesMut::with_capacity(8196), server_info: server_info, process_id: process_id, secret_key: secret_key, in_transaction: false, data_available: false, bad: false, client_server_map: client_server_map, connected_at: chrono::offset::Utc::now().naive_utc(), stats: stats, }); } // We have an unexpected message from the server during this exchange. // Means we implemented the protocol wrong or we're not talking to a Postgres server. _ => { error!("Unknown code: {}", code); return Err(Error::ProtocolSyncError); } }; } } /// Issue a query cancellation request to the server. /// Uses a separate connection that's not part of the connection pool. pub async fn cancel( host: &str, port: &str, process_id: i32, secret_key: i32, ) -> Result<(), Error> { let mut stream = match TcpStream::connect(&format!("{}:{}", host, port)).await { Ok(stream) => stream, Err(err) => { error!("Could not connect to server: {}", err); return Err(Error::SocketError); } }; debug!("Sending CancelRequest"); let mut bytes = BytesMut::with_capacity(16); bytes.put_i32(16); bytes.put_i32(CANCEL_REQUEST_CODE); bytes.put_i32(process_id); bytes.put_i32(secret_key); Ok(write_all(&mut stream, bytes).await?) } /// Send messages to the server from the client. pub async fn send(&mut self, messages: BytesMut) -> Result<(), Error> { self.stats.data_sent(messages.len()); match write_all_half(&mut self.write, messages).await { Ok(_) => Ok(()), Err(err) => { error!("Terminating server because of: {:?}", err); self.bad = true; Err(err) } } } /// Receive data from the server in response to a client request. /// This method must be called multiple times while `self.is_data_available()` is true /// in order to receive all data the server has to offer. pub async fn recv(&mut self) -> Result { loop { let mut message = match read_message(&mut self.read).await { Ok(message) => message, Err(err) => { error!("Terminating server because of: {:?}", err); self.bad = true; return Err(err); } }; // Buffer the message we'll forward to the client later. self.buffer.put(&message[..]); let code = message.get_u8() as char; let _len = message.get_i32(); debug!("Message: {}", code); match code { // ReadyForQuery 'Z' => { let transaction_state = message.get_u8() as char; match transaction_state { // In transaction. 'T' => { self.in_transaction = true; } // Idle, transaction over. 'I' => { self.in_transaction = false; } // Some error occured, the transaction was rolled back. 'E' => { self.in_transaction = true; } // Something totally unexpected, this is not a Postgres server we know. _ => { self.bad = true; return Err(Error::ProtocolSyncError); } }; // There is no more data available from the server. self.data_available = false; break; } // DataRow 'D' => { // More data is available after this message, this is not the end of the reply. self.data_available = true; // Don't flush yet, the more we buffer, the faster this goes... // up to a limit of course. if self.buffer.len() >= 8196 { break; } } // CopyInResponse: copy is starting from client to server. 'G' => break, // CopyOutResponse: copy is starting from the server to the client. 'H' => { self.data_available = true; break; } // CopyData: we are not buffering this one because there will be many more // and we don't know how big this packet could be, best not to take a risk. 'd' => break, // CopyDone // Buffer until ReadyForQuery shows up, so don't exit the loop yet. 'c' => (), // Anything else, e.g. errors, notices, etc. // Keep buffering until ReadyForQuery shows up. _ => (), }; } let bytes = self.buffer.clone(); // Keep track of how much data we got from the server for stats. self.stats.data_received(bytes.len()); // Clear the buffer for next query. self.buffer.clear(); // Pass the data back to the client. Ok(bytes) } /// If the server is still inside a transaction. /// If the client disconnects while the server is in a transaction, we will clean it up. pub fn in_transaction(&self) -> bool { self.in_transaction } /// We don't buffer all of server responses, e.g. COPY OUT produces too much data. /// The client is responsible to call `self.recv()` while this method returns true. pub fn is_data_available(&self) -> bool { self.data_available } /// Server & client are out of sync, we must discard this connection. /// This happens with clients that misbehave. pub fn is_bad(&self) -> bool { self.bad } /// Get server startup information to forward it to the client. /// Not used at the moment. pub fn server_info(&self) -> BytesMut { self.server_info.clone() } /// Indicate that this server connection cannot be re-used and must be discarded. pub fn mark_bad(&mut self) { error!("Server marked bad"); self.bad = true; } /// Claim this server as mine for the purposes of query cancellation. pub fn claim(&mut self, process_id: i32, secret_key: i32) { let mut guard = self.client_server_map.lock().unwrap(); guard.insert( (process_id, secret_key), ( self.process_id, self.secret_key, self.address.host.clone(), self.address.port.clone(), ), ); } /// Execute an arbitrary query against the server. /// It will use the simple query protocol. /// Result will not be returned, so this is useful for things like `SET` or `ROLLBACK`. pub async fn query(&mut self, query: &str) -> Result<(), Error> { let mut query = BytesMut::from(&query.as_bytes()[..]); query.put_u8(0); // C-string terminator (NULL character). let len = query.len() as i32 + 4; let mut msg = BytesMut::with_capacity(len as usize + 1); msg.put_u8(b'Q'); msg.put_i32(len); msg.put_slice(&query[..]); self.send(msg).await?; loop { let _ = self.recv().await?; if !self.data_available { break; } } Ok(()) } /// A shorthand for `SET application_name = $1`. #[allow(dead_code)] pub async fn set_name(&mut self, name: &str) -> Result<(), Error> { Ok(self .query(&format!("SET application_name = '{}'", name)) .await?) } /// Get the servers address. #[allow(dead_code)] pub fn address(&self) -> Address { self.address.clone() } pub fn process_id(&self) -> i32 { self.process_id } } impl Drop for Server { /// Try to do a clean shut down. Best effort because /// the socket is in non-blocking mode, so it may not be ready /// for a write. fn drop(&mut self) { self.stats.server_disconnecting(self.process_id()); let mut bytes = BytesMut::with_capacity(4); bytes.put_u8(b'X'); bytes.put_i32(4); match self.write.try_write(&bytes) { Ok(_) => (), Err(_) => (), }; self.bad = true; let now = chrono::offset::Utc::now().naive_utc(); let duration = now - self.connected_at; info!( "Server connection closed, session duration: {}", crate::format_duration(&duration) ); } }