Table of Contents

Status

Current state: Under Discussion Accepted

Discussion thread: here

JIRA: none yet

Jira

server	ASF JIRA
serverId	5aa69414-a9e9-3523-82ec-879b028fb15b
key	KAFKA-10259

Please keep the discussion on the mailing list rather than commenting on the wiki (wiki discussions get unwieldy fast).

...

As part of the KIP-500 effort to remove Kafka's ZooKeeper dependency, we need a broker-side API to alter these settings.

Public Interfaces

...

describeUserScramCredentials

listScramUsers describeUserScramCredentials will list describe the currently configured SCRAM usersuser credentials. For security reasons, it will not list their passwords.

Code Block

language	java

public enum ScramMechanism {
    UNKNOWN(0),
    HMACSCRAM_SHA_256(1),
    HMACSCRAM_SHA_512(2);

    private final byte type;

    private ScramMechanism(byte type) {final String mechanismName;

    public static ScramMechanism fromType(byte this.type) = type;{
    }
}

public class ScramMechanismInfo {
    private final ScramMechanism mechanism;// etc...
    }

    privatepublic finalstatic int iterations;
    private final byte[] salt;
    private final byte[] storedKey;
    private final byte[] serverKey;
}

public class ScramUserListingScramMechanism fromMechanismName(String mechanismName) {
        // etc...
    }

    public String mechanismName() {
    private final String name;
    private final List<ScramMechanismInfo> infos;
// etc...
    }

public class ListScramUsersOptions extends AbstractOptions<ListScramUsersOptions>public { }

default ListScramUsersResult listScramUsersbyte type() {
       return listScramUsers(new ListScramUsersOptions());
// etc...
    }

ListScramUsersResult listScramUsers(ListScramUsersOptions options);

public class ListScramUsersResult    private ScramMechanism(byte type) {
    public  KafkaFuture<Map<String, ScramUserListing>> all();
}

listScramUsers will be implemented by a new RPC.

 // etc...
    }
}

public class ScramCredentialInfo {
    private final ScramMechanism mechanism;
    private final int iterations;
}

public class UserScramCredentialsDescription {
    private final String name;
    private final List<ScramCredentialInfo> infos;
}

public class DescribeScramUserCredentialsOptions extends AbstractOptions<DescribeScramUserCredentialsOptions> { }

// interface Admin: Describe all users.
default DescribeScramUserCredentialsResult describeScramUserCredentials() {
    return describeScramUserCredentials(null);
}

// interface Admin: Describe indicated users (null or empty implies all).
default DescribeScramUserCredentialsResult describeScramUserCredentials(List<String> users) {
    return describeScramUserCredentials(users, new DescribeScramUserCredentialsOptions());
}

// interface Admin
DescribeScramUserCredentialsResult describeScramUserCredentials(List<String> users, DescribeScramUserCredentialsOptions options);

public class DescribeScramUserCredentialsResult {
    // completes successfully only if users() does and every described user does
    public KafkaFuture<Map<String, UserScramCredentialsDescription>> all();

    // completes successfully if request was authorized and the list of users described is determined
    public KafkaFuture<List<String>> users();

    // completes successfully if the individual user is described successfully
    public KafkaFuture<UserScramCredentialsDescription> description(String userName)
}

describeScramUserCredentials will be implemented by a new RPC.

Code Block

{
  "apiKey": 50,
  "type": "request",
  "name": "DescribeUserScramCredentialsRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [

Code Block

{ 
  "apiKey": 50,
  "type": "request",
  "name": "ListScramUsersRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
  ]
}

{ 
  "apiKey": 50, 
  "type": "response",
  "name": "ListScramUsersResponse", 
  "validVersions": "0", 
  "flexibleVersions": "0+", 
  "fields": [ 
    { "name": "Error", "type": "int16", "versions": "0+",
      "about": "The message-level error code." },
    { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+",
      "about": "The message-level error message." },
    { "name": "Users", "type": "[]ScramUser", "versions": "0+",
      "about": "The SCRAM users.", "fields": [
      { "name": "Name", "type": "string", "versions": "0+",
        "about": "The user name." },
      { "name": "MechanismInfos", "type": "ScramUserMechanismInfo", "versions": "0+",
        "about": "The user name." },
        { "name": "MechanismUsers", "type": "int8[]UserName", "versions": "0+",
    "nullableVersions": "0+",
      "about": "The SCRAM mechanism." },
   users to describe, or null/empty to describe all users.", "fields": [
      { "name": "IterationsName", "type": "int32string", "versions": "0+",
          "about": "The numberuser of iterations used in the SCRAM mechanism." },
        { name." }
    ]}
  ]
}

{
  "apiKey": 50,
  "type": "response",
  "name": "SaltDescribeUserScramCredentialsResponse",
  "typevalidVersions": "bytes0",
  "versionsflexibleVersions": "0+",
          "about"fields": "The password salt." },
 [
       { "name": "StoredKeyThrottleTimeMs", "type": "byteint32", "versions": "0+",
          "about": "The hashedduration clientin key." },
        { "name": "ServerKeymilliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota." },
    { "name": "ErrorCode", "type": "byteint16", "versions": "0+",
          "about": "The hashedmessage-level server key." }
      }
    ]}
  ]
}

It will require ALTER permissions on the CLUSTER resource. It will return CLUSTER_AUTHORIZATION_FAILED if the user has insufficient permissions.

It will be will be sent to the controller, and will return NOT_CONTROLLER if the receiving broker is not the controller.

AlterScramUsers

alterScramUsers will delete, create, or change SCRAM users.

Deletions are done by user name.

Alterations will create the given user if it doesn't exist, or alter it if it does.

Code Block

public class ScramUserDeletion {
    private final String user;
}

public class ScramCredential {
    private final ScramMechanismInfo info;
    private final byte[] salt;
    private final String password;

    // There will be one constructor that randomly generates a salt, and one that accepts a pre-defined salt.
}

public class ScramUserAlteration {
    private final String user;
    private final List<ScramCredential> credentials;

    public ScramCredentialAlteration(String user, List<ScramCredential> credentials) {error code, 0 except for user authorization or infrastructure issues." },
    { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+",
      "about": "The message-level error message, if any." },
    { "name": "Results", "type": "[]DescribeUserScramCredentialsResult", "versions": "0+",
      "about": "The results for descriptions, one per user.", "fields": [
      { "name": "User", "type": "string", "versions": "0+",
        "about": "The user name." },
      { "name": "ErrorCode", "type": "int16", "versions": "0+",
        "about": "The user-level error code." },
      { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+",
        this.user = user;
        this.credentials = credentials;
    }
"about": "The user-level error message, if any." },
    public String user() {
 "name": "CredentialInfos", "type": "[]CredentialInfo",    return user;"versions": "0+",
    }

    public List<ScramCredential> credentials() {
        return credentials;"about": "The mechanism and related information associated with the user's SCRAM credentials.", "fields": [
    }
}

public class AlterScramUsersOptions extends AbstractOptions<AlterScramUsersOptions> {}

default AlterScramUsersResult alterScramUsers(List<ScramUserDeletion> deletions,
     "name": "Mechanism", "type": "int8", "versions": "0+",
          "about": "The SCRAM mechanism." },
        { "name": "Iterations", "type": "int32", "versions": "0+",
          "about": "The number of iterations List<ScramUserAlteration>used alterations)in {
the SCRAM credential." }]}
 return alterScramUsers(deletions, alterations, new AlterScramUsersOptions());
 ]}

AlterScramUsersResult alterScramUsers(List<ScramUserDeletion> deletions,
                            ]
}

It will require DESCRIBE permissions on the CLUSTER resource. It will return CLUSTER_AUTHORIZATION_FAILED if the user has insufficient permissions.

It will return RESOURCE_NOT_FOUND if a user is requested to be described but that user does not exist/has no credentials. Note that DescribeScramUserCredentialsResult will not consider such a username to be part of its users() result list, and this RESOURCE_NOT_FOUND error by itself will not prevent the future returned by all() from completing successfully.

It will return DUPLICATE_RESOURCE if a user is requested to be described twice. Note that DescribeScramUserCredentialsResult will consider such a username to be part of its users() result list, and this will cause the future returned by all() to complete exceptionally.

AlterScramUserCredentials

alterScramUserCredentials will create or change SCRAM user credentials.

Alterations will create the given user credential if it doesn't exist, or alter it if it does.

Code Block

public abstract class UserScramCredentialAlteration {
    private final String user;
}

public class UserScramCredentialUpsertion extends UserScramCredentialAlteration {
    private final ScramCredentialInfo info;
    private final byte[] salt;
    private final byte[] password;

