/
response.go
253 lines (209 loc) · 9.11 KB
/
response.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
// Copyright (c) 2018 Timo Savola. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
package web
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"strconv"
"strings"
"time"
server "gate.computer/gate/server/api"
"gate.computer/gate/server/event"
"gate.computer/gate/server/web/api"
)
const (
accessControlMaxAge = "86400"
cacheControlStatic = "public, max-age=3600"
contentTypeText = "text/plain; charset=utf-8"
contentTypeJSON = "application/json; charset=utf-8"
)
var (
errContentNotEmpty = errors.New("request content not empty")
errDuplicateQueryParam = errors.New("duplicate query parameter")
errEncodingNotSupported = errors.New("unsupported content encoding")
errLengthRequired = errors.New("length required")
errMethodNotAllowed = errors.New("method not allowed")
errNotAcceptable = errors.New("not acceptable")
errUnsupportedMediaType = errors.New("unsupported content type")
)
func join(fields ...string) string {
return strings.Join(fields, ", ")
}
func mustMarshalJSON(x any) []byte {
content, err := json.MarshalIndent(x, "", "\t")
if err != nil {
panic(err)
}
return append(content, '\n')
}
// setAccessControl returns true if request contained Origin header.
func setAccessControl(w http.ResponseWriter, r *http.Request, s *webserver, methods string) bool {
_, originSet := r.Header[api.HeaderOrigin]
if originSet {
origin := "*"
if !s.anyOrigin {
origin = r.Header.Get(api.HeaderOrigin)
}
w.Header().Set("Access-Control-Allow-Methods", methods)
w.Header().Set("Access-Control-Allow-Origin", origin)
w.Header().Set("Access-Control-Max-Age", accessControlMaxAge)
}
return originSet
}
// setAccessControlAllowHeaders returns true if request contained Origin header.
func setAccessControlAllowHeaders(w http.ResponseWriter, r *http.Request, s *webserver, methods, headers string) bool {
originSet := setAccessControl(w, r, s, methods)
if originSet {
w.Header().Set("Access-Control-Allow-Headers", headers)
}
return originSet
}
func setAccessControlAllowExposeHeaders(w http.ResponseWriter, r *http.Request, s *webserver, methods, allowHeaders, exposeHeaders string) {
if setAccessControlAllowHeaders(w, r, s, methods, allowHeaders) {
w.Header().Set("Access-Control-Expose-Headers", exposeHeaders)
}
}
func setOptions(w http.ResponseWriter, allow string) {
w.Header().Set("Allow", allow)
}
func respond(w http.ResponseWriter, r *http.Request, status int, text string) {
if acceptsText(r) {
w.Header().Set(api.HeaderContentType, contentTypeText)
w.WriteHeader(status)
fmt.Fprintln(w, text)
} else {
w.WriteHeader(status)
}
}
type requestResponseWriter struct {
response http.ResponseWriter
request *http.Request
}
func (wr *requestResponseWriter) SetHeader(key, value string) {
wr.response.Header().Set(key, value)
}
func (wr *requestResponseWriter) WriteError(status int, text string) {
respond(wr.response, wr.request, status, text)
}
func respondMethodNotAllowed(w http.ResponseWriter, r *http.Request, s *webserver, allow string) {
w.Header().Set("Allow", allow)
w.Header().Set("Cache-Control", cacheControlStatic)
respond(w, r, http.StatusMethodNotAllowed, errMethodNotAllowed.Error())
reportProtocolError(r.Context(), s, errMethodNotAllowed)
}
func respondNotAcceptable(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusNotAcceptable, errNotAcceptable.Error())
reportProtocolError(r.Context(), s, errNotAcceptable)
}
func respondUnsupportedMediaType(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusUnsupportedMediaType, errUnsupportedMediaType.Error())
reportProtocolError(r.Context(), s, errUnsupportedMediaType)
}
func respondLengthRequired(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusLengthRequired, errLengthRequired.Error())
reportProtocolError(r.Context(), s, errLengthRequired)
}
func respondContentNotEmpty(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusRequestEntityTooLarge, "request content must be empty")
reportProtocolError(r.Context(), s, errContentNotEmpty)
}
func respondPathNotFound(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusNotFound, "not found")
reportProtocolError(r.Context(), s, fmt.Errorf("path not found: %s", r.URL.Path))
}
func respondDuplicateHeader(w http.ResponseWriter, r *http.Request, s *webserver, key string) {
err := fmt.Errorf("duplicate header: %s", key)
respond(w, r, http.StatusBadRequest, err.Error())
reportProtocolError(r.Context(), s, err)
}
func respondQueryError(w http.ResponseWriter, r *http.Request, s *webserver, err error) {
respond(w, r, http.StatusBadRequest, "query string decode error")
reportProtocolError(r.Context(), s, err)
}
func respondMissingQueryParam(w http.ResponseWriter, r *http.Request, s *webserver, key string) {
err := fmt.Errorf("missing query parameter: %s", key)
respond(w, r, http.StatusBadRequest, err.Error())
reportProtocolError(r.Context(), s, err)
}
func respondInvalidFunction(w http.ResponseWriter, r *http.Request, s *webserver, value string) {
err := fmt.Errorf("invalid function name: %q", value)
respond(w, r, http.StatusBadRequest, err.Error())
reportProtocolError(r.Context(), s, err)
}
func respondUnsupportedLog(w http.ResponseWriter, r *http.Request, s *webserver, value string) {
err := fmt.Errorf("unsupported log argument: %q", value)
respond(w, r, http.StatusNotImplemented, err.Error())
reportProtocolError(r.Context(), s, err)
}
func respondDuplicateQueryParam(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusBadRequest, errDuplicateQueryParam.Error())
reportProtocolError(r.Context(), s, errDuplicateQueryParam)
}
func respondExcessQueryParams(w http.ResponseWriter, r *http.Request, s *webserver) {
respond(w, r, http.StatusBadRequest, "unexpected query parameters")
reportProtocolError(r.Context(), s, fmt.Errorf("unexpected query params: %s", r.URL.RawQuery))
}
func respondUnsupportedAction(w http.ResponseWriter, r *http.Request, s *webserver) {
w.Header().Set("Cache-Control", cacheControlStatic)
respond(w, r, http.StatusNotImplemented, "unsupported action")
reportProtocolError(r.Context(), s, fmt.Errorf("bad action query: %s", r.URL.RawQuery))
}
func respondUnsupportedFeature(w http.ResponseWriter, r *http.Request, s *webserver) {
w.Header().Set("Cache-Control", cacheControlStatic)
respond(w, r, http.StatusNotImplemented, "unsupported feature")
reportProtocolError(r.Context(), s, fmt.Errorf("bad action query: %s", r.URL.RawQuery))
}
func respondUnauthorized(ctx context.Context, ew errorWriter, s *webserver) {
ew.SetHeader("Www-Authenticate", fmt.Sprintf("%s realm=%q", api.AuthorizationTypeBearer, s.identity))
ew.WriteError(http.StatusUnauthorized, "missing authentication credentials")
reportRequestFailure(ctx, s, event.FailAuthMissing)
}
func respondUnauthorizedError(ctx context.Context, ew errorWriter, s *webserver, errorCode string) {
ew.SetHeader("Www-Authenticate", fmt.Sprintf("%s realm=%q error=%q", api.AuthorizationTypeBearer, s.identity, errorCode))
ew.WriteError(http.StatusUnauthorized, errorCode)
reportRequestFailure(ctx, s, event.FailAuthInvalid)
}
func respondUnauthorizedErrorDesc(ctx context.Context, ew errorWriter, s *webserver, errorCode, errorDesc string, failType event.FailType, err error) {
ew.SetHeader("Www-Authenticate", fmt.Sprintf("%s realm=%q error=%q error_description=%q", api.AuthorizationTypeBearer, s.identity, errorCode, errorDesc))
ew.WriteError(http.StatusUnauthorized, errorDesc)
reportRequestError(ctx, s, failType, "", "", "", "", err)
}
func respondContentParseError(ctx context.Context, ew errorWriter, s *webserver, err error) {
ew.WriteError(http.StatusBadRequest, "content parse error")
reportPayloadError(ctx, s, err)
}
func respondContentDecodeError(ctx context.Context, ew errorWriter, s *webserver, err error) {
ew.WriteError(http.StatusBadRequest, "content decode error")
reportPayloadError(ctx, s, err)
}
func respondUnsupportedEncoding(ctx context.Context, ew errorWriter, s *webserver) {
ew.WriteError(http.StatusBadRequest, errEncodingNotSupported.Error())
reportPayloadError(ctx, s, errEncodingNotSupported)
}
func respondServerError(ctx context.Context, ew errorWriter, s *webserver, sourceURI, progHash, function, instID string, err error) {
status := api.ErrorStatus(err)
switch status {
case http.StatusUnauthorized:
ew.SetHeader("Www-Authenticate", fmt.Sprintf("%s realm=%q", api.AuthorizationTypeBearer, s.identity))
case http.StatusTooManyRequests:
if e := server.AsTooManyRequests(err); e != nil {
if d := e.RetryAfter(); d > 0 {
s := d / time.Second
if s == 0 {
s = 1
}
ew.SetHeader("Retry-After", strconv.Itoa(int(s)))
}
}
case http.StatusInternalServerError:
ew.WriteError(status, server.PublicErrorString(err, "internal error"))
reportInternalError(ctx, s, sourceURI, progHash, function, instID, err)
return
}
ew.WriteError(status, server.PublicErrorString(err, "unknown error"))
reportRequestError(ctx, s, event.ErrorFailType(err), sourceURI, progHash, function, instID, err)
}