Skip to content
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.

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

Issue #8 - Better helptext about placement of key file #9

Open
wants to merge 3 commits into
base: 1.x-3.x
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,9 @@ when editing, making it even more important that this provider not be
used in a production environment.
* **File:** Stores the key in a file, which can be anywhere in the file
system, as long as it's readable by the user that runs the web server.
Storing the key in a file outside of the web root is generally more
secure than storing it in the database.
You will be required to manually create this file with the key and place
it on your server. Storing the key in a file outside of the web root is
generally more secure than storing it in the database.

Both the Configuration and File provider plugins support storing the
key with Base64 encoding.
Expand Down
2 changes: 1 addition & 1 deletion plugins/key_provider/file.inc
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ function key_provider_file_build_configuration_form($form, &$form_state) {
$form['file_location'] = array(
'#type' => 'textfield',
'#title' => t('File location'),
'#description' => t('The location of the file in which the key will be stored. The path may be absolute (e.g., %abs), relative to the Backdrop directory (e.g., %rel), or defined using a stream wrapper (e.g., %str).',
'#description' => t('The location of the file in which the key will be stored. The path may be absolute (e.g., %abs), relative to the Backdrop directory (e.g., %rel), or defined using a stream wrapper (e.g., %str). You will need to manually place this file on your server with the key in it.',
array(
'%abs' => '/etc/keys/foobar.key',
'%rel' => '../keys/foobar.key',
Expand Down