misalcedo/ppp

A Proxy Protocol Parser written in Rust.

📢 About Me

Hi, my name is Miguel Salcedo. I am currently working as a Software Developer at . Before that, I worked at for close to 6 years.

🎮 Hobbies

I love to program on my latest idea, watch anime and play video games. Although my 👶 daughter monopolizes most of my time during the day, I still often spend my nights in front of a 💻 or 📺 screen. I start most of my mornings with a cup of ☕ and will have 1 or 2 more before the day is done.

• ⚡ Fun fact: I don't remember the last time I read a book that was not software-related. Though, I do know it was a book in the Witcher series.
• ⚡ Fun fact: In the order I learned them, I speak: Español, English and some 日本語.

📋 My Projects

• Tortuga 🐢 - An HTTP server implementing the CGI protocol for system processes and WASI module instances.
• PPP 💻 - An HAProxy Protocol Parser written in Rust. Parses versions 1 and 2 of the protocol.
• WASM-AST 🕸️ - A WebAssembly Abstract Syntax Tree. Meant to ease WebAssembly code-generation for compilers written in Rust.
• Literate-rs 📔 - A Literate Programming tool that extracts the contents of fenced code blocks from Markdown files.

ppp's Issues

SSL TLV should be hex 0x20

There is a typo in the definition of PP2_TYPE_SSL, it's 20 in decimal and it should be in hex.

ppp/src/v2/model.rs

Line 132 in 2eebc45

SSL = 20,

See proxy-protocol.txt

#define PP2_TYPE_SSL            0x20
#define PP2_SUBTYPE_SSL_VERSION 0x21
#define PP2_SUBTYPE_SSL_CN      0x22

Use Cow in headers

Cow allows borrowed or owned values so the header would be able to store either a byte or string slice, or a byte vector or string respectively.

That allows us to build headers using the same struct returned when parsing headers, which removes the need for the builder. Though we still need the builder's ability to create TLVs.

Auto-publish new versions to crates.io

Add a new release that only runs when when the Cargo.toml file changes on master to publish a new version to crates.IO

Build ppv2 headers to write

The goal is to make writer an enum of either a vec or box dyn write.

Then to create a from impl for write, create a new with builder method, and expose the write header method as having arguments.

Finally flush the writer in build

Short IPv6 parsing

Awesome crate!

HAproxy sends shortened ipv6 sometimes (like ::1), but this crate doesn't parse them. Would it be possible to add this feature?

For example, this test fails:

        let text =
            "PROXY TCP6 ::1 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff 65535 65535\r\nHi!".as_bytes();
        let expected = Header::version_1(
            (
                [0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x1],
                [
                    0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF, 0xFFFF,
                ],
                65535,
                65535,
            )
                .into(),
        );

        assert_eq!(parse_v1_header(text), Ok((&b"Hi!"[..], expected)));

Add support for zero copy header parsing

Currently, creating a header clones all of the information into a struct that owns the cloned bits.

An alternative would be to have a struct with the same lifetime as the input source that could be turned into an owned version as needed.

This would be beneficial in cases where you only need a subset of fields as owned values or don't need the header past the input's lifetime.

See https://doc.rust-lang.org/std/borrow/trait.ToOwned.html

Lastly, would be useful to separate the header into an enum with different structs for version 1 vs. 2. Version 1 is much simpler as it lacks TLV support.