/* Copyright 2018 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 exec import ( "bytes" "encoding/json" "fmt" "io/ioutil" "net/http" "net/http/httptest" "strings" "testing" "time" "k8s.io/client-go/pkg/apis/clientauthentication" "k8s.io/client-go/tools/clientcmd/api" ) func TestCacheKey(t *testing.T) { c1 := &api.ExecConfig{ Command: "foo-bar", Args: []string{"1", "2"}, Env: []api.ExecEnvVar{ {Name: "3", Value: "4"}, {Name: "5", Value: "6"}, {Name: "7", Value: "8"}, }, APIVersion: "client.authentication.k8s.io/v1alpha1", } c2 := &api.ExecConfig{ Command: "foo-bar", Args: []string{"1", "2"}, Env: []api.ExecEnvVar{ {Name: "3", Value: "4"}, {Name: "5", Value: "6"}, {Name: "7", Value: "8"}, }, APIVersion: "client.authentication.k8s.io/v1alpha1", } c3 := &api.ExecConfig{ Command: "foo-bar", Args: []string{"1", "2"}, Env: []api.ExecEnvVar{ {Name: "3", Value: "4"}, {Name: "5", Value: "6"}, }, APIVersion: "client.authentication.k8s.io/v1alpha1", } key1 := cacheKey(c1) key2 := cacheKey(c2) key3 := cacheKey(c3) if key1 != key2 { t.Error("key1 and key2 didn't match") } if key1 == key3 { t.Error("key1 and key3 matched") } if key2 == key3 { t.Error("key2 and key3 matched") } } func compJSON(t *testing.T, got, want []byte) { t.Helper() gotJSON := &bytes.Buffer{} wantJSON := &bytes.Buffer{} if err := json.Indent(gotJSON, got, "", " "); err != nil { t.Errorf("got invalid JSON: %v", err) } if err := json.Indent(wantJSON, want, "", " "); err != nil { t.Errorf("want invalid JSON: %v", err) } g := strings.TrimSpace(gotJSON.String()) w := strings.TrimSpace(wantJSON.String()) if g != w { t.Errorf("wanted %q, got %q", w, g) } } func TestGetToken(t *testing.T) { tests := []struct { name string config api.ExecConfig output string interactive bool response *clientauthentication.Response wantInput string wantToken string wantExpiry time.Time wantErr bool }{ { name: "basic-request", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": {} }`, output: `{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "foo-bar" } }`, wantToken: "foo-bar", }, { name: "interactive", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, interactive: true, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": { "interactive": true } }`, output: `{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "foo-bar" } }`, wantToken: "foo-bar", }, { name: "response", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, response: &clientauthentication.Response{ Header: map[string][]string{ "WWW-Authenticate": {`Basic realm="Access to the staging site", charset="UTF-8"`}, }, Code: 401, }, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": { "response": { "header": { "WWW-Authenticate": [ "Basic realm=\"Access to the staging site\", charset=\"UTF-8\"" ] }, "code": 401 } } }`, output: `{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "foo-bar" } }`, wantToken: "foo-bar", }, { name: "expiry", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": {} }`, output: `{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "foo-bar", "expirationTimestamp": "2006-01-02T15:04:05Z" } }`, wantExpiry: time.Date(2006, 01, 02, 15, 04, 05, 0, time.UTC), wantToken: "foo-bar", }, { name: "no-group-version", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": {} }`, output: `{ "kind": "ExecCredential", "status": { "token": "foo-bar" } }`, wantErr: true, }, { name: "no-status", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": {} }`, output: `{ "kind": "ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1" }`, wantErr: true, }, { name: "no-token", config: api.ExecConfig{ APIVersion: "client.authentication.k8s.io/v1alpha1", }, wantInput: `{ "kind":"ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "spec": {} }`, output: `{ "kind": "ExecCredential", "apiVersion":"client.authentication.k8s.io/v1alpha1", "status": {} }`, wantErr: true, }, } for _, test := range tests { t.Run(test.name, func(t *testing.T) { c := test.config c.Command = "./testdata/test-plugin.sh" c.Env = append(c.Env, api.ExecEnvVar{ Name: "TEST_OUTPUT", Value: test.output, }) a, err := newAuthenticator(newCache(), &c) if err != nil { t.Fatal(err) } stderr := &bytes.Buffer{} a.stderr = stderr a.interactive = test.interactive a.environ = func() []string { return nil } token, err := a.getToken(test.response) if err != nil { if !test.wantErr { t.Errorf("get token %v", err) } return } if test.wantErr { t.Fatal("expected error getting token") } if token != test.wantToken { t.Errorf("expected token %q got %q", test.wantToken, token) } if !a.exp.Equal(test.wantExpiry) { t.Errorf("expected expiry %v got %v", test.wantExpiry, a.exp) } compJSON(t, stderr.Bytes(), []byte(test.wantInput)) }) } } func TestRoundTripper(t *testing.T) { wantToken := "" n := time.Now() now := func() time.Time { return n } env := []string{""} environ := func() []string { s := make([]string, len(env)) copy(s, env) return s } setOutput := func(s string) { env[0] = "TEST_OUTPUT=" + s } handler := func(w http.ResponseWriter, r *http.Request) { gotToken := "" parts := strings.Split(r.Header.Get("Authorization"), " ") if len(parts) > 1 && strings.EqualFold(parts[0], "bearer") { gotToken = parts[1] } if wantToken != gotToken { http.Error(w, "Unauthorized", http.StatusUnauthorized) return } fmt.Fprintln(w, "ok") } server := httptest.NewServer(http.HandlerFunc(handler)) c := api.ExecConfig{ Command: "./testdata/test-plugin.sh", APIVersion: "client.authentication.k8s.io/v1alpha1", } a, err := newAuthenticator(newCache(), &c) if err != nil { t.Fatal(err) } a.environ = environ a.now = now a.stderr = ioutil.Discard client := http.Client{ Transport: a.WrapTransport(http.DefaultTransport), } get := func(t *testing.T, statusCode int) { t.Helper() resp, err := client.Get(server.URL) if err != nil { t.Fatal(err) } defer resp.Body.Close() if resp.StatusCode != statusCode { t.Errorf("wanted status %d got %d", statusCode, resp.StatusCode) } } setOutput(`{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "token1" } }`) wantToken = "token1" get(t, http.StatusOK) setOutput(`{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "token2" } }`) // Previous token should be cached get(t, http.StatusOK) wantToken = "token2" // Token is still cached, hits unauthorized but causes token to rotate. get(t, http.StatusUnauthorized) // Follow up request uses the rotated token. get(t, http.StatusOK) setOutput(`{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "token3", "expirationTimestamp": "` + now().Add(time.Hour).Format(time.RFC3339Nano) + `" } }`) wantToken = "token3" // Token is still cached, hit's unauthorized but causes rotation to token with an expiry. get(t, http.StatusUnauthorized) get(t, http.StatusOK) // Move time forward 2 hours, "token3" is now expired. n = n.Add(time.Hour * 2) setOutput(`{ "kind": "ExecCredential", "apiVersion": "client.authentication.k8s.io/v1alpha1", "status": { "token": "token4", "expirationTimestamp": "` + now().Add(time.Hour).Format(time.RFC3339Nano) + `" } }`) wantToken = "token4" // Old token is expired, should refresh automatically without hitting a 401. get(t, http.StatusOK) }