DOC Update secure coding documentation to reflect best practices #696
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`_config.php` used to be very common for configuration, but more and more we're preferring YAML configuration. I've never seen a project use the php API for this, since it doesn't allow as much configuration as the YAML API does.
GuySartorelli
commented
Feb 16, 2025
Comment on lines
+803
to
+813
| ### Using SSL in database connections | ||
|
|
||
| In some circumstances, like connecting to a database on a remote host for example, you may wish to enable SSL encryption to ensure the protection of sensitive information and database access credentials. | ||
| You can configure that by setting the following environment variables: | ||
|
|
||
| | Name | Description | | ||
| | ---- | ----------- | | ||
| | `SS_DATABASE_SSL_KEY` | Absolute path to SSL key file (optional - but if set, `SS_DATABASE_SSL_CERT` must also be set) | | ||
| | `SS_DATABASE_SSL_CERT` | Absolute path to SSL certificate file (optional - but if set, `SS_DATABASE_SSL_KEY` must also be set) | | ||
| | `SS_DATABASE_SSL_CA` | Absolute path to SSL Certificate Authority bundle file (optional) | | ||
| | `SS_DATABASE_SSL_CIPHER` | Custom SSL cipher for database connections (optional) | |
There was a problem hiding this comment.
Makes sense to move this to be adjacent to the other bit of docs talking about TLS.
GuySartorelli
commented
Feb 16, 2025
| | `SS_DATABASE_SSL_CA` | Absolute path to SSL Certificate Authority bundle file (optional) | | ||
| | `SS_DATABASE_SSL_CIPHER` | Custom SSL cipher for database connections (optional) | | ||
|
|
||
| ## Secure sessions and cookies |
There was a problem hiding this comment.
Makes sense to separate this into its own section - secure cookies and TLS are sort-of related but I don't think enough so to join them together like that.
GuySartorelli
commented
Feb 16, 2025
|
|
||
| if (!Director::isDev()) { | ||
| Director::forceSSL(); |
There was a problem hiding this comment.
This API does exist but it's a lot less powerful than configuring via YAML because
- there are a lot of options on
CanonicalURLMiddlewarethat can't be set via director (even the rest of this old docs has to instantiate a singleton of the middleware to set something) - you ideally want everything configuring this in the same place - so if you have to set some of it in YAML and then some here, that's hard to notice and may cause problems
- I'd expect basically every project that configures
CanonicalURLMiddlewareuses YAML, following CWP's example.
Basically there's no good reason to be setting this in _config.php
emteknetnz
approved these changes
Feb 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Two commits here - if you squash, make sure the commit message is broad enough to encompass both of them.
Commit 1: Update best practice for setting
CanonicalURLMiddleware.ForceSSLCommit 2: Backport of #692 minus the bit about the warning. The beta has been delayed and it's possible the blog post will be live before we swap over the source of documentation.
Issue