mirror of
https://github.com/open-goal/jak-project
synced 2026-09-12 20:56:09 -04:00
Alexander J. Semenuk
5d5e35fb9b
## Problem Windows builds break with a current local toolchain (Scoop LLVM 22.1.8, CMake 4.4.0, VS 2026), in two independent ways: 1. The build stops at curl's deliberate guard: `#error "no non-blocking method was found/used/set"` in `third-party/curl/lib/nonblock.c`. 2. From the second configure onward, `cmake --build` re-runs CMake in an endless loop (observed 42 consecutive reconfigure cycles in a single build). Likely the same mechanism behind the "endlessly building" VS 2026 note in `docs/setup/dev/vs.md`. ## Root cause 1. `third-party/curl/CMake/CurlTests.c` passes `int *` to `ioctlsocket()`, whose third parameter is `u_long *`. Clang 22 promotes `-Wincompatible-pointer-types` to a hard error in C, so the `HAVE_IOCTLSOCKET_FIONBIO` try_compile silently fails and `curl_config.h` never defines it. Upstream CI does not see this because the windows-2022 runner image ships an older LLVM. GCC 14 promotes the same warning to a hard error, which is very likely the `CurlTests.c.obj` failure reported from MSYS2 in open-goal/jak-project#3551. Upstream curl hit the identical problem with GCC 14 and fixed the probe in curl 8.8.0 (curl/curl#13578). 2. The root CMakeLists copies the build tree's `compile_commands.json` into `<src>/build/` for clangd using `configure_file()`, which registers its input as a configure dependency. CMake rewrites `compile_commands.json` late in every generation, after `CTestTestfile.cmake` and `cmake_install.cmake` (outputs of the same Ninja regen rule), so once the dependency is registered the rule is deterministically dirty and every `ninja` invocation re-runs CMake. A pristine first configure is safe (the file does not exist yet, so the `if(EXISTS ...)` guard skips the copy), which is why the loop looks machine- or IDE-specific. ## Fix 1. Per review, re-vendor `third-party/curl` at the `curl-8_21_0` tag (previously `curl-8_3_0`), which carries the upstream probe fix plus two years of upstream development; `vendor.yaml` updated to match. Adjustments the version jump forced: - curl 8.15 removed the native macOS Secure Transport backend (`CURL_USE_SECTRANSP`), so macOS now builds curl against OpenSSL like Linux. The two macOS workflows install Homebrew `openssl@3` and export `OPENSSL_ROOT_DIR` (keg-only), and the macOS setup docs gained the same two lines. - `CURL_BROTLI` / `CURL_ZSTD` switched to AUTO-detection in curl 8.10; pinned OFF to keep the previous no-compression behavior and avoid silently linking whatever the CI images happen to have. - curl's new top-level `BUILD_EXAMPLES` cache option (default ON) leaked into discord-rpc's identically named option and broke configure at a nonexistent `examples/send-presence` directory; pinned OFF ahead of the third-party subdirectories. The diff is dominated by the mechanical tag-tree swap under `third-party/curl` (linguist-vendored, collapsed in review). The hand-written changes are `CMakeLists.txt`, the two macOS workflows, `docs/setup/system/macos.md`, and `vendor.yaml`. 2. Swap `configure_file()` for `file(COPY ...)`: the same clangd copy with no configure dependency registered. (`file(COPY_FILE ... ONLY_IF_DIFFERENT)` would be cleaner still but requires CMake 3.21, above the declared `cmake_minimum_required(VERSION 3.10)`.) ## Test plan - [x] Fresh `cmake --preset Release-windows-clang` (LLVM 22, no cache seeding) completes and logs `Enabled SSL backends: Schannel`; the FIONBIO probe passes without the previous `#error` - [x] Full Windows Release build from scratch in the branch worktree (all 1422 targets) - [x] goalc-test suite: 1509 passed, 0 failed - [x] Second consecutive configure with `compile_commands.json` present: the regen rule in `build.ninja` has no `compile_commands.json` input; `<src>/build/compile_commands.json` is still refreshed for clangd - [x] Repeated `ninja` invocations after a full build no longer re-run CMake - [x] macOS Intel and ARM CI green (first exercise of the OpenSSL backend switch) --- I work off a self-hosted forge, so this GitHub account is quiet; the configure logs and ninja dirty-node traces from the investigation are available if anyone wants the raw data. (AI-assisted)
199 lines
7.3 KiB
C
Vendored
Generated
199 lines
7.3 KiB
C
Vendored
Generated
#ifndef HEADER_CURL_SSLUSE_H
|
|
#define HEADER_CURL_SSLUSE_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
#ifdef USE_OPENSSL
|
|
|
|
#ifdef USE_WIN32_CRYPTO
|
|
#include <wincrypt.h>
|
|
/* If <wincrypt.h> is included directly, or indirectly via <schannel.h>,
|
|
* <winldap.h>, <iphlpapi.h>, or something else, <wincrypt.h> does this:
|
|
* #define X509_NAME ((LPCSTR)7)
|
|
*
|
|
* In AWC-LC/BoringSSL's <openssl/base.h> there is:
|
|
* typedef struct X509_name_st X509_NAME;
|
|
* etc.
|
|
*
|
|
* The redefined symbols break these OpenSSL headers when included after
|
|
* <wincrypt.h>.
|
|
* The workaround is to undefine those defines here (and only here).
|
|
*
|
|
* For unity builds it may need to be repeated elsewhere too, e.g. in ldap.c,
|
|
* to apply to other sources using OpenSSL includes. Each compilation unit
|
|
* needs undefine them between the first <wincrypt.h> include and the first
|
|
* OpenSSL include.
|
|
*
|
|
* OpenSSL does this in <openssl/ssl.h> and <openssl/x509v3.h>, but it
|
|
* also does the #undef by including <openssl/ossl_typ.h>. <3.1.0 only does
|
|
* it on the first include.
|
|
*
|
|
* LibreSSL automatically undefines these symbols before using them.
|
|
*/
|
|
#undef X509_NAME
|
|
#undef X509_EXTENSIONS
|
|
#undef PKCS7_ISSUER_AND_SERIAL
|
|
#undef PKCS7_SIGNER_INFO
|
|
#undef OCSP_REQUEST
|
|
#undef OCSP_RESPONSE
|
|
#endif /* USE_WIN32_CRYPTO */
|
|
|
|
/*
|
|
* This header should only be needed to get included by vtls.c, openssl.c
|
|
* and ngtcp2.c
|
|
*/
|
|
#include <openssl/opensslv.h>
|
|
#include <openssl/ossl_typ.h>
|
|
#include <openssl/ssl.h>
|
|
|
|
#include "urldata.h"
|
|
|
|
#if OPENSSL_VERSION_NUMBER >= 0x30000000L
|
|
#define HAVE_OPENSSL3 /* non-fork OpenSSL 3.x or later */
|
|
#endif
|
|
|
|
#if defined(OPENSSL_IS_AWSLC) || defined(OPENSSL_IS_BORINGSSL)
|
|
#define HAVE_BORINGSSL_LIKE
|
|
#endif
|
|
|
|
/* OpenSSL 3.5.0+ has built-in 'SSLKEYLOGFILE' support if built with
|
|
'enable-sslkeylog' */
|
|
#if OPENSSL_VERSION_NUMBER >= 0x30500000L && !defined(OPENSSL_NO_SSLKEYLOG)
|
|
#define HAVE_KEYLOG_UPSTREAM
|
|
#endif
|
|
|
|
/*
|
|
* Whether SSL_CTX_set_keylog_callback is available.
|
|
* BoringSSL: supported since d28f59c27bac (committed 2015-11-19)
|
|
* LibreSSL: not supported. 3.5.0+ has a stub function that does nothing.
|
|
* OpenSSL: supported since 1.1.1 https://github.com/openssl/openssl/pull/2287
|
|
*/
|
|
#ifndef LIBRESSL_VERSION_NUMBER
|
|
#define HAVE_KEYLOG_CALLBACK
|
|
#endif
|
|
|
|
/* Check for OpenSSL 1.1.1 which has early data support. */
|
|
#undef HAVE_OPENSSL_EARLYDATA
|
|
#if defined(TLS1_3_VERSION) && !defined(HAVE_BORINGSSL_LIKE)
|
|
#define HAVE_OPENSSL_EARLYDATA
|
|
#endif
|
|
|
|
struct alpn_spec;
|
|
struct ssl_peer;
|
|
struct Curl_ssl_session;
|
|
|
|
/* Struct to hold a curl OpenSSL instance */
|
|
struct ossl_ctx {
|
|
/* these ones requires specific SSL-types */
|
|
SSL_CTX *ssl_ctx;
|
|
SSL *ssl;
|
|
BIO_METHOD *bio_method;
|
|
CURLcode io_result; /* result of last BIO cfilter operation */
|
|
/* blocked writes need to retry with same length, remember it */
|
|
int blocked_ssl_write_len;
|
|
#if !defined(HAVE_KEYLOG_UPSTREAM) && !defined(HAVE_KEYLOG_CALLBACK)
|
|
/* Set to true once a valid keylog entry has been created to avoid dupes.
|
|
This is a bool and not a bitfield because it is passed by address. */
|
|
bool keylog_done;
|
|
#endif
|
|
BIT(x509_store_setup); /* x509 store has been set up */
|
|
BIT(store_is_empty); /* no certs/paths/blobs in x509 store */
|
|
BIT(reused_session); /* session-ID was reused for this */
|
|
};
|
|
|
|
size_t Curl_ossl_version(char *buffer, size_t size);
|
|
|
|
typedef CURLcode Curl_ossl_ctx_setup_cb(struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
void *user_data);
|
|
|
|
typedef int Curl_ossl_new_session_cb(SSL *ssl, SSL_SESSION *ssl_sessionid);
|
|
typedef CURLcode Curl_ossl_init_session_reuse_cb(struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
struct alpn_spec *alpns,
|
|
struct Curl_ssl_session *scs,
|
|
bool *do_early_data);
|
|
|
|
CURLcode Curl_ossl_ctx_init(struct ossl_ctx *octx,
|
|
struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
struct ssl_peer *peer,
|
|
const struct alpn_spec *alpns_requested,
|
|
Curl_ossl_ctx_setup_cb *cb_setup,
|
|
void *cb_user_data,
|
|
Curl_ossl_new_session_cb *cb_new_session,
|
|
void *ssl_user_data,
|
|
Curl_ossl_init_session_reuse_cb *sess_reuse_cb);
|
|
|
|
/* Is a resolved HTTPS-RR needed for initializing OpenSSL? */
|
|
bool Curl_ossl_need_httpsrr(struct Curl_easy *data);
|
|
|
|
#ifndef HAVE_OPENSSL3
|
|
#define SSL_get1_peer_certificate SSL_get_peer_certificate
|
|
#endif
|
|
|
|
extern const struct Curl_ssl Curl_ssl_openssl;
|
|
|
|
/**
|
|
* Setup the OpenSSL X509_STORE in `ssl_ctx` for the cfilter `cf` and
|
|
* easy handle `data`. Allows reuse of a shared cache if suitable
|
|
* and configured.
|
|
*/
|
|
CURLcode Curl_ssl_setup_x509_store(struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
struct ossl_ctx *octx);
|
|
|
|
CURLcode Curl_ossl_ctx_configure(struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
SSL_CTX *ssl_ctx);
|
|
|
|
/*
|
|
* Add a new session to the cache. Takes ownership of the session.
|
|
*/
|
|
CURLcode Curl_ossl_add_session(struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
const char *ssl_peer_key,
|
|
SSL_SESSION *session,
|
|
int ietf_tls_id,
|
|
const char *alpn,
|
|
unsigned char *quic_tp,
|
|
size_t quic_tp_len);
|
|
|
|
/*
|
|
* Get the server cert, verify it and show it, etc., only call failf() if
|
|
* SSL config verifypeer or -host is set. Otherwise all this is for
|
|
* informational purposes only!
|
|
*/
|
|
CURLcode Curl_ossl_check_peer_cert(struct Curl_cfilter *cf,
|
|
struct Curl_easy *data,
|
|
struct ossl_ctx *octx,
|
|
struct ssl_peer *peer);
|
|
|
|
/* Report properties of a successful handshake */
|
|
void Curl_ossl_report_handshake(struct Curl_easy *data, struct ossl_ctx *octx);
|
|
|
|
#endif /* USE_OPENSSL */
|
|
#endif /* HEADER_CURL_SSLUSE_H */
|