Encrypted-Session (original) (raw)

  1. Home
  2. F5 NGINX Plus
  3. Admin Guide
  4. Dynamic Modules Encrypted-Session

The Encrypted Session dynamic module provides encryption and decryption support for NGINX variables based on AES-256 with MAC. It is usually used with the Set-Misc dynamic module and the NGINX rewrite module.

  1. Check the Technical Specifications page to verify that the module is supported by your operating system.
  2. Prior to installing the module, verify that the NDK module is already installed.

  1. Install the Encrypted Session module package nginx-plus-module-encrypted-session.
    For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
    shell
sudo yum update && \  
sudo yum install nginx-plus-module-encrypted-session  
sudo yum update && \  
sudo yum install nginx-plus-module-encrypted-session

for Amazon Linux 2023, AlmaLinux, Rocky Linux:
shell 

sudo dnf update && \  
sudo dnf install nginx-plus-module-encrypted-session  
sudo dnf update && \  
sudo dnf install nginx-plus-module-encrypted-session

For Debian and Ubuntu:
shell 

sudo apt update && \  
sudo apt install nginx-plus-module-encrypted-session  
sudo apt update && \  
sudo apt install nginx-plus-module-encrypted-session

For SLES:
shell 

sudo zypper refresh && \  
sudo zypper install nginx-plus-module-encrypted-session  
sudo zypper refresh && \  
sudo zypper install nginx-plus-module-encrypted-session

For Alpine: 

apk add nginx-plus-module-encrypted-session  
apk add nginx-plus-module-encrypted-session

For FreeBSD:
shell 

sudo pkg update && \  
sudo pkg install nginx-plus-module-encrypted-session  
sudo pkg update && \  
sudo pkg install nginx-plus-module-encrypted-session

After installation you will need to enable and configure the module in F5 NGINX Plus configuration file nginx.conf.

  1. Put the load_module directive in the top‑level (“main”) context of NGINX Plus configuration file, nginx.conf:
    nginx
load_module modules/ndk_http_module.so;  
load_module modules/ngx_http_encrypted_session_module.so;  
http {  
    # ...  
}  
load_module modules/ndk_http_module.so;  
load_module modules/ngx_http_encrypted_session_module.so;  
http {  
    # ...  
}

Note: The directives must be in this order.
The directives must be in this order. 2. Perform additional configuration as required by the module. 3. Test the NGINX Plus configuration. In a terminal, type-in the command:
Expected output of the command:
shell 

nginx: the configuration file /etc/nginx/nginx.conf syntax is ok  
nginx: configuration file /etc/nginx/nginx.conf is successful  
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok  
nginx: configuration file /etc/nginx/nginx.conf is successful
  1. Reload the NGINX Plus configuration to enable the module: