gitpod/components/public-api-server/pkg/apiv1/identityprovider.go

// Copyright (c) 2023 Gitpod GmbH. All rights reserved.
// Licensed under the GNU Affero General Public License (AGPL).
// See License.AGPL.txt in the project root for license information.

package apiv1

import (
	"context"
	"fmt"
	"strings"

	connect "github.com/bufbuild/connect-go"
	"github.com/gitpod-io/gitpod/common-go/experiments"
	"github.com/gitpod-io/gitpod/common-go/log"
	v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
	"github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1/v1connect"
	protocol "github.com/gitpod-io/gitpod/gitpod-protocol"
	"github.com/gitpod-io/gitpod/public-api-server/pkg/proxy"
	"github.com/zitadel/oidc/pkg/oidc"
)

type IDTokenSource interface {
	IDToken(ctx context.Context, org string, audience []string, userInfo oidc.UserInfo) (string, error)
}

func NewIdentityProviderService(serverConnPool proxy.ServerConnectionPool, source IDTokenSource, expClient experiments.Client) *IdentityProviderService {
	return &IdentityProviderService{
		connectionPool: serverConnPool,
		idTokenSource:  source,
		expClient:      expClient,
	}
}

type IdentityProviderService struct {
	connectionPool proxy.ServerConnectionPool
	idTokenSource  IDTokenSource
	expClient      experiments.Client

	v1connect.UnimplementedWorkspacesServiceHandler
}

var _ v1connect.IdentityProviderServiceHandler = ((*IdentityProviderService)(nil))

// GetIDToken implements v1connect.IDPServiceHandler
func (srv *IdentityProviderService) GetIDToken(ctx context.Context, req *connect.Request[v1.GetIDTokenRequest]) (*connect.Response[v1.GetIDTokenResponse], error) {
	workspaceID, err := validateWorkspaceID(ctx, req.Msg.GetWorkspaceId())
	if err != nil {
		return nil, err
	}

	if len(req.Msg.Audience) < 1 {
		return nil, connect.NewError(connect.CodeInvalidArgument, fmt.Errorf("Must have at least one audience entry"))
	}

	conn, err := getConnection(ctx, srv.connectionPool)
	if err != nil {
		return nil, err
	}

	// We use GetIDToken as standin for the IDP operation authorisation until we have a better way of handling this
	err = conn.GetIDToken(ctx)
	if err != nil {
		return nil, err
	}

	workspace, err := conn.GetWorkspace(ctx, workspaceID)
	if err != nil {
		log.Extract(ctx).WithError(err).Error("Failed to get workspace.")
		return nil, proxy.ConvertError(err)
	}

	user, err := conn.GetLoggedInUser(ctx)
	if err != nil {
		log.Extract(ctx).WithError(err).Error("Failed to get calling user.")
		return nil, proxy.ConvertError(err)
	}

	if workspace.Workspace == nil {
		log.Extract(ctx).WithError(err).Error("Server did not return a workspace.")
		return nil, connect.NewError(connect.CodeNotFound, fmt.Errorf("workspace not found"))
	}

	userInfo := oidc.NewUserInfo()
	userInfo.SetName(user.Name)
	userInfo.AppendClaims("user_id", user.ID)
	userInfo.AppendClaims("org_id", workspace.Workspace.OrganizationId)
	userInfo.AppendClaims("context", getContext(workspace))
	userInfo.AppendClaims("workspace_id", workspaceID)

	if req.Msg.GetScope() != "" {
		userInfo.AppendClaims("scope", req.Msg.GetScope())
	}

	if workspace.Workspace.Context != nil && workspace.Workspace.Context.Repository != nil && workspace.Workspace.Context.Repository.CloneURL != "" {
		userInfo.AppendClaims("repository", workspace.Workspace.Context.Repository.CloneURL)
	}

	var email string
	var emailVerified bool
	if user.OrganizationId != "" {
		emailVerified = true
		email = user.GetSSOEmail()
		if email == "" {
			return nil, connect.NewError(connect.CodeInternal, fmt.Errorf("SSO email is empty"))
		}
	} else {
		emailVerified = false
		email = user.GetRandomEmail()
	}
	if email != "" {
		userInfo.SetEmail(email, emailVerified)
		userInfo.AppendClaims("email", email)
	}

	userInfo.SetSubject(srv.getOIDCSubject(ctx, userInfo, user, workspace))

	token, err := srv.idTokenSource.IDToken(ctx, "gitpod", req.Msg.Audience, userInfo)
	if err != nil {
		log.Extract(ctx).WithError(err).Error("Failed to produce ID token.")
		return nil, proxy.ConvertError(err)
	}
	return &connect.Response[v1.GetIDTokenResponse]{
		Msg: &v1.GetIDTokenResponse{
			Token: token,
		},
	}, nil
}

func (srv *IdentityProviderService) getOIDCSubject(ctx context.Context, userInfo oidc.UserInfoSetter, user *protocol.User, workspace *protocol.WorkspaceInfo) string {
	claimKeys := experiments.GetIdPClaimKeys(ctx, srv.expClient, experiments.Attributes{
		UserID: user.ID,
		TeamID: workspace.Workspace.OrganizationId,
	})
	subject := getContext(workspace)
	if len(claimKeys) != 0 {
		subArr := []string{}
		for _, key := range claimKeys {
			value := userInfo.GetClaim(key)
			if value == nil {
				value = ""
			}
			subArr = append(subArr, fmt.Sprintf("%s:%+v", key, value))
		}
		subject = strings.Join(subArr, ":")
	}
	return subject
}

func getContext(workspace *protocol.WorkspaceInfo) string {
	context := "no-context"
	if workspace.Workspace.Context != nil && workspace.Workspace.Context.NormalizedContextURL != "" {
		// using Workspace.Context.NormalizedContextURL to not include prefixes (like "referrer:jetbrains-gateway", or other prefix contexts)
		context = workspace.Workspace.Context.NormalizedContextURL
	}
	return context
}