Add CA bundle version and pinning status to user agent string#109
Open
mihir-pradhan wants to merge 1 commit into
Open
Add CA bundle version and pinning status to user agent string#109mihir-pradhan wants to merge 1 commit into
mihir-pradhan wants to merge 1 commit into
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Comment on lines
+684
to
698
| String caPinningStatus = disableCaPinning ? "disabled" : "enabled"; | ||
| duoClient.setHeader("user-agent", String.format("%s ca_bundle/%s (ca_pinning=%s)", | ||
| UserAgentString, CA_BUNDLE_VERSION, caPinningStatus)); | ||
| if (disableCaPinning) { | ||
| duoClient.disableCaPinning(); | ||
| } | ||
| if (additionalDuoHeaders != null) { | ||
| duoClient.addAdditionalDuoHeader(additionalDuoHeaders); | ||
| } | ||
| if (headers != null) { | ||
| for (String name : headers.keySet()) { | ||
| String value = headers.get(name); | ||
| duoClient.addHeader(name, value); | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
There's a preexisting issue here; if a consumer calls addHeader to set user-agent, then this logic will add an additional user-agent header, which is undefined behavior depending on the server.
As an improvement, if we move the newly added duoClient.setHeader("user-agent"... logic down to after the if (headers != null) { block, then the setHeader will overwrite any custom set user-agent. It's not ideal to lose the user-agent, but it's better than the undefined behavior of having multiple ones. This also better matches our other sdk behavior.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
CA_BUNDLE_VERSION = "1.0"constant inHttp.javaClientBuilder.build()to appendca_bundle/1.0and(ca_pinning=enabled|disabled)to the user agent string based on thedisableCaPinningruntime statedisableCaPinningflag that configures TLS, so the reported value always matches the client's actual pinning stateHow Has This Been Tested?
testDefaultBuilder_includesCaBundleVersion— verifiesca_bundle/1.0is present in the user agenttestDefaultBuilder_includesCaPinningEnabled— verifies(ca_pinning=enabled)when pinning is not disabledtestDisableCaPinning_includesCaPinningDisabled— verifies(ca_pinning=disabled)whendisableCaPinning()is calledtestLegacyConstructor_includesCaBundleAndPinningEnabled— verifies both fields present via the deprecated constructor pathTypes of Changes