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
|
/*
*
* Copyright 2018 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 testutil include useful test utilities for the handshaker.
package testutil
import (
"bytes"
"encoding/binary"
"fmt"
"io"
"net"
"sync"
"time"
"google.golang.org/grpc/codes"
"google.golang.org/grpc/credentials/alts/internal/conn"
altsgrpc "google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp"
altspb "google.golang.org/grpc/credentials/alts/internal/proto/grpc_gcp"
)
// Stats is used to collect statistics about concurrent handshake calls.
type Stats struct {
mu sync.Mutex
calls int
MaxConcurrentCalls int
}
// Update updates the statistics by adding one call.
func (s *Stats) Update() func() {
s.mu.Lock()
s.calls++
if s.calls > s.MaxConcurrentCalls {
s.MaxConcurrentCalls = s.calls
}
s.mu.Unlock()
return func() {
s.mu.Lock()
s.calls--
s.mu.Unlock()
}
}
// Reset resets the statistics.
func (s *Stats) Reset() {
s.mu.Lock()
defer s.mu.Unlock()
s.calls = 0
s.MaxConcurrentCalls = 0
}
// testConn mimics a net.Conn to the peer.
type testConn struct {
net.Conn
in *bytes.Buffer
out *bytes.Buffer
readLatency time.Duration
}
// NewTestConn creates a new instance of testConn object.
func NewTestConn(in *bytes.Buffer, out *bytes.Buffer) net.Conn {
return &testConn{
in: in,
out: out,
readLatency: time.Duration(0),
}
}
// NewTestConnWithReadLatency creates a new instance of testConn object that
// pauses for readLatency before any call to Read() returns.
func NewTestConnWithReadLatency(in *bytes.Buffer, out *bytes.Buffer, readLatency time.Duration) net.Conn {
return &testConn{
in: in,
out: out,
readLatency: readLatency,
}
}
// Read reads from the in buffer.
func (c *testConn) Read(b []byte) (n int, err error) {
time.Sleep(c.readLatency)
return c.in.Read(b)
}
// Write writes to the out buffer.
func (c *testConn) Write(b []byte) (n int, err error) {
return c.out.Write(b)
}
// Close closes the testConn object.
func (c *testConn) Close() error {
return nil
}
// unresponsiveTestConn mimics a net.Conn for an unresponsive peer. It is used
// for testing the PeerNotResponding case.
type unresponsiveTestConn struct {
net.Conn
}
// NewUnresponsiveTestConn creates a new instance of unresponsiveTestConn object.
func NewUnresponsiveTestConn() net.Conn {
return &unresponsiveTestConn{}
}
// Read reads from the in buffer.
func (c *unresponsiveTestConn) Read(b []byte) (n int, err error) {
return 0, io.EOF
}
// Write writes to the out buffer.
func (c *unresponsiveTestConn) Write(b []byte) (n int, err error) {
return 0, nil
}
// Close closes the TestConn object.
func (c *unresponsiveTestConn) Close() error {
return nil
}
// MakeFrame creates a handshake frame.
func MakeFrame(pl string) []byte {
f := make([]byte, len(pl)+conn.MsgLenFieldSize)
binary.LittleEndian.PutUint32(f, uint32(len(pl)))
copy(f[conn.MsgLenFieldSize:], []byte(pl))
return f
}
// FakeHandshaker is a fake implementation of the ALTS handshaker service.
type FakeHandshaker struct {
altsgrpc.HandshakerServiceServer
}
// DoHandshake performs a fake ALTS handshake.
func (h *FakeHandshaker) DoHandshake(stream altsgrpc.HandshakerService_DoHandshakeServer) error {
var isAssistingClient bool
var handshakeFramesReceivedSoFar []byte
for {
req, err := stream.Recv()
if err != nil {
if err == io.EOF {
return nil
}
return fmt.Errorf("stream recv failure: %v", err)
}
var resp *altspb.HandshakerResp
switch req := req.ReqOneof.(type) {
case *altspb.HandshakerReq_ClientStart:
isAssistingClient = true
resp, err = h.processStartClient(req.ClientStart)
if err != nil {
return fmt.Errorf("processStartClient failure: %v", err)
}
case *altspb.HandshakerReq_ServerStart:
// If we have received the full ClientInit, send the ServerInit and
// ServerFinished. Otherwise, wait for more bytes to arrive from the client.
isAssistingClient = false
handshakeFramesReceivedSoFar = append(handshakeFramesReceivedSoFar, req.ServerStart.InBytes...)
sendHandshakeFrame := bytes.Equal(handshakeFramesReceivedSoFar, []byte("ClientInit"))
resp, err = h.processServerStart(req.ServerStart, sendHandshakeFrame)
if err != nil {
return fmt.Errorf("processServerStart failure: %v", err)
}
case *altspb.HandshakerReq_Next:
// If we have received all handshake frames, send the handshake result.
// Otherwise, wait for more bytes to arrive from the peer.
oldHandshakesBytes := len(handshakeFramesReceivedSoFar)
handshakeFramesReceivedSoFar = append(handshakeFramesReceivedSoFar, req.Next.InBytes...)
isHandshakeComplete := false
if isAssistingClient {
isHandshakeComplete = bytes.HasPrefix(handshakeFramesReceivedSoFar, []byte("ServerInitServerFinished"))
} else {
isHandshakeComplete = bytes.HasPrefix(handshakeFramesReceivedSoFar, []byte("ClientInitClientFinished"))
}
if !isHandshakeComplete {
resp = &altspb.HandshakerResp{
BytesConsumed: uint32(len(handshakeFramesReceivedSoFar) - oldHandshakesBytes),
Status: &altspb.HandshakerStatus{
Code: uint32(codes.OK),
},
}
break
}
resp, err = h.getHandshakeResult(isAssistingClient)
if err != nil {
return fmt.Errorf("getHandshakeResult failure: %v", err)
}
default:
return fmt.Errorf("handshake request has unexpected type: %v", req)
}
if err = stream.Send(resp); err != nil {
return fmt.Errorf("stream send failure: %v", err)
}
}
}
func (h *FakeHandshaker) processStartClient(req *altspb.StartClientHandshakeReq) (*altspb.HandshakerResp, error) {
if req.HandshakeSecurityProtocol != altspb.HandshakeProtocol_ALTS {
return nil, fmt.Errorf("unexpected handshake security protocol: %v", req.HandshakeSecurityProtocol)
}
if len(req.ApplicationProtocols) != 1 || req.ApplicationProtocols[0] != "grpc" {
return nil, fmt.Errorf("unexpected application protocols: %v", req.ApplicationProtocols)
}
if len(req.RecordProtocols) != 1 || req.RecordProtocols[0] != "ALTSRP_GCM_AES128_REKEY" {
return nil, fmt.Errorf("unexpected record protocols: %v", req.RecordProtocols)
}
return &altspb.HandshakerResp{
OutFrames: []byte("ClientInit"),
BytesConsumed: 0,
Status: &altspb.HandshakerStatus{
Code: uint32(codes.OK),
},
}, nil
}
func (h *FakeHandshaker) processServerStart(req *altspb.StartServerHandshakeReq, sendHandshakeFrame bool) (*altspb.HandshakerResp, error) {
if len(req.ApplicationProtocols) != 1 || req.ApplicationProtocols[0] != "grpc" {
return nil, fmt.Errorf("unexpected application protocols: %v", req.ApplicationProtocols)
}
parameters, ok := req.GetHandshakeParameters()[int32(altspb.HandshakeProtocol_ALTS)]
if !ok {
return nil, fmt.Errorf("missing ALTS handshake parameters")
}
if len(parameters.RecordProtocols) != 1 || parameters.RecordProtocols[0] != "ALTSRP_GCM_AES128_REKEY" {
return nil, fmt.Errorf("unexpected record protocols: %v", parameters.RecordProtocols)
}
if sendHandshakeFrame {
return &altspb.HandshakerResp{
OutFrames: []byte("ServerInitServerFinished"),
BytesConsumed: uint32(len(req.InBytes)),
Status: &altspb.HandshakerStatus{
Code: uint32(codes.OK),
},
}, nil
}
return &altspb.HandshakerResp{
OutFrames: []byte("ServerInitServerFinished"),
BytesConsumed: 10,
Status: &altspb.HandshakerStatus{
Code: uint32(codes.OK),
},
}, nil
}
func (h *FakeHandshaker) getHandshakeResult(isAssistingClient bool) (*altspb.HandshakerResp, error) {
if isAssistingClient {
return &altspb.HandshakerResp{
OutFrames: []byte("ClientFinished"),
BytesConsumed: 24,
Result: &altspb.HandshakerResult{
ApplicationProtocol: "grpc",
RecordProtocol: "ALTSRP_GCM_AES128_REKEY",
KeyData: []byte("negotiated-key-data-for-altsrp-gcm-aes128-rekey"),
PeerIdentity: &altspb.Identity{
IdentityOneof: &altspb.Identity_ServiceAccount{
ServiceAccount: "server@bar.com",
},
},
PeerRpcVersions: &altspb.RpcProtocolVersions{
MaxRpcVersion: &altspb.RpcProtocolVersions_Version{
Minor: 1,
Major: 2,
},
MinRpcVersion: &altspb.RpcProtocolVersions_Version{
Minor: 1,
Major: 2,
},
},
},
Status: &altspb.HandshakerStatus{
Code: uint32(codes.OK),
},
}, nil
}
return &altspb.HandshakerResp{
BytesConsumed: 14,
Result: &altspb.HandshakerResult{
ApplicationProtocol: "grpc",
RecordProtocol: "ALTSRP_GCM_AES128_REKEY",
KeyData: []byte("negotiated-key-data-for-altsrp-gcm-aes128-rekey"),
PeerIdentity: &altspb.Identity{
IdentityOneof: &altspb.Identity_ServiceAccount{
ServiceAccount: "client@baz.com",
},
},
PeerRpcVersions: &altspb.RpcProtocolVersions{
MaxRpcVersion: &altspb.RpcProtocolVersions_Version{
Minor: 1,
Major: 2,
},
MinRpcVersion: &altspb.RpcProtocolVersions_Version{
Minor: 1,
Major: 2,
},
},
},
Status: &altspb.HandshakerStatus{
Code: uint32(codes.OK),
},
}, nil
}
|