    // There will be one constructor that randomly generates a salt, and one that accepts a pre-defined salt.
}

public class UserScramCredentialDeletion extends UserScramCredentialAlteration {
    private final ScramMechanism mechanism;
}

public class AlterScramUserCredentialsOptions extends AbstractOptions<AlterScramUserCredentialsOptions> {}

// interface Admin
default AlterScramUserCredentialsResult alterScramUserCredentials(List<UserScramCredentialAlteration> alterations) {
    return alterScramUserCredentials( alterations, new AlterScramUserCredentialsOptions());
}

// interface Admin
AlterScramUserCredentialsResult alterScramUserCredentials(List<UserScramCredentialAlteration> alterations,
                                      AlterScramUserCredentialsOptions options);

public class AlterUserScramCredentialsResult {
    public Map<String, KafkaFuture<Void>> values();
    public KafkaFuture<Void> all(); // completes successfully only if everything in values() does
}

If any of the operations associated with a single user can't be done, none of the operations will be done. On the other hand, operations could succeed for one user but fail for another, different user.

If a user doesn't exist and we add a credential for them, they will be created. If a user exists and we remove their last credential, they will be deleted.

The AlterScramUserCredentialsRequest and AlterScramUserCredentialsResponse implement the new API.

Code Block

language	java

{
  "apiKey": 51,
  "type": "request",
  "name": "AlterUserScramCredentialsRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    { "name": "Deletions", "type": "[]ScramCredentialDeletion", "versions": "0+",
      "about": "The SCRAM credentials to remove.", "fields": [
      { "name": "Name", "type":  List<ScramUserAlteration> alterations"string", "versions": "0+",
        "about": "The user name." },
      { "name": "Mechanism", "type": "int8", "versions": "0+",
        "about": "The SCRAM mechanism." }
    AlterScramUsersOptions options);

public class AlterScramCredentialsResult {
    public KafkaFuture<Void> all();]},
    { "name": "Upsertions", "type": "[]ScramCredentialUpsertion", "versions": "0+",
    public Map<String, KafkaFuture<Void>> results();
}

The AlterScramUsersRequest and AlterScreamUsersResponse implement the new API.

Code Block

language	java

{ 
  "apiKey": 51, 
  "type": "response",
  "about": "The SCRAM credentials to update/insert.", "fields": [
      { "name": "AlterScramUsersRequestName",
  "validVersionstype": "0string", 
  "flexibleVersionsversions": "0+",
      
  "fieldsabout": [ 
 "The user name." },
      { "name": "DeletionsMechanism", "type": "[]ScramUserDeletionint8", "versions": "0+",
      "about": "The SCRAM users to remove.", "fieldsabout": "The [
SCRAM mechanism." },
      { "name": "NameIterations", "type": "stringint32", "versions": "0+",
          "about": "The number userof nameiterations." },
      ]},
    { "name": "AlterationsSalt", "type": "[]ScramUserAlterationbytes", "versions": "0+",
        "about": "The SCRAM users to alter.", "fields": [A random salt generated by the client." },
      { "name": "NameSaltedPassword", "type": "stringbytes", "versions": "0+",
        "about": "The usersalted namepassword." }
    ]}
  ]
}

{
  "nameapiKey": "Credentials"51,
  "type": "ScramCredentialresponse",
  "versionsname": "0+AlterUserScramCredentialsResponse",
      "validVersions": "0",
  "aboutflexibleVersions": "The SCRAM credentials to configure." }0+",
    "fields": [
    { "name": "MechanismThrottleTimeMs", "type": "int8int32", "versions": "0+",
      "about": "The duration in milliseconds for which the request was throttled due to a  "about": "The SCRAM mechanismquota violation, or zero if the request did not violate any quota." },
        { "name": "IterationsResults", "type": "int32[]AlterUserScramCredentialsResult", "versions": "0+",
          "about": "The numberresults offor iterations,deletions orand -1alterations, toone useper theaffected server defaultuser." },
 "fields": [
      { "name": "SaltUser", "type": "bytesstring", "versions": "0+", ",
          "about": "AThe random salt generated by the clientuser name." },
        { "name": "SaltedPasswordErrorCode", "type": "bytesint16", "versions": "0+", ",
          "about": "The salted password." }

      ]}
    ]}  
  ]       
}   

