Files
jak-project/third-party/curl/docs/internals/CREDENTIALS.md
Alexander J. Semenuk 5d5e35fb9b fix: Windows toolchain compatibility (curl 8.21 re-vendor, endless reconfigure loop) (#4355)
## 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)
2026-07-27 19:19:18 -04:00

3.0 KiB
Vendored
Generated

curl creds

Authorization credentials are kept in struct Curl_creds. This contains:

  • user: the username, maybe the empty string
  • passwd: the password, maybe the empty string
  • sasl_authzid: the SASL authz value, maybe the empty string
  • oauth_bearer: the OAUTH bearer token, maybe the empty string
  • source: where the credentials from
  • refcount: a reference counter to link/unlink creds

A creds with all values empty is equivalent to NULL, e.g. no creds instance. With reference counting, creds can be linked in several places.

Two creds are the same if all values are equal apart from source and refcount. The comparison of strings is done via Curl_timestrcmp() to prevent side channel attacks.

creds locations

Credentials are kept in three places:

  • data->state.creds: the credentials to use for the transfer in talking to the origin (see PEERS)
  • conn->creds: the credentials tied to a connection (more below)
  • conn->*_proxy.creds: credentials used to talk to the conn->*_proxy.peer

data->state.creds

This creds instance is created when the transfer starts looking for a suitable connection. For an easy_perform() this may happen several times if, for example, http redirects are followed.

When an easy_perform() starts, the transfer's data->state.initial_origin peer is cleared. When creating the connection, data->state.origin is calculated (e.g. who the request talks to). If data->state.initial_origin is not set, the first data->state.origin is linked there. Now libcurl knows where the transfer initially talked to on all possible subsequent requests.

Credential information from CURLOPT_* settings is only applicable for the initial origin. Any followup request going to another origin must not use it. Therefore data->state.creds is only created from CURLOPT_* when current origin and initial origin match.

Without credentials from CURLOPT_*, the URL is inspected for user and password and netrc is consulted as well (when built in).

conn->creds

Once data->state.creds is known, the connection credentials are determined. For protocols that tie authorization to everything send on a connection (protocols without flag PROTOPT_CREDSPERREQUEST), conn->creds is linked to data->state.creds. Only connections carrying the same credentials may be reused.

Protocol with flag PROTOPT_CREDSPERREQUEST leave conn->creds empty, as connections for such protocols may be reused with different credentials.

That being said, there are authentication schemes like NTLM and NEGOTIATE that tie credentials to a connection. Those do set conn->creds once they start to operate, preventing connection reuse from then on for transfers with different credentials.

conn->*_proxy.creds

Those are set during connection setup from the CURLOPT_* values. They do not require any "initial origin" handling as the origin of a proxy does not change for a transfer.