From: Matt Caswell <matt@openssl.org>
Date: Mon, 15 Mar 2021 17:44:42 +0000 (+0000)
Subject: Fix a TODO(3.0) in the siphash code
X-Git-Tag: openssl-3.0.0-alpha14~269
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5db682733de0afcfece92ac011c1eb1ca775c32a;p=thirdparty%2Fopenssl.git

Fix a TODO(3.0) in the siphash code

All 3 files that included crypto/siphash.h also included siphash_local.h,
and no other files included siphash_local.h independently. They probably
should be just one header file.

Fixes #14360

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/14558)
---

diff --git a/crypto/siphash/siphash.c b/crypto/siphash/siphash.c
index 071339d4443..7584255709d 100644
--- a/crypto/siphash/siphash.c
+++ b/crypto/siphash/siphash.c
@@ -28,7 +28,6 @@
 #include <openssl/crypto.h>
 
 #include "crypto/siphash.h"
-#include "siphash_local.h"
 
 #define ROTL(x, b) (uint64_t)(((x) << (b)) | ((x) >> (64 - (b))))
 
diff --git a/crypto/siphash/siphash_local.h b/crypto/siphash/siphash_local.h
deleted file mode 100644
index 54d65dfc6eb..00000000000
--- a/crypto/siphash/siphash_local.h
+++ /dev/null
@@ -1,28 +0,0 @@
-/*
- * Copyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved.
- *
- * Licensed under the Apache License 2.0 (the "License").  You may not use
- * this file except in compliance with the License.  You can obtain a copy
- * in the file LICENSE in the source distribution or at
- * https://www.openssl.org/source/license.html
- */
-
-/* Based on https://131002.net/siphash C reference implementation */
-
-struct siphash_st {
-    uint64_t total_inlen;
-    uint64_t v0;
-    uint64_t v1;
-    uint64_t v2;
-    uint64_t v3;
-    unsigned int len;
-    unsigned int hash_size;
-    unsigned int crounds;
-    unsigned int drounds;
-    unsigned char leavings[SIPHASH_BLOCK_SIZE];
-};
-
-/* default: SipHash-2-4 */
-#define SIPHASH_C_ROUNDS 2
-#define SIPHASH_D_ROUNDS 4
-
diff --git a/include/crypto/siphash.h b/include/crypto/siphash.h
index 02f74c4ae2e..0d0767fcf48 100644
--- a/include/crypto/siphash.h
+++ b/include/crypto/siphash.h
@@ -28,4 +28,23 @@ int SipHash_Init(SIPHASH *ctx, const unsigned char *k,
 void SipHash_Update(SIPHASH *ctx, const unsigned char *in, size_t inlen);
 int SipHash_Final(SIPHASH *ctx, unsigned char *out, size_t outlen);
 
+/* Based on https://131002.net/siphash C reference implementation */
+
+struct siphash_st {
+    uint64_t total_inlen;
+    uint64_t v0;
+    uint64_t v1;
+    uint64_t v2;
+    uint64_t v3;
+    unsigned int len;
+    unsigned int hash_size;
+    unsigned int crounds;
+    unsigned int drounds;
+    unsigned char leavings[SIPHASH_BLOCK_SIZE];
+};
+
+/* default: SipHash-2-4 */
+# define SIPHASH_C_ROUNDS 2
+# define SIPHASH_D_ROUNDS 4
+
 #endif
diff --git a/providers/implementations/macs/siphash_prov.c b/providers/implementations/macs/siphash_prov.c
index 0181d68ed1f..0c374bd8619 100644
--- a/providers/implementations/macs/siphash_prov.c
+++ b/providers/implementations/macs/siphash_prov.c
@@ -16,12 +16,6 @@
 #include <openssl/proverr.h>
 
 #include "crypto/siphash.h"
-/*
- * TODO(3.0) when siphash has moved entirely to our providers, this
- * header should be moved to the provider include directory.  For the
- * moment, crypto/siphash/siphash_ameth.c has us stuck.
- */
-#include "../../../crypto/siphash/siphash_local.h"
 
 #include "prov/implementations.h"
 #include "prov/providercommon.h"
diff --git a/test/siphash_internal_test.c b/test/siphash_internal_test.c
index e77e9d265f9..2361921c575 100644
--- a/test/siphash_internal_test.c
+++ b/test/siphash_internal_test.c
@@ -15,7 +15,6 @@
 #include <openssl/bio.h>
 #include "testutil.h"
 #include "crypto/siphash.h"
-#include "../crypto/siphash/siphash_local.h"
 #include "internal/nelem.h"
 
 typedef struct {