Usa una chiave Cloud HSM per l'offload TLS con NGINX

Questa guida fornisce istruzioni per configurare NGINX per l'utilizzo di una chiave Cloud HSM per l'offload TLS su Debian 11 (Bullseye). Potresti dover modificare questi comandi in modo che funzionino con il tuo sistema operativo o la tua distribuzione Linux.

Nota: la terminazione TLS con Nginx è supportata solo per le chiavi Elliptic Curve Digital Signature Algorithm (ECDSA).

Casi d'uso

L'utilizzo di una chiave Cloud HSM con NGINX per l'offload TLS consente di soddisfare le seguenti esigenze di sicurezza aziendale:

• Vuoi che il server web NGINX esegua l'offload delle operazioni di crittografia TLS in Cloud HSM.
• e non vuoi archiviare la chiave privata del certificato nel file system locale dell'istanza di Compute Engine che ospita la tua applicazione web.
• Devi soddisfare i requisiti normativi quando le applicazioni rivolte al pubblico richiedono che i certificati siano protetti da un HSM con certificazione FIPS 140-2 di livello 3.
• Vuoi utilizzare NGINX per creare un proxy inverso con terminazione TLS per proteggere la tua applicazione web.

Prima di iniziare

Prima di continuare, completa i passaggi descritti in Utilizzo di una chiave Cloud HSM con OpenSSL.

Una volta completata la configurazione di OpenSSL, assicurati che sia installata una versione recente di nginx:

sudo apt-get update
sudo apt-get install libengine-pkcs11-openssl opensc nginx

Nota: nginx 1.18.0-6.1 e versioni successive supportano lo schema URI PKCS #11 (RFC 7512). Potresti dover eseguire l'upgrade del pacchetto nginx installato in precedenza.

Suggerimenti per la configurazione della sicurezza

Proteggi l'istanza che ospita NGINX con i seguenti suggerimenti:

1. Segui le istruzioni per creare e abilitare gli account di servizio per le istanze per ospitare NGINX.

   1. Assegna i seguenti ruoli:
      • roles/cloudkms.signerVerifier
      • roles/cloudkms.viewer

2. Configura i criteri dell'organizzazione come segue per limitare gli IP esterni e la creazione di chiavi degli account di servizio.

   • constraints/compute.vmExternalIpAccess
   • constraints/iam.disableServiceAccountKeyCreation

3. Crea una subnet personalizzata che consente l'accesso privato Google.

4. Configurare le regole del firewall.

   • Crea regole firewall IAP solo per SSH.

5. Crea una VM Linux e configurala come segue:

   • Seleziona l'account di servizio corretto che hai creato in precedenza.
   • Seleziona la rete che hai creato in precedenza.
     • Aggiungi le etichette appropriate per tutte le regole firewall.
     • Assicurati che il campo "IP esterno" per la subnet sia impostato su none.

6. Concedi alla tua identità il ruolo Utente del tunnel con protezione IAP (roles/iap.tunnelResourceAccessor) nell'istanza.

   • Scopri di più, consulta l'articolo Configurazione IAP per il computing.

Crea e configura una chiave di firma ospitata in Cloud KMS

Le sezioni successive descrivono in dettaglio i passaggi necessari per creare e configurare una chiave di firma ospitata in Cloud KMS.

Crea una chiave di firma ospitata in Cloud KMS

Crea una chiave di firma EC-P256-SHA256 di Cloud KMS nel tuo progetto Google Cloud, nel keyring configurato in precedenza per OpenSSL:

gcloud kms keys create NGINX_KEY \
  --keyring "KEY_RING" --project "PROJECT_ID" \
  --location "LOCATION" --purpose "asymmetric-signing" \
  --default-algorithm "ec-sign-p256-sha256" --protection-level "hsm"

Nota: per poter utilizzare il keyring, assicurati che l'account di servizio Compute Engine disponga delle autorizzazioni IAM (Identity and Access Management) corrette sul keyring.

SSH nella VM tramite IAP

Accedi alla VM tramite SSH utilizzando IAP con il seguente comando:

gcloud compute ssh INSTANCE \
  --zone ZONE --tunnel-through-iap

Se riscontri un problema, verifica di aver utilizzato il flag --tunnel-through-iap. Inoltre, verifica di disporre del ruolo Utente del tunnel con protezione IAP (roles/iap.tunnelResourceAccessor) nell'istanza per l'identità autenticata con gcloud CLI.

Crea un certificato con OpenSSL

