Detect misconfiguration of bundle_endpoint_profile #3395
Merged
Conversation
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
Signed-off-by: Ryuma Yoshida <[email protected]>
ryysud
force-pushed
the
detect-misconfiguration
branch
from
5086c66 to
4de58b1
Compare
ryysud
requested review from
evan2645,
amartinezfayo,
azdagron,
MarcosDY and
rturner3
as code owners
azdagron
reviewed
Sep 1, 2022
pkg/server/bundle/client/client.go
Outdated
Comment on lines
76
to
83
| var hostnameError *x509.HostnameError | ||
| if errors.As(err, &hostnameError) && c.c.SPIFFEAuth == nil { | ||
| id, e := spiffeid.FromString(hostnameError.Certificate.URIs[0].String()) | ||
| if e != nil { | ||
| return nil, errs.New("failed to fetch bundle: %v", err) | ||
| } | ||
| return nil, errs.New("failed to fetch bundle, the server certificate contains SPIFFE ID %q, should specify https_spiffe instead of https_web: %v", id, err) | ||
| } |
There was a problem hiding this comment.
Line 78 will panic if the certificate does not contain a URI SAN. Also, the branch when e != nil is not necessary since we can fall through to the return statement on line 84:
Suggested change
| var hostnameError *x509.HostnameError | |
| if errors.As(err, &hostnameError) && c.c.SPIFFEAuth == nil { | |
| id, e := spiffeid.FromString(hostnameError.Certificate.URIs[0].String()) | |
| if e != nil { | |
| return nil, errs.New("failed to fetch bundle: %v", err) | |
| } | |
| return nil, errs.New("failed to fetch bundle, the server certificate contains SPIFFE ID %q, should specify https_spiffe instead of https_web: %v", id, err) | |
| } | |
| var hostnameError *x509.HostnameError | |
| if errors.As(err, &hostnameError) && c.c.SPIFFEAuth == nil && len(hostnameError.Certificate.URIs) > 0 { | |
| if id, idErr := spiffeid.FromString(hostnameError.Certificate.URIs[0].String()); idErr == nil { | |
| return nil, errs.New("failed to authenticate bundle endpoint using web authentication but the server certificate contains SPIFFE ID %q: maybe use https_spiffe instead of https_web: %v", id, err) | |
| } | |
| } |
azdagron
previously approved these changes
Sep 2, 2022
azdagron
reviewed
Sep 2, 2022
pkg/server/bundle/client/client.go
Outdated
| @@ -72,6 +73,12 @@ func NewClient(config ClientConfig) (Client, error) { | |||
| func (c *client) FetchBundle(ctx context.Context) (*bundleutil.Bundle, error) { | |||
| resp, err := c.client.Get(c.c.EndpointURL) | |||
| if err != nil { | |||
| var hostnameError *x509.HostnameError | |||
There was a problem hiding this comment.
I was doing some quick testing and noticed that the x509 stack returns this error as a struct value (i.e. x509.HostnameError{}), not a pointer to struct value (i.e. &x509.HostnameError). This means that errors.As will return false unless passed a pointer to the struct, not a pointer to a pointer.
Suggested change
| var hostnameError *x509.HostnameError | |
| var hostnameError x509.HostnameError |
I can push a commit with my tests.
Signed-off-by: Ryuma Yoshida <[email protected]>
…o detect-misconfiguration
|
Thanks for your help shepherding this @azdagron - @amartinezfayo has volunteered to review when you're done |
Signed-off-by: Andrew Harding <[email protected]>
|
I've added a unit test. @amartinezfayo if you could please take a look. |
|
Oops. I forgot one crucial change to the test framework to support this :) Change incoming. |
Signed-off-by: Andrew Harding <[email protected]>
Signed-off-by: Andrew Harding <[email protected]>
stevend-uber
pushed a commit
to stevend-uber/spire
that referenced
this pull request
Oct 16, 2023
* Detect misconfiguration of bundle_endpoint_profile Signed-off-by: Ryuma Yoshida <[email protected]> Co-authored-by: Andrew Harding <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: Ryuma Yoshida [email protected]
Pull Request check list
Affected functionality
Federation.
Description of change
Detect misconfiguration of bundle_endpoint_profile.
https://github.com/spiffe/spire/blob/v1.4.0/doc/spire_server.md#configuration-options-for-federationfederates_withtrust-domainbundle_endpoint
Which issue this PR fixes