/
TsiHandshakeHandler.java
193 lines (172 loc) · 7.03 KB
/
TsiHandshakeHandler.java
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
/*
* Copyright 2018 The 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 io.grpc.alts.internal;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static io.grpc.alts.internal.AltsProtocolNegotiator.AUTH_CONTEXT_KEY;
import static io.grpc.alts.internal.AltsProtocolNegotiator.TSI_PEER_KEY;
import io.grpc.Attributes;
import io.grpc.ChannelLogger.ChannelLogLevel;
import io.grpc.InternalChannelz.Security;
import io.grpc.SecurityLevel;
import io.grpc.alts.internal.TsiHandshakeHandler.HandshakeValidator.SecurityDetails;
import io.grpc.internal.GrpcAttributes;
import io.grpc.netty.InternalProtocolNegotiationEvent;
import io.grpc.netty.InternalProtocolNegotiators;
import io.grpc.netty.ProtocolNegotiationEvent;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelFutureListener;
import io.netty.channel.ChannelHandler;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ByteToMessageDecoder;
import java.security.GeneralSecurityException;
import java.util.List;
import javax.annotation.Nullable;
/**
* Performs The TSI Handshake.
*/
public final class TsiHandshakeHandler extends ByteToMessageDecoder {
/**
* Validates a Tsi Peer object.
*/
public abstract static class HandshakeValidator {
public static final class SecurityDetails {
private final SecurityLevel securityLevel;
private final Security security;
/**
* Constructs SecurityDetails.
*/
public SecurityDetails(io.grpc.SecurityLevel securityLevel, @Nullable Security security) {
this.securityLevel = checkNotNull(securityLevel, "securityLevel");
this.security = security;
}
public Security getSecurity() {
return security;
}
public SecurityLevel getSecurityLevel() {
return securityLevel;
}
}
/**
* Validates a Tsi Peer object.
*/
public abstract SecurityDetails validatePeerObject(Object peerObject)
throws GeneralSecurityException;
}
private static final int HANDSHAKE_FRAME_SIZE = 1024;
private final NettyTsiHandshaker handshaker;
private final HandshakeValidator handshakeValidator;
private final ChannelHandler next;
private ProtocolNegotiationEvent pne;
/**
* Constructs a TsiHandshakeHandler.
*/
public TsiHandshakeHandler(
ChannelHandler next, NettyTsiHandshaker handshaker, HandshakeValidator handshakeValidator) {
this.handshaker = checkNotNull(handshaker, "handshaker");
this.handshakeValidator = checkNotNull(handshakeValidator, "handshakeValidator");
this.next = checkNotNull(next, "next");
}
@Override
protected void decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
throws Exception {
// TODO: Not sure why override is needed. Investigate if it can be removed.
decode(ctx, in, out);
}
@Override
protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
// Process the data. If we need to send more data, do so now.
if (handshaker.processBytesFromPeer(in) && handshaker.isInProgress()) {
sendHandshake(ctx);
}
// If the handshake is complete, transition to the framing state.
if (!handshaker.isInProgress()) {
TsiPeer peer = handshaker.extractPeer();
Object authContext = handshaker.extractPeerObject();
SecurityDetails details = handshakeValidator.validatePeerObject(authContext);
// createFrameProtector must be called last.
TsiFrameProtector protector = handshaker.createFrameProtector(ctx.alloc());
TsiFrameHandler framer;
boolean success = false;
try {
framer = new TsiFrameHandler(protector);
// adding framer and next handler after this handler before removing Decoder (current
// handler). This will prevents any missing read from decoder and/or unframed write from
// next handler.
ctx.pipeline().addAfter(ctx.name(), null, framer);
ctx.pipeline().addAfter(ctx.pipeline().context(framer).name(), null, next);
ctx.pipeline().remove(ctx.name());
fireProtocolNegotiationEvent(ctx, peer, authContext, details);
success = true;
} finally {
if (!success && protector != null) {
protector.destroy();
}
}
}
}
@Override
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
if (evt instanceof ProtocolNegotiationEvent) {
checkState(pne == null, "negotiation already started");
pne = (ProtocolNegotiationEvent) evt;
InternalProtocolNegotiators.negotiationLogger(ctx)
.log(ChannelLogLevel.INFO, "TsiHandshake started");
sendHandshake(ctx);
} else {
super.userEventTriggered(ctx, evt);
}
}
private void fireProtocolNegotiationEvent(
ChannelHandlerContext ctx, TsiPeer peer, Object authContext, SecurityDetails details) {
checkState(pne != null, "negotiation not yet complete");
InternalProtocolNegotiators.negotiationLogger(ctx)
.log(ChannelLogLevel.INFO, "TsiHandshake finished");
ProtocolNegotiationEvent localPne = pne;
Attributes.Builder attrs = InternalProtocolNegotiationEvent.getAttributes(localPne).toBuilder()
.set(TSI_PEER_KEY, peer)
.set(AUTH_CONTEXT_KEY, authContext)
.set(GrpcAttributes.ATTR_SECURITY_LEVEL, details.getSecurityLevel());
localPne = InternalProtocolNegotiationEvent.withAttributes(localPne, attrs.build());
localPne = InternalProtocolNegotiationEvent.withSecurity(localPne, details.getSecurity());
ctx.fireUserEventTriggered(localPne);
}
/** Sends as many bytes as are available from the handshaker to the remote peer. */
@SuppressWarnings("FutureReturnValueIgnored") // for addListener
private void sendHandshake(ChannelHandlerContext ctx) throws GeneralSecurityException {
while (true) {
boolean written = false;
ByteBuf buf = ctx.alloc().buffer(HANDSHAKE_FRAME_SIZE).retain(); // refcnt = 2
try {
handshaker.getBytesToSendToPeer(buf);
if (buf.isReadable()) {
ctx.writeAndFlush(buf).addListener(ChannelFutureListener.FIRE_EXCEPTION_ON_FAILURE);
written = true;
} else {
break;
}
} catch (GeneralSecurityException e) {
throw new GeneralSecurityException("TsiHandshakeHandler encountered exception", e);
} finally {
buf.release(written ? 1 : 2);
}
}
}
@Override
protected void handlerRemoved0(ChannelHandlerContext ctx) throws Exception {
handshaker.close();
}
}