-
Notifications
You must be signed in to change notification settings - Fork 3
/
transport.go
439 lines (397 loc) · 13.9 KB
/
transport.go
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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
package apicommunication
// Copyright 2020 ShiftLeft Inc.
//
// 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.
import (
"context"
"crypto/tls"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net"
"net/http"
"net/url"
"path"
"strconv"
"strings"
"time"
gojira "github.com/andygrunwald/go-jira"
"github.com/golang-jwt/jwt"
"golang.org/x/oauth2"
"golang.org/x/oauth2/jira"
"github.com/ShiftLeftSecurity/atlassian-connect-go/storage"
"github.com/pkg/errors"
)
// ScopesFromStrings returns a string representing scopes in a way JIRA likes
func ScopesFromStrings(scopes []string) string {
return strings.Join(scopes, scopeSeparator)
}
// HostClient takes its name from the atlassian connect express code base
// where it was stolen because naming things is hard
type HostClient struct {
ctx context.Context
scopes []string
Config *storage.JiraInstallInformation
UserAccountID string
baseURL string
client *http.Client
localCache map[string]*HostClient // more than enough for 60 sec tokens
}
// theoretically this combines DialContext and TLSHandshakeTimeout for TLS conns, we can look
// a bit more into it and define a DialTLS if necessary.
var defaultJiraTransport http.RoundTripper = &http.Transport{
Proxy: http.ProxyFromEnvironment,
DialContext: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
DualStack: true,
}).DialContext,
ForceAttemptHTTP2: true,
MaxIdleConns: 100,
IdleConnTimeout: 90 * time.Second,
TLSHandshakeTimeout: 10 * time.Second,
TLSClientConfig: &tls.Config{},
ExpectContinueTimeout: 1 * time.Second,
}
// NewHostClient returns a new host client for JIRA interaction based on the passed config and user account ID
func NewHostClient(ctx context.Context, config *storage.JiraInstallInformation, userAccountID string, scopes []string) (*HostClient, error) {
return NewHostClientWithRoundtripper(ctx, config, userAccountID, scopes, defaultJiraTransport)
}
// NewHostClientWithRoundtripper is the same as NewHostClient but allows the caller to specify a custom transport
func NewHostClientWithRoundtripper(ctx context.Context, config *storage.JiraInstallInformation,
userAccountID string, scopes []string, roundtripper http.RoundTripper) (*HostClient, error) {
hostClient := &HostClient{
ctx: ctx,
scopes: scopes,
Config: config,
UserAccountID: userAccountID,
baseURL: config.BaseURL,
}
if userAccountID != "" {
cfg, err := getOauth2Config(ctx,
config.BaseURL, config.OauthClientID, config.SharedSecret, userAccountID, "", scopes, "", "")
if err != nil {
return nil, fmt.Errorf("creating jwt config: %w", err)
}
hostClient.client = cfg.Client(ctx)
return hostClient, nil
}
transport := gojira.JWTAuthTransport{
Secret: []byte(config.SharedSecret),
Issuer: config.Key,
Transport: roundtripper,
}
hostClient.client = transport.Client()
if config.BaseURL == "" {
return nil, fmt.Errorf("jira install information is incomplete, base URL is empty")
}
hostClient.localCache = map[string]*HostClient{}
return hostClient, nil
}
// Do performs an http action in JIRA using this client's configuration and the passed info.
func (h *HostClient) Do(method, path string, queryArgs map[string]string, body io.Reader) (*http.Response, error) {
if h.client == nil {
return nil, errors.Errorf("we are missing an http client")
}
u, err := url.Parse(h.baseURL)
if err != nil {
return nil, errors.Wrap(err, "parsing jira information base URL")
}
u.Path = path
q := u.Query()
for k, v := range queryArgs {
q.Add(k, v)
}
u.RawQuery = q.Encode()
r, err := http.NewRequest(method, u.String(), body)
if err != nil {
return nil, errors.Wrap(err, "building request to JIRA")
}
r.Header.Add("Accept", "application/json")
r.Header.Add("Content-Type", "application/json")
response, err := h.client.Do(r)
if err != nil {
return nil, errors.Wrapf(err, "querying for %s", u.String())
}
return response, nil
}
// TypeFromResponse deserializes an http.Response body into an arbitrary type
// beware, this will accept anything but fail if it's not a pointer to.
func TypeFromResponse(r *http.Response, target interface{}) error {
err := json.NewDecoder(r.Body).Decode(target)
if err != nil {
return errors.Wrap(err, "unmarshaling body into type")
}
return nil
}
// UnexpectedResponse should be returned when DoWithTarget encounters an HTTP status code that was
// not expected on a response from JIRA.
type UnexpectedResponse struct {
obtained int
expected []int
}
func (err *UnexpectedResponse) Error() string {
e := make([]string, len(err.expected), len(err.expected))
for i, ex := range err.expected {
e[i] = strconv.Itoa(ex)
}
return fmt.Sprintf("obtained code %d expected one of: [%s]", err.obtained, strings.Join(e, ", "))
}
// IsUnexpectedResponse returns true if the passed error is of type UnexpectedResponse
func IsUnexpectedResponse(err error) bool {
_, ok := err.(*UnexpectedResponse)
return ok
}
// DoWithTarget performs a request much like do but can check for expected response codes and deserialize
// the response body into a passed target.
func (h *HostClient) DoWithTarget(method, path string, queryArgs map[string]string,
body io.Reader, target interface{}, expectedCodes []int) (int, error) {
resp, err := h.Do(method, path, queryArgs, body)
if err != nil {
return -1, fmt.Errorf("performing HTTP request: %w", err)
}
if len(expectedCodes) > 0 {
for _, c := range expectedCodes {
if resp.StatusCode == c {
if err := TypeFromResponse(resp, target); err != nil {
return resp.StatusCode, fmt.Errorf("deserializing result: %w", err)
}
}
}
return resp.StatusCode, &UnexpectedResponse{
obtained: resp.StatusCode,
expected: expectedCodes,
}
}
if err := TypeFromResponse(resp, target); err != nil {
return resp.StatusCode, fmt.Errorf("deserializing result: %w", err)
}
return resp.StatusCode, nil
}
const (
// ProductTypeJira represents a jira server
ProductTypeJira = "jira"
// ProductTypeConfluence represents a confluence server
ProductTypeConfluence = "confluence"
)
// AsUserByAccountID returns a HostClient whose calls impersoante another user, who is
// defined by the passed account ID
func (h *HostClient) AsUserByAccountID(userAccountID string) (*HostClient, error) {
if userAccountID == "" {
return nil, fmt.Errorf("user account ID must not be blank")
}
if chc, cached := h.localCache[userAccountID]; cached {
// TODO: does this know how to renegotiate itself?
return chc, nil
}
if strings.ToLower(h.Config.ProductType) != ProductTypeJira {
if strings.ToLower(h.Config.ProductType) == ProductTypeConfluence {
return nil, fmt.Errorf("the asUserByAccountID method is available for %s add-ons but this plug-in does not support it", h.Config.ProductType)
}
return nil, fmt.Errorf("the asUserByAccountID method is not available for %s add-ons", h.Config.ProductType)
}
hc, err := NewHostClient(h.ctx, h.Config, userAccountID, h.scopes)
if err != nil {
return nil, fmt.Errorf("creating impersonating host client: %w", err)
}
h.localCache[userAccountID] = hc
return hc, nil
}
// HostClientClaims hold the necessary claims for a JIRA token
type HostClientClaims struct {
Issuer string `json:"iss,omitempty"`
Audience string `json:"sub,omitempty"`
ExpiresIn int64 `json:"exp,omitempty"`
IssuedAt int64 `json:"iat,omitempty"`
QueryStringHash string `json:"qsh,omitempty"` // https://developer.atlassian.com/cloud/bitbucket/query-string-hash/
}
// Valid implements jwt.Claims
func (h *HostClientClaims) Valid() error {
return nil
}
const (
authorizationServerURL = "https://oauth-2-authorization-server.services.atlassian.com"
jwtClaimPrefix = "urn:atlassian:connect"
grantType = "urn:ietf:params:oauth:grant-type:jwt-bearer"
scopeSeparator = " "
defaultAuthorizationPath = "/oauth2/token"
defaultJWTValidityInMinutes = 3
)
func getOauth2Config(ctx context.Context,
hostBaseURL, oauthClientID, sharedSecret, userAccountID, userKey string,
scopes []string,
authorizationServerBaseURL, authorizationPath string) (*jira.Config, error) {
var userIdentifier string
if userAccountID != "" {
userIdentifier = userAccountID
} else {
userIdentifier = userKey
}
if authorizationServerBaseURL == "" {
authorizationServerBaseURL = authorizationServerURL
}
if authorizationPath == "" {
authorizationPath = defaultAuthorizationPath
}
au, err := url.Parse(authorizationServerBaseURL)
if err != nil {
return nil, fmt.Errorf("parsing authorization server base url: %w", err)
}
au.Path = path.Join(au.Path, authorizationPath)
tokenURL := au.String()
cfg := jira.Config{
BaseURL: hostBaseURL,
Subject: userIdentifier,
Config: oauth2.Config{
ClientID: oauthClientID,
ClientSecret: sharedSecret,
Endpoint: oauth2.Endpoint{
AuthURL: authorizationServerURL,
TokenURL: tokenURL,
},
// Scopes are joined as a string because this is how jira acepts them
// passing them as a list of scopes causes them to be concatenated with + symbols
// and jira rejects the claim due to invalid scopes.
Scopes: []string{ScopesFromStrings(scopes)},
},
}
return &cfg, nil
}
// GetAccessToken performs the oauth negotiation and returns the token.
func GetAccessToken(ctx context.Context,
hostBaseURL, oauthClientID, sharedSecret, userAccountID, userKey string,
scopes []string,
authorizationServerBaseURL, authorizationPath string) (*oauth2.Token, error) {
cfg, err := getOauth2Config(ctx,
hostBaseURL, oauthClientID, sharedSecret, userAccountID, userKey,
scopes,
authorizationServerBaseURL, authorizationPath)
if err != nil {
return nil, fmt.Errorf("getting oauth2 config: %w", err)
}
tokenSource := cfg.TokenSource(ctx)
token, err := tokenSource.Token()
if err != nil {
return nil, fmt.Errorf("fetching token from atlassian: %w", err)
}
return token, nil
}
type jwtClaims jira.ClaimSet
func (j *jwtClaims) Valid() error {
if j.ExpiresIn == 0 {
return nil
}
t := time.Unix(j.ExpiresIn, 0)
if time.Now().UTC().After(t) {
return jwt.NewValidationError(fmt.Sprintf("expired in %d", j.ExpiresIn), jwt.ValidationErrorExpired)
}
return nil
}
// toClaims wraps jira claim set in a valid claims... why on earth would the ClaimSet not be
// compatible with jwt.Claims??
func toClaims(jcs *jira.ClaimSet) jwt.Claims {
var validClaims *jwtClaims
validClaims = (*jwtClaims)(jcs)
return validClaims
}
// ValidateRequest returns jira install information for the request author if valid or error if not.
// This validation will not work in lifecycle installed event
func ValidateRequest(r *http.Request, st storage.Store) (*storage.JiraInstallInformation, error) {
q := r.URL.Query()
queryJWT := q.Get("jwt")
if queryJWT == "" {
authHeader := r.Header.Get("Authorization")
queryJWT = strings.TrimPrefix(authHeader, "JWT ")
if queryJWT == "" {
return nil, fmt.Errorf("jwt was expected in the query string or header")
}
}
p := &jwt.Parser{}
// massage a bit oauth2 claimset to be jwt.Claims friendly
jcs := &jira.ClaimSet{}
claims := toClaims(jcs)
// Decode jwt to obtain info from claims
_, _, err := p.ParseUnverified(queryJWT, claims)
if err != nil {
return nil, fmt.Errorf("malformed token: %w", err)
}
jii, err := st.JiraInstallInformation(jcs.Issuer)
if err != nil {
return nil, fmt.Errorf("reading jira install information from storage: %w", err)
}
if jii == nil {
return nil, fmt.Errorf("no jira install information for client key: %s", jcs.Issuer)
}
// now validate the thing
_, err = p.ParseWithClaims(queryJWT, claims, func(token *jwt.Token) (interface{}, error) {
return []byte(jii.SharedSecret), nil
})
if err != nil {
if _, ok := err.(*jwt.ValidationError); ok {
return nil, fmt.Errorf("malformed token: %w", err)
}
return nil, fmt.Errorf("parsing token: %w", err)
}
return jii, nil
}
const kidValidationURL = "https://connect-install-keys.atlassian.com/"
// ValidateInstallRequest attempts to validate new install method for jira
func ValidateInstallRequest(r *http.Request, st storage.Store) error {
q := r.URL.Query()
queryJWT := q.Get("jwt")
if queryJWT == "" {
authHeader := r.Header.Get("Authorization")
queryJWT = strings.TrimPrefix(authHeader, "JWT ")
if queryJWT == "" {
return fmt.Errorf("jwt was expected in the query string or header")
}
}
p := &jwt.Parser{}
// massage a bit oauth2 claimset to be jwt.Claims friendly
jcs := &jira.ClaimSet{}
claims := toClaims(jcs)
// Decode jwt to obtain info from claims
t, _, err := p.ParseUnverified(queryJWT, claims)
if err != nil {
return fmt.Errorf("malformed token: %w", err)
}
// now validate the thing
_, err = p.ParseWithClaims(queryJWT, claims, func(token *jwt.Token) (interface{}, error) {
kidRaw := t.Header["kid"]
kid, ok := kidRaw.(string)
if !ok {
return nil, fmt.Errorf("kid is not a string but %T", kidRaw)
}
if kid != "" {
kidURL := kidValidationURL + kid
kidResp, err := http.Get(kidURL)
if err != nil {
return nil, fmt.Errorf("obtaining public key from atlassian: %w", err)
}
kidPKey, err := ioutil.ReadAll(kidResp.Body)
if err != nil {
return nil, fmt.Errorf("reading public key from atlassian: %w", err)
}
return kidPKey, nil
}
return []byte{}, nil
})
if err != nil {
if _, ok := err.(*jwt.ValidationError); ok {
return fmt.Errorf("malformed token: %w", err)
}
return fmt.Errorf("parsing token: %w", err)
}
return nil
}