KerberosConfig.java

package com.thinkbiganalytics.nifi.v2.sqoop.security;

/*-
 * #%L
 * thinkbig-nifi-hadoop-processors
 * %%
 * Copyright (C) 2017 ThinkBig Analytics
 * %%
 * 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.
 * #L%
 */

import org.apache.nifi.logging.ComponentLog;

import java.util.ArrayList;
import java.util.List;


/**
 * Class to store Kerberos Configuration. Used for doing a kinit in Kerberized environment.
 */
public class KerberosConfig {

    private String kerberosPrincipal = null;
    private String kerberosKeytab = null;
    private String kerberosKinitLocation = "/usr/bin/kinit";
    private ComponentLog logger = null;

    /**
     * Set Logger
     *
     * @param logger logger to set
     * @return {@link KerberosConfig}
     */
    public KerberosConfig setLogger(ComponentLog logger) {
        this.logger = logger;
        return this;
    }


    /**
     * Set Kerberos Principal
     *
     * @param kerberosPrincipal kerberos principal to set
     * @return {@link KerberosConfig}
     */
    public KerberosConfig setKerberosPrincipal(String kerberosPrincipal) {
        this.kerberosPrincipal = kerberosPrincipal;
        if (logger != null) {
            logger.info("Kerberos Principal set to {}", new Object[]{this.kerberosPrincipal});
        }
        return this;
    }

    /**
     * Set Kerberos Keytab
     *
     * @param kerberosKeytab kerberos keytab to set
     * @return {@link KerberosConfig}
     */
    public KerberosConfig setKerberosKeytab(String kerberosKeytab) {
        this.kerberosKeytab = kerberosKeytab;
        if (logger != null) {
            logger.info("Kerberos Keytab set to {}", new Object[]{this.kerberosKeytab});
        }
        return this;
    }

    /**
     * Set Kerberos kinit Location (Default used is /usr/bin/kinit)
     *
     * @param kerberosKinitLocation kinit location to set
     * @return {@link KerberosConfig}
     */
    @SuppressWarnings("unused")
    public KerberosConfig setKerberosKinitLocation(String kerberosKinitLocation) {
        if (kerberosKinitLocation == null) {
            logger.warn("Kerberos Kinit location is provided as null."
                        + " Skipping setting it. Will use default value of " + this.kerberosKinitLocation);
            return this;
        } else if (!kerberosKinitLocation.contains("kinit")) {
            logger.warn("Kerberos Kinit location is provided as " + kerberosKinitLocation
                        + ". Appears invalid since it does not include 'kinit'. Skipping setting it. Will use default value of " + this.kerberosKinitLocation);
            return this;
        }
        this.kerberosKinitLocation = kerberosKinitLocation;
        logger.info("Kerberos Kinit Location set to {}", new Object[]{this.kerberosKinitLocation});
        return this;
    }

    /**
     * Get the Kerberos kinit command
     *
     * @return kinit command
     */
    public String getKinitCommandAsString() {
        //kinit nifi -kt /etc/security/keytabs/nifi.headless.keytab
        StringBuffer kInitCommand = new StringBuffer();
        return kInitCommand.append(kerberosKinitLocation)
            .append(" ")
            .append(kerberosPrincipal)
            .append(" ")
            .append("-kt")
            .append(" ")
            .append(kerberosKeytab)
            .toString();
    }

    /**
     * Get the Kerberos kinit command
     *
     * @return kinit command as a list of strings
     */
    public List<String> getKinitCommandAsList() {
        List<String> kinitCommandAsList = new ArrayList<>();
        kinitCommandAsList.add(kerberosKinitLocation);
        kinitCommandAsList.add(kerberosPrincipal);
        kinitCommandAsList.add("-kt");
        kinitCommandAsList.add(kerberosKeytab);
        return kinitCommandAsList;
    }

    /**
     * Check if Kerberos is configured
     *
     * @return true/false indicating if Kerberos is configured
     */
    public boolean isKerberosConfigured() {
        return ((kerberosPrincipal != null) && (kerberosKeytab != null));
    }
}