Per un ambiente di produzione, crea una richiesta di firma del certificato (CSR). Per scoprire di più, leggi l'esempio su come generare una CSR. Fornisci il CSR all'autorità di certificazione (CA) in modo che possa creare un certificato per te. Utilizza il certificato fornito dall'autorità di certificazione nelle sezioni successive.

Ad esempio, puoi generare un certificato autofirmato con la chiave di firma ospitata da Cloud KMS. Per farlo, OpenSSL consente di utilizzare gli URI PKCS #11 invece di un percorso normale, identificando la chiave in base all'etichetta (per le chiavi Cloud KMS, l'etichetta è il nome della CryptoKey).

openssl req -new -x509 -days 3650 -subj '/CN=CERTIFICATE_NAME/' \
  DIGEST_FLAG -engine pkcs11 -keyform engine \
  -key PKCS_KEY_TYPE=KEY_IDENTIFIER > CA_CERT

Sostituisci quanto segue:

• CERTIFICATE_NAME: un nome per il certificato.
• DIGEST_FLAG: l'algoritmo digest utilizzato dalla chiave di firma asimmetrica. Usa -sha256, -sha384 o -sha512, a seconda della chiave.
• PKCS_KEY_TYPE: il tipo di identificatore utilizzato per identificare la chiave. Per usare la versione più recente della chiave, usa pkcs11:object con il nome della chiave. Per usare una versione specifica della chiave, usa pkcs11:id con l'ID risorsa completo della versione della chiave.
• KEY_IDENTIFIER: un identificatore della chiave. Se utilizzi pkcs11:object, usa il nome della chiave, ad esempio NGINX_KEY. Se utilizzi pkcs11:id, utilizza l'ID risorsa completo della chiave o della versione della chiave, ad esempio projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/NGINX_KEY/cryptoKeyVersions/KEY_VERSION.
• CA_CERT: il percorso in cui vuoi salvare il file del certificato.

Se il comando non riesce, PKCS11_MODULE_PATH potrebbe non essere stato impostato correttamente o potresti non disporre delle autorizzazioni corrette per utilizzare la chiave di firma di Cloud KMS.

A questo punto dovresti avere un certificato simile al seguente:

-----BEGIN CERTIFICATE-----
...
...
...
-----END CERTIFICATE-----

Installa il certificato per NGINX

Esegui questi comandi per creare una località in cui inserire il certificato pubblico:

sudo mkdir /etc/ssl/nginx
sudo mv CA_CERT /etc/ssl/nginx

Configura il tuo ambiente per l'utilizzo della libreria PKCS #11

Le sezioni successive descrivono nel dettaglio i passaggi necessari per preparare e testare l'ambiente.

Prepara le configurazioni della libreria per NGINX

Consenti a NGINX di registrare le proprie operazioni del motore PKCS #11 con la libreria con quanto segue:

sudo mkdir /var/log/kmsp11
sudo chown www-data /var/log/kmsp11

Crea un file di configurazione della libreria vuoto con le autorizzazioni appropriate per NGINX.

sudo touch /etc/nginx/pkcs11-config.yaml
sudo chmod 744 /etc/nginx/pkcs11-config.yaml

Modifica il file di configurazione vuoto e aggiungi la configurazione necessaria come mostrato nello snippet seguente:

# cat /etc/nginx/pkcs11-config.yaml
---
tokens:
  - key_ring: "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING"
log_directory: "/var/log/kmsp11"

Testare la configurazione OpenSSL

Esegui questo comando:

openssl engine -tt -c -v pkcs11

Dovresti vedere un output simile al seguente:

(pkcs11) pkcs11 engine
 [RSA, rsaEncryption, id-ecPublicKey]
     [ available ]
     SO_PATH, MODULE_PATH, PIN, VERBOSE, QUIET, INIT_ARGS, FORCE_LOGIN

Configura NGINX per l'utilizzo di Cloud HSM

Consenti l'offload TLS modificando alcuni file NGINX. Innanzitutto, modifica il file /etc/nginx/nginx.conf in due posizioni per aggiungere alcune istruzioni per configurare NGINX in modo che utilizzi PKCS #11.

Dopo il blocco event e prima del blocco http, aggiungi le seguenti istruzioni:

ssl_engine pkcs11;
env KMS_PKCS11_CONFIG=/etc/nginx/pkcs11-config.yaml;

Nello stesso file /etc/nginx/nginx.conf, configura le istruzioni SSL per utilizzare il certificato e la relativa chiave privata in Cloud HSM. Nel blocco http aggiungi i seguenti attributi:

