From cb75e10c99af8c5654d94b9dcae2f8c7879b4f87 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Tue, 5 Dec 2023 12:33:13 +0100
Subject: Add support for the UNIQUE_ID proxy protocol header TLV

---
 doc/src/manual/ranch_proxy_header.asciidoc | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'doc/src/manual/ranch_proxy_header.asciidoc')

diff --git a/doc/src/manual/ranch_proxy_header.asciidoc b/doc/src/manual/ranch_proxy_header.asciidoc
index c194d98..c4ef150 100644
--- a/doc/src/manual/ranch_proxy_header.asciidoc
+++ b/doc/src/manual/ranch_proxy_header.asciidoc
@@ -37,6 +37,7 @@ proxy_info() = #{
     %% Extra TLV-encoded data.
     alpn      => binary(), %% US-ASCII.
     authority => binary(), %% UTF-8.
+    unique_id => binary(), %% Opaque byte sequence of up to 128 bytes.
     netns     => binary(), %% US-ASCII.
     ssl       => #{
         client   := [ssl | cert_conn | cert_sess],
@@ -105,6 +106,10 @@ authority::
 The host name serving as authority for the connection.
 This is typically passed using the SNI extension for TLS.
 
+unique_id::
+An opaque byte sequence of up to 128 bytes generated
+by the upstream proxy that uniquely identifies the connection.
+
 netns::
 
 The namespace's name for the original connection.
@@ -158,6 +163,7 @@ The non-standard TLVs that Ranch was not able to parse.
 
 == Changelog
 
+* *2.2*: The `unique_id` TLV was added.
 * *1.7*: Module introduced.
 
 == See also
-- 
cgit v1.2.3

