{{ message }}
Repository navigation
Expand file tree
/
Copy pathgithubapp_test.go
More file actions
290 lines (247 loc) · 9.36 KB
/
Copy pathgithubapp_test.go
File metadata and controls
290 lines (247 loc) · 9.36 KB
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
package githubapp
import (
"bytes"
"crypto"
"crypto/ed25519"
"crypto/rand"
"crypto/rsa"
"crypto/sha256"
"crypto/x509"
"encoding/base64"
"encoding/json"
"encoding/pem"
"fmt"
"log/slog"
"net/http"
"net/http/httptest"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func newTestKey(t *testing.T) *rsa.PrivateKey {
t.Helper()
key, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
return key
}
func pkcs1PEM(t *testing.T, key *rsa.PrivateKey) []byte {
t.Helper()
return pkcs1PEMBytes(key)
}
func pkcs8PEM(t *testing.T, key *rsa.PrivateKey) []byte {
t.Helper()
der, err := x509.MarshalPKCS8PrivateKey(key)
require.NoError(t, err)
return pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: der})
}
func TestParsePrivateKey(t *testing.T) {
key := newTestKey(t)
t.Run("PKCS1", func(t *testing.T) {
got, err := parsePrivateKey(pkcs1PEM(t, key))
require.NoError(t, err)
assert.Equal(t, key.N, got.N)
})
t.Run("PKCS8", func(t *testing.T) {
got, err := parsePrivateKey(pkcs8PEM(t, key))
require.NoError(t, err)
assert.Equal(t, key.N, got.N)
})
t.Run("not PEM", func(t *testing.T) {
_, err := parsePrivateKey([]byte("not a pem"))
require.Error(t, err)
assert.Contains(t, err.Error(), "no PEM block")
})
t.Run("non-RSA key", func(t *testing.T) {
_, priv, err := ed25519.GenerateKey(rand.Reader)
require.NoError(t, err)
der, err := x509.MarshalPKCS8PrivateKey(priv)
require.NoError(t, err)
keyPEM := pem.EncodeToMemory(&pem.Block{Type: "PRIVATE KEY", Bytes: der})
_, err = parsePrivateKey(keyPEM)
require.Error(t, err)
assert.Contains(t, err.Error(), "want an RSA key")
})
}
func TestConfigValidate(t *testing.T) {
key := newTestKey(t)
base := Config{AppID: "123", InstallationID: "456", PrivateKeyPEM: pkcs1PEM(t, key), BaseRESTURL: "https://api.github.com/"}
require.NoError(t, base.validate())
tests := []struct {
name string
mutate func(c *Config)
want string
}{
{"missing app id", func(c *Config) { c.AppID = "" }, "App ID or client ID is required"},
{"missing installation id", func(c *Config) { c.InstallationID = "" }, "installation ID is required"},
{"missing private key", func(c *Config) { c.PrivateKeyPEM = nil }, "private key is required"},
{"missing base url", func(c *Config) { c.BaseRESTURL = "" }, "REST base URL is required"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
c := base
tt.mutate(&c)
err := c.validate()
require.Error(t, err)
assert.Contains(t, err.Error(), tt.want)
})
}
}
// verifyJWT parses and verifies an app JWT against the public key and returns
// its claims, asserting the structural requirements GitHub enforces.
func verifyJWT(t *testing.T, token string, pub *rsa.PublicKey) map[string]any {
t.Helper()
parts := strings.Split(token, ".")
require.Len(t, parts, 3, "JWT must have three segments")
headerJSON, err := base64.RawURLEncoding.DecodeString(parts[0])
require.NoError(t, err)
var header map[string]string
require.NoError(t, json.Unmarshal(headerJSON, &header))
assert.Equal(t, "RS256", header["alg"])
assert.Equal(t, "JWT", header["typ"])
signingInput := parts[0] + "." + parts[1]
digest := sha256.Sum256([]byte(signingInput))
signature, err := base64.RawURLEncoding.DecodeString(parts[2])
require.NoError(t, err)
require.NoError(t, rsa.VerifyPKCS1v15(pub, crypto.SHA256, digest[:], signature), "signature must verify")
claimsJSON, err := base64.RawURLEncoding.DecodeString(parts[1])
require.NoError(t, err)
var claims map[string]any
require.NoError(t, json.Unmarshal(claimsJSON, &claims))
return claims
}
func TestMintJWT(t *testing.T) {
key := newTestKey(t)
now := time.Now()
token, err := mintJWT("my-app-id", key, now)
require.NoError(t, err)
claims := verifyJWT(t, token, &key.PublicKey)
assert.Equal(t, "my-app-id", claims["iss"])
iat := int64(claims["iat"].(float64))
exp := int64(claims["exp"].(float64))
assert.Equal(t, now.Add(-clockSkew).Unix(), iat, "iat should be backdated by the clock skew")
assert.Equal(t, now.Add(jwtLifetime).Unix(), exp)
assert.LessOrEqual(t, exp-iat, int64((10 * time.Minute).Seconds()), "JWT must live no longer than GitHub's 10 minute cap")
}
// installationServer is a fake installation token endpoint that verifies the
// app JWT and returns a token expiring at expiresAt. It counts mint requests.
func installationServer(t *testing.T, pub *rsa.PublicKey, token string, expiresAt time.Time) (*httptest.Server, *atomic.Int32) {
t.Helper()
var calls atomic.Int32
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
calls.Add(1)
assert.Equal(t, http.MethodPost, r.Method)
assert.Equal(t, "/app/installations/456/access_tokens", r.URL.Path)
authz := r.Header.Get("Authorization")
require.True(t, strings.HasPrefix(authz, "Bearer "), "must send the app JWT as a bearer token")
verifyJWT(t, strings.TrimPrefix(authz, "Bearer "), pub)
w.WriteHeader(http.StatusCreated)
_ = json.NewEncoder(w).Encode(map[string]any{
"token": token,
"expires_at": expiresAt.UTC().Format(time.RFC3339),
})
}))
t.Cleanup(srv.Close)
return srv, &calls
}
func newTestConfig(key *rsa.PrivateKey, baseURL string) Config {
return Config{AppID: "123", InstallationID: "456", PrivateKeyPEM: pkcs1PEMBytes(key), BaseRESTURL: baseURL + "/"}
}
func pkcs1PEMBytes(key *rsa.PrivateKey) []byte {
return pem.EncodeToMemory(&pem.Block{Type: "RSA PRIVATE KEY", Bytes: x509.MarshalPKCS1PrivateKey(key)})
}
func newTestTokenSource(t *testing.T, cfg Config, client *http.Client) *installationTokenSource {
t.Helper()
privateKey, err := parsePrivateKey(cfg.PrivateKeyPEM)
require.NoError(t, err)
return newInstallationTokenSource(cfg, privateKey, client)
}
func TestProviderFetchesToken(t *testing.T) {
key := newTestKey(t)
srv, calls := installationServer(t, &key.PublicKey, "ghs_fresh", time.Now().Add(time.Hour))
provider, err := NewProvider(newTestConfig(key, srv.URL), slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil)))
require.NoError(t, err)
assert.Equal(t, "ghs_fresh", provider.AccessToken())
assert.Equal(t, int32(1), calls.Load())
}
func TestProviderCachesToken(t *testing.T) {
key := newTestKey(t)
srv, calls := installationServer(t, &key.PublicKey, "ghs_cached", time.Now().Add(time.Hour))
provider, err := NewProvider(newTestConfig(key, srv.URL), slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil)))
require.NoError(t, err)
for range 3 {
assert.Equal(t, "ghs_cached", provider.AccessToken())
}
assert.Equal(t, int32(1), calls.Load(), "a token valid for an hour should be minted only once")
}
func TestProviderRefreshesNearExpiry(t *testing.T) {
key := newTestKey(t)
// expires within the refresh buffer, so the stored expiry is already in the
// past and every call re-mints.
srv, calls := installationServer(t, &key.PublicKey, "ghs_short", time.Now().Add(refreshBuffer-time.Minute))
provider, err := NewProvider(newTestConfig(key, srv.URL), slog.New(slog.NewTextHandler(&bytes.Buffer{}, nil)))
require.NoError(t, err)
assert.Equal(t, "ghs_short", provider.AccessToken())
assert.Equal(t, "ghs_short", provider.AccessToken())
assert.Equal(t, int32(2), calls.Load(), "a token expiring within the refresh buffer should re-mint each call")
}
func TestProviderErrorLoggedOnce(t *testing.T) {
key := newTestKey(t)
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusUnauthorized)
_, _ = w.Write([]byte(`{"message":"A JSON web token could not be decoded"}`))
}))
t.Cleanup(srv.Close)
var logBuf bytes.Buffer
logger := slog.New(slog.NewTextHandler(&logBuf, nil))
provider, err := NewProvider(newTestConfig(key, srv.URL), logger)
require.NoError(t, err)
assert.Empty(t, provider.AccessToken())
assert.Empty(t, provider.AccessToken())
assert.Equal(t, 1, strings.Count(logBuf.String(), "failed to obtain GitHub App installation token"),
"a repeated fetch failure should only be logged once")
}
func TestProviderErrorIncludesStatus(t *testing.T) {
key := newTestKey(t)
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusNotFound)
_, _ = w.Write([]byte(`{"message":"Not Found"}`))
}))
t.Cleanup(srv.Close)
source := newTestTokenSource(t, newTestConfig(key, srv.URL), srv.Client())
_, err := source.Token()
require.Error(t, err)
assert.Contains(t, err.Error(), "404")
assert.Contains(t, err.Error(), "Not Found")
}
func TestNewProviderValidates(t *testing.T) {
_, err := NewProvider(Config{}, nil)
require.Error(t, err)
assert.Contains(t, err.Error(), "App ID or client ID is required")
}
func TestSourceRejectsIncompleteTokenResponse(t *testing.T) {
key := newTestKey(t)
tests := []struct {
name string
body string
want string
}{
{name: "missing token", body: `{"expires_at":"2099-01-01T00:00:00Z"}`, want: "did not contain a token"},
{name: "missing expiry", body: `{"token":"ghs_token"}`, want: "did not contain an expiry"},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, _ *http.Request) {
w.WriteHeader(http.StatusCreated)
_, _ = fmt.Fprint(w, tt.body)
}))
t.Cleanup(srv.Close)
source := newTestTokenSource(t, newTestConfig(key, srv.URL), srv.Client())
_, err := source.Token()
require.Error(t, err)
assert.Contains(t, err.Error(), tt.want)
})
}
}
You can’t perform that action at this time.