Ranch 1.7.1 and Cowboy 2.6.1

1 files changed, 80 insertions, 58 deletions

diff --git a/docs/index.xml b/docs/index.xml
index 8da47e8a..5bfba95e 100644
--- a/docs/index.xml
+++ b/docs/index.xml
@@ -1761,14 +1761,14 @@ Ranch 1.6.1 This release fixes a minor issue in the README and adds an undocumen
     </item>
     
     <item>
-      <title>Migrating from Ranch 1.6 to 1.7</title>
-      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.6/</link>
+      <title>Changes since Ranch 1.7</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.7/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.6/</guid>
-      <description>Ranch 1.7 adds built-in support for the PROXY protocol.
-The PROXY protocol is a simple and efficient way for proxies to transmit information about the client.
-While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description>
+      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.7/</guid>
+      <description>The following patch versions were released since Ranch 1.7:
+Ranch 1.7.1 This release fixes an issue with the PROXY protocol where the wrong CRC32 algorithm was used and would cause checksum verification to fail.
+Because the plain crc32 checksum is not supported by the PROXY protocol, the configuration value when building PROXY headers has been changed to crc32c.</description>
     </item>
     
     <item>
@@ -1950,14 +1950,14 @@ Features added Listeners can now be suspended/resumed without stopping existing
     </item>
     
     <item>
-      <title>Migrating from Ranch 1.5 to 1.6</title>
-      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</link>
+      <title>Migrating from Ranch 1.6 to 1.7</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.6/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</guid>
-      <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0.
-Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed.
-Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes.  Transport options can now be updated for suspended listeners.</description>
+      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.6/</guid>
+      <description>Ranch 1.7 adds built-in support for the PROXY protocol.
+The PROXY protocol is a simple and efficient way for proxies to transmit information about the client.
+While a third-party library already existed, it was not entirely compatible with the Ranch interface, in particular when socket active mode was involved. This new implementation fixes that and supports the full protocol with as little overhead as possible compared to normal operations: just one extra function call.</description>
     </item>
     
     <item>
@@ -2049,21 +2049,22 @@ The Req object is the subject of a few different chapters. In this chapter we wi
     </item>
     
     <item>
-      <title>Migrating from Ranch 1.x</title>
-      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</link>
+      <title>Migrating from Ranch 1.5 to 1.6</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</guid>
-      <description>The changelog for Ranch releases before 1.6 can be found in this section.
-1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2  Fix ranch:info/0 and ranch:procs/2 in embedded mode  Prevent ranch_conns_sup from stopping on unexpected messages   1.4.0 Add new transport option num_acceptor  Deprecate ranch:start_listener/6 in favor of start_listener/5  Deprecate ranch:child_spec/6 in favor of child_spec/5   1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description>
+      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.5/</guid>
+      <description>Ranch 1.6 added the ability to suspend and resume listeners. It also deprecates a number of features and add interfaces that will be used in Ranch 2.0.
+Ranch 1.6 is compatible with Erlang/OTP 18.0 onward. Support for older releases has been removed.
+Features added Listeners can now be suspended/resumed without stopping existing connection processes. This effectively closes the listening socket and stops the acceptor processes.  Transport options can now be updated for suspended listeners.</description>
     </item>
     
     <item>
       <title>Migrating from Ranch 1.x</title>
-      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</link>
+      <link>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</guid>
+      <guid>https://ninenines.eu/docs/en/ranch/1.6/guide/migrating_from_1.x/</guid>
       <description>The changelog for Ranch releases before 1.6 can be found in this section.
 1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2  Fix ranch:info/0 and ranch:procs/2 in embedded mode  Prevent ranch_conns_sup from stopping on unexpected messages   1.4.0 Add new transport option num_acceptor  Deprecate ranch:start_listener/6 in favor of start_listener/5  Deprecate ranch:child_spec/6 in favor of child_spec/5   1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description>
     </item>
@@ -2260,6 +2261,16 @@ While only one response is allowed for every request, HTTP/2 introduced a mechan
     </item>
     
     <item>
+      <title>Migrating from Ranch 1.x</title>
+      <link>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/migrating_from_1.x/</guid>
+      <description>The changelog for Ranch releases before 1.6 can be found in this section.
+1.5.0 Add transport functions getopts/2, getstat/1 and getstat/2  Fix ranch:info/0 and ranch:procs/2 in embedded mode  Prevent ranch_conns_sup from stopping on unexpected messages   1.4.0 Add new transport option num_acceptor  Deprecate ranch:start_listener/6 in favor of start_listener/5  Deprecate ranch:child_spec/6 in favor of child_spec/5   1.3.0 The version numbers 1.3.1 and 1.3.2 were later made to fix small mistakes made during the 1.</description>
+    </item>
+    
+    <item>
       <title>Erlang shell</title>
       <link>https://ninenines.eu/docs/en/erlang.mk/1/guide/shell/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -3174,6 +3185,17 @@ Cowboy 2.2.2 While fixing the miscount in the previous patch release an issue wa
     </item>
     
     <item>
+      <title>Changes since Cowboy 2.6</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.6/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.6/</guid>
+      <description>The following patch versions were released since Cowboy 2.6:
+Cowboy 2.6.1 This release updates Ranch to 1.7.1.
+It fixes an issue with the PROXY protocol where the wrong CRC32 algorithm was used and would cause checksum verification to fail.</description>
+    </item>
+    
+    <item>
       <title>Migrating from Cowboy 1.0 to 2.0</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/migrating_from_1.0/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -3225,17 +3247,6 @@ Features added Add option linger_timeout to control how long Cowboy will wait be
     </item>
     
     <item>
-      <title>Migrating from Cowboy 2.5 to 2.6</title>
-      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/</link>
-      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
-      
-      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/</guid>
-      <description>Cowboy 2.6 greatly refactored the HTTP/2 code, a large part of which was moved to Cowlib and is now used by both the Cowboy server and the Gun client.
-A large number of tickets were also closed which resulted in many bugs fixed and many features and options added, although some of them are still experimental.
-Features added Add support for the PROXY protocol header. It can be enabled via the proxy_header option.</description>
-    </item>
-    
-    <item>
       <title>HTTP and other specifications</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.0/guide/specs/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -3297,13 +3308,14 @@ Features added Add experimental support for Websocket over HTTP/2. You can use t
     </item>
     
     <item>
-      <title>Migrating from Cowboy 2.4 to 2.5</title>
-      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/</link>
+      <title>Migrating from Cowboy 2.5 to 2.6</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/</guid>
-      <description>Cowboy 2.5 focused on making the test suites pass. A variety of new features, fixes and improvements have also been worked on.
-Features added Add option linger_timeout to control how long Cowboy will wait before closing the socket when shutting down the connection. This helps avoid the TCP reset problem HTTP/1.1 suffers from. The default is now 1000 ms.  It is now possible to stream a response body without using chunked transfer-encoding when the protocol is HTTP/1.</description>
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.5/</guid>
+      <description>Cowboy 2.6 greatly refactored the HTTP/2 code, a large part of which was moved to Cowlib and is now used by both the Cowboy server and the Gun client.
+A large number of tickets were also closed which resulted in many bugs fixed and many features and options added, although some of them are still experimental.
+Features added Add support for the PROXY protocol header. It can be enabled via the proxy_header option.</description>
     </item>
     
     <item>
@@ -3357,13 +3369,13 @@ Features added Add support for all functions from the module sys. Note that Cowb
     </item>
     
     <item>
-      <title>Migrating from Cowboy 2.3 to 2.4</title>
-      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</link>
+      <title>Migrating from Cowboy 2.4 to 2.5</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</guid>
-      <description>Cowboy 2.4 focused on improving the HTTP/2 implementation. All existing tests from RFC7540 and the h2spec test suite now all pass. Numerous options have been added to control SETTINGS and related behavior. In addition experimental support for Websocket over HTTP/2 was added.
-Features added Add experimental support for Websocket over HTTP/2. You can use the enable_connect_protocol option to enable. It implements the following draft: https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01  Add options max_decode_table_size and max_encode_table_size to restrict the size of the HPACK compression dictionary.</description>
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.4/</guid>
+      <description>Cowboy 2.5 focused on making the test suites pass. A variety of new features, fixes and improvements have also been worked on.
+Features added Add option linger_timeout to control how long Cowboy will wait before closing the socket when shutting down the connection. This helps avoid the TCP reset problem HTTP/1.1 suffers from. The default is now 1000 ms.  It is now possible to stream a response body without using chunked transfer-encoding when the protocol is HTTP/1.</description>
     </item>
     
     <item>
