Prevent logging invalid header values
Impact
What kind of vulnerability is it?
Apollo Server can log sensitive information (Studio API keys) if they are passed incorrectly (with leading/trailing whitespace) or if they have any characters that are invalid as part of a header value.
Who is impacted?
Users who (all of the below):
- use either the schema reporting or usage reporting feature
- use an Apollo Studio API key which has invalid header values
- use the default fetcher (
node-fetch) or configured their own node-fetch fetcher
The following node snippet can test whether your API key has invalid header values. This code is taken directly from node-fetch@2's header value validation code.
```js
const invalidHeaderCharRegex = /[^\t\x20-\x7e\x80-\xff]/;
if (invalidHeaderCharRegex.test('<YOUR_API_KEY>')) {
console.log('potentially affected');
}
console.log('unaffected');
```
If the provided API key is not a valid header value, whenever Apollo Server uses that API key in a request (to Studio, for example), node-fetch will throw an error _which contains the header value_. This error is logged in various ways depending on the user's configuration, but most likely the console or some configured logging service.
Patches
This problem is patched in the latest version of Apollo Server as soon as this advisory is published.
Workarounds
- Try retrieving a new API key from Studio. Note: this may not work if the invalid character is not part of the secret (it may be derived from identifiers like graph name, user name).
- Override the
fetcher - Disable schema reporting and/or usage reporting
Solution
- Apollo Server will now call
.trim() on incoming API keys in order to eliminate leading/trailing whitespace and log a warning when it does so. - Apollo Server will now perform the same validation of API keys as
node-fetch@2 performs on header values on startup. Apollo Server will throw an error on startup (i.e., fail to start completely) and notify the user their API key is invalid along with the offending characters.
