GSS-API authenticator plugin for Apache Cassandra
Switch branches/tags
Clone or download
Latest commit 7ce0a4f Dec 5, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
conf Squashed commit of the following: Oct 30, 2018
src/main/java/com/instaclustr/cassandra/auth Squashed commit of the following: Oct 30, 2018
.gitignore Initial outline. Work in progress. Sep 24, 2018
LICENSE Initial outline. Work in progress. Sep 24, 2018
README.md Update README.md Dec 5, 2018
pom.xml Sign release artefacts Oct 30, 2018

README.md

Cassandra Kerberos Authenticator

A GSSAPI authentication provider for Apache Cassandra.

This authenticator plugin is intended to work with the Cassandra Java Driver Kerberos Authenticator plugin for the Cassandra Java driver.

Note: This build is tested with Cassandra 3.11.x. For Cassandra 3.0.x support, switch to the cassandra-3.0.x branch

Build

To build a fully-packaged JAR, just run mvn clean package

Install

Environment set-up

  1. Ensure that the following pre-requisite systems are configured:

    • A unique DNS record is created for each node (use hostname -f on each node to verify that the DNS FQDN is configured)
    • A reverse DNS record is created for each node, matching the broadcast_rpc_address
    • A Kerberos 5 KDC server is available
    • Kerberos client libraries are installed on each Cassandra node
    • An NTP client is installed & configured on each Cassandra node. Ideally the Cassandra nodes sync with the same time source as the KDC in order to minimise potential time-sync issues.
    • If using Oracle Java, ensure that the Java Cryptographic Extensions Unlimited Strength Jurisdiction Policy Files are installed (not necessary when using OpenJDK or other JRE implementations)
  2. Ensure that the value of rpc_address (and optionally broadcast_rpc_address, if using) in the cassandra.yaml config file is not set to localhost. Reverse-DNS records must be created to match the broadcast_rpc_address. This enables clients to resolve the Kerberos service principal's hostname from the IP address.

  3. Configure the /etc/krb5.conf Kerberos config file on each node (see here for further details)

    Below is an example krb5.conf for an EXAMPLE.COM Kerberos realm:

    [logging]
    default = FILE:/var/log/krb5libs.log
    
    [libdefaults]
     default_realm = EXAMPLE.COM
     dns_lookup_realm = false
     dns_lookup_kdc = false
    
    [realms]
     EXAMPLE.COM = {
      kdc = kdc.example.com
      admin_server = kdc.example.com
    }
    
    [domain_realm]
     .example.com = EXAMPLE.COM
     example.com = EXAMPLE.COM
    
  4. For each cassandra node, create a new Kerberos service principal (see here for further details)

    kadmin -q "addprinc -randkey cassandra/node1.mycluster.example.com@EXAMPLE.COM"
    kadmin -q "addprinc -randkey cassandra/node2.mycluster.example.com@EXAMPLE.COM"
    kadmin -q "addprinc -randkey cassandra/node3.mycluster.example.com@EXAMPLE.COM"
    

    Note that the service name portion of the principal (cassandra, in this example) must be the same for each node in the cluster, and must also match the SASL protocol name specified when configuring the the Cassandra Java driver Kerberos authenticator.

    The hostname portion of the principal (e.g. node1.mycluster.example.com) must match the DNS entry for each Cassandra node.

  5. Create a keytab for each newly created service principal (see here for further details)

    kadmin -q "ktadd -k /node1.keytab cassandra/node1.mycluster.example.com@EXAMPLE.COM"
    kadmin -q "ktadd -k /node2.keytab cassandra/node2.mycluster.example.com@EXAMPLE.COM"
    kadmin -q "ktadd -k /node3.keytab cassandra/node3.mycluster.example.com@EXAMPLE.COM"
    
  6. Copy the corresponding keytab file to the Cassandra configuration directory on each node, and set the appropriate access controls

    scp kdc.example.com:/node1.keytab /etc/cassandra/node1.keytab
    chown cassandra:cassandra /etc/cassandra/node1.keytab
    chmod 400 /etc/cassandra/node1.keytab
    

Install & configure the Kerberos authenticator

  1. Copy the cassandra-krb5.properties file to the Cassandra configuration directory on each node (e.g. /etc/cassandra). Set service_principal and keytab to correspond to the service principals and keytabs created in the previous steps.

    service_principal=cassandra/node1.mycluster.example.com@EXAMPLE.COM
    keytab=node1.keytab
    qop=auth
    
  2. Copy the authenicator jar to the Cassandra lib directory (e.g. /usr/share/cassandra/lib/)

  3. Set the authenticator option in the cassandra.yaml config file.

    authenticator: com.instaclustr.cassandra.auth.KerberosAuthenticator
    

Please see https://www.instaclustr.com/support/documentation/announcements/instaclustr-open-source-project-status/ for Instaclustr support status of this project