luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

CURLOPT_ECH: polish

Browse Source 
- remove the pointer to build instructions, it won't work in manpages
- add see-also
- minor white space edits

Closes #13379
This commit is contained in:
Daniel Stenberg 2024-04-16 08:37:43 +02:00
parent f81f60206d
commit a1ecd0ba6b
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 29 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
docs/libcurl/opts/CURLOPT_ECH.md
View File

@ -5,7 +5,7 @@ Title: CURLOPT_ECH
Section: 3
Source: libcurl
See-also:
- (3)
- CURLOPT_DOH_URL (3)
Protocol:
- TLS
TLS-backend:
@ -31,33 +31,43 @@ ECH is only compatible with TLSv1.3.
This experimental feature requires a special build of OpenSSL, as ECH is not
yet supported in OpenSSL releases. In contrast ECH is supported by the latest
BoringSSL and wolfSSL releases. See [ECH.md](../../ECH.md) for details of how
to build such an OpenSSL library.
BoringSSL and wolfSSL releases.
There is also a known issue with using wolfSSL which does not support ECH
when the HelloRetryRequest mechanism is used.
There is also a known issue with using wolfSSL which does not support ECH when
the HelloRetryRequest mechanism is used.
Pass a string that specifies configuration details for ECH.
In all cases, if ECH is attempted, it may fail for various reasons.
The keywords supported are:
Pass a string that specifies configuration details for ECH. In all cases, if
ECH is attempted, it may fail for various reasons. The keywords supported are:
## false
Turns off ECH.
## grease
Instructs client to emit a GREASE ECH extension.
(The connection fails if ECH is attempted but fails.)
Instructs client to emit a GREASE ECH extension. (The connection fails if ECH
is attempted but fails.)
## true
Instructs client to attempt ECH, if possible, but to not fail if attempting ECH is not possible.
Instructs client to attempt ECH, if possible, but to not fail if attempting
ECH is not possible.
## hard
Instructs client to attempt ECH and fail if if attempting ECH is not possible.
## ecl:\<base64-value\>
If the string starts with "ecl:" then the remainder of the string should be a base64-encoded
ECHConfigList that is used for ECH rather than attempting to download such a value from
the DNS.
If the string starts with `ecl:` then the remainder of the string should be a
base64-encoded ECHConfigList that is used for ECH rather than attempting to
download such a value from the DNS.
## pn:\<name\>
If the string starts with "pn:" then the remainder of the string should be a DNS/hostname
that is used to over-ride the public_name field of the ECHConfigList that is used
for ECH.
If the string starts with `pn:` then the remainder of the string should be a
DNS/hostname that is used to over-ride the public_name field of the
ECHConfigList that is used for ECH.
# DEFAULT
@ -80,4 +90,5 @@ Added in 8.8.0
# RETURN VALUE
Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient heap space.
Returns CURLE_OK on success or CURLE_OUT_OF_MEMORY if there was insufficient
heap space.