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

[VAULT-30189] enos: verify identity and OIDC tokens #28274

Merged
merged 5 commits into from
Sep 9, 2024
Merged

Conversation

ryancragun
Copy link
Collaborator

Description

Expand our baseline API and data verification by including the identity and identity OIDC tokens secrets engines. We now create a test entity, entity-alias, identity group, various policies, and associate them with the entity. For the OIDC side, we now configure the OIDC issuer, create and rotate named keys, create and associate roles with the named key, and issue and introspect tokens.

During a second phase we also verify that the those same entities, groups, keys, roles, config, etc all exist with the expected values. This is useful to test durability after upgrades, migrations, etc.

This change also includes new updates our prior auth/userpass and kv verification. We had two modules that were loosely coupled and interdependent. This restructures those both into a singular module with child modules and fixes the assumed values by requiring the read module to verify against the created state.

Going forward we can continue to extend this secrets engine verification module with additional create and read checks for new secrets engines.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this PR is in the ENT repo and needs to be backported, backport
    to N, N-1, and N-2, using the backport/ent/x.x.x+ent labels. If this PR is in the CE repo, you should only backport to N, using the backport/x.x.x label, not the enterprise labels.
    • If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

Sorry, something went wrong.

@ryancragun ryancragun requested a review from a team as a code owner September 4, 2024 19:12
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Sep 4, 2024
Copy link

github-actions bot commented Sep 4, 2024

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Sep 4, 2024

Build Results:
All builds succeeded! ✅

Copy link
Contributor

@brewgator brewgator left a comment

Choose a reason for hiding this comment

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

Just some minor tweaks

Expand our baseline API and data verification by including the identity
and identity OIDC tokens secrets engines. We now create a test entity,
entity-alias, identity group, various policies, and associate them with
the entity. For the OIDC side, we now configure the OIDC issuer, create
and rotate named keys, create and associate roles with the named key,
and issue and introspect tokens.

During a second phase we also verify that the those some entities,
groups, keys, roles, config, etc all exist with the expected values.
This is useful to test durability after upgrades, migrations, etc.

This change also includes new updates our prior `auth/userpass` and `kv`
verification. We had two modules that were loosely coupled and
interdependt. This restructures those both into a singular module with
child modules and fixes the assumed values by requiring the read module
to verify against the created state.

Going forward we can continue to extend this secrets engine verification
module with additional create and read checks for new secrets engines.

Signed-off-by: Ryan Cragun <[email protected]>
Signed-off-by: Ryan Cragun <[email protected]>
Signed-off-by: Ryan Cragun <[email protected]>
Now that we are using a new module for secrets engines verification
without retries we could run into a race:

```
╷
│ Error: exit status 1
│
│ Error: Execution Error
│
│   with module.verify_replicated_data_during_failover.enos_remote_exec.auth_login_testuser,
│   on ../../modules/verify_secrets_engines/modules/read/auth.tf line 8, in resource "enos_remote_exec" "auth_login_testuser":
│    8: resource "enos_remote_exec" "auth_login_testuser" {
│
│ failed to execute commands due to: running script:
│ [/Users/ryan/code/hashi/vault/enos/modules/verify_secrets_engines/scripts/auth-userpass-login.sh]
│ failed, due to: 1 error occurred:
│       * executing script
│ auth/userpass/login/testuser: Error making API request.
│
│ URL: PUT http://[::1]:8200/v1/auth/userpass/login/testuser
│ Code: 503. Errors:
│
│ * Vault is sealed
```

We solve this by waiting for the cluster to be fully unsealed before
attempting to login during the data read.

Signed-off-by: Ryan Cragun <[email protected]>
@ryancragun ryancragun merged commit 3924128 into main Sep 9, 2024
85 checks passed
@ryancragun ryancragun deleted the vault-30189 branch September 9, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.16.x+ent Changes are backported to 1.16.x+ent hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants