org.apache.flink.runtime.security.SecurityUtils Maven / Gradle / Ivy
/*
* 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.flink.runtime.security;
import org.apache.hadoop.conf.Configuration;
import org.apache.hadoop.security.UserGroupInformation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.security.PrivilegedExceptionAction;
/**
* A utility class that lets program code run in a security context provided by the
* Hadoop security user groups.
*
* The secure context will for example pick up authentication information from Kerberos.
*/
public final class SecurityUtils {
private static final Logger LOG = LoggerFactory.getLogger(SecurityUtils.class);
// load Hadoop configuration when loading the security utils.
private static Configuration hdConf = new Configuration();
public static boolean isSecurityEnabled() {
UserGroupInformation.setConfiguration(hdConf);
return UserGroupInformation.isSecurityEnabled();
}
public static T runSecured(final FlinkSecuredRunner runner) throws Exception {
UserGroupInformation.setConfiguration(hdConf);
UserGroupInformation ugi = UserGroupInformation.getCurrentUser();
if (!ugi.hasKerberosCredentials()) {
LOG.error("Security is enabled but no Kerberos credentials have been found. " +
"You may authenticate using the kinit command.");
}
return ugi.doAs(new PrivilegedExceptionAction() {
@Override
public T run() throws Exception {
return runner.run();
}
});
}
public interface FlinkSecuredRunner {
T run() throws Exception;
}
/**
* Private constructor to prevent instantiation.
*/
private SecurityUtils() {
throw new RuntimeException();
}
}