{ 
  "apiKey": 51, 
  "type": "response",
  "name": "AlterScramUsersResponse",
  "validVersions": "0", 
  "flexibleVersions": "0+", 
  "fields": [ 
    { "name": "Results", "type": "[]AlterScramUsersResult", "versions": "0+",
      "about": "The results for removals, followed by the results for alterations.", "fields": [
        { "name": "ErrorCode", "type": "int8", "versions": "0+",
          "about": "The error code." },
        { "name": "ErrorString", "type": "string", "versions": "0+", "nullableVersions": "0+",
          "about": "The error message, if any." }
    ]}  
  ]       
}

A removal or alteration will return INVALID_REQUEST if an empty user name is passed, or an invalid number of iterations, or a duplicate user name. Note that if the number of iterations is set to -1, the server-side default will be used.

A removal will return a new error code, RESOURCE_NOT_FOUND, if it was instructed to delete a user, but that user was not found.

The RPC will require ALTER on CLUSTER. It will return CLUSTER_AUTHORIZATION_FAILED if the user has insufficient permissions. It will be will be sent to the controller, and will return NOT_CONTROLLER if the receiving broker is not the controller.

Command-Line Changes

...

 error code." },
      { "name": "ErrorMessage", "type": "string", "versions": "0+", "nullableVersions": "0+",
        "about": "The error message, if any." }
    ]}
  ]
}

An addition will return UNACCEPTABLE_CREDENTIAL if an empty user name or an invalid number of iterations (less than the minimum required for the mechanism or more than a hard-coded max of 16,384) is passed.

DUPLICATE_RESOURCE will be returned if a user appears as both an upsertion and a deletion in the same request.

UNSUPPORTED_SASL_MECHANISM will be returned if the broker does not recognize the requested SASL mechanism.

A removal will return an error code, RESOURCE_NOT_FOUND, if it was instructed to delete a credential that did not exist.

The RPC will require ALTER on CLUSTER. It will return CLUSTER_AUTHORIZATION_FAILED if the user has insufficient permissions.

It will be will be sent to the controller and will return NOT_CONTROLLER if the receiving broker is not the controller.

Command-Line Changes

We will extend the kafka-configs.sh command to so that it is possible to set a SCRAM configuration without using --zookeeper. The command-line syntax will be unchanged, except for the fact that users will now be able to pass --bootstrap-server instead of --zookeeper.

As mentioned earlier, this API does not return secrets. Therefore, the salt, salted password, and so on will not be returned by a kafka-configs.sh --describe operation. The describe operation will return only the presence of the user plus the algorithm and number of iterations used. For example:

Code Block

$ bin/kafka-configs.sh --bootstrap-server localhost:9020 \
    --alter \
    --entity-type users \
    --entity-name alice \
    --add-config 'SCRAM-SHA-256=[iterations=8192,password=alice-secret],SCRAM-SHA-512=[password=alice-secret]'

Completed updating config for entity: user-principal 'alice'.

$ bin/kafka-configs.sh --bootstrap-server localhost:9020 --entity-type users --entity-name alice --describe

Configs for user-principal 'alice' are SCRAM-SHA-512=iterations=8192

Compatibility, Deprecation, and Migration Plan

...

Space shortcuts

Child pages

Versions Compared

Old Version 6

New Version Current

Key

Status

Public Interfaces

describeUserScramCredentials

AlterScramUsers

AlterScramUserCredentials

Command-Line Changes

Command-Line Changes

Compatibility, Deprecation, and Migration Plan

Space shortcuts

Child pages

Page History

Versions Compared

Old Version 6

New Version Current

Key

Status

Public Interfaces

describeUserScramCredentials

AlterScramUsers

AlterScramUserCredentials

Command-Line Changes

Command-Line Changes

Compatibility, Deprecation, and Migration Plan