ssl_certificate "/etc/ssl/nginx/CA_CERT";
ssl_certificate_key "engine:pkcs11:PKCS_KEY_TYPE=KEY_IDENTIFIER";
ssl_protocols TLSv1.2 TLSv1.3; # Consider changing the default to only TLS1.2 or newer

# Consider defining the `ssl_ciphers` to use ciphers approved by your security teams and handle
# appropriate client compatibility requirements.

Il tuo file /etc/nginx/nginx.conf dovrebbe avere il seguente aspetto:

user www-data;
worker_processes auto;
pid /run/nginx.pid;
include /etc/nginx/modules-enabled/*.conf;

events {
        worker_connections 768;
        # multi_accept on;
}

ssl_engine pkcs11;
env KMS_PKCS11_CONFIG=/etc/nginx/pkcs11-config.yaml;

http {

        #...
        #...

        # SSL configuration
        ssl_certificate "/etc/ssl/nginx/CA_CERT";
        ssl_certificate_key "engine:pkcs11:pkcs11:object=NGINX_KEY";
        ssl_protocols TLSv1.2 TLSv1.3; # Dropping SSLv3, ref: POODLE
        # ssl_ciphers YOUR_CIPHERS
        ssl_prefer_server_ciphers on;

        #...
        #...

}

Configurare NGINX per l'ascolto del traffico TLS

Modifica il file /etc/nginx/sites-enabled/default per rimanere in ascolto del traffico TLS. Rimuovi il commento dalla configurazione SSL nel blocco server. La modifica risultante dovrebbe avere l'aspetto seguente:

server {
        listen 80 default_server;
        listen [::]:80 default_server;

        # SSL configuration
        listen 443 ssl default_server;
        listen [::]:443 ssl default_server;

        # ...
        # ...
}

Fornisci variabili di ambiente al servizio NGINX

Esegui questo comando:

sudo systemctl edit nginx.service

Nell'editor risultante, aggiungi le righe seguenti e sostituisci LIBPATH con il valore del percorso in cui hai installato libkmsp11.so:

[Service]
Environment="GRPC_ENABLE_FORK_SUPPORT=1"
Environment="KMS_PKCS11_CONFIG=/etc/nginx/pkcs11-config.yaml"
Environment="PKCS11_MODULE_PATH=LIBPATH/libkmsp11-1.0-linux-amd64/libkmsp11.so"

Dopo aver configurato questi valori, dovrai eseguire il seguente comando per renderli disponibili:

sudo systemctl daemon-reload

Riavvia NGINX con offload TLS

Esegui questo comando in modo che NGINX si riavvii e utilizzi la configurazione aggiornata:

sudo systemctl start nginx

Nota: se visualizzi errori al riavvio, controlla /var/log/nginx/error.log e /var/log/kmsp11/ per ulteriori dettagli.

Il test NGINX utilizza l'offload TLS su Cloud HSM

Usa openssl s_client per verificare la connessione al server NGINX eseguendo questo comando:

openssl s_client -connect localhost:443

Il client dovrebbe completare l'handshake SSL e metterlo in pausa. Il cliente è in attesa di un tuo feedback, come illustrato di seguito:

# completes SSL handshake
# ...
# ...
# ...
    Verify return code: 18 (self signed certificate)
# ...
    Max Early Data: 0
---
read R BLOCK

# When the client pauses, it’s waiting for instructions.
# Have the client get the index.html file in the root path (“/”), by typing the following:

GET /

# Press enter.
# You should now see the default NGINX index.html file.

Ora i log di controllo dovrebbero mostrare le operazioni sulla chiave NGINX_KEY. Per visualizzare i log, vai a Cloud Logging nella console Cloud. Aggiungi il seguente filtro nel progetto che stai utilizzando:

resource.type="cloudkms_cryptokeyversion"

Dopo aver eseguito la query, dovresti vedere le operazioni relative alle chiavi asimmetriche sulla chiave NGINX_KEY.

Configurazioni facoltative

Potrebbe essere necessario creare un bilanciatore del carico di rete passthrough esterno per esporre il server NGINX con un IP esterno.

Se devi utilizzare NGINX come proxy inverso con il bilanciamento del carico, valuta la possibilità di aggiornare il file di configurazione NGINX. Scopri di più sulla configurazione di NGINX come proxy inverso, leggi All-Active HA per NGINX Plus sulla Google Cloud Platform.

Passaggi successivi

Hai configurato il server NGINX per l'utilizzo dell'offload TLS su Cloud HSM.