-
Notifications
You must be signed in to change notification settings - Fork 5
/
readme.txt
128 lines (78 loc) · 4.72 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
=== Secure DB Connection ===
Contributors: HypertextRanch
Tags: db, mysql, secure, encrypted, ssl
Donate link: https://cash.me/$xyu
Requires at least: 4.9
Tested up to: 4.9.6
Requires PHP: 5.2.4
Stable tag: 1.1.6
License: GPLv3
License URI: http://www.gnu.org/licenses/gpl-3.0.html
Sets SSL keys and certs for encrypted MySQL database connections.
== Description ==
Depending on the MySQL server setup the SSL certs used may not be in the trusted store, if that's the case `mysqli_ssl_set()` needs to be called to set custom keys and certs before connect. This Plugin adds a custom DB class that allows these settings to be configured via custom constants.
This plugin will also add a custom item on the "At a Glance" section of the Dashboard to show if the `$wpdb` connection is secure or not.
Also find me on [GitHub](https://github.com/xyu/secure-db-connection).
== Installation ==
For detailed installation instructions, please read the [standard installation procedure for WordPress plugins](http://codex.wordpress.org/Managing_Plugins#Installing_Plugins).
1. Install and activate plugin, if the filesystem is writable the Secure DB Connection dropin will be installed for you automatically. If not proceed to step 2
2. Symlink or copy the `db.php` file from the `/wp-content/plugins/secure-db-connection/lib/` directory to the `/wp-content/` directory.
3. Set the relevant defines in your `wp-config.php` file.
= Configuration Parameters =
To adjust the configuration, define any of the following applicable constants in your `wp-config.php` file.
* `MYSQL_SSL_KEY` [default: not set]
The path name to the key file. (RSA Key)
* `MYSQL_SSL_CERT` [default: not set]
The path name to the certificate file.
* `MYSQL_SSL_CA` [default: not set]
The path name to the certificate authority file in PEM format.
* `MYSQL_SSL_CA_PATH` [default: not set]
The pathname to a directory that contains trusted SSL CA certificates in PEM format.
* `MYSQL_SSL_CIPHER` [default: not set]
A list of allowable ciphers to use for SSL encryption. You can leave this blank if you want to just use the strongest available.
= Turning on SSL =
First please note, only the `mysqli` (MySQL Improved) extension is supported this is the default extension used by WordPress however if you do not have the extension installed WordPress will fallback on the much older mysql extension which does not support secure connections.
Depending on your database configuration you may not need to set all the available options. For example when connecting to RDS Amazon helpfully provides a certificate bundle so once that's downloaded to the server all that's need is to set the CA option:
define(
'MYSQL_SSL_CA',
'/path/to/rds-combined-ca-bundle.pem'
);
Once SSL keys / certs have been configured you via the defines above define an WP core constant to pass a use SSL flag to the mysqli client also in your `wp-config.php` file.
define(
'MYSQL_CLIENT_FLAGS',
MYSQLI_CLIENT_SSL
);
If you are using the MySQL Native Driver and MySQL 5.6 or later `mysqli_real_connect()` will verify the server SSL certificate before connecting. If the SSL cert installed on the MySQL server your are connecting to is not valid PHP will refuse to connect. A flag was added to disable server certificate validation. If your server has an invalid certificate turn on SSL and turn off validation like so:
define(
'MYSQL_CLIENT_FLAGS',
MYSQLI_CLIENT_SSL |
MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT
);
= Example Config =
Aside from setting the normal MySQL connection parameters the minimum configs to get SSL connections to the database will look something like this in `wp-config.php`:
define( 'MYSQL_SSL_CA', '/path/to/ca-bundle.pem' );
define( 'MYSQL_CLIENT_FLAGS', MYSQLI_CLIENT_SSL );
== Screenshots ==
1. An at a glance item is added showing the status of the MySQL connection when this plugin is activated. If the connection is encrypted the SSL version and cipher used will also be shown.
== Changelog ==
= 1.1.6 =
* Cleanup GitHub repo, remove screenshot image
* Minor code cleanup
= 1.1.5 =
* PHP backwards compatibility with versions prior to 5.5
* Syncs DB connect code with WP Core 4.9 (Fixes https://core.trac.wordpress.org/ticket/41722)
= 1.1.4 =
* Update version numbers in file headers.
= 1.1.3 =
* Better PHP backwards compatibility.
= 1.1.2 =
* Only set MySQL SSL opts if secure connections are requested.
= 1.1.1 =
* Retag release to fix version inconsistency
= 1.1.0 =
* Fix status message for when DB connection is not SSL enabled
* Automatically install and remove db.php dropin on activate / deactivate
* Check and report status of dropin
* Add i18n support
= 1.0 =
* Initial release