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

Support Gitpod workspaces #3601

Open
wants to merge 2 commits into
base: main
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
7 changes: 7 additions & 0 deletions pkg/cosign/env/env.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ const (
VariableGitHubToken Variable = "GITHUB_TOKEN" //nolint:gosec
VariableGitHubRequestToken Variable = "ACTIONS_ID_TOKEN_REQUEST_TOKEN"
VariableGitHubRequestURL Variable = "ACTIONS_ID_TOKEN_REQUEST_URL"
VariableGitpodWorkspaceId Variable = "GITPOD_WORKSPACE_ID"
VariableSPIFFEEndpointSocket Variable = "SPIFFE_ENDPOINT_SOCKET"
VariableGoogleServiceAccountName Variable = "GOOGLE_SERVICE_ACCOUNT_NAME"
VariableGitLabHost Variable = "GITLAB_HOST"
Expand Down Expand Up @@ -157,6 +158,12 @@ var (
Sensitive: false,
External: true,
},
VariableGitpodWorkspaceId: {
Description: "is the ID of the workspace in Gitpod",
Expects: "string with the ID of the Gitpod workspace",
Sensitive: false,
External: true,
},
VariableSPIFFEEndpointSocket: {
Description: "allows you to specify non-default SPIFFE socket to use.",
Expects: "string with SPIFFE socket path",
Expand Down
18 changes: 18 additions & 0 deletions pkg/providers/gitpod/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
//
// Copyright 2021 The Sigstore Authors.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Copyright 2021 The Sigstore Authors.
// Copyright 2024 The Sigstore Authors.

//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package gitpod defines an implementation of the providers.Interface
// that reads identity tokens from the gitpod API within a workspace.
package gitpod
72 changes: 72 additions & 0 deletions pkg/providers/gitpod/gitpod.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
//
// Copyright 2021 The Sigstore Authors.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// Copyright 2021 The Sigstore Authors.
// Copyright 2024 The Sigstore Authors.

//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package gitpod

import (
"bytes"
"context"
"encoding/json"
"os/exec"

"github.com/sigstore/cosign/v2/pkg/cosign/env"
"github.com/sigstore/cosign/v2/pkg/providers"
)

func init() {
providers.Register("filesystem", &gitpod{})
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
providers.Register("filesystem", &gitpod{})
providers.Register("gitpod", &gitpod{})

}

type gitpod struct{}

var _ providers.Interface = (*gitpod)(nil)

// Enabled implements providers.Interface
func (ga *gitpod) Enabled(_ context.Context) bool {
// Check we are in a Gitpod Workspace
if env.Getenv(env.VariableGitpodWorkspaceId) != "" {

//Check we are able to generate tokens with a verified email address
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
//Check we are able to generate tokens with a verified email address
// Check we are able to generate tokens with a verified email address

(golangci-lint run will catch this)

output, err := exec.Command("gp", "idp", "token", "--audience", "example.org", "--decode").Output()
Copy link
Contributor

Choose a reason for hiding this comment

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

How necessary is this check, if the workspace variable is known to be set? The github provider, for example, only bothers to check the variable.

Is there a timeout option for this command?

All the providers are looped through when a new signer is created, so if this command doesn't exit quickly when not enabled, it will stall keyless signing.

if err != nil {
return false
}

var token struct {
Payload *struct {
Email *string `json:"email"`
EmailVerified bool `json:"email_verified"`
} `json:"Payload"`
}
dec := json.NewDecoder(bytes.NewBuffer(output))
if err := dec.Decode(&token); err != nil {
return false
}

if token.Payload != nil {
return token.Payload.Email != nil && token.Payload.EmailVerified
}
}
return false
}

// Provide implements providers.Interface
func (ga *gitpod) Provide(ctx context.Context, audience string) (string, error) {
token, err := exec.Command("gp", "idp", "token", "--audience", audience).Output()
if err != nil {
return "", err
}
return string(token), nil
}