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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.spark.network.crypto;
import java.io.IOException;
import java.nio.ByteBuffer;
import java.security.GeneralSecurityException;
import java.security.Key;
import javax.crypto.KeyGenerator;
import javax.crypto.Mac;
import static java.nio.charset.StandardCharsets.UTF_8;
import com.google.common.base.Preconditions;
import com.google.common.base.Throwables;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.Channel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.apache.spark.network.client.TransportClient;
import org.apache.spark.network.client.TransportClientBootstrap;
import org.apache.spark.network.sasl.SaslClientBootstrap;
import org.apache.spark.network.sasl.SecretKeyHolder;
import org.apache.spark.network.util.JavaUtils;
import org.apache.spark.network.util.TransportConf;
/**
* Bootstraps a {@link TransportClient} by performing authentication using Spark's auth protocol.
*
* This bootstrap falls back to using the SASL bootstrap if the server throws an error during
* authentication, and the configuration allows it. This is used for backwards compatibility
* with external shuffle services that do not support the new protocol.
*
* It also automatically falls back to SASL if the new encryption backend is disabled, so that
* callers only need to install this bootstrap when authentication is enabled.
*/
public class AuthClientBootstrap implements TransportClientBootstrap {
private static final Logger LOG = LoggerFactory.getLogger(AuthClientBootstrap.class);
private final TransportConf conf;
private final String appId;
private final String authUser;
private final SecretKeyHolder secretKeyHolder;
public AuthClientBootstrap(
TransportConf conf,
String appId,
SecretKeyHolder secretKeyHolder) {
this.conf = conf;
// TODO: right now this behaves like the SASL backend, because when executors start up
// they don't necessarily know the app ID. So they send a hardcoded "user" that is defined
// in the SecurityManager, which will also always return the same secret (regardless of the
// user name). All that's needed here is for this "user" to match on both sides, since that's
// required by the protocol. At some point, though, it would be better for the actual app ID
// to be provided here.
this.appId = appId;
this.authUser = secretKeyHolder.getSaslUser(appId);
this.secretKeyHolder = secretKeyHolder;
}
@Override
public void doBootstrap(TransportClient client, Channel channel) {
if (!conf.encryptionEnabled()) {
LOG.debug("AES encryption disabled, using old auth protocol.");
doSaslAuth(client, channel);
return;
}
try {
doSparkAuth(client, channel);
} catch (GeneralSecurityException | IOException e) {
throw Throwables.propagate(e);
} catch (RuntimeException e) {
// There isn't a good exception that can be caught here to know whether it's really
// OK to switch back to SASL (because the server doesn't speak the new protocol). So
// try it anyway, and in the worst case things will fail again.
if (conf.saslFallback()) {
LOG.warn("New auth protocol failed, trying SASL.", e);
doSaslAuth(client, channel);
} else {
throw e;
}
}
}
private void doSparkAuth(TransportClient client, Channel channel)
throws GeneralSecurityException, IOException {
AuthEngine engine = new AuthEngine(authUser, secretKeyHolder.getSecretKey(authUser), conf);
try {
ClientChallenge challenge = engine.challenge();
ByteBuf challengeData = Unpooled.buffer(challenge.encodedLength());
challenge.encode(challengeData);
ByteBuffer responseData = client.sendRpcSync(challengeData.nioBuffer(),
conf.authRTTimeoutMs());
ServerResponse response = ServerResponse.decodeMessage(responseData);
engine.validate(response);
engine.sessionCipher().addToChannel(channel);
} finally {
engine.close();
}
}
private void doSaslAuth(TransportClient client, Channel channel) {
SaslClientBootstrap sasl = new SaslClientBootstrap(conf, appId, secretKeyHolder);
sasl.doBootstrap(client, channel);
}
}
|
