File: certs_test.go

package info (click to toggle)
cloudsql-proxy 1.33.14-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 900 kB
  • sloc: sh: 57; makefile: 25
file content (174 lines) | stat: -rw-r--r-- 5,776 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
// Copyright 2021 Google LLC
//
// 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 certs

import (
	"context"
	"encoding/json"
	"fmt"
	"io/ioutil"
	"net/http"
	"net/http/httptest"
	"testing"
	"time"

	"google.golang.org/api/option"
	sqladmin "google.golang.org/api/sqladmin/v1beta4"
)

const fakeCert = `-----BEGIN CERTIFICATE-----
MIICgTCCAWmgAwIBAgIBADANBgkqhkiG9w0BAQsFADAAMCIYDzAwMDEwMTAxMDAw
MDAwWhgPMDAwMTAxMDEwMDAwMDBaMAAwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw
ggEKAoIBAQCvN0H6/ecloIfNyRu8KKtVSIK0JaW1lB1C1/ZI9iZmihqiUrxeyKTb
9hWuMPJ3u9NfSn1Vlwuj0bw7/T8e3Ol5BImcGxYxWMefkqFtqnjCafo2wnIea/eQ
JFLt4wXYkeveHReUseGtaBzpCo4wYOiqgxyIrGiQ/rq4Xjr2hXuqTg4TTgxv+0Iv
nrJwn61pitGvLPjsl9quzSQ6CdM3tWfb6cwozF5uJatbxRCZDsp1qUBXX9/zYqmx
8regdRG95btNgXLCfNS0iX0jopl00vGwYRGGKjfPZ5AkpuxX9M4Ys3X7pOspaQMC
Zf4VjXdwOljqZxIOGhOBbrXQacSywTLjAgMBAAGjAjAAMA0GCSqGSIb3DQEBCwUA
A4IBAQAXj/0iiU2AQGztlFstLVwQ9yz+7/pfqAr26DYu9hpI/QvrZsJWjwNUNlX+
7gwhrwiJs7xsLZqnEr2qvj6at/MtxIEVgQd43sOsWW9de8R5WNQNzsCb+5npWcx7
vtcKXD9jFFLDDCIYjAf9+6m/QrMJtIf++zBmjguShccjZzY+GQih78oWqNTYqRQs
//wOP15vFQ/gB4DcJ0UyO9icVgbJha66yzG7XABDEepha5uhpLhwFaONU8jMxW7A
fOx52xqIUu3m4M3Ci0ZIp22TeGVuJ/Dy1CPbDOshcb0dXTE+mU5T91SHKRF4jz77
+9TQIXHGk7lJyVVhbed8xm/p727f
-----END CERTIFICATE-----`

func TestLocalCertSupportsStaleReads(t *testing.T) {
	var (
		gotReadTimes []string
		ok           bool
	)
	handleEphemeralCert := func(w http.ResponseWriter, r *http.Request) {
		var actual sqladmin.GenerateEphemeralCertRequest
		data, err := ioutil.ReadAll(r.Body)
		if err != nil {
			t.Fatalf("failed to read request body: %v", err)
		}
		defer r.Body.Close()
		if err = json.Unmarshal(data, &actual); err != nil {
			t.Fatalf("failed to unmarshal request body: %v", err)
		}
		gotReadTimes = append(gotReadTimes, actual.ReadTime)
		if !ok {
			w.WriteHeader(http.StatusServiceUnavailable)
			fmt.Fprintln(w, `{"message":"the first request fails"}`)
			ok = true
			return
		}
		// the second request succeeds
		fmt.Fprintln(w, fmt.Sprintf(`{"ephemeralCert":{"cert": %q}}`, fakeCert))
	}
	ts := httptest.NewServer(http.HandlerFunc(handleEphemeralCert))
	defer ts.Close()

	cs := NewCertSourceOpts(ts.Client(), RemoteOpts{})
	// replace SQL Admin API client with client backed by test server
	var err error
	cs.serv, err = sqladmin.NewService(context.Background(),
		option.WithEndpoint(ts.URL), option.WithHTTPClient(ts.Client()))
	if err != nil {
		t.Fatalf("failed to replace SQL Admin client: %v", err)
	}

	// Send request to generate a cert
	_, err = cs.Local("my-proj:reg:my-inst")
	if err != nil {
		t.Fatal(err)
	}

	// Verify read time is not present for first request
	// and is 30 seconds before "now" for second request
	if len(gotReadTimes) != 2 {
		t.Fatalf("expected two results, got = %v", len(gotReadTimes))
	}
	if gotReadTimes[0] != "" {
		t.Fatalf("expected empty ReadTime for first request, got = %v", gotReadTimes[0])
	}
	wantStaleness := 30 * time.Second
	if !staleTimestamp(gotReadTimes[1], wantStaleness) {
		t.Fatalf("expected timestamp at least %v old, got = %v (now = %v)",
			wantStaleness, gotReadTimes[1], time.Now().UTC().Format(time.RFC3339))
	}
}

func staleTimestamp(ts string, staleness time.Duration) bool {
	t, err := time.Parse(time.RFC3339, ts)
	if err != nil {
		// ts was not in expected format, fail
		return false
	}
	return t.Before(time.Now().Add(-staleness))
}

func TestRemoteCertSupportsStaleReads(t *testing.T) {
	var (
		gotReadTimes []string
		ok           bool
	)
	handleConnectSettings := func(w http.ResponseWriter, r *http.Request) {
		rt := r.URL.Query()["readTime"]
		// if the URL parameter isn't nil, record its value; otherwise add an
		// empty string to indicate no query param was set
		if rt != nil {
			gotReadTimes = append(gotReadTimes, rt[0])
		} else {
			gotReadTimes = append(gotReadTimes, "")
		}
		if !ok {
			w.WriteHeader(http.StatusServiceUnavailable)
			fmt.Fprintln(w, `{"message":"the first request fails"}`)
			ok = true
			return
		}
		fmt.Fprintln(w, fmt.Sprintf(`{
			"region":"us-central1",
			"ipAddresses": [
				{"type":"PRIMARY", "ipAddress":"127.0.0.1"}
			],
			"serverCaCert": {"cert": %q}
		}`, fakeCert))
	}
	ts := httptest.NewServer(http.HandlerFunc(handleConnectSettings))
	defer ts.Close()

	cs := NewCertSourceOpts(ts.Client(), RemoteOpts{})
	var err error
	// replace SQL Admin API client with client backed by test server
	cs.serv, err = sqladmin.NewService(context.Background(),
		option.WithEndpoint(ts.URL), option.WithHTTPClient(ts.Client()))
	if err != nil {
		t.Fatalf("failed to replace SQL Admin client: %v", err)
	}

	// Send request to retrieve instance metadata
	_, _, _, _, err = cs.Remote("my-proj:us-central1:my-inst")
	if err != nil {
		t.Fatal(err)
	}

	// Verify read time is not present for first request
	// and is 30 seconds before "now" for second request
	if len(gotReadTimes) != 2 {
		t.Fatalf("expected two results, got = %v", len(gotReadTimes))
	}
	if gotReadTimes[0] != "" {
		t.Fatalf("expected empty ReadTime for first request, got = %v", gotReadTimes[0])
	}
	wantStaleness := 30 * time.Second
	if !staleTimestamp(gotReadTimes[1], wantStaleness) {
		t.Fatalf("expected timestamp at least %v old, got = %v (now = %v)",
			wantStaleness, gotReadTimes[1], time.Now().UTC().Format(time.RFC3339))
	}
}