/* Copyright © The ESO 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 https://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 quay provides functionality for generating authentication tokens for Quay container registry. package quay import ( "context" b64 "encoding/base64" "encoding/json" "errors" "fmt" "io" "net/http" "strings" "time" apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" "sigs.k8s.io/controller-runtime/pkg/client" "sigs.k8s.io/yaml" genv1alpha1 "github.com/external-secrets/external-secrets/apis/generators/v1alpha1" "github.com/external-secrets/external-secrets/runtime/esutils" ) // Generator implements token generation for Quay.io container registry. type Generator struct { httpClient *http.Client } const ( defaultQuayURL = "quay.io" errNoSpec = "no config spec provided" errParseSpec = "unable to parse spec: %w" errGetToken = "unable to get authorization token: %w" httpClientTimeout = 5 * time.Second ) // Generate creates an authentication token for Quay container registry. func (g *Generator) Generate(ctx context.Context, jsonSpec *apiextensions.JSON, kube client.Client, namespace string) (map[string][]byte, genv1alpha1.GeneratorProviderState, error) { return g.generate( ctx, jsonSpec, kube, namespace, ) } // Cleanup performs any necessary cleanup after token generation. func (g *Generator) Cleanup(_ context.Context, _ *apiextensions.JSON, _ genv1alpha1.GeneratorProviderState, _ client.Client, _ string) error { return nil } func (g *Generator) generate( ctx context.Context, jsonSpec *apiextensions.JSON, _ client.Client, namespace string) (map[string][]byte, genv1alpha1.GeneratorProviderState, error) { if jsonSpec == nil { return nil, nil, errors.New(errNoSpec) } res, err := parseSpec(jsonSpec.Raw) if err != nil { return nil, nil, fmt.Errorf(errParseSpec, err) } // Fetch the service account token token, err := esutils.FetchServiceAccountToken(ctx, res.Spec.ServiceAccountRef, namespace) if err != nil { return nil, nil, fmt.Errorf("failed to fetch service account token: %w", err) } url := res.Spec.URL if url == "" { url = defaultQuayURL } url = strings.TrimPrefix(url, "https://") accessToken, err := getQuayRobotToken(ctx, token, res.Spec.RobotAccount, url, g.httpClient) if err != nil { return nil, nil, err } exp, err := esutils.ExtractJWTExpiration(accessToken) if err != nil { return nil, nil, err } return map[string][]byte{ "registry": []byte(url), "auth": []byte(b64.StdEncoding.EncodeToString([]byte(res.Spec.RobotAccount + ":" + accessToken))), "expiry": []byte(exp), }, nil, nil } // https://docs.projectquay.io/manage_quay.html#exchanging-oauth2-robot-account-token func getQuayRobotToken(ctx context.Context, fedToken, robotAccount, url string, hc *http.Client) (string, error) { if hc == nil { hc = &http.Client{ Timeout: httpClientTimeout, } } req, err := http.NewRequestWithContext(ctx, "GET", "https://"+url+"/oauth2/federation/robot/token", http.NoBody) if err != nil { return "", err } req.SetBasicAuth(robotAccount, fedToken) resp, err := hc.Do(req) if err != nil { return "", err } defer func() { _ = resp.Body.Close() }() if resp.StatusCode != 200 { return "", fmt.Errorf("request failed do to unexpected status: %s", resp.Status) } body, err := io.ReadAll(resp.Body) if err != nil { return "", err } var result map[string]interface{} err = json.Unmarshal(body, &result) if err != nil { return "", err } token, ok := result["token"] if !ok { return "", fmt.Errorf("token not found in response") } tokenString, ok := token.(string) if !ok { return "", fmt.Errorf("error when typecasting token to string") } return tokenString, nil } func parseSpec(data []byte) (*genv1alpha1.QuayAccessToken, error) { var spec genv1alpha1.QuayAccessToken err := yaml.Unmarshal(data, &spec) return &spec, err } // NewGenerator creates a new Generator instance. func NewGenerator() genv1alpha1.Generator { return &Generator{} } // Kind returns the generator kind. func Kind() string { return string(genv1alpha1.GeneratorKindQuayAccessToken) }