Examples with ClientFirstMessage org.apache.kafka.common.security.scram.internals.ScramMessages.ClientFirstMessage used on opensource projects

Example 1 with ClientFirstMessage

use of org.apache.kafka.common.security.scram.internals.ScramMessages.ClientFirstMessage in project kafka by apache.

the class ScramMessagesTest method validClientFirstMessage.

@Test
public void validClientFirstMessage() throws SaslException {
    String nonce = formatter.secureRandomString();
    ClientFirstMessage m = new ClientFirstMessage("someuser", nonce, Collections.emptyMap());
    checkClientFirstMessage(m, "someuser", nonce, "");
    // Default format used by Kafka client: only user and nonce are specified
    String str = String.format("n,,n=testuser,r=%s", nonce);
    m = createScramMessage(ClientFirstMessage.class, str);
    checkClientFirstMessage(m, "testuser", nonce, "");
    m = new ClientFirstMessage(m.toBytes());
    checkClientFirstMessage(m, "testuser", nonce, "");
    // Username containing comma, encoded as =2C
    str = String.format("n,,n=test=2Cuser,r=%s", nonce);
    m = createScramMessage(ClientFirstMessage.class, str);
    checkClientFirstMessage(m, "test=2Cuser", nonce, "");
    assertEquals("test,user", ScramFormatter.username(m.saslName()));
    // Username containing equals, encoded as =3D
    str = String.format("n,,n=test=3Duser,r=%s", nonce);
    m = createScramMessage(ClientFirstMessage.class, str);
    checkClientFirstMessage(m, "test=3Duser", nonce, "");
    assertEquals("test=user", ScramFormatter.username(m.saslName()));
    // Optional authorization id specified
    str = String.format("n,a=testauthzid,n=testuser,r=%s", nonce);
    checkClientFirstMessage(createScramMessage(ClientFirstMessage.class, str), "testuser", nonce, "testauthzid");
    // Optional reserved value specified
    for (String reserved : VALID_RESERVED) {
        str = String.format("n,,%s,n=testuser,r=%s", reserved, nonce);
        checkClientFirstMessage(createScramMessage(ClientFirstMessage.class, str), "testuser", nonce, "");
    }
    // Optional extension specified
    for (String extension : VALID_EXTENSIONS) {
        str = String.format("n,,n=testuser,r=%s,%s", nonce, extension);
        checkClientFirstMessage(createScramMessage(ClientFirstMessage.class, str), "testuser", nonce, "");
    }
    // optional tokenauth specified as extensions
    str = String.format("n,,n=testuser,r=%s,%s", nonce, "tokenauth=true");
    m = createScramMessage(ClientFirstMessage.class, str);
    assertTrue(m.extensions().tokenAuthenticated(), "Token authentication not set from extensions");
}

Example 2 with ClientFirstMessage

use of org.apache.kafka.common.security.scram.internals.ScramMessages.ClientFirstMessage in project kafka by apache.

the class ScramSaslServer method evaluateResponse.

/**
 * @throws SaslAuthenticationException if the requested authorization id is not the same as username.
 * <p>
 * <b>Note:</b> This method may throw {@link SaslAuthenticationException} to provide custom error messages
 * to clients. But care should be taken to avoid including any information in the exception message that
 * should not be leaked to unauthenticated clients. It may be safer to throw {@link SaslException} in
 * most cases so that a standard error message is returned to clients.
 * </p>
 */
@Override
public byte[] evaluateResponse(byte[] response) throws SaslException, SaslAuthenticationException {
    try {
        switch(state) {
            case RECEIVE_CLIENT_FIRST_MESSAGE:
                this.clientFirstMessage = new ClientFirstMessage(response);
                this.scramExtensions = clientFirstMessage.extensions();
                if (!SUPPORTED_EXTENSIONS.containsAll(scramExtensions.map().keySet())) {
                    log.debug("Unsupported extensions will be ignored, supported {}, provided {}", SUPPORTED_EXTENSIONS, scramExtensions.map().keySet());
                }
                String serverNonce = formatter.secureRandomString();
                try {
                    String saslName = clientFirstMessage.saslName();
                    this.username = ScramFormatter.username(saslName);
                    NameCallback nameCallback = new NameCallback("username", username);
                    ScramCredentialCallback credentialCallback;
                    if (scramExtensions.tokenAuthenticated()) {
                        DelegationTokenCredentialCallback tokenCallback = new DelegationTokenCredentialCallback();
                        credentialCallback = tokenCallback;
                        callbackHandler.handle(new Callback[] { nameCallback, tokenCallback });
                        if (tokenCallback.tokenOwner() == null)
                            throw new SaslException("Token Authentication failed: Invalid tokenId : " + username);
                        this.authorizationId = tokenCallback.tokenOwner();
                        this.tokenExpiryTimestamp = tokenCallback.tokenExpiryTimestamp();
                    } else {
                        credentialCallback = new ScramCredentialCallback();
                        callbackHandler.handle(new Callback[] { nameCallback, credentialCallback });
                        this.authorizationId = username;
                        this.tokenExpiryTimestamp = null;
                    }
                    this.scramCredential = credentialCallback.scramCredential();
                    if (scramCredential == null)
                        throw new SaslException("Authentication failed: Invalid user credentials");
                    String authorizationIdFromClient = clientFirstMessage.authorizationId();
                    if (!authorizationIdFromClient.isEmpty() && !authorizationIdFromClient.equals(username))
                        throw new SaslAuthenticationException("Authentication failed: Client requested an authorization id that is different from username");
                    if (scramCredential.iterations() < mechanism.minIterations())
                        throw new SaslException("Iterations " + scramCredential.iterations() + " is less than the minimum " + mechanism.minIterations() + " for " + mechanism);
                    this.serverFirstMessage = new ServerFirstMessage(clientFirstMessage.nonce(), serverNonce, scramCredential.salt(), scramCredential.iterations());
                    setState(State.RECEIVE_CLIENT_FINAL_MESSAGE);
                    return serverFirstMessage.toBytes();
                } catch (SaslException | AuthenticationException e) {
                    throw e;
                } catch (Throwable e) {
                    throw new SaslException("Authentication failed: Credentials could not be obtained", e);
                }
            case RECEIVE_CLIENT_FINAL_MESSAGE:
                try {
                    ClientFinalMessage clientFinalMessage = new ClientFinalMessage(response);
                    verifyClientProof(clientFinalMessage);
                    byte[] serverKey = scramCredential.serverKey();
                    byte[] serverSignature = formatter.serverSignature(serverKey, clientFirstMessage, serverFirstMessage, clientFinalMessage);
                    ServerFinalMessage serverFinalMessage = new ServerFinalMessage(null, serverSignature);
                    clearCredentials();
                    setState(State.COMPLETE);
                    return serverFinalMessage.toBytes();
                } catch (InvalidKeyException e) {
                    throw new SaslException("Authentication failed: Invalid client final message", e);
                }
            default:
                throw new IllegalSaslStateException("Unexpected challenge in Sasl server state " + state);
        }
    } catch (SaslException | AuthenticationException e) {
        clearCredentials();
        setState(State.FAILED);
        throw e;
    }
}

