-
Notifications
You must be signed in to change notification settings - Fork 7.6k
/
debuggen.go
171 lines (148 loc) · 4.93 KB
/
debuggen.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
// Copyright Istio Authors
//
// 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 xds
import (
"bytes"
"encoding/json"
"net/http"
"net/url"
"strconv"
discovery "github.com/envoyproxy/go-control-plane/envoy/service/discovery/v3"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/status"
anypb "google.golang.org/protobuf/types/known/anypb"
"istio.io/istio/pilot/pkg/model"
v3 "istio.io/istio/pilot/pkg/xds/v3"
)
var activeNamespaceDebuggers = map[string]struct{}{
"config_dump": {},
"ndsz": {},
"edsz": {},
}
// DebugGen is a Generator for istio debug info
type DebugGen struct {
Server *DiscoveryServer
SystemNamespace string
DebugMux *http.ServeMux
}
type ResponseCapture struct {
body *bytes.Buffer
header map[string]string
wroteHeader bool
}
func (r ResponseCapture) Header() http.Header {
header := make(http.Header)
for k, v := range r.header {
header.Set(k, v)
}
return header
}
func (r ResponseCapture) Write(i []byte) (int, error) {
return r.body.Write(i)
}
func (r ResponseCapture) WriteHeader(statusCode int) {
r.header["statusCode"] = strconv.Itoa(statusCode)
}
func NewResponseCapture() *ResponseCapture {
return &ResponseCapture{
header: make(map[string]string),
body: new(bytes.Buffer),
wroteHeader: false,
}
}
func NewDebugGen(s *DiscoveryServer, systemNamespace string, debugMux *http.ServeMux) *DebugGen {
return &DebugGen{
Server: s,
SystemNamespace: systemNamespace,
DebugMux: debugMux,
}
}
// Generate XDS debug responses according to the incoming debug request
func (dg *DebugGen) Generate(proxy *model.Proxy, w *model.WatchedResource, req *model.PushRequest) (model.Resources, model.XdsLogDetails, error) {
if err := validateProxyAuthentication(proxy, w); err != nil {
return nil, model.DefaultXdsLogDetails, err
}
resourceName, err := parseAndValidateDebugRequest(proxy, w, dg)
if err != nil {
return nil, model.DefaultXdsLogDetails, err
}
buffer := processDebugRequest(dg, resourceName)
res := model.Resources{&discovery.Resource{
Name: resourceName,
Resource: &anypb.Any{
TypeUrl: v3.DebugType,
Value: buffer.Bytes(),
},
}}
return res, model.DefaultXdsLogDetails, nil
}
// GenerateDeltas XDS debug responses according to the incoming debug request
func (dg *DebugGen) GenerateDeltas(
proxy *model.Proxy,
req *model.PushRequest,
w *model.WatchedResource,
) (model.Resources, model.DeletedResources, model.XdsLogDetails, bool, error) {
if err := validateProxyAuthentication(proxy, w); err != nil {
return nil, nil, model.DefaultXdsLogDetails, true, err
}
resourceName, err := parseAndValidateDebugRequest(proxy, w, dg)
if err != nil {
return nil, nil, model.DefaultXdsLogDetails, true, err
}
buffer := processDebugRequest(dg, resourceName)
res := model.Resources{&discovery.Resource{
Name: resourceName,
Resource: &anypb.Any{
TypeUrl: v3.DebugType,
Value: buffer.Bytes(),
},
}}
return res, nil, model.DefaultXdsLogDetails, true, nil
}
func validateProxyAuthentication(proxy *model.Proxy, w *model.WatchedResource) error {
if proxy.VerifiedIdentity == nil {
log.Warnf("proxy %s is not authorized to receive debug. Ensure you are connecting over TLS port and are authenticated.", proxy.ID)
return status.Error(codes.Unauthenticated, "authentication required")
}
if w.ResourceNames == nil || len(w.ResourceNames) != 1 {
return status.Error(codes.InvalidArgument, "exactly one debug request is required")
}
return nil
}
func parseAndValidateDebugRequest(proxy *model.Proxy, w *model.WatchedResource, dg *DebugGen) (string, error) {
resourceName := w.ResourceNames[0]
u, _ := url.Parse(resourceName)
debugType := u.Path
identity := proxy.VerifiedIdentity
if identity.Namespace != dg.SystemNamespace {
if _, ok := activeNamespaceDebuggers[debugType]; !ok {
return "", status.Errorf(codes.PermissionDenied, "the debug info is not available for current identity: %q", identity)
}
}
return resourceName, nil
}
func processDebugRequest(dg *DebugGen, resourceName string) bytes.Buffer {
var buffer bytes.Buffer
debugURL := "/debug/" + resourceName
hreq, _ := http.NewRequest(http.MethodGet, debugURL, nil)
handler, _ := dg.DebugMux.Handler(hreq)
response := NewResponseCapture()
handler.ServeHTTP(response, hreq)
if response.wroteHeader && len(response.header) >= 1 {
header, _ := json.Marshal(response.header)
buffer.Write(header)
}
buffer.Write(response.body.Bytes())
return buffer
}