org.apache.kafka.clients.admin.UserScramCredentialUpsertion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kafka-clients Show documentation
There is a newer version: 3.9.0
/*
 * 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.kafka.clients.admin;

import org.apache.kafka.common.security.scram.internals.ScramFormatter;

import java.nio.charset.StandardCharsets;
import java.security.SecureRandom;
import java.util.Objects;

/**
 * A request to update/insert a SASL/SCRAM credential for a user.
 *
 * @see KIP-554: Add Broker-side SCRAM Config API
 */
public class UserScramCredentialUpsertion extends UserScramCredentialAlteration {
    private final ScramCredentialInfo info;
    private final byte[] salt;
    private final byte[] password;

    /**
     * Constructor that generates a random salt
     *
     * @param user the user for which the credential is to be updated/inserted
     * @param credentialInfo the mechanism and iterations to be used
     * @param password the password
     */
    public UserScramCredentialUpsertion(String user, ScramCredentialInfo credentialInfo, String password) {
        this(user, credentialInfo, password.getBytes(StandardCharsets.UTF_8));
    }

    /**
     * Constructor that generates a random salt
     *
     * @param user the user for which the credential is to be updated/inserted
     * @param credentialInfo the mechanism and iterations to be used
     * @param password the password
     */
    public UserScramCredentialUpsertion(String user, ScramCredentialInfo credentialInfo, byte[] password) {
        this(user, credentialInfo, password, generateRandomSalt());
    }

    /**
     * Constructor that accepts an explicit salt
     *
     * @param user the user for which the credential is to be updated/inserted
     * @param credentialInfo the mechanism and iterations to be used
     * @param password the password
     * @param salt the salt to be used
     */
    public UserScramCredentialUpsertion(String user, ScramCredentialInfo credentialInfo, byte[] password, byte[] salt) {
        super(Objects.requireNonNull(user));
        this.info = Objects.requireNonNull(credentialInfo);
        this.password = Objects.requireNonNull(password);
        this.salt = Objects.requireNonNull(salt);
    }

    /**
     *
     * @return the mechanism and iterations
     */
    public ScramCredentialInfo credentialInfo() {
        return info;
    }

    /**
     *
     * @return the salt
     */
    public byte[] salt() {
        return salt;
    }

    /**
     *
     * @return the password
     */
    public byte[] password() {
        return password;
    }

    private static byte[] generateRandomSalt() {
        return ScramFormatter.secureRandomBytes(new SecureRandom());
    }
}