pg_stream 0.2.0

A low-level, zero-overhead Rust implementation of the Postgres wire protocol.
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

//! Cleartext password authentication.
//!
//! This is the simplest form of password authentication where the password
//! is sent as-is (null-terminated). Should only be used over TLS connections.

use bytes::{BufMut, BytesMut};

use crate::message::frontend::{MessageCode, cstring_len, frame};

/// Encodes a cleartext password message.
///
/// Returns a `BytesMut` containing the password message ready to be sent.
///
/// # Arguments
///
/// * `password` - The password to encode
///
/// # Example
///
/// ```rust
/// use pg_stream::auth::cleartext_password;
///
/// let msg = cleartext_password("my_secret_password");
/// // Send msg to the server
/// ```
pub fn cleartext_password(password: &str) -> BytesMut {
    let mut msg = BytesMut::new();
    msg.put_u8(MessageCode::PASSWORD_MESSAGE.as_u8());
    frame(&mut msg, cstring_len(password.as_bytes()), |buf| {
        buf.put_slice(password.as_bytes());
        buf.put_u8(0);
    });
    msg
}

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

    #[test]
    fn test_cleartext_password() {
        let msg = cleartext_password("secret");

        // Check message code
        assert_eq!(msg[0], b'p');
        // Check length (4 + "secret\0" = 4 + 7 = 11)
        let len = u32::from_be_bytes([msg[1], msg[2], msg[3], msg[4]]);
        assert_eq!(len, 11);
        // Check password content (including null terminator)
        assert_eq!(&msg[5..12], b"secret\0");
    }
}