-
Notifications
You must be signed in to change notification settings - Fork 4.3k
/
listener_resource_type.go
186 lines (159 loc) · 5.72 KB
/
listener_resource_type.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
/*
*
* Copyright 2022 gRPC 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 xdsresource
import (
"fmt"
"google.golang.org/grpc/internal/pretty"
"google.golang.org/grpc/xds/internal/xdsclient/bootstrap"
"google.golang.org/grpc/xds/internal/xdsclient/xdsresource/version"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/anypb"
)
const (
// ListenerResourceTypeName represents the transport agnostic name for the
// listener resource.
ListenerResourceTypeName = "ListenerResource"
)
var (
// Compile time interface checks.
_ Type = listenerResourceType{}
// Singleton instantiation of the resource type implementation.
listenerType = listenerResourceType{
resourceTypeState: resourceTypeState{
typeURL: version.V3ListenerURL,
typeName: ListenerResourceTypeName,
allResourcesRequiredInSotW: true,
},
}
)
// listenerResourceType provides the resource-type specific functionality for a
// Listener resource.
//
// Implements the Type interface.
type listenerResourceType struct {
resourceTypeState
}
func securityConfigValidator(bc *bootstrap.Config, sc *SecurityConfig) error {
if sc == nil {
return nil
}
if sc.IdentityInstanceName != "" {
if _, ok := bc.CertProviderConfigs[sc.IdentityInstanceName]; !ok {
return fmt.Errorf("identity certificate provider instance name %q missing in bootstrap configuration", sc.IdentityInstanceName)
}
}
if sc.RootInstanceName != "" {
if _, ok := bc.CertProviderConfigs[sc.RootInstanceName]; !ok {
return fmt.Errorf("root certificate provider instance name %q missing in bootstrap configuration", sc.RootInstanceName)
}
}
return nil
}
func listenerValidator(bc *bootstrap.Config, lis ListenerUpdate) error {
if lis.InboundListenerCfg == nil || lis.InboundListenerCfg.FilterChains == nil {
return nil
}
return lis.InboundListenerCfg.FilterChains.Validate(func(fc *FilterChain) error {
if fc == nil {
return nil
}
return securityConfigValidator(bc, fc.SecurityCfg)
})
}
// Decode deserializes and validates an xDS resource serialized inside the
// provided `Any` proto, as received from the xDS management server.
func (listenerResourceType) Decode(opts *DecodeOptions, resource *anypb.Any) (*DecodeResult, error) {
name, listener, err := unmarshalListenerResource(resource)
switch {
case name == "":
// Name is unset only when protobuf deserialization fails.
return nil, err
case err != nil:
// Protobuf deserialization succeeded, but resource validation failed.
return &DecodeResult{Name: name, Resource: &ListenerResourceData{Resource: ListenerUpdate{}}}, err
}
// Perform extra validation here.
if err := listenerValidator(opts.BootstrapConfig, listener); err != nil {
return &DecodeResult{Name: name, Resource: &ListenerResourceData{Resource: ListenerUpdate{}}}, err
}
return &DecodeResult{Name: name, Resource: &ListenerResourceData{Resource: listener}}, nil
}
// ListenerResourceData wraps the configuration of a Listener resource as
// received from the management server.
//
// Implements the ResourceData interface.
type ListenerResourceData struct {
ResourceData
// TODO: We have always stored update structs by value. See if this can be
// switched to a pointer?
Resource ListenerUpdate
}
// Equal returns true if other is equal to l.
func (l *ListenerResourceData) Equal(other ResourceData) bool {
if l == nil && other == nil {
return true
}
if (l == nil) != (other == nil) {
return false
}
return proto.Equal(l.Resource.Raw, other.Raw())
}
// ToJSON returns a JSON string representation of the resource data.
func (l *ListenerResourceData) ToJSON() string {
return pretty.ToJSON(l.Resource)
}
// Raw returns the underlying raw protobuf form of the listener resource.
func (l *ListenerResourceData) Raw() *anypb.Any {
return l.Resource.Raw
}
// ListenerWatcher wraps the callbacks to be invoked for different
// events corresponding to the listener resource being watched.
type ListenerWatcher interface {
// OnUpdate is invoked to report an update for the resource being watched.
OnUpdate(*ListenerResourceData)
// OnError is invoked under different error conditions including but not
// limited to the following:
// - authority mentioned in the resource is not found
// - resource name parsing error
// - resource deserialization error
// - resource validation error
// - ADS stream failure
// - connection failure
OnError(error)
// OnResourceDoesNotExist is invoked for a specific error condition where
// the requested resource is not found on the xDS management server.
OnResourceDoesNotExist()
}
type delegatingListenerWatcher struct {
watcher ListenerWatcher
}
func (d *delegatingListenerWatcher) OnUpdate(data ResourceData) {
l := data.(*ListenerResourceData)
d.watcher.OnUpdate(l)
}
func (d *delegatingListenerWatcher) OnError(err error) {
d.watcher.OnError(err)
}
func (d *delegatingListenerWatcher) OnResourceDoesNotExist() {
d.watcher.OnResourceDoesNotExist()
}
// WatchListener uses xDS to discover the configuration associated with the
// provided listener resource name.
func WatchListener(p Producer, name string, w ListenerWatcher) (cancel func()) {
delegator := &delegatingListenerWatcher{watcher: w}
return p.WatchResource(listenerType, name, delegator)
}