* [PATCH 0/2] Documentation: siphash: formatting fixes
@ 2022-03-29 4:29 Bagas Sanjaya
2022-03-29 4:29 ` [PATCH 1/2] Documentation: siphash: convert danger note to warning for HalfSipHash Bagas Sanjaya
2022-03-29 4:29 ` [PATCH 2/2] Documentation: siphash: enclose HalfSipHash usage example in the literal block Bagas Sanjaya
0 siblings, 2 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2022-03-29 4:29 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, Jonathan Corbet, Eric Biggers, Herbert Xu,
Mauro Carvalho Chehab, linux-kernel
Formatting fixes for Documentation/security/siphash.rst. The shortlog
should be self-explanatory.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Eric Biggers <ebiggers@google.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org
Bagas Sanjaya (2):
Documentation: siphash: convert danger note to warning for HalfSipHash
Documentation: siphash: enclose HalfSipHash usage example in the
literal block
Documentation/security/siphash.rst | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
base-commit: f443e374ae131c168a065ea1748feac6b2e76613
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH 1/2] Documentation: siphash: convert danger note to warning for HalfSipHash
2022-03-29 4:29 [PATCH 0/2] Documentation: siphash: formatting fixes Bagas Sanjaya
@ 2022-03-29 4:29 ` Bagas Sanjaya
2022-03-29 4:29 ` [PATCH 2/2] Documentation: siphash: enclose HalfSipHash usage example in the literal block Bagas Sanjaya
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2022-03-29 4:29 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, Jonathan Corbet, Eric Biggers, Herbert Xu,
Mauro Carvalho Chehab, linux-kernel
Render danger paragraph into warning block for emphasization.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Eric Biggers <ebiggers@google.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/security/siphash.rst | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/security/siphash.rst b/Documentation/security/siphash.rst
index bd9363025fcbc1..42794a7e052f1e 100644
--- a/Documentation/security/siphash.rst
+++ b/Documentation/security/siphash.rst
@@ -121,12 +121,12 @@ even scarier, uses an easily brute-forcable 64-bit key (with a 32-bit output)
instead of SipHash's 128-bit key. However, this may appeal to some
high-performance `jhash` users.
-Danger!
-
-Do not ever use HalfSipHash except for as a hashtable key function, and only
-then when you can be absolutely certain that the outputs will never be
-transmitted out of the kernel. This is only remotely useful over `jhash` as a
-means of mitigating hashtable flooding denial of service attacks.
+.. warning::
+ Do not ever use HalfSipHash except for as a hashtable key function, and
+ only then when you can be absolutely certain that the outputs will never
+ be transmitted out of the kernel. This is only remotely useful over
+ `jhash` as a means of mitigating hashtable flooding denial of service
+ attacks.
Generating a HalfSipHash key
============================
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH 2/2] Documentation: siphash: enclose HalfSipHash usage example in the literal block
2022-03-29 4:29 [PATCH 0/2] Documentation: siphash: formatting fixes Bagas Sanjaya
2022-03-29 4:29 ` [PATCH 1/2] Documentation: siphash: convert danger note to warning for HalfSipHash Bagas Sanjaya
@ 2022-03-29 4:29 ` Bagas Sanjaya
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2022-03-29 4:29 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, Jonathan Corbet, Eric Biggers, Herbert Xu,
Mauro Carvalho Chehab, linux-kernel
Render usage example of HalfSipHash function as code block by using
literal block syntax.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Eric Biggers <ebiggers@google.com>
Cc: Herbert Xu <herbert@gondor.apana.org.au>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/security/siphash.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/security/siphash.rst b/Documentation/security/siphash.rst
index 42794a7e052f1e..06d793e680869c 100644
--- a/Documentation/security/siphash.rst
+++ b/Documentation/security/siphash.rst
@@ -132,10 +132,10 @@ Generating a HalfSipHash key
============================
Keys should always be generated from a cryptographically secure source of
-random numbers, either using get_random_bytes or get_random_once:
+random numbers, either using get_random_bytes or get_random_once::
-hsiphash_key_t key;
-get_random_bytes(&key, sizeof(key));
+ hsiphash_key_t key;
+ get_random_bytes(&key, sizeof(key));
If you're not deriving your key from here, you're doing it wrong.
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2022-03-29 4:30 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-29 4:29 [PATCH 0/2] Documentation: siphash: formatting fixes Bagas Sanjaya
2022-03-29 4:29 ` [PATCH 1/2] Documentation: siphash: convert danger note to warning for HalfSipHash Bagas Sanjaya
2022-03-29 4:29 ` [PATCH 2/2] Documentation: siphash: enclose HalfSipHash usage example in the literal block Bagas Sanjaya
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).