Bugzilla – Attachment 152075 Details for
Bug 33934
'No encryption_key in koha-conf.xml' needs more detail
Home
|
New
|
Browse
|
Search
|
[?]
|
Reports
|
Help
|
New Account
|
Log In
[x]
|
Forgot Password
Login:
[x]
[patch]
Bug 33934: Add more detail to 'No encryption_key in koha-conf.xml'
Bug-33934-Add-more-detail-to-No-encryptionkey-in-k.patch (text/plain), 2.53 KB, created by
David Nind
on 2023-06-07 08:00:53 UTC
(
hide
)
Description:
Bug 33934: Add more detail to 'No encryption_key in koha-conf.xml'
Filename:
MIME Type:
Creator:
David Nind
Created:
2023-06-07 08:00:53 UTC
Size:
2.53 KB
patch
obsolete
>From 4cc404a197ab6462b94542b202f3d7bc405b6414 Mon Sep 17 00:00:00 2001 >From: Jonathan Druart <jonathan.druart@bugs.koha-community.org> >Date: Wed, 7 Jun 2023 09:30:15 +0200 >Subject: [PATCH] Bug 33934: Add more detail to 'No encryption_key in > koha-conf.xml' > >If encryption_key is not set in $KOHA_CONF we are raising an exception. > >This key was only needed for a couple of feature, but now we are using Koha::Encryption from the update DB process, and so the upgrade fails with no more info than 'No encryption_key in koha-conf.xml'. > >We need to provide more detail in this error. > >Additionally we reject "__ENCRYPTION_KEY__", in case people will simple >copy/paste that > >Test plan: >Apply the patch >Edit $KOHA_CONf, remove the encryption_key entry (or blank) >restart_all >Go to the about page and enable 2FA >=> warning on the about page, and 500 server-side are displaying more >info about how to generate the missing entry >Edit $KOHA_CONF and set the value to __ENCRYPTION_KEY__ >restart_all >=> Same messages >Edit $KOHA_CONF and set a correct value >restart_all >=> No error, everything is working correctly > >Signed-off-by: David Nind <david@davidnind.com> >--- > Koha/Encryption.pm | 10 ++++++---- > about.pl | 3 ++- > 2 files changed, 8 insertions(+), 5 deletions(-) > >diff --git a/Koha/Encryption.pm b/Koha/Encryption.pm >index 8dbeddf1b7..faa7dbb3f8 100644 >--- a/Koha/Encryption.pm >+++ b/Koha/Encryption.pm >@@ -54,12 +54,14 @@ It's based on Crypt::CBC > > sub new { > my ( $class ) = @_; >- my $key = C4::Context->config('encryption_key'); >- if( !$key ) { >- Koha::Exceptions::MissingParameter->throw('No encryption_key in koha-conf.xml'); >+ my $encryption_key = C4::Context->config('encryption_key'); >+ if ( !$encryption_key || $encryption_key eq '__ENCRYPTION_KEY__') { >+ Koha::Exceptions::MissingParameter->throw( >+ q{No encryption_key in koha-conf.xml. Please generate a key. We recommend one of at least 32 bytes. (You might use 'pwgen 32' to do so.)} >+ ); > } > return $class->SUPER::new( >- -key => $key, >+ -key => $encryption_key, > -cipher => 'Cipher::AES' > ); > } >diff --git a/about.pl b/about.pl >index 7ac404bdb1..b4b57b115d 100755 >--- a/about.pl >+++ b/about.pl >@@ -281,7 +281,8 @@ if ( ! C4::Context->config('tmp_path') ) { > } > } > >-if( ! C4::Context->config('encryption_key') ) { >+my $encryption_key = C4::Context->config('encryption_key'); >+if ( !$encryption_key || $encryption_key eq '__ENCRYPTION_KEY__') { > push @xml_config_warnings, { error => 'encryption_key_missing' }; > } > >-- >2.30.2
You cannot view the attachment while viewing its details because your browser does not support IFRAMEs.
View the attachment on a separate page
.
View Attachment As Diff
View Attachment As Raw
Actions:
View
|
Diff
|
Splinter Review
Attachments on
bug 33934
:
152074
|
152075
|
152076