Example 3 with ClientFirstMessage

use of org.apache.kafka.common.security.scram.internals.ScramMessages.ClientFirstMessage in project kafka by apache.

the class ScramFormatterTest method rfc7677Example.

/**
 * Tests that the formatter implementation produces the same values for the
 * example included in <a href="https://tools.ietf.org/html/rfc5802#section-5">RFC 7677</a>
 */
@Test
public void rfc7677Example() throws Exception {
    ScramFormatter formatter = new ScramFormatter(ScramMechanism.SCRAM_SHA_256);
    String password = "pencil";
    String c1 = "n,,n=user,r=rOprNGfwEbeRWgbNEkqO";
    String s1 = "r=rOprNGfwEbeRWgbNEkqO%hvYDpWUa2RaTCAfuxFIlj)hNlF$k0,s=W22ZaJ0SNY7soEsUEjb6gQ==,i=4096";
    String c2 = "c=biws,r=rOprNGfwEbeRWgbNEkqO%hvYDpWUa2RaTCAfuxFIlj)hNlF$k0,p=dHzbZapWIk4jUhN+Ute9ytag9zjfMHgsqmmiz7AndVQ=";
    String s2 = "v=6rriTRBi23WpRR/wtup+mMhUZUn/dB5nLTJRsjl95G4=";
    ClientFirstMessage clientFirst = new ClientFirstMessage(ScramFormatter.toBytes(c1));
    ServerFirstMessage serverFirst = new ServerFirstMessage(ScramFormatter.toBytes(s1));
    ClientFinalMessage clientFinal = new ClientFinalMessage(ScramFormatter.toBytes(c2));
    ServerFinalMessage serverFinal = new ServerFinalMessage(ScramFormatter.toBytes(s2));
    String username = clientFirst.saslName();
    assertEquals("user", username);
    String clientNonce = clientFirst.nonce();
    assertEquals("rOprNGfwEbeRWgbNEkqO", clientNonce);
    String serverNonce = serverFirst.nonce().substring(clientNonce.length());
    assertEquals("%hvYDpWUa2RaTCAfuxFIlj)hNlF$k0", serverNonce);
    byte[] salt = serverFirst.salt();
    assertArrayEquals(Base64.getDecoder().decode("W22ZaJ0SNY7soEsUEjb6gQ=="), salt);
    int iterations = serverFirst.iterations();
    assertEquals(4096, iterations);
    byte[] channelBinding = clientFinal.channelBinding();
    assertArrayEquals(Base64.getDecoder().decode("biws"), channelBinding);
    byte[] serverSignature = serverFinal.serverSignature();
    assertArrayEquals(Base64.getDecoder().decode("6rriTRBi23WpRR/wtup+mMhUZUn/dB5nLTJRsjl95G4="), serverSignature);
    byte[] saltedPassword = formatter.saltedPassword(password, salt, iterations);
    byte[] serverKey = formatter.serverKey(saltedPassword);
    byte[] computedProof = formatter.clientProof(saltedPassword, clientFirst, serverFirst, clientFinal);
    assertArrayEquals(clientFinal.proof(), computedProof);
    byte[] computedSignature = formatter.serverSignature(serverKey, clientFirst, serverFirst, clientFinal);
    assertArrayEquals(serverFinal.serverSignature(), computedSignature);
    // Minimum iterations defined in RFC-7677
    assertEquals(4096, ScramMechanism.SCRAM_SHA_256.minIterations());
}