forked from googleapis/google-cloud-go
/
log.go
232 lines (208 loc) · 5.97 KB
/
log.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
// Copyright 2018 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 proxy
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"net/http"
"strconv"
"sync"
"github.com/google/martian"
)
// Replacement for the HAR logging that comes with martian. HAR is not designed for
// replay. In particular, response bodies are interpreted (e.g. decompressed), and we
// just want them to be stored literally. This isn't something we can fix in martian: it
// is required in the HAR spec (http://www.softwareishard.com/blog/har-12-spec/#content).
// LogVersion is the current version of the log format. It can be used to
// support changes to the format over time, so newer code can read older files.
const LogVersion = "0.1"
// A Log is a record of HTTP interactions, suitable for replay. It can be serialized to JSON.
type Log struct {
Initial []byte // initial data for replay
Version string // version of this log format
Entries []*Entry
}
// An Entry single request-response pair.
type Entry struct {
ID string // unique ID
Request *Request
Response *Response
}
// A Request represents an http.Request in the log.
type Request struct {
Method string // http.Request.Method
URL string // http.Request.URL, as a string
Proto string // http.Request.Proto
Header http.Header // http.Request.Header
Body []byte // http.Request.Body, read to completion
Trailer http.Header `json:",omitempty"` // http.Request.Trailer
}
// A Response represents an http.Response in the log.
type Response struct {
StatusCode int // http.Response.StatusCode
Proto string // http.Response.Proto
ProtoMajor int // http.Response.ProtoMajor
ProtoMinor int // http.Response.ProtoMinor
Header http.Header // http.Response.Header
Body []byte // http.Response.Body, read to completion
Trailer http.Header `json:",omitempty"` // http.Response.Trailer
}
// A Logger maintains a request-response log.
type Logger struct {
mu sync.Mutex
entries map[string]*Entry // from ID
log *Log
}
// NewLogger creates a new logger.
func NewLogger() *Logger {
return &Logger{
log: &Log{Version: LogVersion},
entries: map[string]*Entry{},
}
}
// ModifyRequest logs requests.
func (l *Logger) ModifyRequest(req *http.Request) error {
if req.Method == "CONNECT" {
return nil
}
ctx := martian.NewContext(req)
if ctx.SkippingLogging() {
return nil
}
lreq, err := fromHTTPRequest(req)
if err != nil {
return err
}
id := ctx.ID()
entry := &Entry{ID: id, Request: lreq}
l.mu.Lock()
defer l.mu.Unlock()
if _, ok := l.entries[id]; ok {
panic(fmt.Sprintf("proxy: duplicate request ID: %s", id))
}
l.entries[id] = entry
l.log.Entries = append(l.log.Entries, entry)
return nil
}
// ModifyResponse logs responses.
func (l *Logger) ModifyResponse(res *http.Response) error {
ctx := martian.NewContext(res.Request)
if ctx.SkippingLogging() {
return nil
}
id := ctx.ID()
lres, err := fromHTTPResponse(res)
if err != nil {
return err
}
l.mu.Lock()
defer l.mu.Unlock()
if e, ok := l.entries[id]; ok {
e.Response = lres
}
// Ignore the response if we haven't seen the request.
return nil
}
// Extract returns the Log and removes it. The Logger is not usable
// after this call.
func (l *Logger) Extract() *Log {
l.mu.Lock()
defer l.mu.Unlock()
r := l.log
l.log = nil
l.entries = nil
return r
}
func fromHTTPRequest(req *http.Request) (*Request, error) {
data, err := snapshotBody(&req.Body)
if err != nil {
return nil, err
}
return &Request{
Method: req.Method,
URL: req.URL.String(),
Proto: req.Proto,
Header: redactHeaders(req.Header),
Body: data,
Trailer: req.Trailer,
}, nil
}
func fromHTTPResponse(res *http.Response) (*Response, error) {
data, err := snapshotBody(&res.Body)
if err != nil {
return nil, err
}
return &Response{
StatusCode: res.StatusCode,
Proto: res.Proto,
ProtoMajor: res.ProtoMajor,
ProtoMinor: res.ProtoMinor,
Header: res.Header,
Body: data,
Trailer: res.Trailer,
}, nil
}
func toHTTPResponse(lr *Response, req *http.Request) *http.Response {
res := &http.Response{
StatusCode: lr.StatusCode,
Proto: lr.Proto,
ProtoMajor: lr.ProtoMajor,
ProtoMinor: lr.ProtoMinor,
Header: lr.Header,
Body: ioutil.NopCloser(bytes.NewReader(lr.Body)),
ContentLength: int64(len(lr.Body)),
}
res.Request = req
// For HEAD, set ContentLength to the value of the Content-Length header, or -1
// if there isn't one.
if req.Method == "HEAD" {
res.ContentLength = -1
if c := res.Header["Content-Length"]; len(c) == 1 {
if c64, err := strconv.ParseInt(c[0], 10, 64); err == nil {
res.ContentLength = c64
}
}
}
return res
}
func snapshotBody(body *io.ReadCloser) ([]byte, error) {
data, err := ioutil.ReadAll(*body)
if err != nil {
return nil, err
}
(*body).Close()
*body = ioutil.NopCloser(bytes.NewReader(data))
return data, nil
}
// Headers that may contain sensitive data (auth tokens, keys).
var sensitiveHeaders = map[string]bool{
"Authorization": true,
"Proxy-Authorization": true,
"X-Goog-Encryption-Key": true, // used by Cloud Storage for customer-supplied encryption
"X-Goog-Copy-Source-Encryption-Key": true, // ditto
}
// Copy headers, redacting sensitive ones.
func redactHeaders(hs http.Header) http.Header {
rh := http.Header{}
for k, v := range hs {
if sensitiveHeaders[k] {
rh.Set(k, "REDACTED")
} else {
rh[k] = v
}
}
return rh
}