See Data at Rest Encryption Requirements for more information about encryption and Navigator Encrypt requirements.

You must create an internal repository to install or upgrade Navigator Encrypt. For instructions on creating internal repositories (including Cloudera Manager, CDH, and Cloudera Navigator encryption components), see Configuring a Local Package Repository.

  Note: For details about supported Linux Operating Systems, refer to the Cloudera Navigator Encrypt Compatibility Matrix.

1. Install the Cloudera Repository

   Add the internal repository you created. See Configuring Hosts to Use the Internal Repository for more information.

   Import the GPG key by running the following command:

   sudo rpm --import http://repo.example.com/path/to/gpg_gazzang.asc

2. Install the EPEL Repository
   Dependent packages are available through the Extra Packages for Enterprise Linux (EPEL) repository. To install the EPEL repository, install the epel-release package:

   1. Copy the URL for the epel-release-<version>.noarch file for RHEL 6 or RHEL 7 located in the How can I use these extra packages? section of the EPEL wiki page.
   2. Run the following commands to install the EPEL repository:

      sudo wget <epel_rpm_url>
      sudo yum install epel-release-<version>.noarch.rpm

      Replace <version> with the version number of the downloaded RPM (for example, 6-8).

   If the epel-release package is already installed, you see a message similar to the following:

   Examining /var/tmp/yum-root-jmZhL0/epel-release-6-8.noarch.rpm: epel-release-6-8.noarch
   /var/tmp/yum-root-jmZhL0/epel-release-6-8.noarch.rpm: does not update installed package.
   Error: Nothing to do
   

   Confirm that the EPEL repository is installed:

   sudo yum repolist | grep -i epel

3. Install Kernel Libraries

   For Navigator Encrypt to run as a kernel module, you must download and install the kernel development headers. Each kernel module is compiled specifically for the underlying kernel version. Running as a kernel module allows Navigator Encrypt to provide high performance and completely transparency to user-space applications.

   To determine your current kernel version, run uname -r.

   To install the development headers for your current kernel version, run:

   sudo yum install kernel-headers-$(uname -r) kernel-devel-$(uname -r)

   For OL with the Unbreakable Enterprise Kernel (UEK), run:

   sudo yum install kernel-uek-headers-$(uname -r) kernel-uek-devel-$(uname -r)

     Note: For UEK3, you do not need to install kernel-uek-headers-*
   If yum cannot find these packages, it displays an error similar to the following:

   Unable to locate package <packagename>.

   In this case, do one of the following to proceed:

   • Find and install the kernel headers package by using a tool like RPM Pbone .
   • Upgrade your kernel to the latest version. If you upgrade the kernel, you must reboot after upgrading and select the kernel from the grub menu to make it active.
4. (RHEL or CentOS Only) Manually Install dkms
   Because of a broken dependency in all versions of RHEL or CentOS, you must manually install the dkms package:

   sudo yum install http://repository.it4i.cz/mirrors/repoforge/redhat/el6/en/x86_64/rpmforge/RPMS/dkms-2.1.1.2-1.el6.rf.noarch.rpm

     Note: This link is provided as an example for RHEL 6 only. For other versions, be sure to use the correct URL.
5. Install Navigator Encrypt
   Install the Navigator Encrypt client using the yum package manager:

   sudo yum install navencrypt

   If you attempt to install Navigator Encrypt with incorrect or missing kernel headers, you see a message like the following:

   Building navencryptfs 3.8.0 DKMS kernel module...
   
   #################### BUILDING ERROR ####################
   
   
   
   Creating symlink /var/lib/dkms/navencryptfs/3.8.0/source ->
                    /usr/src/navencryptfs-3.8.0
   
   DKMS: add completed.
   Error! echo
   Your kernel headers for kernel 3.10.0-229.4.2.el7.x86_64 cannot be found at
   /lib/modules/3.10.0-229.4.2.el7.x86_64/build or /lib/modules/3.10.0-229.4.2.el7.x86_64/source.
   
   #################### BUILDING ERROR ####################
   
   Failed installation of navencryptfs 3.8.0 DKMS kernel module !

   To recover, see Navigator Encrypt Kernel Module Setup.

1. Install the Cloudera Repository

   Add the internal repository you created. See Configuring Hosts to Use the Internal Repository for more information.

   Import the GPG key by running the following command:

   sudo rpm --import http://repo.example.com/path/to/gpg_gazzang.asc

2. Install NTP

   The Network Time Protocol (NTP) service synchronizes system time. Cloudera recommends using NTP to ensure that timestamps in system logs, cryptographic signatures, and other auditable events are consistent across systems. Install and start NTP with the following commands:

   • SLES 11

     $ sudo zypper install ntp
     # /etc/init.d/ntp start

   • SLES 12

     $ sudo zypper install ntp
     # service ntpd start

3. Install the Kernel Module Package and Navigator Encrypt Client

   Install the kernel module package (KMP) and Navigator Encrypt client with zypper:

   sudo zypper install cloudera-navencryptfs-kmp-<kernel_flavor>
   sudo zypper install navencrypt

   Replace <kernel_flavor> with the kernel flavor for your system. Navigator Encrypt supports the default, xen, and ec2 kernel flavors.

