-
Notifications
You must be signed in to change notification settings - Fork 3.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[fix](kerberos)fix and refactor ugi login for kerberos and simple aut…
…hentication (#37301) ## Proposed changes optimize kerberos ugi login: 1. support authentication framework for external table 2. cache ugi to avoid conflicts when set configuration for ugi login 3. do ugi login just on creating catalog, which reduces the ugi create times 4. only simple authentication will use getloginUser, which avoids conflicts between simple and kerberos authentication <!--Describe your changes.-->
- Loading branch information
Showing
15 changed files
with
427 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
44 changes: 44 additions & 0 deletions
44
...on/src/main/java/org/apache/doris/common/security/authentication/HadoopAuthenticator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // 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.doris.common.security.authentication; | ||
|
|
||
| import org.apache.hadoop.security.UserGroupInformation; | ||
|
|
||
| import java.io.IOException; | ||
| import java.security.PrivilegedExceptionAction; | ||
|
|
||
| public interface HadoopAuthenticator { | ||
|
|
||
| UserGroupInformation getUGI() throws IOException; | ||
|
|
||
| default <T> T doAs(PrivilegedExceptionAction<T> action) throws IOException { | ||
| try { | ||
| return getUGI().doAs(action); | ||
| } catch (InterruptedException e) { | ||
| throw new IOException(e); | ||
| } | ||
| } | ||
|
|
||
| static HadoopAuthenticator getHadoopAuthenticator(AuthenticationConfig config) { | ||
| if (config instanceof KerberosAuthenticationConfig) { | ||
| return new HadoopKerberosAuthenticator((KerberosAuthenticationConfig) config); | ||
| } else { | ||
| return new HadoopSimpleAuthenticator((SimpleAuthenticationConfig) config); | ||
| } | ||
| } | ||
| } |
163 changes: 163 additions & 0 deletions
163
...ain/java/org/apache/doris/common/security/authentication/HadoopKerberosAuthenticator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| // 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.doris.common.security.authentication; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import com.google.common.collect.ImmutableSet; | ||
| import io.trino.plugin.base.authentication.KerberosTicketUtils; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.fs.CommonConfigurationKeysPublic; | ||
| import org.apache.hadoop.security.UserGroupInformation; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Collections; | ||
| import java.util.Date; | ||
| import java.util.Map; | ||
| import java.util.Objects; | ||
| import java.util.Set; | ||
| import javax.security.auth.Subject; | ||
| import javax.security.auth.kerberos.KerberosPrincipal; | ||
| import javax.security.auth.kerberos.KerberosTicket; | ||
| import javax.security.auth.login.AppConfigurationEntry; | ||
| import javax.security.auth.login.LoginContext; | ||
| import javax.security.auth.login.LoginException; | ||
|
|
||
| public class HadoopKerberosAuthenticator implements HadoopAuthenticator { | ||
| private static final Logger LOG = LogManager.getLogger(HadoopKerberosAuthenticator.class); | ||
| private final KerberosAuthenticationConfig config; | ||
| private Subject subject; | ||
| private long nextRefreshTime; | ||
| private UserGroupInformation ugi; | ||
|
|
||
| public HadoopKerberosAuthenticator(KerberosAuthenticationConfig config) { | ||
| this.config = config; | ||
| } | ||
|
|
||
| public static void initializeAuthConfig(Configuration hadoopConf) { | ||
| hadoopConf.set(CommonConfigurationKeysPublic.HADOOP_SECURITY_AUTHORIZATION, "true"); | ||
| synchronized (HadoopKerberosAuthenticator.class) { | ||
| // avoid other catalog set conf at the same time | ||
| UserGroupInformation.setConfiguration(hadoopConf); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public synchronized UserGroupInformation getUGI() throws IOException { | ||
| if (ugi == null) { | ||
| subject = getSubject(config.getKerberosKeytab(), config.getKerberosPrincipal(), config.isPrintDebugLog()); | ||
| ugi = Objects.requireNonNull(login(subject), "login result is null"); | ||
| return ugi; | ||
| } | ||
| if (nextRefreshTime < System.currentTimeMillis()) { | ||
| long lastRefreshTime = nextRefreshTime; | ||
| Subject existingSubject = subject; | ||
| if (LOG.isDebugEnabled()) { | ||
| Date lastTicketEndTime = getTicketEndTime(subject); | ||
| LOG.debug("Current ticket expired time is {}", lastTicketEndTime); | ||
| } | ||
| // renew subject | ||
| Subject newSubject = getSubject(config.getKerberosKeytab(), config.getKerberosPrincipal(), | ||
| config.isPrintDebugLog()); | ||
| Objects.requireNonNull(login(newSubject), "re-login result is null"); | ||
| // modify UGI instead of returning new UGI | ||
| existingSubject.getPrincipals().addAll(newSubject.getPrincipals()); | ||
| Set<Object> privateCredentials = existingSubject.getPrivateCredentials(); | ||
| // clear the old credentials | ||
| synchronized (privateCredentials) { | ||
| privateCredentials.clear(); | ||
| privateCredentials.addAll(newSubject.getPrivateCredentials()); | ||
| } | ||
| Set<Object> publicCredentials = existingSubject.getPublicCredentials(); | ||
| synchronized (publicCredentials) { | ||
| publicCredentials.clear(); | ||
| publicCredentials.addAll(newSubject.getPublicCredentials()); | ||
| } | ||
| nextRefreshTime = calculateNextRefreshTime(newSubject); | ||
| if (LOG.isDebugEnabled()) { | ||
| Date lastTicketEndTime = getTicketEndTime(newSubject); | ||
| LOG.debug("Next ticket expired time is {}", lastTicketEndTime); | ||
| LOG.debug("Refresh kerberos ticket succeeded, last time is {}, next time is {}", | ||
| lastRefreshTime, nextRefreshTime); | ||
| } | ||
| } | ||
| return ugi; | ||
| } | ||
|
|
||
| private UserGroupInformation login(Subject subject) throws IOException { | ||
| // login and get ugi when catalog is initialized | ||
| initializeAuthConfig(config.getConf()); | ||
| String principal = config.getKerberosPrincipal(); | ||
| if (LOG.isDebugEnabled()) { | ||
| LOG.debug("Login by kerberos authentication with principal: {}", principal); | ||
| } | ||
| return UserGroupInformation.getUGIFromSubject(subject); | ||
| } | ||
|
|
||
| private static long calculateNextRefreshTime(Subject subject) { | ||
| Preconditions.checkArgument(subject != null, "subject must be present in kerberos based UGI"); | ||
| KerberosTicket tgtTicket = KerberosTicketUtils.getTicketGrantingTicket(subject); | ||
| return KerberosTicketUtils.getRefreshTime(tgtTicket); | ||
| } | ||
|
|
||
| private static Date getTicketEndTime(Subject subject) { | ||
| Preconditions.checkArgument(subject != null, "subject must be present in kerberos based UGI"); | ||
| KerberosTicket tgtTicket = KerberosTicketUtils.getTicketGrantingTicket(subject); | ||
| return tgtTicket.getEndTime(); | ||
| } | ||
|
|
||
| private static Subject getSubject(String keytab, String principal, boolean printDebugLog) { | ||
| Subject subject = new Subject(false, ImmutableSet.of(new KerberosPrincipal(principal)), | ||
| Collections.emptySet(), Collections.emptySet()); | ||
| javax.security.auth.login.Configuration conf = getConfiguration(keytab, principal, printDebugLog); | ||
| try { | ||
| LoginContext loginContext = new LoginContext("", subject, null, conf); | ||
| loginContext.login(); | ||
| return loginContext.getSubject(); | ||
| } catch (LoginException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } | ||
|
|
||
| private static javax.security.auth.login.Configuration getConfiguration(String keytab, String principal, | ||
| boolean printDebugLog) { | ||
| return new javax.security.auth.login.Configuration() { | ||
| @Override | ||
| public AppConfigurationEntry[] getAppConfigurationEntry(String name) { | ||
| ImmutableMap.Builder<String, String> builder = ImmutableMap.<String, String>builder() | ||
| .put("doNotPrompt", "true") | ||
| .put("isInitiator", "true") | ||
| .put("useKeyTab", "true") | ||
| .put("storeKey", "true") | ||
| .put("keyTab", keytab) | ||
| .put("principal", principal); | ||
| if (printDebugLog) { | ||
| builder.put("debug", "true"); | ||
| } | ||
| Map<String, String> options = builder.build(); | ||
| return new AppConfigurationEntry[]{ | ||
| new AppConfigurationEntry( | ||
| "com.sun.security.auth.module.Krb5LoginModule", | ||
| AppConfigurationEntry.LoginModuleControlFlag.REQUIRED, | ||
| options)}; | ||
| } | ||
| }; | ||
| } | ||
| } |
47 changes: 47 additions & 0 deletions
47
.../main/java/org/apache/doris/common/security/authentication/HadoopSimpleAuthenticator.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // 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.doris.common.security.authentication; | ||
|
|
||
| import org.apache.hadoop.security.UserGroupInformation; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
|
|
||
| public class HadoopSimpleAuthenticator implements HadoopAuthenticator { | ||
| private static final Logger LOG = LogManager.getLogger(HadoopSimpleAuthenticator.class); | ||
| private final UserGroupInformation ugi; | ||
|
|
||
| public HadoopSimpleAuthenticator(SimpleAuthenticationConfig config) { | ||
| String hadoopUserName = config.getUsername(); | ||
| if (hadoopUserName == null) { | ||
| hadoopUserName = "hadoop"; | ||
| config.setUsername(hadoopUserName); | ||
| if (LOG.isDebugEnabled()) { | ||
| LOG.debug("{} is unset, use default user: hadoop", AuthenticationConfig.HADOOP_USER_NAME); | ||
| } | ||
| } | ||
| ugi = UserGroupInformation.createRemoteUser(hadoopUserName); | ||
| if (LOG.isDebugEnabled()) { | ||
| LOG.debug("Login by proxy user, hadoop.username: {}", hadoopUserName); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public UserGroupInformation getUGI() { | ||
| return ugi; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.