Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Native Login method for Go client #12796

Merged
merged 27 commits into from Oct 26, 2021
Merged

Native Login method for Go client #12796

merged 27 commits into from Oct 26, 2021

Conversation

digivava
Copy link
Contributor

@digivava digivava commented Oct 11, 2021

This adds a Login function to the Go client that can be called by passing it anything that satisfies the AuthMethod interface. Functional options pattern is used to allow for defaults, and then each AuthMethod's Login method will do what is necessary to construct and perform the client.Logical().Write() request, and then set the client token.

For the simpler cases (userpass, Kubernetes) this just allows users to use more discoverable, idiomatic Go patterns; for the more complex logins (such as AWS) this should save a ton of headaches as users won't have to figure out how to generate the credentials chain themselves, etc.

Probably will need to add the GCP and Azure ones after 1.9, but I'm hoping to at least get these (AWS, AppRole, Kubernetes--and userpass just for kicks) into the release.

@vercel vercel bot temporarily deployed to Preview – vault-storybook October 11, 2021 15:18 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 11, 2021 15:18 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 11, 2021 21:58 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 11, 2021 21:58 Inactive
Copy link
Contributor

@ncabatoff ncabatoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but I didn't look closely at the k8s/aws stuff since I'm not very familiar with auth for either.

auth/approle/approle.go Outdated Show resolved Hide resolved
auth/approle/approle.go Outdated Show resolved Hide resolved
auth/approle/approle.go Outdated Show resolved Hide resolved
auth/approle/approle.go Outdated Show resolved Hide resolved
auth/approle/approle.go Outdated Show resolved Hide resolved
auth/approle/approle_test.go Outdated Show resolved Hide resolved
auth/approle/approle.go Outdated Show resolved Hide resolved
auth/approle/approle.go Outdated Show resolved Hide resolved
auth/aws/aws.go Outdated Show resolved Hide resolved
auth/kubernetes/kubernetes.go Outdated Show resolved Hide resolved
auth/userpass/userpass.go Outdated Show resolved Hide resolved
auth/aws/aws.go Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview – vault October 14, 2021 16:58 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 14, 2021 16:58 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 14, 2021 17:01 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 14, 2021 17:01 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 14, 2021 22:51 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 14, 2021 22:51 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 15, 2021 17:47 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 15, 2021 17:47 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 22, 2021 16:20 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 22, 2021 16:20 Inactive
@digivava digivava requested a review from calvn October 22, 2021 16:24
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 25, 2021 16:54 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 25, 2021 16:54 Inactive
api/auth/approle/approle.go Outdated Show resolved Hide resolved
api/auth/approle/approle.go Outdated Show resolved Hide resolved
api/auth/aws/aws.go Outdated Show resolved Hide resolved
api/auth/aws/aws.go Outdated Show resolved Hide resolved
api/auth/userpass/userpass.go Outdated Show resolved Hide resolved
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 25, 2021 23:55 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 25, 2021 23:55 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 26, 2021 00:08 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 26, 2021 00:08 Inactive
@vercel vercel bot temporarily deployed to Preview – vault October 26, 2021 00:14 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook October 26, 2021 00:14 Inactive
@digivava digivava merged commit 3ed7bca into main Oct 26, 2021
@digivava digivava deleted the digivava/native-client-login branch October 26, 2021 23:48
qk4l pushed a commit to qk4l/vault that referenced this pull request Feb 4, 2022
* Native Login method, userpass and approle interfaces to implement it

* Add AWS auth interface for Login, unexported struct fields for now

* Add Kubernetes client login

* Add changelog

* Add a test for approle client login

* Return errors from LoginOptions, use limited reader for secret ID

* Fix auth comment length

* Return actual type not interface, check for client token in tests

* Require specification of secret ID location using SecretID struct as AppRole arg

* Allow password from env, file, or plaintext

* Add flexibility in how to fetch k8s service token, but still with default

* Avoid passing strings that need to be validated by just having different login options

* Try a couple real tests with approle and userpass login

* Fix method name in comment

* Add context to Login methods, remove comments about certain sources being inherently insecure

* Perform read of secret ID at login time

* Read password from file at login time

* Pass context in integ tests

* Read env var values in at login time, add extra tests

* Update api version

* Revert "Update api version"

This reverts commit 1ef3949.

* Update api version in all go.mod files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants