Encrypting Configuration File Properties

Configure DSE to use a local encryption key to decrypt properties in the configuration file. Use passwords encrypted with the local key for the following properties:

  • dse.yaml LDAP values:


    Restriction: Use plain text for the KMIP keystore or truststore passwords.

  • cassandra.yaml SSL values:



Complete the key setup described in Setting up local encryption keys.

When using a local encryption key file, set the location system_key_directory and ensure that the key file is owned by the account running DSE.


  1. For each property, replace plain text passwords with encrypted passwords returned by running the dsetool encryptconfigvalue command:

    1. Encrypt the password:

      dsetool encryptconfigvalue
      Using system key system_key
      Enter value to encrypt:
      Enter again to confirm:
      Your encrypted value is:
    2. Replace the old value with the new value in the configuration file, for example the SSL truststore password in the cassandra.yaml file:

      truststore_password: +Vj5oHCR/jqfA+OJE2m8zA==

      After the configuration file property encryption is enabled, DSE startup fails if any of the protected properties are not encrypted.

  2. Locate the dse.yaml and cassandra.yaml configuration files. The location of these files depends on the type of installation:


    File Location


    Package installations: /etc/dse/dse.yaml

    Tarball installations: <installation_location>/resources/dse/conf/dse.yaml


    Package installations: /etc/dse/cassandra/cassandra.yaml

    Tarball installations: <installation_location>/resources/cassandra/conf/cassandra.yaml

  3. In dse.yaml, enable configuration file property encryption:

    1. Set config_encryption_active to true.

      config_encryption_active: true

      When set to true, the configuration values must be encrypted or commented out.

      Restriction: Lifecycle Manager (LCM) is not compatible when config_encryption_active is true in DSE and OpsCenter. For LCM limitations, see Encrypted DSE configuration values.

    2. Set the local key encryption filename:

      config_encryption_key_name: <key_filename>
  4. Update the dse.yaml and cassandra.yaml on all nodes in the cluster.

  5. Set up encryption for system resources, see Encrypting system resources.

  6. Perform a rolling restart.

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com