2021-01-19 15:52:12 +00:00
|
|
|
// Copyright 2020-2021 the Pinniped contributors. All Rights Reserved.
|
2020-09-16 14:19:51 +00:00
|
|
|
// SPDX-License-Identifier: Apache-2.0
|
2020-07-14 15:50:14 +00:00
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
// Package concierge contains functionality to load/store Config's from/to
|
2020-07-14 15:50:14 +00:00
|
|
|
// some source.
|
2020-10-15 19:40:56 +00:00
|
|
|
package concierge
|
2020-07-14 15:50:14 +00:00
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"io/ioutil"
|
Rename many of resources that are created in Kubernetes by Pinniped
New resource naming conventions:
- Do not repeat the Kind in the name,
e.g. do not call it foo-cluster-role-binding, just call it foo
- Names will generally start with a prefix to identify our component,
so when a user lists all objects of that kind, they can tell to which
component it is related,
e.g. `kubectl get configmaps` would list one named "pinniped-config"
- It should be possible for an operator to make the word "pinniped"
mostly disappear if they choose, by specifying the app_name in
values.yaml, to the extent that is practical (but not from APIService
names because those are hardcoded in golang)
- Each role/clusterrole and its corresponding binding have the same name
- Pinniped resource names that must be known by the server golang code
are passed to the code at run time via ConfigMap, rather than
hardcoded in the golang code. This also allows them to be prepended
with the app_name from values.yaml while creating the ConfigMap.
- Since the CLI `get-kubeconfig` command cannot guess the name of the
CredentialIssuerConfig resource in advance anymore, it lists all
CredentialIssuerConfig in the app's namespace and returns an error
if there is not exactly one found, and then uses that one regardless
of its name
2020-09-18 22:56:50 +00:00
|
|
|
"strings"
|
2020-07-14 15:50:14 +00:00
|
|
|
|
|
|
|
"sigs.k8s.io/yaml"
|
|
|
|
|
2020-09-18 19:56:24 +00:00
|
|
|
"go.pinniped.dev/internal/constable"
|
2021-01-13 01:27:41 +00:00
|
|
|
"go.pinniped.dev/internal/groupsuffix"
|
2020-11-10 14:57:29 +00:00
|
|
|
"go.pinniped.dev/internal/plog"
|
2020-07-14 15:50:14 +00:00
|
|
|
)
|
|
|
|
|
2020-08-20 19:17:18 +00:00
|
|
|
const (
|
|
|
|
aboutAYear = 60 * 60 * 24 * 365
|
|
|
|
about9Months = 60 * 60 * 24 * 30 * 9
|
|
|
|
)
|
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
// FromPath loads an Config from a provided local file path, inserts any
|
|
|
|
// defaults (from the Config documentation), and verifies that the config is
|
|
|
|
// valid (per the Config documentation).
|
2020-07-14 15:50:14 +00:00
|
|
|
//
|
2020-10-15 19:40:56 +00:00
|
|
|
// Note! The Config file should contain base64-encoded WebhookCABundle data.
|
2020-07-14 15:50:14 +00:00
|
|
|
// This function will decode that base64-encoded data to PEM bytes to be stored
|
2020-10-15 19:40:56 +00:00
|
|
|
// in the Config.
|
|
|
|
func FromPath(path string) (*Config, error) {
|
2020-07-14 15:50:14 +00:00
|
|
|
data, err := ioutil.ReadFile(path)
|
|
|
|
if err != nil {
|
|
|
|
return nil, fmt.Errorf("read file: %w", err)
|
|
|
|
}
|
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
var config Config
|
2020-07-14 15:50:14 +00:00
|
|
|
if err := yaml.Unmarshal(data, &config); err != nil {
|
|
|
|
return nil, fmt.Errorf("decode yaml: %w", err)
|
|
|
|
}
|
|
|
|
|
2020-08-20 19:17:18 +00:00
|
|
|
maybeSetAPIDefaults(&config.APIConfig)
|
2021-01-19 15:52:12 +00:00
|
|
|
maybeSetAPIGroupSuffixDefault(&config.APIGroupSuffix)
|
2020-09-21 18:16:14 +00:00
|
|
|
maybeSetKubeCertAgentDefaults(&config.KubeCertAgentConfig)
|
2020-08-20 19:17:18 +00:00
|
|
|
|
|
|
|
if err := validateAPI(&config.APIConfig); err != nil {
|
|
|
|
return nil, fmt.Errorf("validate api: %w", err)
|
|
|
|
}
|
|
|
|
|
2021-01-13 01:27:41 +00:00
|
|
|
if err := validateAPIGroupSuffix(*config.APIGroupSuffix); err != nil {
|
|
|
|
return nil, fmt.Errorf("validate apiGroupSuffix: %w", err)
|
|
|
|
}
|
|
|
|
|
Rename many of resources that are created in Kubernetes by Pinniped
New resource naming conventions:
- Do not repeat the Kind in the name,
e.g. do not call it foo-cluster-role-binding, just call it foo
- Names will generally start with a prefix to identify our component,
so when a user lists all objects of that kind, they can tell to which
component it is related,
e.g. `kubectl get configmaps` would list one named "pinniped-config"
- It should be possible for an operator to make the word "pinniped"
mostly disappear if they choose, by specifying the app_name in
values.yaml, to the extent that is practical (but not from APIService
names because those are hardcoded in golang)
- Each role/clusterrole and its corresponding binding have the same name
- Pinniped resource names that must be known by the server golang code
are passed to the code at run time via ConfigMap, rather than
hardcoded in the golang code. This also allows them to be prepended
with the app_name from values.yaml while creating the ConfigMap.
- Since the CLI `get-kubeconfig` command cannot guess the name of the
CredentialIssuerConfig resource in advance anymore, it lists all
CredentialIssuerConfig in the app's namespace and returns an error
if there is not exactly one found, and then uses that one regardless
of its name
2020-09-18 22:56:50 +00:00
|
|
|
if err := validateNames(&config.NamesConfig); err != nil {
|
|
|
|
return nil, fmt.Errorf("validate names: %w", err)
|
|
|
|
}
|
|
|
|
|
2020-11-10 14:57:29 +00:00
|
|
|
if err := plog.ValidateAndSetLogLevelGlobally(config.LogLevel); err != nil {
|
|
|
|
return nil, fmt.Errorf("validate log level: %w", err)
|
|
|
|
}
|
|
|
|
|
2020-10-15 17:14:23 +00:00
|
|
|
if config.Labels == nil {
|
|
|
|
config.Labels = make(map[string]string)
|
|
|
|
}
|
|
|
|
|
2020-07-14 15:50:14 +00:00
|
|
|
return &config, nil
|
|
|
|
}
|
2020-08-20 19:17:18 +00:00
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
func maybeSetAPIDefaults(apiConfig *APIConfigSpec) {
|
2020-08-20 19:17:18 +00:00
|
|
|
if apiConfig.ServingCertificateConfig.DurationSeconds == nil {
|
|
|
|
apiConfig.ServingCertificateConfig.DurationSeconds = int64Ptr(aboutAYear)
|
|
|
|
}
|
|
|
|
|
|
|
|
if apiConfig.ServingCertificateConfig.RenewBeforeSeconds == nil {
|
|
|
|
apiConfig.ServingCertificateConfig.RenewBeforeSeconds = int64Ptr(about9Months)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2021-01-19 15:52:12 +00:00
|
|
|
func maybeSetAPIGroupSuffixDefault(apiGroupSuffix **string) {
|
|
|
|
if *apiGroupSuffix == nil {
|
2021-02-19 18:21:10 +00:00
|
|
|
*apiGroupSuffix = stringPtr(groupsuffix.PinnipedDefaultSuffix)
|
2021-01-19 15:52:12 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
func maybeSetKubeCertAgentDefaults(cfg *KubeCertAgentSpec) {
|
2020-09-21 18:16:14 +00:00
|
|
|
if cfg.NamePrefix == nil {
|
|
|
|
cfg.NamePrefix = stringPtr("pinniped-kube-cert-agent-")
|
|
|
|
}
|
|
|
|
|
|
|
|
if cfg.Image == nil {
|
|
|
|
cfg.Image = stringPtr("debian:latest")
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
func validateNames(names *NamesConfigSpec) error {
|
Rename many of resources that are created in Kubernetes by Pinniped
New resource naming conventions:
- Do not repeat the Kind in the name,
e.g. do not call it foo-cluster-role-binding, just call it foo
- Names will generally start with a prefix to identify our component,
so when a user lists all objects of that kind, they can tell to which
component it is related,
e.g. `kubectl get configmaps` would list one named "pinniped-config"
- It should be possible for an operator to make the word "pinniped"
mostly disappear if they choose, by specifying the app_name in
values.yaml, to the extent that is practical (but not from APIService
names because those are hardcoded in golang)
- Each role/clusterrole and its corresponding binding have the same name
- Pinniped resource names that must be known by the server golang code
are passed to the code at run time via ConfigMap, rather than
hardcoded in the golang code. This also allows them to be prepended
with the app_name from values.yaml while creating the ConfigMap.
- Since the CLI `get-kubeconfig` command cannot guess the name of the
CredentialIssuerConfig resource in advance anymore, it lists all
CredentialIssuerConfig in the app's namespace and returns an error
if there is not exactly one found, and then uses that one regardless
of its name
2020-09-18 22:56:50 +00:00
|
|
|
missingNames := []string{}
|
|
|
|
if names == nil {
|
2021-03-02 17:31:24 +00:00
|
|
|
names = &NamesConfigSpec{}
|
|
|
|
}
|
|
|
|
if names.ServingCertificateSecret == "" {
|
|
|
|
missingNames = append(missingNames, "servingCertificateSecret")
|
|
|
|
}
|
|
|
|
if names.CredentialIssuer == "" {
|
|
|
|
missingNames = append(missingNames, "credentialIssuer")
|
|
|
|
}
|
|
|
|
if names.APIService == "" {
|
|
|
|
missingNames = append(missingNames, "apiService")
|
|
|
|
}
|
|
|
|
if names.ImpersonationConfigMap == "" {
|
|
|
|
missingNames = append(missingNames, "impersonationConfigMap")
|
|
|
|
}
|
|
|
|
if names.ImpersonationLoadBalancerService == "" {
|
|
|
|
missingNames = append(missingNames, "impersonationLoadBalancerService")
|
|
|
|
}
|
|
|
|
if names.ImpersonationTLSCertificateSecret == "" {
|
|
|
|
missingNames = append(missingNames, "impersonationTLSCertificateSecret")
|
|
|
|
}
|
|
|
|
if names.ImpersonationCACertificateSecret == "" {
|
|
|
|
missingNames = append(missingNames, "impersonationCACertificateSecret")
|
Rename many of resources that are created in Kubernetes by Pinniped
New resource naming conventions:
- Do not repeat the Kind in the name,
e.g. do not call it foo-cluster-role-binding, just call it foo
- Names will generally start with a prefix to identify our component,
so when a user lists all objects of that kind, they can tell to which
component it is related,
e.g. `kubectl get configmaps` would list one named "pinniped-config"
- It should be possible for an operator to make the word "pinniped"
mostly disappear if they choose, by specifying the app_name in
values.yaml, to the extent that is practical (but not from APIService
names because those are hardcoded in golang)
- Each role/clusterrole and its corresponding binding have the same name
- Pinniped resource names that must be known by the server golang code
are passed to the code at run time via ConfigMap, rather than
hardcoded in the golang code. This also allows them to be prepended
with the app_name from values.yaml while creating the ConfigMap.
- Since the CLI `get-kubeconfig` command cannot guess the name of the
CredentialIssuerConfig resource in advance anymore, it lists all
CredentialIssuerConfig in the app's namespace and returns an error
if there is not exactly one found, and then uses that one regardless
of its name
2020-09-18 22:56:50 +00:00
|
|
|
}
|
2021-03-10 18:30:06 +00:00
|
|
|
if names.ImpersonationSignerSecret == "" {
|
|
|
|
missingNames = append(missingNames, "impersonationSignerSecret")
|
|
|
|
}
|
2021-05-03 21:20:13 +00:00
|
|
|
if names.ServiceAccount == "" {
|
|
|
|
missingNames = append(missingNames, "serviceAccount")
|
|
|
|
}
|
Rename many of resources that are created in Kubernetes by Pinniped
New resource naming conventions:
- Do not repeat the Kind in the name,
e.g. do not call it foo-cluster-role-binding, just call it foo
- Names will generally start with a prefix to identify our component,
so when a user lists all objects of that kind, they can tell to which
component it is related,
e.g. `kubectl get configmaps` would list one named "pinniped-config"
- It should be possible for an operator to make the word "pinniped"
mostly disappear if they choose, by specifying the app_name in
values.yaml, to the extent that is practical (but not from APIService
names because those are hardcoded in golang)
- Each role/clusterrole and its corresponding binding have the same name
- Pinniped resource names that must be known by the server golang code
are passed to the code at run time via ConfigMap, rather than
hardcoded in the golang code. This also allows them to be prepended
with the app_name from values.yaml while creating the ConfigMap.
- Since the CLI `get-kubeconfig` command cannot guess the name of the
CredentialIssuerConfig resource in advance anymore, it lists all
CredentialIssuerConfig in the app's namespace and returns an error
if there is not exactly one found, and then uses that one regardless
of its name
2020-09-18 22:56:50 +00:00
|
|
|
if len(missingNames) > 0 {
|
|
|
|
return constable.Error("missing required names: " + strings.Join(missingNames, ", "))
|
|
|
|
}
|
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2020-10-15 19:40:56 +00:00
|
|
|
func validateAPI(apiConfig *APIConfigSpec) error {
|
2020-08-20 19:17:18 +00:00
|
|
|
if *apiConfig.ServingCertificateConfig.DurationSeconds < *apiConfig.ServingCertificateConfig.RenewBeforeSeconds {
|
|
|
|
return constable.Error("durationSeconds cannot be smaller than renewBeforeSeconds")
|
|
|
|
}
|
|
|
|
|
2020-08-20 22:14:07 +00:00
|
|
|
if *apiConfig.ServingCertificateConfig.RenewBeforeSeconds <= 0 {
|
|
|
|
return constable.Error("renewBefore must be positive")
|
|
|
|
}
|
|
|
|
|
2020-08-20 19:17:18 +00:00
|
|
|
return nil
|
|
|
|
}
|
|
|
|
|
2021-01-13 01:27:41 +00:00
|
|
|
func validateAPIGroupSuffix(apiGroupSuffix string) error {
|
|
|
|
return groupsuffix.Validate(apiGroupSuffix)
|
|
|
|
}
|
|
|
|
|
2020-08-20 19:17:18 +00:00
|
|
|
func int64Ptr(i int64) *int64 {
|
|
|
|
return &i
|
|
|
|
}
|
2020-09-21 18:16:14 +00:00
|
|
|
|
|
|
|
func stringPtr(s string) *string {
|
|
|
|
return &s
|
|
|
|
}
|