DBeaver Public Key Retrieval Not Allowed: Causes, Solutions, and Best Practices

When using DBeaver to connect to databases, you might encounter the error message “Public Key Retrieval is not allowed.” This issue is common and occurs because DBeaver needs to retrieve a public key from the database server for secure connections. However, by default, this retrieval is disabled for security reasons. This error can prevent successful database connections, making it a relevant concern for users.

Understanding the Error

The “Public Key Retrieval is not allowed” error in DBeaver occurs when attempting to connect to a MySQL database. This error is due to the MySQL server’s security settings, which prevent automatic retrieval of the public key required for secure connections.

Technical Background

MySQL uses public key cryptography to secure connections. When a client (like DBeaver) connects to the MySQL server, it needs the server’s public key to establish a secure connection. By default, MySQL does not allow clients to automatically retrieve this public key for security reasons.

Why It Occurs

1. Security Settings: MySQL’s default configuration disables automatic public key retrieval to prevent unauthorized access.
2. Connection Properties: If the allowPublicKeyRetrieval property is not set to true in the connection settings, DBeaver cannot retrieve the public key, leading to this error.

To resolve this, you need to modify the connection properties in DBeaver:

1. Right-click your connection and select “Edit Connection”.
2. Go to “Edit Driver Settings”.
3. Add the property allowPublicKeyRetrieval and set it to true.
4. Optionally, set useSSL to false if SSL is not required.

This configuration change allows DBeaver to retrieve the public key and establish a secure connection.

Common Causes

Here are the common causes of the “DBeaver public key retrieval is not allowed” error:

1. Public Key Retrieval Disabled:

   • The database server configuration has public key retrieval disabled. This can be fixed by enabling the allowPublicKeyRetrieval property in the connection settings.

2. Incorrect SSH Server Configuration:

   • The SSH server is not configured to allow public key authentication. Ensure that the SSH server is set up correctly to permit public key authentication.

3. Public Key Not Stored Correctly:

   • The public key is not stored in the correct location on the SSH server. Verify that the public key is placed in the appropriate directory.

4. Invalid Public Key Format:

   • The public key is not in the correct format. Ensure that the public key is properly formatted and compatible with the SSH server.

5. SSL Settings:

   • SSL settings might be causing issues. Adjust the connection properties to disable SSL if it’s not required by setting useSSL to false.

These steps should help you troubleshoot and resolve the error.

Step-by-Step Solution

Here’s a detailed, step-by-step guide to resolve the ‘DBeaver public key retrieval is not allowed’ error:

1. Open DBeaver:

   • Launch DBeaver on your computer.

2. Edit Connection:

   • Right-click on your database connection.
   • Select Edit Connection.

3. Edit Driver Settings:

   • In the Connection settings window, click on Edit Driver Settings.

4. Access Driver Properties:

   • Navigate to the Driver properties tab (sometimes labeled as Connection properties).

5. Add New Properties:

   • Right-click in the User properties area and select Add new property.
   • Add the following properties:
     • Property Name: allowPublicKeyRetrieval
     • Value: true
     • Property Name: useSSL
     • Value: false

6. Save and Test Connection:

   • Click OK to save the changes.
   • Test your connection to ensure the error is resolved.

These steps should help you bypass the ‘public key retrieval is not allowed’ error in DBeaver.

Preventive Measures

1. Enable Public Key Retrieval: In DBeaver, go to Edit Connection > Edit Driver Settings > Connection Properties. Add allowPublicKeyRetrieval=true.

2. Disable SSL: Set useSSL=false in the same Connection Properties section.

3. Update Database Configuration: Ensure your database server allows public key retrieval by configuring the server settings appropriately.

4. Use Secure Connections: If disabling SSL, ensure your network is secure to prevent data interception.

5. Regular Updates: Keep DBeaver and your database drivers up to date to avoid compatibility issues.

6. Backup Configurations: Regularly backup your connection settings to quickly restore them if needed.

These steps should help maintain a stable and secure connection to your database.

The ‘DBeaver public key retrieval is not allowed’ error

occurs when DBeaver cannot retrieve a public key from the MySQL server for secure connections, due to security settings or incorrect connection properties.

To resolve this issue, users need to modify their connection properties in DBeaver by adding the property 'allowPublicKeyRetrieval=true'.

Additionally, disabling SSL by setting 'useSSL=false' can also help.

Proper configuration of database servers and regular updates of DBeaver and drivers are essential for maintaining smooth database connections.

Users should also ensure that their network is secure when disabling SSL.