mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-21 10:51:29 +00:00
8100efc7b3
* Add tracker types and tests * Modify ResourceEventHandler interface's OnAdd member * Add additional ResourceEventHandlerDetailedFuncs struct * Fix SharedInformer to let users track HasSynced for their handlers * Fix in-tree controllers which weren't computing HasSynced correctly * Deprecate the cache.Pop function
1078 lines
35 KiB
Go
1078 lines
35 KiB
Go
/*
|
|
Copyright 2021 The Kubernetes 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 client
|
|
|
|
import (
|
|
"context"
|
|
"crypto/tls"
|
|
"crypto/x509"
|
|
"encoding/base64"
|
|
"errors"
|
|
"fmt"
|
|
"net"
|
|
"net/http"
|
|
"os"
|
|
"reflect"
|
|
"strconv"
|
|
"strings"
|
|
"sync"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/davecgh/go-spew/spew"
|
|
"github.com/google/go-cmp/cmp"
|
|
corev1 "k8s.io/api/core/v1"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/util/rand"
|
|
"k8s.io/apimachinery/pkg/util/sets"
|
|
"k8s.io/apimachinery/pkg/util/wait"
|
|
"k8s.io/client-go/informers"
|
|
clientset "k8s.io/client-go/kubernetes"
|
|
v1 "k8s.io/client-go/kubernetes/typed/core/v1"
|
|
"k8s.io/client-go/plugin/pkg/client/auth/exec"
|
|
"k8s.io/client-go/rest"
|
|
"k8s.io/client-go/tools/cache"
|
|
clientcmdapi "k8s.io/client-go/tools/clientcmd/api"
|
|
"k8s.io/client-go/tools/metrics"
|
|
"k8s.io/client-go/transport"
|
|
"k8s.io/client-go/util/cert"
|
|
"k8s.io/client-go/util/connrotation"
|
|
kubeapiservertesting "k8s.io/kubernetes/cmd/kube-apiserver/app/testing"
|
|
"k8s.io/kubernetes/test/integration/framework"
|
|
)
|
|
|
|
// This file tests the client-go credential plugin feature.
|
|
|
|
// These constants are used to communicate behavior to the testdata/exec-plugin.sh test fixture.
|
|
const (
|
|
exitCodeEnvVar = "EXEC_PLUGIN_EXEC_CODE"
|
|
outputEnvVar = "EXEC_PLUGIN_OUTPUT"
|
|
outputFileEnvVar = "EXEC_PLUGIN_OUTPUT_FILE"
|
|
)
|
|
|
|
type roundTripperFunc func(*http.Request) (*http.Response, error)
|
|
|
|
func (f roundTripperFunc) RoundTrip(req *http.Request) (*http.Response, error) {
|
|
return f(req)
|
|
}
|
|
|
|
type syncedHeaderValues struct {
|
|
mu sync.Mutex
|
|
data [][]string
|
|
}
|
|
|
|
func (s *syncedHeaderValues) append(values []string) {
|
|
s.mu.Lock()
|
|
defer s.mu.Unlock()
|
|
s.data = append(s.data, values)
|
|
}
|
|
|
|
func (s *syncedHeaderValues) get() [][]string {
|
|
s.mu.Lock()
|
|
defer s.mu.Unlock()
|
|
return s.data
|
|
}
|
|
|
|
type execPluginCall struct {
|
|
exitCode int
|
|
callStatus string
|
|
}
|
|
|
|
type execPluginMetrics struct {
|
|
calls []execPluginCall
|
|
}
|
|
|
|
func (m *execPluginMetrics) Increment(exitCode int, callStatus string) {
|
|
m.calls = append(m.calls, execPluginCall{exitCode: exitCode, callStatus: callStatus})
|
|
}
|
|
|
|
var execPluginMetricsComparer = cmp.Comparer(func(a, b *execPluginMetrics) bool {
|
|
return reflect.DeepEqual(a, b)
|
|
})
|
|
|
|
type execPluginClientTestData struct {
|
|
name string
|
|
clientConfigFunc func(*rest.Config)
|
|
wantAuthorizationHeaderValues [][]string
|
|
wantCertificate *tls.Certificate
|
|
wantGetCertificateErrorPrefix string
|
|
wantClientErrorPrefix string
|
|
wantMetrics *execPluginMetrics
|
|
}
|
|
|
|
func execPluginClientTests(t *testing.T, unauthorizedCert, unauthorizedKey []byte, clientAuthorizedToken, clientCertFileName, clientKeyFileName string) []execPluginClientTestData {
|
|
v1Tests := []execPluginClientTestData{
|
|
{
|
|
name: "unauthorized token",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: `{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "unauthorized"
|
|
}
|
|
}`,
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer unauthorized"}},
|
|
wantCertificate: &tls.Certificate{},
|
|
wantClientErrorPrefix: "Unauthorized",
|
|
wantMetrics: &execPluginMetrics{
|
|
calls: []execPluginCall{
|
|
// 2 calls since we preemptively refresh the creds upon a 401 HTTP response.
|
|
{exitCode: 0, callStatus: "no_error"},
|
|
{exitCode: 0, callStatus: "no_error"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "unauthorized certificate",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"clientCertificateData": %q,
|
|
"clientKeyData": %q
|
|
}
|
|
}`, unauthorizedCert, unauthorizedKey),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{nil},
|
|
wantCertificate: x509KeyPair(unauthorizedCert, unauthorizedKey, true),
|
|
wantClientErrorPrefix: "Unauthorized",
|
|
wantMetrics: &execPluginMetrics{
|
|
calls: []execPluginCall{
|
|
// 2 calls since we preemptively refresh the creds upon a 401 HTTP response.
|
|
{exitCode: 0, callStatus: "no_error"},
|
|
{exitCode: 0, callStatus: "no_error"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "authorized token",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s"
|
|
}
|
|
}`, clientAuthorizedToken),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer " + clientAuthorizedToken}},
|
|
wantCertificate: &tls.Certificate{},
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 0, callStatus: "no_error"}}},
|
|
},
|
|
{
|
|
name: "authorized certificate",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"clientCertificateData": %s,
|
|
"clientKeyData": %s
|
|
}
|
|
}`, read(t, clientCertFileName), read(t, clientKeyFileName)),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{nil},
|
|
wantCertificate: loadX509KeyPair(clientCertFileName, clientKeyFileName),
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 0, callStatus: "no_error"}}},
|
|
},
|
|
{
|
|
name: "authorized token and certificate",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s",
|
|
"clientCertificateData": %s,
|
|
"clientKeyData": %s
|
|
}
|
|
}`, clientAuthorizedToken, read(t, clientCertFileName), read(t, clientKeyFileName)),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer " + clientAuthorizedToken}},
|
|
wantCertificate: loadX509KeyPair(clientCertFileName, clientKeyFileName),
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 0, callStatus: "no_error"}}},
|
|
},
|
|
{
|
|
name: "unauthorized token and authorized certificate favors authorized certificate",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s",
|
|
"clientCertificateData": %s,
|
|
"clientKeyData": %s
|
|
}
|
|
}`, "client-unauthorized-token", read(t, clientCertFileName), read(t, clientKeyFileName)),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer client-unauthorized-token"}},
|
|
wantCertificate: loadX509KeyPair(clientCertFileName, clientKeyFileName),
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 0, callStatus: "no_error"}}},
|
|
},
|
|
{
|
|
name: "authorized token and unauthorized certificate favors authorized token",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s",
|
|
"clientCertificateData": %q,
|
|
"clientKeyData": %q
|
|
}
|
|
}`, clientAuthorizedToken, string(unauthorizedCert), string(unauthorizedKey)),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer " + clientAuthorizedToken}},
|
|
wantCertificate: x509KeyPair([]byte(unauthorizedCert), []byte(unauthorizedKey), true),
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 0, callStatus: "no_error"}}},
|
|
},
|
|
{
|
|
name: "unauthorized token and unauthorized certificate",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s",
|
|
"clientCertificateData": %q,
|
|
"clientKeyData": %q
|
|
}
|
|
}`, "client-unauthorized-token", string(unauthorizedCert), string(unauthorizedKey)),
|
|
},
|
|
}
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer client-unauthorized-token"}},
|
|
wantCertificate: x509KeyPair(unauthorizedCert, unauthorizedKey, true),
|
|
wantClientErrorPrefix: "Unauthorized",
|
|
wantMetrics: &execPluginMetrics{
|
|
calls: []execPluginCall{
|
|
// 2 calls since we preemptively refresh the creds upon a 401 HTTP response.
|
|
{exitCode: 0, callStatus: "no_error"},
|
|
{exitCode: 0, callStatus: "no_error"},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
name: "good token with static auth basic creds favors static auth basic creds",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s"
|
|
}
|
|
}`, clientAuthorizedToken),
|
|
},
|
|
}
|
|
c.Username = "unauthorized"
|
|
c.Password = "unauthorized"
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Basic " + basicAuthHeaderValue("unauthorized", "unauthorized")}},
|
|
wantClientErrorPrefix: "Unauthorized",
|
|
wantMetrics: &execPluginMetrics{},
|
|
},
|
|
{
|
|
name: "good token with static auth bearer token favors static auth bearer token",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s"
|
|
}
|
|
}`, clientAuthorizedToken),
|
|
},
|
|
}
|
|
c.BearerToken = "some-unauthorized-token"
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{{"Bearer some-unauthorized-token"}},
|
|
wantClientErrorPrefix: "Unauthorized",
|
|
wantMetrics: &execPluginMetrics{},
|
|
},
|
|
{
|
|
name: "good token with static auth cert and key favors static cert",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": "%s"
|
|
}
|
|
}`, clientAuthorizedToken),
|
|
},
|
|
}
|
|
c.CertData = unauthorizedCert
|
|
c.KeyData = unauthorizedKey
|
|
},
|
|
wantAuthorizationHeaderValues: [][]string{nil},
|
|
wantClientErrorPrefix: "Unauthorized",
|
|
wantCertificate: x509KeyPair(unauthorizedCert, unauthorizedKey, false),
|
|
wantMetrics: &execPluginMetrics{},
|
|
},
|
|
{
|
|
name: "unknown binary",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Command = "does not exist"
|
|
},
|
|
wantGetCertificateErrorPrefix: "exec: executable does not exist not found",
|
|
wantClientErrorPrefix: `Get "https`,
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 1, callStatus: "plugin_not_found_error"}}},
|
|
},
|
|
{
|
|
name: "binary not executable",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Command = "./testdata/exec-plugin-not-executable.sh"
|
|
},
|
|
wantGetCertificateErrorPrefix: "exec: fork/exec ./testdata/exec-plugin-not-executable.sh: permission denied",
|
|
wantClientErrorPrefix: `Get "https`,
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 1, callStatus: "plugin_not_found_error"}}},
|
|
},
|
|
{
|
|
name: "binary fails",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: exitCodeEnvVar,
|
|
Value: "10",
|
|
},
|
|
}
|
|
},
|
|
wantGetCertificateErrorPrefix: "exec: executable testdata/exec-plugin.sh failed with exit code 10",
|
|
wantClientErrorPrefix: `Get "https`,
|
|
wantMetrics: &execPluginMetrics{calls: []execPluginCall{{exitCode: 10, callStatus: "plugin_execution_error"}}},
|
|
},
|
|
}
|
|
return append(v1Tests, v1beta1TestsFromV1Tests(v1Tests)...)
|
|
}
|
|
|
|
func v1beta1TestsFromV1Tests(v1Tests []execPluginClientTestData) []execPluginClientTestData {
|
|
v1beta1Tests := make([]execPluginClientTestData, 0, len(v1Tests))
|
|
for _, v1Test := range v1Tests {
|
|
v1Test := v1Test
|
|
|
|
v1beta1Test := v1Test
|
|
v1beta1Test.name = fmt.Sprintf("%s v1beta1", v1Test.name)
|
|
v1beta1Test.clientConfigFunc = func(c *rest.Config) {
|
|
v1Test.clientConfigFunc(c)
|
|
c.ExecProvider.APIVersion = "client.authentication.k8s.io/v1beta1"
|
|
for j, oldOutputEnvVar := range c.ExecProvider.Env {
|
|
if oldOutputEnvVar.Name == outputEnvVar {
|
|
c.ExecProvider.Env[j].Value = strings.Replace(oldOutputEnvVar.Value, "client.authentication.k8s.io/v1", "client.authentication.k8s.io/v1beta1", 1)
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
v1beta1Tests = append(v1beta1Tests, v1beta1Test)
|
|
}
|
|
return v1beta1Tests
|
|
}
|
|
|
|
func TestExecPluginViaClient(t *testing.T) {
|
|
result, clientAuthorizedToken, clientCertFileName, clientKeyFileName := startTestServer(t)
|
|
|
|
unauthorizedCert, unauthorizedKey, err := cert.GenerateSelfSignedCertKey("some-host", nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
tests := execPluginClientTests(t, unauthorizedCert, unauthorizedKey, clientAuthorizedToken, clientCertFileName, clientKeyFileName)
|
|
|
|
for _, test := range tests {
|
|
test := test
|
|
t.Run(test.name, func(t *testing.T) {
|
|
actualMetrics := captureMetrics(t)
|
|
|
|
var authorizationHeaderValues syncedHeaderValues
|
|
clientConfig := rest.AnonymousClientConfig(result.ClientConfig)
|
|
clientConfig.ExecProvider = &clientcmdapi.ExecConfig{
|
|
Command: "testdata/exec-plugin.sh",
|
|
APIVersion: "client.authentication.k8s.io/v1",
|
|
Args: []string{
|
|
// If we didn't have this arg, then some metrics assertions might fail because
|
|
// the authenticator may be pulled from a globalCache and therefore it may have
|
|
// already fetched a valid credential.
|
|
"--random-arg-to-avoid-authenticator-cache-hits",
|
|
rand.String(10),
|
|
},
|
|
InteractiveMode: clientcmdapi.IfAvailableExecInteractiveMode,
|
|
}
|
|
clientConfig.Wrap(func(rt http.RoundTripper) http.RoundTripper {
|
|
return roundTripperFunc(func(req *http.Request) (*http.Response, error) {
|
|
authorizationHeaderValues.append(req.Header.Values("Authorization"))
|
|
return rt.RoundTrip(req)
|
|
})
|
|
})
|
|
|
|
if test.clientConfigFunc != nil {
|
|
test.clientConfigFunc(clientConfig)
|
|
}
|
|
client := clientset.NewForConfigOrDie(clientConfig)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
|
|
defer cancel()
|
|
|
|
// Validate that the client works as expected on its own.
|
|
_, err = client.CoreV1().ConfigMaps("default").List(ctx, metav1.ListOptions{})
|
|
if test.wantClientErrorPrefix != "" {
|
|
if err == nil || !strings.HasPrefix(err.Error(), test.wantClientErrorPrefix) {
|
|
t.Fatalf(`got %v, wanted "%s..."`, err, test.wantClientErrorPrefix)
|
|
}
|
|
} else if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
// Validate that the proper metrics were set.
|
|
if diff := cmp.Diff(test.wantMetrics, actualMetrics, execPluginMetricsComparer); diff != "" {
|
|
t.Error("unexpected metrics; -want, +got:\n" + diff)
|
|
}
|
|
|
|
// Validate that the right token is used.
|
|
if diff := cmp.Diff(test.wantAuthorizationHeaderValues, authorizationHeaderValues.get()); diff != "" {
|
|
t.Error("unexpected authorization header values; -want, +got:\n" + diff)
|
|
}
|
|
|
|
// Validate that the right certs are used.
|
|
tlsConfig, err := rest.TLSConfigFor(clientConfig)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if tlsConfig.GetClientCertificate == nil {
|
|
if test.wantCertificate != nil {
|
|
t.Error("GetClientCertificate is nil, but we expected a certificate")
|
|
}
|
|
} else {
|
|
cert, err := tlsConfig.GetClientCertificate(&tls.CertificateRequestInfo{})
|
|
if len(test.wantGetCertificateErrorPrefix) != 0 {
|
|
if err == nil || !strings.HasPrefix(err.Error(), test.wantGetCertificateErrorPrefix) {
|
|
t.Fatalf(`got %q, wanted "%s..."`, err, test.wantGetCertificateErrorPrefix)
|
|
}
|
|
} else if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
if diff := cmp.Diff(test.wantCertificate, cert); diff != "" {
|
|
t.Error("unexpected certificate; -want, +got:\n" + diff)
|
|
}
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func captureMetrics(t *testing.T) *execPluginMetrics {
|
|
previousCallsMetric := metrics.ExecPluginCalls
|
|
t.Cleanup(func() {
|
|
metrics.ExecPluginCalls = previousCallsMetric
|
|
})
|
|
|
|
actualMetrics := &execPluginMetrics{}
|
|
metrics.ExecPluginCalls = actualMetrics
|
|
return actualMetrics
|
|
}
|
|
|
|
// objectMetaSansResourceVersionComparer compares two metav1.ObjectMeta's except for their resource
|
|
// versions. Since the underlying integration test etcd is shared, these resource versions may jump
|
|
// past the next sequential number for sequential API calls in the test.
|
|
var objectMetaSansResourceVersionComparer = cmp.Comparer(func(a, b metav1.ObjectMeta) bool {
|
|
aa := a.DeepCopy()
|
|
bb := b.DeepCopy()
|
|
|
|
aa.ResourceVersion = ""
|
|
bb.ResourceVersion = ""
|
|
|
|
return cmp.Equal(aa, bb)
|
|
})
|
|
|
|
type oldNew struct {
|
|
old, new interface{}
|
|
}
|
|
|
|
var oldNewComparer = cmp.Comparer(func(a, b oldNew) bool {
|
|
return cmp.Equal(a.old, b.old, objectMetaSansResourceVersionComparer) &&
|
|
cmp.Equal(a.new, a.new, objectMetaSansResourceVersionComparer)
|
|
})
|
|
|
|
type informerSpy struct {
|
|
mu sync.Mutex
|
|
adds []interface{}
|
|
updates []oldNew
|
|
deletes []interface{}
|
|
}
|
|
|
|
func (is *informerSpy) OnAdd(obj interface{}, isInInitialList bool) {
|
|
is.mu.Lock()
|
|
defer is.mu.Unlock()
|
|
is.adds = append(is.adds, obj)
|
|
}
|
|
|
|
func (is *informerSpy) OnUpdate(old, new interface{}) {
|
|
is.mu.Lock()
|
|
defer is.mu.Unlock()
|
|
is.updates = append(is.updates, oldNew{old: old, new: new})
|
|
}
|
|
|
|
func (is *informerSpy) OnDelete(obj interface{}) {
|
|
is.mu.Lock()
|
|
defer is.mu.Unlock()
|
|
is.deletes = append(is.deletes, obj)
|
|
}
|
|
|
|
func (is *informerSpy) clear() {
|
|
is.mu.Lock()
|
|
defer is.mu.Unlock()
|
|
is.adds = []interface{}{}
|
|
is.updates = []oldNew{}
|
|
is.deletes = []interface{}{}
|
|
}
|
|
|
|
// waitForEvents waits for adds, updates, and deletes to be populated with at least one event.
|
|
func (is *informerSpy) waitForEvents(t *testing.T, wantEvents bool) {
|
|
t.Helper()
|
|
// wait for create/update/delete 3 events for 30 seconds
|
|
waitTimeout := time.Second * 30
|
|
if !wantEvents {
|
|
// wait just 15 seconds for no events
|
|
waitTimeout = time.Second * 15
|
|
}
|
|
|
|
err := wait.PollImmediate(time.Second, waitTimeout, func() (bool, error) {
|
|
is.mu.Lock()
|
|
defer is.mu.Unlock()
|
|
return len(is.adds) > 0 && len(is.updates) > 0 && len(is.deletes) > 0, nil
|
|
})
|
|
if wantEvents {
|
|
if err != nil {
|
|
t.Fatalf("wanted events, but got error: %v", err)
|
|
}
|
|
} else {
|
|
if !errors.Is(err, wait.ErrWaitTimeout) {
|
|
if err != nil {
|
|
t.Fatalf("wanted no events, but got error: %v", err)
|
|
} else {
|
|
t.Fatalf("wanted no events, but got some: %s", spew.Sprintf("%#v", is))
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestExecPluginViaInformer(t *testing.T) {
|
|
result, clientAuthorizedToken, clientCertFileName, clientKeyFileName := startTestServer(t)
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*60)
|
|
defer cancel()
|
|
|
|
adminClient := clientset.NewForConfigOrDie(result.ClientConfig)
|
|
ns := createNamespace(ctx, t, adminClient)
|
|
|
|
tests := []struct {
|
|
name string
|
|
clientConfigFunc func(*rest.Config)
|
|
wantAuthorizationHeaderValues [][]string
|
|
wantCertificate *tls.Certificate
|
|
}{
|
|
{
|
|
name: "authorized token",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"token": %q
|
|
}
|
|
}`, clientAuthorizedToken),
|
|
},
|
|
}
|
|
},
|
|
},
|
|
{
|
|
name: "authorized certificate",
|
|
clientConfigFunc: func(c *rest.Config) {
|
|
c.ExecProvider.Env = []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputEnvVar,
|
|
Value: fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"clientCertificateData": %s,
|
|
"clientKeyData": %s
|
|
}
|
|
}`, read(t, clientCertFileName), read(t, clientKeyFileName)),
|
|
},
|
|
}
|
|
},
|
|
},
|
|
}
|
|
for _, test := range tests {
|
|
t.Run(test.name, func(t *testing.T) {
|
|
clientConfig := rest.AnonymousClientConfig(result.ClientConfig)
|
|
clientConfig.ExecProvider = &clientcmdapi.ExecConfig{
|
|
Command: "testdata/exec-plugin.sh",
|
|
APIVersion: "client.authentication.k8s.io/v1",
|
|
InteractiveMode: clientcmdapi.IfAvailableExecInteractiveMode,
|
|
}
|
|
|
|
if test.clientConfigFunc != nil {
|
|
test.clientConfigFunc(clientConfig)
|
|
}
|
|
|
|
informer, informerSpy := startConfigMapInformer(ctx, t, clientset.NewForConfigOrDie(clientConfig), ns.Name)
|
|
waitForInformerSync(ctx, t, informer, true, "")
|
|
createdCM, updatedCM, deletedCM := createUpdateDeleteConfigMap(ctx, t, adminClient.CoreV1().ConfigMaps(ns.Name))
|
|
informerSpy.waitForEvents(t, true)
|
|
assertInformerEvents(t, informerSpy, createdCM, updatedCM, deletedCM)
|
|
})
|
|
}
|
|
}
|
|
|
|
type execPlugin struct {
|
|
t *testing.T
|
|
outputFile *os.File
|
|
}
|
|
|
|
func newExecPlugin(t *testing.T) *execPlugin {
|
|
t.Helper()
|
|
outputFile, err := os.CreateTemp("", "kubernetes-client-exec-test-plugin-output-file-*")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
return &execPlugin{t: t, outputFile: outputFile}
|
|
}
|
|
|
|
func (e *execPlugin) config() *clientcmdapi.ExecConfig {
|
|
return &clientcmdapi.ExecConfig{
|
|
Command: "testdata/exec-plugin.sh",
|
|
APIVersion: "client.authentication.k8s.io/v1",
|
|
InteractiveMode: clientcmdapi.IfAvailableExecInteractiveMode,
|
|
Env: []clientcmdapi.ExecEnvVar{
|
|
{
|
|
Name: outputFileEnvVar,
|
|
Value: e.outputFile.Name(),
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
func (e *execPlugin) rotateToken(newToken string, lifetime time.Duration) {
|
|
e.t.Helper()
|
|
|
|
expirationTimestamp := metav1.NewTime(time.Now().Add(lifetime)).Format(time.RFC3339Nano)
|
|
newOutput := fmt.Sprintf(`{
|
|
"kind": "ExecCredential",
|
|
"apiVersion": "client.authentication.k8s.io/v1",
|
|
"status": {
|
|
"expirationTimestamp": %q,
|
|
"token": %q
|
|
}
|
|
}`, expirationTimestamp, newToken)
|
|
if err := os.WriteFile(e.outputFile.Name(), []byte(newOutput), 0644); err != nil {
|
|
e.t.Fatal(err)
|
|
}
|
|
}
|
|
|
|
func TestExecPluginRotationViaInformer(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
result, clientAuthorizedToken, _, _ := startTestServer(t)
|
|
const clientUnauthorizedToken = "invalid-token"
|
|
const tokenLifetime = time.Second * 5
|
|
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Minute*5)
|
|
defer cancel()
|
|
|
|
adminClient := clientset.NewForConfigOrDie(result.ClientConfig)
|
|
ns := createNamespace(ctx, t, adminClient)
|
|
|
|
clientDialer := connrotation.NewDialer((&net.Dialer{
|
|
Timeout: 30 * time.Second,
|
|
KeepAlive: 30 * time.Second,
|
|
}).DialContext)
|
|
|
|
execPlugin := newExecPlugin(t)
|
|
|
|
clientConfig := rest.AnonymousClientConfig(result.ClientConfig)
|
|
clientConfig.ExecProvider = execPlugin.config()
|
|
clientConfig.Dial = clientDialer.DialContext
|
|
clientConfig.Wrap(func(rt http.RoundTripper) http.RoundTripper {
|
|
// This makes it helpful to see what is happening with the informer's client.
|
|
return transport.NewDebuggingRoundTripper(rt, transport.DebugCurlCommand, transport.DebugURLTiming)
|
|
})
|
|
|
|
// Initialize informer spy wth invalid token.
|
|
// Make sure informer never syncs because it can't authenticate.
|
|
execPlugin.rotateToken(clientUnauthorizedToken, tokenLifetime)
|
|
informer, informerSpy := startConfigMapInformer(ctx, t, clientset.NewForConfigOrDie(clientConfig), ns.Name)
|
|
waitForInformerSync(ctx, t, informer, false, "")
|
|
createUpdateDeleteConfigMap(ctx, t, adminClient.CoreV1().ConfigMaps(ns.Name))
|
|
informerSpy.waitForEvents(t, false)
|
|
|
|
// Rotate token to valid token.
|
|
// Make sure informer sees events because it now has a valid token with which it can authenticate.
|
|
execPlugin.rotateToken(clientAuthorizedToken, tokenLifetime)
|
|
waitForInformerSync(ctx, t, informer, true, "")
|
|
informerSpy.clear()
|
|
createdCM, updatedCM, deletedCM := createUpdateDeleteConfigMap(ctx, t, adminClient.CoreV1().ConfigMaps(ns.Name))
|
|
informerSpy.waitForEvents(t, true)
|
|
assertInformerEvents(t, informerSpy, createdCM, updatedCM, deletedCM)
|
|
|
|
// Rotate token to something invalid and clip watch connection.
|
|
// Informer should recreate connection with invalid token.
|
|
// Make sure informer does not see events since it is using the invalid token.
|
|
execPlugin.rotateToken(clientUnauthorizedToken, tokenLifetime)
|
|
time.Sleep(tokenLifetime) // wait for old token to expire to make sure the watch is restarted with clientUnauthorizedToken
|
|
clientDialer.CloseAll()
|
|
waitForInformerSync(ctx, t, informer, true, "")
|
|
informerSpy.clear()
|
|
createUpdateDeleteConfigMap(ctx, t, adminClient.CoreV1().ConfigMaps(ns.Name))
|
|
informerSpy.waitForEvents(t, false)
|
|
|
|
// Rotate token to valid token.
|
|
// Make sure informer sees events because it now has a valid token with which it can authenticate.
|
|
lastSyncResourceVersion := informer.LastSyncResourceVersion()
|
|
execPlugin.rotateToken(clientAuthorizedToken, tokenLifetime)
|
|
waitForInformerSync(ctx, t, informer, true, lastSyncResourceVersion)
|
|
informerSpy.clear()
|
|
createdCM, updatedCM, deletedCM = createUpdateDeleteConfigMap(ctx, t, adminClient.CoreV1().ConfigMaps(ns.Name))
|
|
informerSpy.waitForEvents(t, true)
|
|
assertInformerEvents(t, informerSpy, createdCM, updatedCM, deletedCM)
|
|
}
|
|
|
|
func startTestServer(t *testing.T) (result *kubeapiservertesting.TestServer, clientAuthorizedToken string, clientCertFileName string, clientKeyFileName string) {
|
|
certDir, err := os.MkdirTemp("", "kubernetes-client-exec-test-cert-dir-*")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
t.Cleanup(func() {
|
|
if err := os.RemoveAll(certDir); err != nil {
|
|
t.Error(err)
|
|
}
|
|
})
|
|
|
|
clientAuthorizedToken = "client-authorized-token"
|
|
tokenFileName := writeTokenFile(t, clientAuthorizedToken)
|
|
clientCAFileName, clientSigningCert, clientSigningKey := writeCACertFiles(t, certDir)
|
|
clientCertFileName, clientKeyFileName = writeCerts(t, clientSigningCert, clientSigningKey, certDir, time.Hour)
|
|
result = kubeapiservertesting.StartTestServerOrDie(
|
|
t,
|
|
nil,
|
|
[]string{
|
|
"--token-auth-file", tokenFileName,
|
|
"--client-ca-file=" + clientCAFileName,
|
|
},
|
|
framework.SharedEtcd(),
|
|
)
|
|
t.Cleanup(result.TearDownFn)
|
|
|
|
return
|
|
}
|
|
|
|
func writeTokenFile(t *testing.T, goodToken string) string {
|
|
t.Helper()
|
|
|
|
tokenFile, err := os.CreateTemp("", "kubernetes-client-exec-test-token-file-*")
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if _, err := tokenFile.WriteString(fmt.Sprintf(`%s,admin,uid1,"system:masters"`, goodToken)); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if err := tokenFile.Close(); err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
return tokenFile.Name()
|
|
}
|
|
|
|
func read(t *testing.T, fileName string) string {
|
|
t.Helper()
|
|
data, err := os.ReadFile(fileName)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
return fmt.Sprintf("%q", string(data))
|
|
}
|
|
|
|
func basicAuthHeaderValue(username, password string) string {
|
|
return base64.StdEncoding.EncodeToString([]byte(fmt.Sprintf("%s:%s", username, password)))
|
|
}
|
|
|
|
func x509KeyPair(certPEMBlock, keyPEMBlock []byte, leaf bool) *tls.Certificate {
|
|
cert, err := tls.X509KeyPair(certPEMBlock, keyPEMBlock)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
if leaf {
|
|
cert.Leaf, err = x509.ParseCertificate(cert.Certificate[0])
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
}
|
|
return &cert
|
|
}
|
|
|
|
func loadX509KeyPair(certFile, keyFile string) *tls.Certificate {
|
|
cert, err := tls.LoadX509KeyPair(certFile, keyFile)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
cert.Leaf, err = x509.ParseCertificate(cert.Certificate[0])
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
return &cert
|
|
}
|
|
|
|
func createNamespace(ctx context.Context, t *testing.T, client clientset.Interface) *corev1.Namespace {
|
|
t.Helper()
|
|
|
|
ns, err := client.CoreV1().Namespaces().Create(
|
|
ctx,
|
|
&corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "test-exec-plugin-with-informer-ns"}},
|
|
metav1.CreateOptions{},
|
|
)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
t.Cleanup(func() {
|
|
// Use a new context since the one passed to this function would have timed out.
|
|
ctx, cancel := context.WithTimeout(context.Background(), time.Second*10)
|
|
defer cancel()
|
|
if err := client.CoreV1().Namespaces().Delete(ctx, ns.Name, metav1.DeleteOptions{}); err != nil {
|
|
t.Error(err)
|
|
}
|
|
})
|
|
|
|
return ns
|
|
}
|
|
|
|
func startConfigMapInformer(ctx context.Context, t *testing.T, client clientset.Interface, namespace string) (cache.SharedIndexInformer, *informerSpy) {
|
|
t.Helper()
|
|
|
|
var informerSpy informerSpy
|
|
informerFactory := informers.NewSharedInformerFactoryWithOptions(client, 0, informers.WithNamespace(namespace))
|
|
cmInformer := informerFactory.Core().V1().ConfigMaps().Informer()
|
|
cmInformer.AddEventHandler(&informerSpy)
|
|
if err := cmInformer.SetWatchErrorHandler(func(r *cache.Reflector, err error) {
|
|
// t.Logf("watch error handler: failure in reflector %#v: %v", r, err) // Uncomment for more verbose logging
|
|
}); err != nil {
|
|
t.Fatalf("could not set watch error handler: %v", err)
|
|
}
|
|
informerFactory.Start(ctx.Done())
|
|
|
|
return cmInformer, &informerSpy
|
|
}
|
|
|
|
func waitForInformerSync(ctx context.Context, t *testing.T, informer cache.SharedIndexInformer, wantSynced bool, lastSyncResourceVersion string) {
|
|
t.Helper()
|
|
|
|
syncCtx, cancel := context.WithTimeout(ctx, time.Second*60)
|
|
defer cancel()
|
|
if gotSynced := cache.WaitForCacheSync(syncCtx.Done(), informer.HasSynced); wantSynced != gotSynced {
|
|
t.Fatalf("wanted sync %t, got sync %t", wantSynced, gotSynced)
|
|
}
|
|
|
|
if len(lastSyncResourceVersion) != 0 {
|
|
if err := wait.PollImmediate(time.Second, time.Second*60, func() (bool, error) {
|
|
return informer.LastSyncResourceVersion() != lastSyncResourceVersion, nil
|
|
}); err != nil {
|
|
t.Fatalf("informer never changed resource versions from %q: %v", lastSyncResourceVersion, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
func createUpdateDeleteConfigMap(ctx context.Context, t *testing.T, cms v1.ConfigMapInterface) (created, updated, deleted *corev1.ConfigMap) {
|
|
t.Helper()
|
|
|
|
var err error
|
|
created, err = cms.Create(ctx, &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "cm"}}, metav1.CreateOptions{})
|
|
if err != nil {
|
|
t.Fatal("could not create ConfigMap:", err)
|
|
}
|
|
|
|
updated = created.DeepCopy()
|
|
updated.Annotations = map[string]string{"tuna": "fish"}
|
|
updated, err = cms.Update(ctx, updated, metav1.UpdateOptions{})
|
|
if err != nil {
|
|
t.Fatal("could not update ConfigMap:", err)
|
|
}
|
|
|
|
if err := cms.Delete(ctx, updated.Name, metav1.DeleteOptions{}); err != nil {
|
|
t.Fatal("could not delete ConfigMap:", err)
|
|
}
|
|
|
|
deleted = updated.DeepCopy()
|
|
|
|
return created, updated, deleted
|
|
}
|
|
|
|
func assertInformerEvents(t *testing.T, informerSpy *informerSpy, created, updated, deleted interface{}) {
|
|
t.Helper()
|
|
|
|
// Validate that the informer was called correctly.
|
|
if diff := cmp.Diff([]interface{}{created}, informerSpy.adds, objectMetaSansResourceVersionComparer); diff != "" {
|
|
t.Errorf("unexpected add event(s), -want, +got:\n%s", diff)
|
|
}
|
|
if diff := cmp.Diff([]oldNew{{created, updated}}, informerSpy.updates, oldNewComparer); diff != "" {
|
|
t.Errorf("unexpected update event(s), -want, +got:\n%s", diff)
|
|
}
|
|
if diff := cmp.Diff([]interface{}{deleted}, informerSpy.deletes, objectMetaSansResourceVersionComparer); diff != "" {
|
|
t.Errorf("unexpected deleted event(s), -want, +got:\n%s", diff)
|
|
}
|
|
|
|
}
|
|
|
|
func TestExecPluginGlobalCache(t *testing.T) {
|
|
// we do not really need the server for this test but this allows us to easily share the test data
|
|
result, clientAuthorizedToken, clientCertFileName, clientKeyFileName := startTestServer(t)
|
|
|
|
unauthorizedCert, unauthorizedKey, err := cert.GenerateSelfSignedCertKey("some-host", nil, nil)
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
testsFirstRun := execPluginClientTests(t, unauthorizedCert, unauthorizedKey, clientAuthorizedToken, clientCertFileName, clientKeyFileName)
|
|
testsSecondRun := execPluginClientTests(t, unauthorizedCert, unauthorizedKey, clientAuthorizedToken, clientCertFileName, clientKeyFileName)
|
|
|
|
randStrings := make([]string, 0, len(testsFirstRun))
|
|
for range testsFirstRun {
|
|
randStrings = append(randStrings, rand.String(10))
|
|
}
|
|
|
|
getTestExecClientAddresses := func(t *testing.T, tests []execPluginClientTestData, suffix string) []string {
|
|
var addresses []string
|
|
for i, test := range tests {
|
|
test := test
|
|
t.Run(test.name+" "+suffix, func(t *testing.T) {
|
|
clientConfig := rest.AnonymousClientConfig(result.ClientConfig)
|
|
clientConfig.ExecProvider = &clientcmdapi.ExecConfig{
|
|
Command: "testdata/exec-plugin.sh",
|
|
APIVersion: "client.authentication.k8s.io/v1",
|
|
Args: []string{
|
|
// carefully control what the global cache sees as the same exec plugin
|
|
"--random-arg-to-avoid-authenticator-cache-hits",
|
|
randStrings[i],
|
|
},
|
|
}
|
|
|
|
if test.clientConfigFunc != nil {
|
|
test.clientConfigFunc(clientConfig)
|
|
}
|
|
|
|
addresses = append(addresses, execPluginMemoryAddress(t, clientConfig, i))
|
|
})
|
|
}
|
|
return addresses
|
|
}
|
|
|
|
addressesFirstRun := getTestExecClientAddresses(t, testsFirstRun, "first")
|
|
addressesSecondRun := getTestExecClientAddresses(t, testsSecondRun, "second")
|
|
|
|
if diff := cmp.Diff(addressesFirstRun, addressesSecondRun); diff != "" {
|
|
t.Error("unexpected addresses; -want, +got:\n" + diff)
|
|
}
|
|
|
|
if want, got := len(testsFirstRun), len(addressesFirstRun); want != got {
|
|
t.Errorf("expected %d addresses but got %d", want, got)
|
|
}
|
|
|
|
if want, got := len(addressesFirstRun), sets.NewString(addressesFirstRun...).Len(); want != got {
|
|
t.Errorf("expected %d distinct authenticators but got %d", want, got)
|
|
}
|
|
}
|
|
|
|
func execPluginMemoryAddress(t *testing.T, config *rest.Config, i int) string {
|
|
t.Helper()
|
|
|
|
wantType := reflect.TypeOf(&exec.Authenticator{})
|
|
|
|
tc, err := config.TransportConfig()
|
|
if err != nil {
|
|
t.Fatal(err)
|
|
}
|
|
|
|
if tc.WrapTransport == nil {
|
|
return "<nil> " + strconv.Itoa(i)
|
|
}
|
|
|
|
rt := tc.WrapTransport(nil)
|
|
|
|
val := reflect.Indirect(reflect.ValueOf(rt))
|
|
for i := 0; i < val.NumField(); i++ {
|
|
field := val.Field(i)
|
|
if field.Type() == wantType {
|
|
return strconv.FormatUint(uint64(field.Pointer()), 10)
|
|
}
|
|
}
|
|
|
|
t.Fatal("unable to find authenticator in rest config")
|
|
return ""
|
|
}
|