@@ -3409,13 +3421,13 @@ Features added Add support for sending trailers at the end of response bodies. T
     </item>
     
     <item>
-      <title>Migrating from Cowboy 2.2 to 2.3</title>
-      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</link>
+      <title>Migrating from Cowboy 2.3 to 2.4</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</guid>
-      <description>Cowboy 2.3 focused on making the Cowboy processes behave properly according to OTP principles. This version is a very good milestone toward that goal and most of everything should now work. Release upgrades and a few details will be improved in future versions.
-Features added Add support for all functions from the module sys. Note that Cowboy currently does not implement the sys debugging mechanisms as tracing is recommended instead.  Add a max_frame_size option for Websocket handlers to close the connection when the client attempts to send a frame that&amp;apos;s too large.</description>
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.3/</guid>
+      <description>Cowboy 2.4 focused on improving the HTTP/2 implementation. All existing tests from RFC7540 and the h2spec test suite now all pass. Numerous options have been added to control SETTINGS and related behavior. In addition experimental support for Websocket over HTTP/2 was added.
+Features added Add experimental support for Websocket over HTTP/2. You can use the enable_connect_protocol option to enable. It implements the following draft: https://tools.ietf.org/html/draft-ietf-httpbis-h2-websockets-01  Add options max_decode_table_size and max_encode_table_size to restrict the size of the HPACK compression dictionary.</description>
     </item>
     
     <item>
@@ -3460,13 +3472,13 @@ Features added It is now possible to obtain the client TLS certificate and the l
     </item>
     
     <item>
-      <title>Migrating from Cowboy 2.1 to 2.2</title>
-      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</link>
+      <title>Migrating from Cowboy 2.2 to 2.3</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</guid>
-      <description>Cowboy 2.2 focused on adding features required for writing gRPC servers and on completing test suites for the core HTTP RFCs, fixing many bugs along the way.
-Features added Add support for sending trailers at the end of response bodies. Trailers are additional header fields that may be sent after the body to add more information to the response. Their usage is required in gRPC servers. They are optional and may be discarded in other scenarios (for example if the request goes through an HTTP/1.</description>
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.2/</guid>
+      <description>Cowboy 2.3 focused on making the Cowboy processes behave properly according to OTP principles. This version is a very good milestone toward that goal and most of everything should now work. Release upgrades and a few details will be improved in future versions.
+Features added Add support for all functions from the module sys. Note that Cowboy currently does not implement the sys debugging mechanisms as tracing is recommended instead.  Add a max_frame_size option for Websocket handlers to close the connection when the client attempts to send a frame that&amp;apos;s too large.</description>
     </item>
     
     <item>
@@ -3491,13 +3503,13 @@ Compatibility Compatibility with Erlang/OTP R16, 17 and 18 has been dropped. Erl
     </item>
     
     <item>
-      <title>Migrating from Cowboy 2.0 to 2.1</title>
-      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</link>
+      <title>Migrating from Cowboy 2.1 to 2.2</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
-      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</guid>
-      <description>Cowboy 2.1 focused on adding features that were temporarily removed in Cowboy 2.0. A number of bugs found in the 2.0 release were also fixed.
-Features added It is now possible to obtain the client TLS certificate and the local IP/port for the connection from the Req object.  Informational responses (1XX responses) can now be sent. They must be sent before initiating the final response.  The expect: 100-continue header is now handled automatically.</description>
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.1/</guid>
+      <description>Cowboy 2.2 focused on adding features required for writing gRPC servers and on completing test suites for the core HTTP RFCs, fixing many bugs along the way.
+Features added Add support for sending trailers at the end of response bodies. Trailers are additional header fields that may be sent after the body to add more information to the response. Their usage is required in gRPC servers. They are optional and may be discarded in other scenarios (for example if the request goes through an HTTP/1.</description>
     </item>
     
     <item>
@@ -3511,6 +3523,16 @@ HTTP IANA Registries HTTP Method Registry  HTTP Status Code Registry  Message He
     </item>
     
     <item>
+      <title>Migrating from Cowboy 2.0 to 2.1</title>
+      <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      
+      <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_2.0/</guid>
+      <description>Cowboy 2.1 focused on adding features that were temporarily removed in Cowboy 2.0. A number of bugs found in the 2.0 release were also fixed.
+Features added It is now possible to obtain the client TLS certificate and the local IP/port for the connection from the Req object.  Informational responses (1XX responses) can now be sent. They must be sent before initiating the final response.  The expect: 100-continue header is now handled automatically.</description>
+    </item>
+    
+    <item>
       <title>Migrating from Cowboy 1.0 to 2.0</title>
       <link>https://ninenines.eu/docs/en/cowboy/2.6/guide/migrating_from_1.0/</link>
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
@@ -3682,7 +3704,7 @@ cowboy(3) - Listener management  cowboy_req(3) - Request and response  cowboy_ro
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://ninenines.eu/docs/en/cowboy/2.6/guide/</guid>
-      <description>Rationale The modern Web  Erlang and the Web   Introduction Introduction  Getting started  Flow diagram   Configuration Listeners  Routing  Constraints   Handlers Handlers  Loop handlers  Static files   Request and response Request details  Reading the request body  Sending a response  Using cookies  Multipart   REST REST principles  Handling REST requests  REST flowcharts  Designing a resource handler   Websocket The Websocket protocol  Websocket handlers   Advanced Streams  Middlewares   Additional information Migrating from Cowboy 2.</description>
+      <description>Rationale The modern Web  Erlang and the Web   Introduction Introduction  Getting started  Flow diagram   Configuration Listeners  Routing  Constraints   Handlers Handlers  Loop handlers  Static files   Request and response Request details  Reading the request body  Sending a response  Using cookies  Multipart   REST REST principles  Handling REST requests  REST flowcharts  Designing a resource handler   Websocket The Websocket protocol  Websocket handlers   Advanced Streams  Middlewares   Additional information Changes since Cowboy 2.</description>
     </item>
     
     <item>
@@ -3970,7 +3992,7 @@ ranch_ssl(3) - SSL transport  ranch_tcp(3) - TCP transport   Behaviors:</descrip
       <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
       
       <guid>https://ninenines.eu/docs/en/ranch/1.7/guide/</guid>
-      <description>Interface Introduction  Listeners  Transports  Protocols  Embedded mode   How to Writing parsers  SSL client authentication   Advanced Internals   Additional information Upcoming changes in Ranch 2.0  Migrating from Ranch 1.6 to 1.7  Migrating from Ranch 1.5 to 1.6  Migrating from Ranch 1.x   </description>
+      <description>Interface Introduction  Listeners  Transports  Protocols  Embedded mode   How to Writing parsers  SSL client authentication   Advanced Internals   Additional information Upcoming changes in Ranch 2.0  Changes since Ranch 1.7  Migrating from Ranch 1.6 to 1.7  Migrating from Ranch 1.5 to 1.6  Migrating from Ranch 1.x   </description>
     </item>
     
     <item>
@@ -12130,7 +12152,7 @@ Exports ranch_proxy_header:parse(3) - Parse a PROXY protocol header  ranch_proxy
       
       <guid>https://ninenines.eu/docs/en/ranch/1.7/manual/ranch_proxy_header.header/</guid>
       <description>Name ranch_proxy_header:header - Build a PROXY protocol header
-Description header(ProxyInfo) -&amp;gt; header(ProxyInfo, #{}) header(ProxyInfo, BuildOpts) -&amp;gt; iodata() ProxyInfo :: ranch_proxy_header:proxy_info() BuildOpts :: #{ checksum =&amp;gt; crc32, padding =&amp;gt; pos_integer() %% &amp;gt;= 3 }  Build a PROXY protocol header.
+Description header(ProxyInfo) -&amp;gt; header(ProxyInfo, #{}) header(ProxyInfo, BuildOpts) -&amp;gt; iodata() ProxyInfo :: ranch_proxy_header:proxy_info() BuildOpts :: #{ checksum =&amp;gt; crc32c, padding =&amp;gt; pos_integer() %% &amp;gt;= 3 }  Build a PROXY protocol header.
 Arguments ProxyInfo The proxy information to encode.
  BuildOpts Options to control whether to add a checksum or padding should be included in the encoded PROXY protocol header.
   Return value The PROXY protocol header is returned.</description>