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

Add integration test for assuming an API Key Role using a Buildkite OIDC token #5416

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions test/factories/oidc/provider.rb
Original file line number Diff line number Diff line change
Expand Up @@ -63,5 +63,56 @@
transient do
pkey { OpenSSL::PKey::RSA.generate(2048) }
end

trait :buildkite do
issuer { "https://agent.buildkite.com" }
configuration do
{
issuer: issuer,
jwks_uri: "#{issuer}/.well-known/jwks",
id_token_signing_alg_values_supported: [
"RS256"
],
response_types_supported: [
"id_token"
],
scopes_supported: [
"openid"
],
subject_types_supported: %w[
public
pairwise
],
claims_supported: %w[
sub
aud
exp
iat
iss
nbf
jti
organization_id
organization_slug
pipeline_id
pipeline_slug
build_number
build_branch
build_tag
build_commit
build_source
step_key
job_id
agent_id
cluster_id
cluster_name
queue_id
queue_key
runner_environment
]
}
end
Copy link
Author

Choose a reason for hiding this comment

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

end

factory :oidc_provider_buildkite, traits: [:buildkite]
end
end
65 changes: 65 additions & 0 deletions test/integration/api/v1/oidc/api_key_roles_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -383,5 +383,70 @@ def jwt(claims = @claims, key: @pkey)
)
end
end

context "with a Buildkite OIDC token" do
setup do
@role = create(:oidc_api_key_role, provider: build(:oidc_provider_buildkite, pkey: @pkey))
@user = @role.user

@claims = {
"aud" => "rubygems.org",
"exp" => 1_680_020_837,
"iat" => 1_680_020_537,
"iss" => "https://agent.buildkite.com",
"jti" => "0194b014-8517-7cef-b232-76a827315f08",
"nbf" => 1_680_019_937,
"sub" => "organization:example-org:pipeline:example-pipeline:ref:refs/heads/main:commit:b5ffe3aeea51cec6c41aef16e45ee6bce47d8810:step:",
"organization_slug" => "example-org",
"pipeline_slug" => "example-pipeline",
"build_number" => 5,
"build_branch" => "main",
"build_tag" => nil,
"build_commit" => "b5ffe3aeea51cec6c41aef16e45ee6bce47d8810",
"step_key" => nil,
"job_id" => "01945ecf-80f0-41e8-9b83-a2970a9305a1",
"agent_id" => "01945ecf-8bcf-40a6-9d70-a765db9a0928",
"build_source" => "ui",
"runner_environment" => "buildkite-hosted"
}

travel_to Time.zone.at(1_680_020_830) # after the JWT iat, before the exp
end

context "with matching conditions" do
should "return API key" do
# remove the Github Actions shaped condition in the default fixture
@role.access_policy.statements.first.conditions.clear
Copy link
Author

Choose a reason for hiding this comment

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

This feels like a hack - would you prefer the test setup create just a Buildkite shaped policy? Maybe via a new trait?

Copy link
Member

Choose a reason for hiding this comment

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

yes please 🙏

@role.access_policy.statements.first.conditions << OIDC::AccessPolicy::Statement::Condition.new(
operator: "string_equals",
claim: "organization_slug",
value: "example-org"
)
@role.save!

post assume_role_api_v1_oidc_api_key_role_path(@role.token),
params: {
jwt: jwt.to_s
},
headers: {}

assert_response :created

resp = response.parsed_body

assert_match(/^rubygems_/, resp["rubygems_api_key"])
assert_equal_hash(
{ "rubygems_api_key" => resp["rubygems_api_key"],
"name" => "#{@role.name}-0194b014-8517-7cef-b232-76a827315f08",
"scopes" => ["push_rubygem"],
"expires_at" => 30.minutes.from_now },
resp
)
hashed_key = @user.api_keys.sole.hashed_key

assert_equal hashed_key, Digest::SHA256.hexdigest(resp["rubygems_api_key"])
end
end
end
end
end
Loading