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
15A HaProxy V2 parser.
16
17Use the [ProxyHdrV2] to compose the header.
18
19Use the [ProxyV2Parser] to parse the Ha proxy V2 header.
20
21## Examples:
22
23Composer:
24```rust
25use haprox_rs::{ProxyV2Addr, ProxyHdrV2, HdrV2OpProxy, ProxyTransportFam, PP2TlvClient};
26
27let addr = ProxyV2Addr::try_from(("127.0.0.1:39754", "127.0.0.67:11883")).unwrap();
28
29let mut comp =
30 ProxyHdrV2::<HdrV2OpProxy>::new(ProxyTransportFam::STREAM, addr).unwrap();
31
32let plts = comp.set_plts();
33
34let mut ssl = plts.add_ssl(PP2TlvClient::PP2_CLIENT_SSL, 0).unwrap();
35
36ssl.add_ssl_sub_version("TLSv1.2").unwrap();
37
38ssl.done().unwrap();
39
40let pkt: Vec<u8> = comp.try_into().unwrap();
41```
42
43Parser:
44
45```rust
46use haprox_rs::{ProxyV2Addr, ProxyHdrV2, HdrV2OpProxy, ProxyTransportFam,
47 PP2TlvClient, ProxyV2Parser, ProtocolVersion, HdrV2Command, ProxyV2AddrType, PP2Tlvs};
48use haprox_rs::protocol::protocol_raw;
49use crate::haprox_rs::protocol::PP2TlvDump;
50
51let pkt_ssl =
52b"\x0d\x0a\x0d\x0a\x00\x0d\x0a\x51\x55\x49\x54\x0a\x21\x11\x00\x2a\
53\x7f\x00\x00\x01\x7f\x00\x00\x43\x9d\xd2\x2e\x6b\x20\x00\x1b\x07\
54\x00\x00\x00\x00\x21\x00\x07\x54\x4c\x53\x76\x31\x2e\x32\x22\x00\
55\x09\x6d\x71\x74\x74\x75\x73\x65\x72\x31";
56
57let dec = ProxyV2Parser::try_from_slice(pkt_ssl.as_slice()).unwrap();
58
59assert_eq!(dec.get_transport().is_ok(), true);
60assert_eq!(dec.get_transport().unwrap(), ProxyTransportFam::STREAM);
61
62assert_eq!(dec.get_proto_version(), ProtocolVersion::V2);
63assert_eq!(dec.get_proto_command(), HdrV2Command::PROXY);
64
65assert_eq!(dec.get_address_family().is_ok(), true);
66assert_eq!(dec.get_address_family().unwrap(), ProxyV2AddrType::AfInet);
67
68assert_eq!(dec.get_palyload_len() as usize, pkt_ssl.len() - size_of::<protocol_raw::ProxyHdrV2>());
69
70let addr = dec.get_address().unwrap();
71
72assert_eq!(addr.is_some(), true);
73
74let addr = addr.unwrap();
75let maddr = ProxyV2Addr::try_from(("127.0.0.1:40402", "127.0.0.67:11883")).unwrap();
76
77assert_eq!(addr, maddr);
78
79let tlv_iter = dec.get_tlvs_iter();
80
81assert_eq!(tlv_iter.is_some(), true);
82
83let mut tlv_iter = tlv_iter.unwrap();
84
85let type_ssl = tlv_iter.next().unwrap().take_internal().unwrap();
86
87assert_eq!(type_ssl.get_type(), PP2Tlvs::TYPE_SSL);
88let PP2Tlvs::TypeSsl { client, verify } = type_ssl else {panic!("wrong")};
89
90assert_eq!(client, PP2TlvClient::all());
91assert_eq!(verify, 0);
92```
93 */
94extern crate bitflags;
95pub extern crate byteorder;
96extern crate crc32fast;
97
98pub mod protocol;
99pub mod error;
100pub mod common;
101
102pub use crate::error::HaProxRes;
103pub use crate::protocol::protocol::*;
104pub use crate::protocol::protocol_parser::{ProxyV2Parser, ProxyV2TlvSource, ProxyV2TlvIter};
105pub use crate::protocol::protocol_composer::{HdrV2OpLocal, HdrV2OpProxy, TlvSubTypeSsl, TlType, ProxyHdrV2};
106
107pub use byteorder::{BigEndian, WriteBytesExt};