Illustration Image

Cassandra.Link

The best knowledge base on Apache Cassandra®

Helping platform leaders, architects, engineers, and operators build scalable real time data platforms.

10/22/2018

Reading time:1 min

Cassandra - Database - Secrets Engines - Vault by HashiCorp

by John Doe

Cassandra is one of the supported plugins for the database secrets engine. Thisplugin generates database credentials dynamically based on configured roles forthe Cassandra database.See the database secrets engine docs formore information about setting up the database secrets engine. » SetupEnable the database secrets engine if it is not already enabled:$ vault secrets enable databaseSuccess! Enabled the database secrets engine at: database/By default, the secrets engine will enable at the name of the engine. Toenable the secrets engine at a different path, use the -path argument.Configure Vault with the proper plugin and connection information:$ vault write database/config/my-cassandra-database \ plugin_name="cassandra-database-plugin" \ hosts=127.0.0.1 \ protocol_version=4 \ username=cassandra \ password=cassandra \ allowed_roles=my-roleConfigure a role that maps a name in Vault to an SQL statement to execute tocreate the database credential:$ vault write database/roles/my-role \ db_name=my-cassandra-database \ creation_statements="CREATE USER '{{username}}' WITH PASSWORD '{{password}}' NOSUPERUSER; \ GRANT SELECT ON ALL KEYSPACES TO {{username}};" \ default_ttl="1h" \ max_ttl="24h"Success! Data written to: database/roles/my-role » UsageAfter the secrets engine is configured and a user/machine has a Vault token withthe proper permission, it can generate credentials.Generate a new credential by reading from the /creds endpoint with the nameof the role:$ vault read database/creds/my-roleKey Value--- -----lease_id database/creds/my-role/2f6a614c-4aa2-7b19-24b9-ad944a8d4de6lease_duration 1hlease_renewable truepassword 8cab931c-d62e-a73d-60d3-5ee85139cd66username v-root-e2978cd0- » APIThe full list of configurable options can be seen in the Cassandra databaseplugin API page.For more information on the database secrets engine's HTTP API please see the Database secretsecrets engine API page.

Illustration Image

Cassandra is one of the supported plugins for the database secrets engine. This plugin generates database credentials dynamically based on configured roles for the Cassandra database.

See the database secrets engine docs for more information about setting up the database secrets engine.

» Setup

  1. Enable the database secrets engine if it is not already enabled:

    $ vault secrets enable database
    Success! Enabled the database secrets engine at: database/
    

    By default, the secrets engine will enable at the name of the engine. To enable the secrets engine at a different path, use the -path argument.

  2. Configure Vault with the proper plugin and connection information:

    $ vault write database/config/my-cassandra-database \
        plugin_name="cassandra-database-plugin" \
        hosts=127.0.0.1 \
        protocol_version=4 \
        username=cassandra \
        password=cassandra \
        allowed_roles=my-role
    
  3. Configure a role that maps a name in Vault to an SQL statement to execute to create the database credential:

    $ vault write database/roles/my-role \
        db_name=my-cassandra-database \
        creation_statements="CREATE USER '{{username}}' WITH PASSWORD '{{password}}' NOSUPERUSER; \
             GRANT SELECT ON ALL KEYSPACES TO {{username}};" \
        default_ttl="1h" \
        max_ttl="24h"
    Success! Data written to: database/roles/my-role
    

» Usage

After the secrets engine is configured and a user/machine has a Vault token with the proper permission, it can generate credentials.

  1. Generate a new credential by reading from the /creds endpoint with the name of the role:

    $ vault read database/creds/my-role
    Key                Value
    ---                -----
    lease_id           database/creds/my-role/2f6a614c-4aa2-7b19-24b9-ad944a8d4de6
    lease_duration     1h
    lease_renewable    true
    password           8cab931c-d62e-a73d-60d3-5ee85139cd66
    username           v-root-e2978cd0-
    

» API

The full list of configurable options can be seen in the Cassandra database plugin API page.

For more information on the database secrets engine's HTTP API please see the Database secret secrets engine API page.

Related Articles

cassandra
ssl
security

Setting Up a Cassandra Cluster With SSL - DZone Cloud

Jean-Paul Azar

7/26/2022

cassandra
security

Checkout Planet Cassandra

Claim Your Free Planet Cassandra Contributor T-shirt!

Make your contribution and score a FREE Planet Cassandra Contributor T-Shirt! 
We value our incredible Cassandra community, and we want to express our gratitude by sending an exclusive Planet Cassandra Contributor T-Shirt you can wear with pride.

Join Our Newsletter!

Sign up below to receive email updates and see what's going on with our company

Explore Related Topics

AllKafkaSparkScyllaSStableKubernetesApiGithubGraphQl

Explore Further

cassandra