All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jason Baron <jbaron@akamai.com>
To: davem@davemloft.net, edumazet@google.com
Cc: ycheng@google.com, ilubashe@akamai.com, netdev@vger.kernel.org,
	Christoph Paasch <cpaasch@apple.com>
Subject: [PATCH net-next 5/6] Documentation: ip-sysctl.txt: Document tcp_fastopen_key
Date: Wed, 22 May 2019 16:39:37 -0400	[thread overview]
Message-ID: <aa4defa5f0f75908b140855e4495388468a94c01.1558557001.git.jbaron@akamai.com> (raw)
In-Reply-To: <cover.1558557001.git.jbaron@akamai.com>
In-Reply-To: <cover.1558557001.git.jbaron@akamai.com>

Add docs for /proc/sys/net/ipv4/tcp_fastopen_key

Signed-off-by: Christoph Paasch <cpaasch@apple.com>
Signed-off-by: Jason Baron <jbaron@akamai.com>
---
 Documentation/networking/ip-sysctl.txt | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/Documentation/networking/ip-sysctl.txt b/Documentation/networking/ip-sysctl.txt
index 14fe930..e8d848e 100644
--- a/Documentation/networking/ip-sysctl.txt
+++ b/Documentation/networking/ip-sysctl.txt
@@ -648,6 +648,26 @@ tcp_fastopen_blackhole_timeout_sec - INTEGER
 	0 to disable the blackhole detection.
 	By default, it is set to 1hr.
 
+tcp_fastopen_key - list of comma separated 32-digit hexadecimal INTEGERs
+	The list consists of a primary key and an optional backup key. The
+	primary key is used for both creating and validating cookies, while the
+	optional backup key is only used for validating cookies. The purpose of
+	the backup key is to maximize TFO validation when keys are rotated.
+
+	A randomly chosen primary key may be configured by the kernel if
+	the tcp_fastopen sysctl is set to 0x400 (see above), or if the
+	TCP_FASTOPEN setsockopt() optname is set and a key has not been
+	previously configured via sysctl. If keys are configured via
+	setsockopt() by using the TCP_FASTOPEN_KEY optname, then those
+	per-socket keys will be used instead of any keys that are specified via
+	sysctl.
+
+	A key is specified as 4 8-digit hexadecimal integers which are separted
+	by a '-' as: xxxxxxxx-xxxxxxxx-xxxxxxxx-xxxxxxxx. Leading zeros may be
+	omitted. A primary and a backup key may be specified by separting them
+	by a comma. If only one key is specified, it becomes the primary key and
+	any previous backup keys are removed.
+
 tcp_syn_retries - INTEGER
 	Number of times initial SYNs for an active TCP connection attempt
 	will be retransmitted. Should not be higher than 127. Default value
-- 
2.7.4


  parent reply	other threads:[~2019-05-22 20:42 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-22 20:39 [PATCH net-next 0/6] add TFO backup key Jason Baron
2019-05-22 20:39 ` [PATCH net-next 1/6] tcp: introduce __tcp_fastopen_cookie_gen_cipher() Jason Baron
2019-05-22 20:39 ` [PATCH net-next 2/6] tcp: add backup TFO key infrastructure Jason Baron
2019-05-22 20:39 ` [PATCH net-next 3/6] tcp: add support to TCP_FASTOPEN_KEY for optional backup key Jason Baron
2019-05-22 20:39 ` [PATCH net-next 4/6] tcp: add support for optional TFO backup key to /proc/sys/net/ipv4/tcp_fastopen_key Jason Baron
2019-05-22 20:39 ` Jason Baron [this message]
2019-05-22 21:07   ` [PATCH net-next 5/6] Documentation: ip-sysctl.txt: Document tcp_fastopen_key Jeremy Sowden
2019-05-22 20:39 ` [PATCH net-next 6/6] selftests/net: add TFO key rotation selftest Jason Baron
2019-05-23 19:14 ` [PATCH net-next 0/6] add TFO backup key David Miller
2019-05-23 23:31   ` Yuchung Cheng
2019-05-24 23:17     ` Yuchung Cheng
2019-05-28 14:36       ` Jason Baron
2019-05-28 16:44         ` Yuchung Cheng

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aa4defa5f0f75908b140855e4495388468a94c01.1558557001.git.jbaron@akamai.com \
    --to=jbaron@akamai.com \
    --cc=cpaasch@apple.com \
    --cc=davem@davemloft.net \
    --cc=edumazet@google.com \
    --cc=ilubashe@akamai.com \
    --cc=netdev@vger.kernel.org \
    --cc=ycheng@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.