Add validation to ldap secret to catch misconfigurations #3031
Conversation
This file contains 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
Brian-McM
reviewed
Dec 15, 2023
pkg/controller/utils/auth.go
Outdated
| bindPW := secret.Data[render.BindPWSecretField] | ||
| if len(bindDN) > 0 && len(bindPW) > 0 { | ||
| if _, err := ldap.ParseDN(string(bindDN)); err != nil { | ||
| return nil, fmt.Errorf("secret %s/%s: should have be a valid LDAP DN", common.OperatorNamespace(), secretName) |
There was a problem hiding this comment.
The wording seems a little off here should have be a
pkg/controller/utils/auth.go
Outdated
| // Validate LDAP fields. | ||
| bindDN := secret.Data[render.BindDNSecretField] | ||
| bindPW := secret.Data[render.BindPWSecretField] | ||
| if len(bindDN) > 0 && len(bindPW) > 0 { |
There was a problem hiding this comment.
Is it valid to have one and not the other? If not, should that be validated too?
There was a problem hiding this comment.
They are both part of the requiredFields variable, which the loop above checks are all present. So at this point we know that if this is an ldap secret, both of these are present.
pkg/controller/utils/auth.go
Outdated
| }[s] | ||
| })) | ||
| if err := json.Unmarshal(data, &map[string]any{}); err != nil { | ||
| return nil, fmt.Errorf("secret %s/%s should have properly escaped data for bindDN and bindPW", common.OperatorNamespace(), secretName) |
There was a problem hiding this comment.
Nit, would the error message be better worded stating just that it's not escaped "Fields bindDN and bindPW in secret %s/%s are not properly escaped"?
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.
ev-4161 ci-1331
The secret for LDAP is mounted into the dex pod via ENV and there, Dex is using os.epandenv to insert it into a json config. This means that certain characters need extra escaping. Currently, the user does not see an error in the TigeraStatus when Dex fails to start. This PR adds that validation by performing similar operations.