4. Enable Unsupported Modules
   Edit /etc/modprobe.d/unsupported-modules and set allow_unsupported_modules to 1. For example:

   #
   # Every kernel module has a flag 'supported'. If this flag is not set loading
   # this module will taint your kernel. You will not get much help with a kernel
   # problem if your kernel is marked as tainted. In this case you firstly have
   # to avoid loading of unsupported modules.
   #
   # Setting allow_unsupported_modules 1 enables loading of unsupported modules
   # by modprobe, setting allow_unsupported_modules 0 disables it. This can
   # be overridden using the --allow-unsupported-modules command line switch.
   allow_unsupported_modules 1

5. (SLES 12 only) Run systemctl daemon-reload

   Due to changes in SLES 12, you must run the following command after installing Navigator Encrypt:

   sudo systemctl daemon-reload

1. Install the Cloudera Repository
   Add the internal repository you created. See Configuring Hosts to Use the Internal Repository for more information.

   • Ubuntu

     echo "deb http://repo.example.com/path/to/ubuntu/stable $DISTRIB_CODENAME main" | sudo tee -a /etc/apt/sources.list

   • Debian

     echo "deb http://repo.example.com/path/to/debian/stable $DISTRIB_CODENAME main" | sudo tee -a /etc/apt/sources.list

   Import the GPG key by running the following command:

   wget -O - http://repo.example.com/path/to/gpg_gazzang.asc | apt-key add -

   Update the repository index with apt-get update.

2. Install NTP
   The Network Time Protocol (NTP) service synchronizes system time. Cloudera recommends using NTP to ensure that timestamps in system logs, cryptographic signatures, and other auditable events are consistent across systems. Install and start NTP with the following commands:

   sudo apt-get install ntp
   sudo /etc/init.d/ntp start

3. Install Kernel Headers
   Determine your kernel version by running uname -r, and install the appropriate headers:

   sudo apt-get install linux-headers-$(uname -r)

4. Install the Navigator Encrypt Client
   Install Navigator Encrypt:

   sudo apt-get install navencrypt

Transport Layer Security (TLS) certificates are used to secure communication with Navigator Encrypt. Cloudera strongly recommends using certificates signed by a trusted Certificate Authority (CA).

If the TLS certificate is signed by an unrecognized CA, such as an internal CA, then you must add the root certificate to the host certificate truststore of each Navigator Encrypt client. Be aware that Navigator Encrypt uses the operating system's truststore, which is distinct from the JDK truststore used by Cloudera Manager.

[root@navencrypt-1 ~]# service navencrypt-mount stop
Stopping navencrypt directories
 * Umounting /dev/nvtest/test1 ...                         [  OK  ]
 * Umounting /dev/nvtest/test2 ...                         [  OK  ]
 * Unloading module ...                                    [  OK  ]

[root@navencrypt-1 ~]# update-ca-trust enable
[root@navencrypt-1 ~]# cp dd-1.lab.usa.company.com.pem /etc/pki/ca-trust/source/anchors/
[root@navencrypt-1 ~]# update-ca-trust

[root@navencrypt-1 ~]# service navencrypt-mount start
Starting navencrypt directories
 * Mounting '/dev/nvtest/test1'                            [  OK  ]
 * Mounting '/dev/nvtest/test2'                            [  OK  ]

Many cryptographic operations, such as those used with TLS or HDFS encryption, require a sufficient level of system entropy to ensure randomness; likewise, Navigator Encrypt needs a source of random numbers to ensure good performance. Hence, you need to make sure that the hosts running Navigator Encrypt (as well as Key Trustee Server, Key Trustee KMS) and have sufficient entropy to perform cryptographic operations.

You can check the available entropy on a Linux system by running the following command:

cat /proc/sys/kernel/random/entropy_avail             

The output displays the entropy currently available. Check the entropy several times to determine the state of the entropy pool on the system. If the entropy is consistently low (500 or less), you must increase it by installing rng-tools version 4 or higher, and starting the rngd service.

Install rng_tools Using Package Manager

If version 4 or higher of the rng-tools package is available from the local package manager (yum), then install it directly from the package manager. If the appropriate version of rng-tools is unavailable, see Building rng-tools From Source.

  Note: If you're using RHEL 6.7 and later, or recent versions of Ubuntu, Debian, and SLES, then package manager should provide version 4.x or higher. Be sure to check the version of rng-tools provided by your package manager before installation to determine whether or not you need to build from source instead.

Run the following commands on RHEL 6-compatible systems:

sudo yum install rng-tools
sudo service rngd start
sudo chkconfig rngd on

For RHEL 7, run the following commands:

sudo yum install rng-tools
cp /usr/lib/systemd/system/rngd.service /etc/systemd/system/
systemctl daemon-reload
systemctl start rngd
systemctl enable rngd

Building rng-tools From Source

If you are unable to install rng-tools using package manager, then build from source.

  Note: If your package manager only offers an older version (3.x or earlier), then you must build from source.

To install and start rngd and build from source:

1. Download the source code:

   sudo wget http://downloads.sourceforge.net/project/gkernel/rng-tools/4/rng-tools-4.tar.gz

2. Extract the source code:

   tar xvfz rng-tools-4.tar.gz

3. Enter the rng-tools-4 directory:

   cd rng-tools-4

4. Run ./configure
5. Run make
6. Run make install

After you have installed rng-tools, start the rngd daemon by running the following command as root:

sudo rngd --no-tpm=1 -o /dev/random

For improved performance, Cloudera recommends configuring Navigator Encrypt to read directly from /dev/random instead of /dev/urandom.

To configure Navigator Encrypt to use /dev/random as an entropy source, add --use-random to the navencrypt-prepare command when you are setting up Navigator Encrypt.