MySQL

The current server implementation is functional up to the point of client authentication. NTLM and SPNEGO authentication mechanisms are not yet supported and are planned for a future release.

By default, the server will log any client attempts to initiate SSL negotiation. If a certificate is not configured, the server will terminate the connection due to the missing TLS implementation.

Section [MySQL]

Added in version 1.0.0.dev7.

MySQL.Port: int = 3306

Maps to mysql.MySQLConfig.mysql_port

Specifies the port the MySQL server listens on.

MySQL.ServerVersion: str = "8.0.42"

Maps to mysql.MySQLConfig.mysql_version

Sets the server version string returned to clients.

MySQL.AuthPlugin: str = "mysql_clear_password"

Maps to mysql.MySQLConfig.mysql_plugin_name. Reserved for future use.

Attention

Currently non-functional: support for alternative authentication plugins (e.g. caching_sha2_password, mysql_native_password) is planned for a future release.

Error Configuration

MySQL.ErrorCode: int = 1045

Maps to mysql.MySQLConfig.mysql_error_code

Sets the error code returned to clients after authentication.

MySQL.ErrorMessage: str = "Access denied for user"

Maps to mysql.MySQLConfig.mysql_error_msg

Sets the error message returned to clients.

SSL Configuration

MySQL.TLS: bool = false

Maps to mysql.MySQLConfig.use_ssl

Enables SSL/TLS support using a custom certificate. The server will set the CLIENT_SSL capability flag to prompt clients to upgrade to a secure connection.

MySQL.Cert: str

Maps to mysql.MySQLConfig.certfile. Can also be set in [Globals]

Specifies the path to the certificate file used when TLS is enabled.

MySQL.Key: str

Maps to mysql.MySQLConfig.keyfile. Can also be set in [Globals]

Specifies the path to the private key file associated with the TLS certificate.

Default Configuration

MySQL configuration section (default values)
1[MySQL]
2Port = 3305
3ServerVersion = "8.0.42"
4ErrorCode = 1045
5ErrorMessage = "Access denied for user"