haprox_rs/lib.rs
1/*-
2 * haprox-rs - a HaProxy protocol parser.
3 *
4 * Copyright 2025 (c) Aleksandr Morozov
5 * The scram-rs crate can be redistributed and/or modified
6 * under the terms of either of the following licenses:
7 *
8 * 1. the Mozilla Public License Version 2.0 (the “MPL”) OR
9 *
10 * 2. EUROPEAN UNION PUBLIC LICENCE v. 1.2 EUPL © the European Union 2007, 2016
11 */
12
13/*!
14 <img src="https://cdn.4neko.org/haprox_rs_logo.webp" width="280"/> <img src="https://cdn.4neko.org/source_avail.webp" width="280"/> <img src="https://cdn.4neko.org/mpl_or_eupl_500.webp" width="280"/>
15
16A HaProxy V2 parser.
17
18Use the [ProxyHdrV2] to compose the header.
19
20Use the [ProxyV2Parser] to parse the Ha proxy V2 header.
21
22## Examples:
23
24Composer:
25```rust
26use haprox_rs::{ProxyV2Addr, ProxyHdrV2, HdrV2OpProxy, ProxyTransportFam, PP2TlvClient};
27
28let addr = ProxyV2Addr::try_from(("127.0.0.1:39754", "127.0.0.67:11883")).unwrap();
29
30let mut comp =
31 ProxyHdrV2::<HdrV2OpProxy>::new(ProxyTransportFam::STREAM, addr).unwrap();
32
33let plts = comp.set_plts();
34
35let mut ssl = plts.add_ssl(PP2TlvClient::PP2_CLIENT_SSL, 0).unwrap();
36
37ssl.add_ssl_sub_version("TLSv1.2").unwrap();
38
39ssl.done().unwrap();
40
41let pkt: Vec<u8> = comp.try_into().unwrap();
42```
43
44Parser:
45
46```rust
47use haprox_rs::{ProxyV2Addr, ProxyHdrV2, HdrV2OpProxy, ProxyTransportFam,
48 PP2TlvClient, ProxyV2Parser, ProtocolVersion, HdrV2Command, ProxyV2AddrType, PP2Tlvs};
49use haprox_rs::protocol::protocol_raw;
50use crate::haprox_rs::protocol::PP2TlvDump;
51
52let pkt_ssl =
53b"\x0d\x0a\x0d\x0a\x00\x0d\x0a\x51\x55\x49\x54\x0a\x21\x11\x00\x2a\
54\x7f\x00\x00\x01\x7f\x00\x00\x43\x9d\xd2\x2e\x6b\x20\x00\x1b\x07\
55\x00\x00\x00\x00\x21\x00\x07\x54\x4c\x53\x76\x31\x2e\x32\x22\x00\
56\x09\x6d\x71\x74\x74\x75\x73\x65\x72\x31";
57
58let dec = ProxyV2Parser::try_from_slice(pkt_ssl.as_slice()).unwrap();
59
60assert_eq!(dec.get_transport().is_ok(), true);
61assert_eq!(dec.get_transport().unwrap(), ProxyTransportFam::STREAM);
62
63assert_eq!(dec.get_proto_version(), ProtocolVersion::V2);
64assert_eq!(dec.get_proto_command(), HdrV2Command::PROXY);
65
66assert_eq!(dec.get_address_family().is_ok(), true);
67assert_eq!(dec.get_address_family().unwrap(), ProxyV2AddrType::AfInet);
68
69assert_eq!(dec.get_palyload_len() as usize, pkt_ssl.len() - size_of::<protocol_raw::ProxyHdrV2>());
70
71let addr = dec.get_address().unwrap();
72
73assert_eq!(addr.is_some(), true);
74
75let addr = addr.unwrap();
76let maddr = ProxyV2Addr::try_from(("127.0.0.1:40402", "127.0.0.67:11883")).unwrap();
77
78assert_eq!(addr, maddr);
79
80let tlv_iter = dec.get_tlvs_iter();
81
82assert_eq!(tlv_iter.is_some(), true);
83
84let mut tlv_iter = tlv_iter.unwrap();
85
86let type_ssl = tlv_iter.next().unwrap().take_internal().unwrap();
87
88assert_eq!(type_ssl.get_type(), PP2Tlvs::TYPE_SSL);
89let PP2Tlvs::TypeSsl { client, verify } = type_ssl else {panic!("wrong")};
90
91assert_eq!(client, PP2TlvClient::all());
92assert_eq!(verify, 0);
93```
94 */
95extern crate bitflags;
96pub extern crate byteorder;
97extern crate crc32fast;
98
99pub mod protocol;
100pub mod error;
101pub mod common;
102
103pub use crate::error::HaProxRes;
104pub use crate::protocol::protocol::*;
105pub use crate::protocol::protocol_parser::{ProxyV2Parser, ProxyV2TlvSource, ProxyV2TlvIter};
106pub use crate::protocol::protocol_composer::{HdrV2OpLocal, HdrV2OpProxy, TlvSubTypeSsl, TlType, ProxyHdrV2};
107
108pub use byteorder::{BigEndian, WriteBytesExt};