Reference
set ssl ca-file
Available since
- HAProxy 2.5
- HAProxy Enterprise 2.5r1
Reset an SSL CA file with new certificates.
Description Jump to heading
Reset an SSL CA file with new certificates. The command creates a new runtime CA file into which the certificates contained in the payload are stored.
The CA file is kept in a temporary transaction until the transaction is committed with commit ssl ca-file
, at which time it is stored in runtime memory. If a transaction with the same filename already exists, the previous CA file entry is deleted and replaced by the new one.
Use the add ssl crt-list
command to add the CA file to a cert list in memory.
Optionally, you can use abort ssl ca-file
to abort the transaction.
As of version 2.7r1
, If you want to add multiple certificates separately, use the add ssl ca-file
command. Unlike set ssl ca-file
, the add ssl ca-file
command does not reset (clear) the CA file before adding certificates.
When you use the Runtime API, your changes take effect in the memory of the running load balancer, but are not stored on disk. They will therefore be lost when the load balancer stops.
This operation changes only the CA list in memory. To make the changes permanent, also make the changes to the CA file on disk.
Examples Jump to heading
Reset cafile.pem
with the certificates from rootCA.crt
. Then commit the transaction.
nix
echo -e "set ssl ca-file cafile.pem <<\n$(cat rootCA.crt)\n" | \sudo socat stdio tcp4-connect:127.0.0.1:9999
nix
echo -e "set ssl ca-file cafile.pem <<\n$(cat rootCA.crt)\n" | \sudo socat stdio tcp4-connect:127.0.0.1:9999
nix
echo "commit ssl ca-file cafile.pem" | \sudo socat stdio tcp4-connect:127.0.0.1:9999
nix
echo "commit ssl ca-file cafile.pem" | \sudo socat stdio tcp4-connect:127.0.0.1:9999
Example workflow Jump to heading
This operation is generally performed as part of a series of transactions used to manage CA files. You can manage CA files for different domains by passing them to the add ssl crt-list
command.
The example in this section demonstrates how to upload a new CA file and attach it to the load balancer’s running configuration.
Verify client certificates Jump to heading
The simplest way to configure an application to use a CA file for verifying client certificates is to specify the CA file or directory in the frontend configuration.
-
Declare the CA file or directory in the frontend
bind
directive using theca-file
orca-verify-file
parameter. The argument passed to theca-file
parameter can be a specific CA file or a directory containing CA files. The file or directory must already exist.haproxyfrontend fe_mainmode httpbind :80bind :443 ssl crt /etc/hapee-3.0/ssl.pem alpn h2 verify required ca-file /etc/hapee-3.0/intermediate-ca.crt ca-verify-file /etc/hapee-3.0/root-ca.crthttp-request redirect scheme https unless { ssl_fc }default_backend servershaproxyfrontend fe_mainmode httpbind :80bind :443 ssl crt /etc/hapee-3.0/ssl.pem alpn h2 verify required ca-file /etc/hapee-3.0/intermediate-ca.crt ca-verify-file /etc/hapee-3.0/root-ca.crthttp-request redirect scheme https unless { ssl_fc }default_backend servers
Use the Runtime API to update a CA file Jump to heading
There are Runtime API commands for modifying CA file contents during runtime.
You can:
- replace the contents of a CA file entirely using the
set ssl ca-file
command - add certificates to the existing content using the
add ssl ca-file
command - remove the contents of a CA file in memory using
del ssl ca-file
These commands initiate a transaction, and the modifications are not in effect until the transaction is committed with the commit ssl ca-file
command. Alternatively, you can abandon the changes with the abort ssl ca-file
command.
Changes made to the runtime CA file exist only in the memory of the running proxy process and are not reflected in the CA file on disk. If you need CA changes to be persisted beyond the current proxy session, you must modify the CA file on disk.
To modify the runtime CA file, follow these steps.
-
To replace the CA file contents with new certificates, use the
set ssl ca-file
command.nixecho -e "set ssl ca-file /etc/hapee-3.0/intermediate-ca.crt <<\n$(cat ./new_certificate.pem)\n" | \sudo socat stdio tcp4-connect:127.0.0.1:9999nixecho -e "set ssl ca-file /etc/hapee-3.0/intermediate-ca.crt <<\n$(cat ./new_certificate.pem)\n" | \sudo socat stdio tcp4-connect:127.0.0.1:9999outputtexttransaction created for CA /etc/hapee-3.0/intermediate-ca.crt!outputtexttransaction created for CA /etc/hapee-3.0/intermediate-ca.crt! -
To add an entry to a CA file, use the
add ssl ca-file
command.nixecho -e "add ssl ca-file /etc/hapee-3.0/intermediate-ca.crt <<\n(cat ./new_certificate2.pem)\n" | \sudo socat stdio tcp4-connect:127.0.0.1:9999nixecho -e "add ssl ca-file /etc/hapee-3.0/intermediate-ca.crt <<\n(cat ./new_certificate2.pem)\n" | \sudo socat stdio tcp4-connect:127.0.0.1:9999outputtexttransaction updated for CA /etc/hapee-3.0/intermediate-ca.crt!outputtexttransaction updated for CA /etc/hapee-3.0/intermediate-ca.crt! -
Updates to the CA file in memory do not take effect until the transaction is committed. Commit the transaction:
nixecho -e "commit ssl ca-file /etc/hapee-3.0/intermediate-ca.crt" | \sudo socat stdio tcp4-connect:127.0.0.1:9999nixecho -e "commit ssl ca-file /etc/hapee-3.0/intermediate-ca.crt" | \sudo socat stdio tcp4-connect:127.0.0.1:9999outputtextCommitting /etc/hapee-3.0/intermediate-ca.crtSuccess!outputtextCommitting /etc/hapee-3.0/intermediate-ca.crtSuccess! -
Use
show ssl ca-file
to verify that the CA file was updated correctly:nixecho "show ssl ca-file /etc/hapee-3.0/intermediate-ca.crt" | \sudo socat stdio tcp4-connect:127.0.0.1:9999nixecho "show ssl ca-file /etc/hapee-3.0/intermediate-ca.crt" | \sudo socat stdio tcp4-connect:127.0.0.1:9999outputtextFilename: /etc/hapee-3.0/intermediate-ca.crtStatus: UnusedCertificate #1:Serial: 03BB662E4A45FE7E576F3C22195ADDC0notBefore: Nov 9 00:00:00 1994 GMTnotAfter: Jan 7 23:59:59 2010 GMTSubject Alternative Name:Algorithm: RSA1000SHA1 FingerPrint: 4463A531B4BCA1004794612BC646D3BF8233846FSubject: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityIssuer: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityCertificate #2:Serial: 04BB662E4A45FE7E576F3C22195AEDC0notBefore: Nov 9 00:00:00 1994 GMTnotAfter: Jan 7 23:59:59 2010 GMTSubject Alternative Name:Algorithm: RSA1000SHA1 FingerPrint: 2463A531B4BCA1004794212BC646D3BF8233846DSubject: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityIssuer: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityoutputtextFilename: /etc/hapee-3.0/intermediate-ca.crtStatus: UnusedCertificate #1:Serial: 03BB662E4A45FE7E576F3C22195ADDC0notBefore: Nov 9 00:00:00 1994 GMTnotAfter: Jan 7 23:59:59 2010 GMTSubject Alternative Name:Algorithm: RSA1000SHA1 FingerPrint: 4463A531B4BCA1004794612BC646D3BF8233846FSubject: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityIssuer: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityCertificate #2:Serial: 04BB662E4A45FE7E576F3C22195AEDC0notBefore: Nov 9 00:00:00 1994 GMTnotAfter: Jan 7 23:59:59 2010 GMTSubject Alternative Name:Algorithm: RSA1000SHA1 FingerPrint: 2463A531B4BCA1004794212BC646D3BF8233846DSubject: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification AuthorityIssuer: /C=US/O=RSA Data Security, Inc./OU=Secure Server Certification Authority -
To delete a CA file in memory, use
del ssl ca-file
.nixecho -e "del ssl ca-file /etc/hapee-3.0/intermediate-ca.crt" | \sudo socat stdio tcp4-connect:127.0.0.1:9999nixecho -e "del ssl ca-file /etc/hapee-3.0/intermediate-ca.crt" | \sudo socat stdio tcp4-connect:127.0.0.1:9999outputtextCA file '/etc/hapee-3.0/intermediate-ca.crt' deleted!outputtextCA file '/etc/hapee-3.0/intermediate-ca.crt' deleted!
Verify server certificates Jump to heading
To use CA files to verify server certificates, specify the CA file using the ca-file
parameter in the backend server
or default-server
directive.
The server
directive must also specify:
-
the
ssl
parameter to enable HTTPS communication -
the
verify required
parameter to verify the server SSL certificate against the CA’s provided in the CA filehaproxybackend web_serversmode httpserver s1 192.168.1.25:80 ssl verify required ca-file /etc/hapee-3.0/server-trusted-ca.crtserver s2 192.168.1.26:80 ssl verify required ca-file /etc/hapee-3.0/server-trusted-ca.crtserver s3 192.168.1.27:80 ssl verify required ca-file /etc/hapee-3.0/server-trusted-ca.crthaproxybackend web_serversmode httpserver s1 192.168.1.25:80 ssl verify required ca-file /etc/hapee-3.0/server-trusted-ca.crtserver s2 192.168.1.26:80 ssl verify required ca-file /etc/hapee-3.0/server-trusted-ca.crtserver s3 192.168.1.27:80 ssl verify required ca-file /etc/hapee-3.0/server-trusted-ca.crt
See also Jump to heading
Do you have any suggestions on how we can improve the content of this page?