summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2020-11-13 15:24:55 +0100
committerDaniel Stenberg <daniel@haxx.se>2020-11-13 23:28:58 +0100
commit03822c3a6d3a0b1b434737eab6d291845f7b30d4 (patch)
tree03655cff20d514db8ed852934c7ba933c54406c9
parentdf2af7dd819f76abada7cb1204c35e75bc1c91b8 (diff)
downloadcurl-03822c3a6d3a0b1b434737eab6d291845f7b30d4.tar.gz
CURLOPT_HSTS.3: document the file format
Closes #6205
-rw-r--r--docs/libcurl/opts/CURLOPT_HSTS.315
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_HSTS.3 b/docs/libcurl/opts/CURLOPT_HSTS.3
index c3fc5bf50..2eb366878 100644
--- a/docs/libcurl/opts/CURLOPT_HSTS.3
+++ b/docs/libcurl/opts/CURLOPT_HSTS.3
@@ -46,6 +46,21 @@ only enable HSTS without reading from or writing to any file.
If this option is set multiple times, libcurl will load cache entries from
each given file but will only store the last used name for later writing.
+.SH "FILE FORMAT"
+The HSTS cache is saved to and loaded from a text file with one entry per
+physical line. Each line in the file has the following format:
+
+[host] [stamp]
+
+[host] is the domain name for the entry and the name is dot-prefixed if it is
+a includeSubDomain entry (if the entry is valid for all subdmains to the name
+as well or only for the exact name).
+
+[stamp] is the time (in UTC) when the entry expires and it uses the format
+\&"YYYYMMDD HH:MM:SS".
+
+Lines starting with "#" are treated as comments and are ignored. There is
+currently no length or size limit.
.SH DEFAULT
NULL, no file name
.SH PROTOCOLS