feat: read dex clientSecret from argocd-secret #847
Merged
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
Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com>
Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com>
jannfis
approved these changes
Feb 2, 2023
| @@ -164,7 +160,7 @@ func (r *ReconcileArgoCD) getOpenShiftDexConfig(cr *argoprojv1a1.ArgoCD) (string | |||
| Config: map[string]interface{}{ | |||
| "issuer": "https://kubernetes.default.svc", // TODO: Should this be hard-coded? | |||
| "clientID": getDexOAuthClientID(cr), | |||
| "clientSecret": *clientSecret, | |||
| "clientSecret": "$oidc.dex.clientSecret", | |||
There was a problem hiding this comment.
You have defined the ArgoCDDexSecretKey constant already, would it make sense to use it here?
reginapizza
approved these changes
Feb 2, 2023
There was a problem hiding this comment.
Looks good and works for me! The original request was that the user wished that the token would not be exposed as that is a security concern, but an additional issue we were running into was that even writing the clientSecret in a variable was getting overwritten during reconciliation. With this PR even if the user wishes to change their secret, they can do so in argocd-secret and it won't get overwritten. Two birds with one stone- thanks Abhishek! :D
jaideepr97
reviewed
Feb 2, 2023
| @@ -228,4 +228,7 @@ const ( | |||
|
|
|||
| // ArgoCDServerClusterRoleEnvName is an environment variable to specify a custom cluster role for Argo CD server | |||
| ArgoCDServerClusterRoleEnvName = "SERVER_CLUSTER_ROLE" | |||
|
|
|||
| // ArgoCDDexSecretKey is used to reference Dex secret from Argo CD secret into Argo CD configmap | |||
| ArgoCDDexSecretKey = "oidc.dex.clientSecret" | |||
There was a problem hiding this comment.
Should this be $oidc.dex.clientSecret?
Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com>
iam-veeramalla
added a commit
that referenced
this pull request
Feb 3, 2023
This was referenced Mar 9, 2023
ciiay
pushed a commit
to ciiay/argocd-operator
that referenced
this pull request
Mar 21, 2023
* feat: read dex clientSecret from argocd-secret Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com> * chore: add example file for dex openshift connector Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com> * fix: upgrade path and unit tests Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com> --------- Signed-off-by: iam-veeramalla <abhishek.veeramalla@gmail.com> Signed-off-by: Yi Cai <yicai@redhat.com>
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: iam-veeramalla abhishek.veeramalla@gmail.com
What type of PR is this?
What does this PR do / why we need it:
This PR will introduce a behavioral change in the way operator configures Dex for OpenShift connector.
Currently, Operator configures dex openshift connector to the Argo CD Instance when
.spec.dex.OpenShiftOAuth: true&&.spec.provider: dex. While this configuration works as expected, the oidc configuration which includes theclientSecretis placed in the configmap as plain text. This can be a security risk.Once this PR is merged, operator will provide the reference of the
clientSecretin the configmap and not the actual secret. Argo CD Server will read thisclientSecretreference fromargocd-secret.The new configuration will look something like below
kubectl get cm argocd-cm -oyamlHave you updated the necessary documentation?
NA
How to test changes / Special notes to the reviewer:
make install runclientSecretis not comprised but is just a reference to theoidc.dex.clientSecretinargocd-secret.