Several configuration parameters are available to indicate whether to use encrypted connections, and to specify the appropriate certificate and key files. This section provides general guidance about configuring the server and clients for encrypted connections:
Encrypted connections also can be used in these contexts:
Between master and slave replication servers. See Setting Up Replication to Use Encrypted Connections.
Among Group Replication servers. See Securing Group Communication Connections with Secure Socket Layer (SSL).
By client programs that are based on the MySQL C API. See C API Support for Encrypted Connections.
Instructions for creating any required certificate and key files are available in Section 5.3, “Creating SSL and RSA Certificates and Keys”.
On the server side, the
option specifies that the server permits but does not require
encrypted connections. This option is enabled by default, so it
need not be specified explicitly.
These system variables on the server side specify the certificate and key files the server uses when permitting clients to establish encrypted connections:
ssl_cert: The path name of the server public key certificate file. This certificate can be sent to the client and authenticated against the CA certificate that it has.
ssl_key: The path name of the server private key file.
For example, to enable the server for encrypted connections,
start it with these lines in the
file, changing the file names as necessary:
[mysqld] ssl_ca=ca.pem ssl_cert=server-cert.pem ssl_key=server-key.pem
To specify in addition that clients are required to use
encrypted connections, enable the
[mysqld] ssl_ca=ca.pem ssl_cert=server-cert.pem ssl_key=server-key.pem require_secure_transport=ON
Each certificate and key system variable names a file in PEM
format. Should you need to create the required certificate and
key files, see Section 5.3, “Creating SSL and RSA Certificates and Keys”. MySQL
servers compiled using OpenSSL can generate missing certificate
and key files automatically at startup. See
Section 5.3.1, “Creating SSL and RSA Certificates and Keys using MySQL”.
Alternatively, if you have a MySQL source distribution, you can
test your setup using the demonstration certificate and key
files in its
The server performs certificate and key file autodiscovery. If
no explicit encrypted-connection options are given other than
--ssl (possibly along with
ssl_cipher) to configure
encrypted connections, the server attempts to enable
encrypted-connection support automatically at startup:
If the server discovers valid certificate and key files named
server-key.pemin the data directory, it enables support for encrypted connections by clients. (The files need not have been generated automatically; what matters is that they have those names and are valid.)
If the server does not find valid certificate and key files in the data directory, it continues executing but without support for encrypted connections.
If the server automatically enables encrypted connection support, it writes a note to the error log. If the server discovers that the CA certificate is self-signed, it writes a warning to the error log. (The certificate is self-signed if created automatically by the server or manually using mysql_ssl_rsa_setup.)
MySQL also provides these system variables for server-side encrypted-connection control:
ssl_cipher: The list of permissible ciphers for connection encryption.
tls_ciphersuites: Which encryption protocols and ciphersuites the server permits for encrypted connections; see Section 5.2, “Encrypted Connection TLS Protocols and Ciphers”. For example, you can set
tls_versionto prevent clients from using less-secure protocols.
If the server cannot create a valid TLS context from the system variables for server-side encrypted-connection control, the server does not support encrypted connections.
Prior to MySQL 8.0.16, the
variables that configure encrypted-connection support can be set
only at server startup. These system variables therefore
determine the TLS context the server uses for all new
As of MySQL 8.0.16, the
variables are dynamic and can be set at runtime, not just at
startup. If changed with
GLOBAL, the new values apply only until server
restart. If changed with
PERSIST, the new values also carry over to subsequent
server restarts. See SET Syntax for Variable Assignment. However,
runtime changes to these variables do not immediately affect the
TLS context for new connections, as explained later in this
Along with the change in MySQL 8.0.16 that enables runtime changes to the TLS context-related system variables, the server enables runtime updates to the actual TLS context used for new connections. This capability may be useful, for example, to avoid restarting a MySQL server that has been running so long that its SSL certificate has expired.
To create the initial TLS context, the server uses the values that the context-related system variables have at startup. To expose the context values, the server also initializes a set of corresponding status variables. The following table shows the system variables that define the TLS context and the corresponding status variables that expose the currently active context values.
Table 5.1 System and Status Variables for Server Main Connection Interface TLS Context
|System Variable Name||Corresponding Status Variable Name|
To reconfigure the TLS context at runtime, use this procedure:
For any TLS context-related system variables that should be changed, set them to their new values.
ALTER INSTANCE RELOAD TLS. This statement reconfigures the active TLS context from the current values of the TLS context-related system variables. It also sets the context-related status variables to reflect the new active context values. The statement requires the
New connections established after execution of
ALTER INSTANCE RELOAD TLSuse the new TLS context. Existing connections remain unaffected. If existing connections should be terminated, use the
The members of each pair of system and status variables may have different values temporarily due to the way the reconfiguration procedure works:
Changes to the system variables prior to
ALTER INSTANCE RELOAD TLSdo not change the TLS context. At this point, those changes have no effect on new connections, and corresponding context-related system and status variables may have different values. This enables you to make any changes required to individual system variables, then update the active TLS context atomically with
ALTER INSTANCE RELOAD TLSafter all system variable changes have been made.
ALTER INSTANCE RELOAD TLS, corresponding system and status variables have the same values. This remains true until the next change to the system variables.
In some cases,
ALTER INSTANCE RELOAD
TLS by itself may suffice to reconfigure the TLS
context, without changing any system variables. Suppose that the
certificate in the file named by
ssl_cert has expired. It is
sufficient to replace the existing file contents with a
nonexpired certificate and execute
INSTANCE RELOAD TLS to cause the new file contents to
be read and used for new connections.
As of MySQL 8.0.21, the server implements independent
connection-encryption configuration for the administrative
connection interface. See
Administrative Interface Support for Encrypted Connections.
ALTER INSTANCE RELOAD
TLS is extended with a
clause that enables specifying the channel (interface) for which
to reload the TLS context. See ALTER INSTANCE Statement.
There are no status variables to expose the administrative
interface TLS context, but the Performance Schema
tls_channel_status table exposes
TLS properties for both the main and administrative interfaces.
The tls_channel_status Table.
Updating the main interface TLS context has these effects:
The update changes the TLS context used for new connections on the main connection interface.
The update also changes the TLS context used for new connections on the administrative interface unless some nondefault TLS parameter value is configured for that interface.
The update does not affect the TLS context used by other enabled server plugins or components such as Group Replication or X Plugin:
To apply the main interface reconfiguration to Group Replication's group communication connections, which take their settings from the server's TLS context-related system variables, you must execute
STOP GROUP_REPLICATIONfollowed by
START GROUP_REPLICATIONto stop and restart Group Replication.
X Plugin initializes its TLS context at plugin initialization as described at Using Encrypted Connections with X Plugin. This context does not change thereafter.
By default, the
RELOAD TLS action rolls back
with an error and has no effect if the configuration values do
not permit creation of the new TLS context. The previous context
values continue to be used for new connections. If the optional
NO ROLLBACK ON ERROR clause is given and the
new context cannot be created, rollback does not occur. Instead,
a warning is generated and encryption is disabled for new
connections on the interface to which the statement applies.
Options that enable or disable encrypted connections on a
connection interface have an effect only at startup. For
--admin-ssl options affect only
at startup whether the main and administrative interfaces
support encrypted connections. Such options are ignored and have
no effect on the operation of
INSTANCE RELOAD TLS at runtime. For example, you can
--ssl=OFF to start the server
with encrypted connections disabled on the main interface, then
reconfigure TLS and execute
RELOAD TLS to enable encrypted connections at runtime.
For a complete list of client options related to establishment of encrypted connections, see Command Options for Encrypted Connections.
By default, MySQL client programs attempt to establish an
encrypted connection if the server supports encrypted
connections, with further control available through the
In the absence of an
--ssl-modeoption, clients attempt to connect using encryption, falling back to an unencrypted connection if an encrypted connection cannot be established. This is also the behavior with an explicit
--ssl-mode=REQUIRED, clients require an encrypted connection and fail if one cannot be established.
--ssl-mode=DISABLED, clients use an unencrypted connection.
--ssl-mode=VERIFY_IDENTITY, clients require an encrypted connection, and also perform verification against the server CA certificate and (with
VERIFY_IDENTITY) against the server host name in its certificate.
Attempts to establish an unencrypted connection fail if the
variable is enabled on the server side to cause the server to
require encrypted connections. See
Configuring Encrypted Connections as Mandatory.
The following options on the client side identify the
certificate and key files clients use when establishing
encrypted connections to the server. They are similar to the
ssl_key system variables used
on the server side, but
--ssl-key identify the client
public and private key:
--ssl-ca: The path name of the Certificate Authority (CA) certificate file. This option, if used, must specify the same certificate used by the server. (
--ssl-capathis similar but specifies the path name of a directory of CA certificate files.)
--ssl-cert: The path name of the client public key certificate file.
--ssl-key: The path name of the client private key file.
For additional security relative to that provided by the default encryption, clients can supply a CA certificate matching the one used by the server and enable host name identity verification. In this way, the server and client place their trust in the same CA certificate and the client verifies that the host to which it connected is the one intended:
Host name identity verification with
VERIFY_IDENTITY does not work with
self-signed certificates that are created automatically by the
server or manually using
Section 5.3.1, “Creating SSL and RSA Certificates and Keys using MySQL”). Such
self-signed certificates do not contain the server name as the
Common Name value.
Host name identity verification also does not work with certificates that specify the Common Name using wildcards because that name is compared verbatim to the server name.
MySQL also provides these options for client-side SSL control:
--ssl-cipher: The list of permissible ciphers for connection encryption.
--ssl-crl: The path name of the file containing certificate revocation lists. (
--ssl-crlpathis similar but specifies the path name of a directory of certificate revocation-list files.)
--tls-ciphersuites: The permitted encryption protocols and ciphersuites; see Section 5.2, “Encrypted Connection TLS Protocols and Ciphers”.
Depending on the encryption requirements of the MySQL account used by a client, the client may be required to specify certain options to connect using encryption to the MySQL server.
Suppose that you want to connect using an account that has no
special encryption requirements or that was created using a
CREATE USER statement that
REQUIRE SSL clause. Assuming
that the server supports encrypted connections, a client can
connect using encryption with no
--ssl-mode option or with an
For an account created with a
clause, the connection attempt fails if an encrypted connection
cannot be established. For an account with no special encryption
requirements, the attempt falls back to an unencrypted
connection if an encrypted connection cannot be established. To
prevent fallback and fail if an encrypted connection cannot be
obtained, connect like this:
If the account has more stringent security requirements, other options must be specified to establish an encrypted connection:
For accounts created with a
REQUIRE X509clause, clients must specify at least
--ssl-key. In addition,
--ssl-capath) is recommended so that the public certificate provided by the server can be verified. For example (enter the command on a single line):
mysql --ssl-ca=ca.pem --ssl-cert=client-cert.pem --ssl-key=client-key.pem
For accounts created with a
REQUIRE SUBJECTclause, the encryption requirements are the same as for
REQUIRE X509, but the certificate must match the issue or subject, respectively, specified in the account definition.
For additional information about the
clause, see CREATE USER Statement.
To prevent use of encryption and override other
invoke the client program with
To determine whether the current connection with the server uses
encryption, check the session value of the
Ssl_cipher status variable. If
the value is empty, the connection is not encrypted. Otherwise,
the connection is encrypted and the value indicates the
encryption cipher. For example:
mysql> SHOW SESSION STATUS LIKE 'Ssl_cipher'; +---------------+---------------------------+ | Variable_name | Value | +---------------+---------------------------+ | Ssl_cipher | DHE-RSA-AES128-GCM-SHA256 | +---------------+---------------------------+
For the mysql client, an alternative is to
command and check the
mysql> \s ... SSL: Not in use ...
mysql> \s ... SSL: Cipher in use is DHE-RSA-AES128-GCM-SHA256 ...
For some MySQL deployments it may be not only desirable but mandatory to use encrypted connections (for example, to satisfy regulatory requirements). This section discusses configuration settings that enable you to do this. These levels of control are available:
You can configure the server to require that clients connect using encrypted connections.
You can invoke individual client programs to require an encrypted connection, even if the server permits but does not require encryption.
You can configure individual MySQL accounts to be usable only over encrypted connections.
To require that clients connect using encrypted connections,
variable. For example, put these lines in the server
Alternatively, to set and persist the value at runtime, use this statement:
SET PERSIST require_secure_transport=ON;
enabled, client connections to the server are required to use
some form of secure transport, and the server permits only
TCP/IP connections that use SSL, or connections that use a
socket file (on Unix) or shared memory (on Windows). The server
rejects nonsecure connection attempts, which fail with an
To invoke a client program such that it requires an encrypted
connection whether or not the server requires encryption, use an
--ssl-mode option value of
VERIFY_IDENTITY. For example:
mysql --ssl-mode=REQUIRED mysqldump --ssl-mode=VERIFY_CA mysqladmin --ssl-mode=VERIFY_IDENTITY
To configure a MySQL account to be usable only over encrypted
connections, include a
REQUIRE clause in the
CREATE USER statement that
creates the account, specifying in that clause the encryption
characteristics you require. For example, to require an
encrypted connection and the use of a valid X.509 certificate,
CREATE USER 'jeffrey'@'localhost' REQUIRE X509;
For additional information about the
clause, see CREATE USER Statement.
To modify existing accounts that have no encryption
requirements, use the