Skip to content

Add SSL flag #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
swissspidy merged 16 commits into from
Jul 28, 2025
Merged

Add SSL flag #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
85d5fc4
Add SSL flag
michaelw85 Jun 6, 2025
606a34e
Add behat test creating user requiring ssl connection and creating a …
michaelw85 Jul 25, 2025
41944d8
Merge branch 'main' into 113_add_ssl_flag
michaelw85 Jul 25, 2025
3e71b2e
Fix test
michaelw85 Jul 25, 2025
78a85ad
Use different var for root pw
michaelw85 Jul 25, 2025
ade7746
Add host to try and fix tests
michaelw85 Jul 25, 2025
3e7d309
retry with different var
michaelw85 Jul 25, 2025
afbd674
Add port
michaelw85 Jul 25, 2025
bae6126
Attempt to get test working for ancient mysql version
michaelw85 Jul 25, 2025
4266069
Update mysql syntax to try and make it compatible with mysql 5.6
michaelw85 Jul 25, 2025
b15e3be
Swap run with try so it doesnt fail locally if the user exists
michaelw85 Jul 25, 2025
db853e7
Update host for user
michaelw85 Jul 25, 2025
cf5db36
Limit test to mysql 5.7 and up due to SQL syntax
michaelw85 Jul 28, 2025
b27a45a
Add check for mariadb
michaelw85 Jul 28, 2025
c26491e
Add require mysql to exclude sql lite
michaelw85 Jul 28, 2025
9f3e367
Adjust docs
swissspidy Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions features/config-create.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,3 +242,16 @@ Feature: Create a wp-config file
"""
PasswordWith'SingleQuotes'
"""

@require-mysql @require-mysql-5.7
Scenario: Configure with required SSL connection
Given an empty directory
And WP files
And I run `MYSQL_PWD='{DB_ROOT_PASSWORD}' MYSQL_HOST='{MYSQL_HOST}' MYSQL_TCP_PORT='{MYSQL_PORT}' mysql -u root -e "CREATE USER IF NOT EXISTS 'wp_cli_test_ssl'@'%' IDENTIFIED BY 'password2' REQUIRE SSL;"`

When I try `wp config create --dbhost=127.0.0.1 --dbname=wp_cli_test --dbuser=wp_cli_test_ssl --dbpass=password2 --ssl`
Then the return code should be 0
And the wp-config.php file should contain:
"""
define( 'DB_USER', 'wp_cli_test_ssl' )
"""
14 changes: 12 additions & 2 deletions src/Config_Command.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,9 @@ private static function get_initial_locale() {
* [--insecure]
* : Retry API download without certificate validation if TLS handshake fails. Note: This makes the request vulnerable to a MITM attack.
*
* [--ssl]
* : Use SSL when checking the database connection.
*
* ## EXAMPLES
*
* # Standard wp-config.php file
Expand Down Expand Up @@ -201,6 +204,7 @@ public function create( $_, $assoc_args ) {
'dbcollate' => '',
'locale' => self::get_initial_locale(),
'config-file' => rtrim( ABSPATH, '/\\' ) . '/wp-config.php',
'ssl' => false,
];
$assoc_args = array_merge( $defaults, $assoc_args );
if ( empty( $assoc_args['dbprefix'] ) ) {
Expand Down Expand Up @@ -231,12 +235,18 @@ public function create( $_, $assoc_args ) {
$host = substr( $host, 0, $socket_pos );
}

$flags = 0;

if ( $assoc_args['ssl'] ) {
$flags = MYSQLI_CLIENT_SSL;
}

if ( file_exists( $socket ) ) {
// If dbhost is a path to a socket
mysqli_real_connect( $mysql, null, $assoc_args['dbuser'], $assoc_args['dbpass'], null, null, $socket );
mysqli_real_connect( $mysql, null, $assoc_args['dbuser'], $assoc_args['dbpass'], null, null, $socket, $flags );
} else {
// If dbhost is a hostname or IP address
mysqli_real_connect( $mysql, $host, $assoc_args['dbuser'], $assoc_args['dbpass'] );
mysqli_real_connect( $mysql, $host, $assoc_args['dbuser'], $assoc_args['dbpass'], null, null, null, $flags );
}
} catch ( mysqli_sql_exception $exception ) {
WP_CLI::error( 'Database connection error (' . $exception->getCode() . ') ' . $exception->getMessage() );
Expand Down