com.datastax.dse.driver.internal.core.auth.BaseDseAuthenticator Maven / Gradle / Ivy

/*
 * Copyright DataStax, Inc.
 *
 * This software can be used solely with DataStax Enterprise. Please consult the license at
 * http://www.datastax.com/terms/datastax-dse-driver-license-terms
 */
package com.datastax.dse.driver.internal.core.auth;

import com.datastax.oss.driver.api.core.auth.SyncAuthenticator;
import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.nio.ByteBuffer;
import net.jcip.annotations.ThreadSafe;

/**
 * Base class for {@link SyncAuthenticator} implementations that want to make use of the
 * authentication scheme negotiation in DseAuthenticator.
 */
@ThreadSafe
public abstract class BaseDseAuthenticator implements SyncAuthenticator {

  private static final String DSE_AUTHENTICATOR =
      "com.datastax.bdp.cassandra.auth.DseAuthenticator";

  private final String serverAuthenticator;

  BaseDseAuthenticator(@NonNull String serverAuthenticator) {
    this.serverAuthenticator = serverAuthenticator;
  }

  /**
   * Return a byte array containing the required SASL mechanism. This should be one of:
   *
   * 
   *   PLAIN
   *   
GSSAPI
   * 
   *
   * @return a {@link ByteBuffer} containing the SASL mechanism
   */
  @NonNull
  public abstract ByteBuffer getMechanism();

  /**
   * Return a byte array containing the expected successful server challenge. This should be one of:
   *
   * 
   *   PLAIN-START
   *   
GSSAPI-START
   * 
   *
   * @return a {@link ByteBuffer} containing the server challenge
   */
  @NonNull
  public abstract ByteBuffer getInitialServerChallenge();

  @Nullable
  @Override
  public ByteBuffer initialResponseSync() {
    // DseAuthenticator communicates back the mechanism in response to server authenticate message.
    // older authenticators simply expect the auth response with credentials.
    if (isDseAuthenticator()) {
      return getMechanism();
    } else {
      return evaluateChallengeSync(getInitialServerChallenge());
    }
  }

  @Override
  public void onAuthenticationSuccessSync(@Nullable ByteBuffer token) {}

  private boolean isDseAuthenticator() {
    return serverAuthenticator.equals(DSE_AUTHENTICATOR);
  }
}