mirror of
https://github.com/apple/swift-nio.git
synced 2026-05-20 20:30:36 +00:00
John HarrisonandCory Benfield
fa977dc16b
When building swift-nio with a system with explicit modules (bazel build rules) I was getting incorrect sha1 results. It turns out the root cause is the `BYTE_ORDER` macro was not defined in my build context.
Using `-Wundef` in clang I was seeing:
```
Sources/CNIOSHA1/c_nio_sha1.c:56:7: error: '__linux__' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:63:5: error: 'BYTE_ORDER' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:63:19: error: 'BIG_ENDIAN' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:113:5: error: 'BYTE_ORDER' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:113:19: error: 'LITTLE_ENDIAN' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:222:5: error: 'BYTE_ORDER' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:222:19: error: 'BIG_ENDIAN' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:267:5: error: 'BYTE_ORDER' is not defined, evaluates to 0 [-Werror,-Wundef]
^
Sources/CNIOSHA1/c_nio_sha1.c:267:19: error: 'BIG_ENDIAN' is not defined, evaluates to 0 [-Werror,-Wundef]
```
The soundness check was not actually signaling an error because it was implicitly comparing 0 to 0.
This change includes an update to the `#include`'s to ensure `BIG_ENDIAN` is defined on macOS and updates the soundness check to have an explicit error if `BYTE_ORDER` is not defined.
Co-authored-by: Cory Benfield <lukasa@apple.com>
97 lines
3.1 KiB
C
97 lines
3.1 KiB
C
/* Additional changes for SwiftNIO:
|
|
- prefixed all symbols by 'c_nio_'
|
|
- removed the _KERNEL include guards
|
|
- defined the __min_size macro inline
|
|
- included sys/endian.h on Android
|
|
- use welcoming language (soundness check)
|
|
- ensure BYTE_ORDER is defined
|
|
*/
|
|
/* $FreeBSD$ */
|
|
/* $KAME: sha1.h,v 1.5 2000/03/27 04:36:23 sumikawa Exp $ */
|
|
|
|
/*-
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*
|
|
* Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the project nor the names of its contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*/
|
|
/*
|
|
* FIPS pub 180-1: Secure Hash Algorithm (SHA-1)
|
|
* based on: http://csrc.nist.gov/fips/fip180-1.txt
|
|
* implemented by Jun-ichiro itojun Itoh <itojun@itojun.org>
|
|
*/
|
|
|
|
#ifndef _CRYPTO_SHA1_H_
|
|
#define _CRYPTO_SHA1_H_
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct sha1_ctxt {
|
|
union {
|
|
uint8_t b8[20];
|
|
uint32_t b32[5];
|
|
} h;
|
|
union {
|
|
uint8_t b8[8];
|
|
uint64_t b64[1];
|
|
} c;
|
|
union {
|
|
uint8_t b8[64];
|
|
uint32_t b32[16];
|
|
} m;
|
|
uint8_t count;
|
|
};
|
|
typedef struct sha1_ctxt SHA1_CTX;
|
|
|
|
#define SHA1_RESULTLEN (160/8)
|
|
|
|
#ifdef __cplusplus
|
|
#define __min_size(x) (x)
|
|
#else
|
|
#define __min_size(x) static (x)
|
|
#endif
|
|
|
|
extern void c_nio_sha1_init(struct sha1_ctxt *);
|
|
extern void c_nio_sha1_pad(struct sha1_ctxt *);
|
|
extern void c_nio_sha1_loop(struct sha1_ctxt *, const uint8_t *, size_t);
|
|
extern void c_nio_sha1_result(struct sha1_ctxt *, char[__min_size(SHA1_RESULTLEN)]);
|
|
|
|
/* compatibilty with other SHA1 source codes */
|
|
#define SHA1Init(x) c_nio_sha1_init((x))
|
|
#define SHA1Update(x, y, z) c_nio_sha1_loop((x), (y), (z))
|
|
#define SHA1Final(x, y) c_nio_sha1_result((y), (x))
|
|
|
|
#ifdef __cplusplus
|
|
} /* extern "C" */
|
|
#endif
|
|
|
|
#endif /*_CRYPTO_SHA1_H_*/
|