From 8bf1e6cd5d0036c7c84076f2599ffecec3ef84db Mon Sep 17 00:00:00 2001 From: Jonathan Prykop Date: Tue, 20 Dec 2016 14:05:08 -0600 Subject: [PATCH] 73085: Enable credit card/ach encryption on a live system [v3 merge] --- FS-Test/bin/freeside-test-stop | 2 +- FS/FS/Setup.pm | 6 ++ FS/FS/Upgrade.pm | 3 +- FS/FS/cust_main.pm | 84 +++++++++++++++++++++++++++ FS/t/suite/15-activate_encryption.t | 110 ++++++++++++++++++++++++++++++++++++ 5 files changed, 203 insertions(+), 2 deletions(-) create mode 100755 FS/t/suite/15-activate_encryption.t diff --git a/FS-Test/bin/freeside-test-stop b/FS-Test/bin/freeside-test-stop index 5e221a85b..ad355c3de 100755 --- a/FS-Test/bin/freeside-test-stop +++ b/FS-Test/bin/freeside-test-stop @@ -22,7 +22,7 @@ if (sudo grep -q '^test:' /usr/local/etc/freeside/htpasswd); then oldhtpasswd=$( cd /usr/local/etc/freeside; \ ls |grep -P 'htpasswd_\d{8}' | \ sort -nr |head -1 ) - if [ -f $oldhtpasswd ]; then + if [ -f /usr/local/etc/freeside/$oldhtpasswd ]; then echo "Renaming $oldhtpasswd to htpasswd." sudo mv /usr/local/etc/freeside/$oldhtpasswd \ /usr/local/etc/freeside/htpasswd diff --git a/FS/FS/Setup.pm b/FS/FS/Setup.pm index cac26c1f5..f09291920 100644 --- a/FS/FS/Setup.pm +++ b/FS/FS/Setup.pm @@ -84,6 +84,12 @@ sub enable_encryption { $conf->set('encryptionpublickey', $rsa->get_public_key_string ); $conf->set('encryptionprivatekey', $rsa->get_private_key_string ); + # reload Record globals, false laziness with FS::Record + $FS::Record::conf_encryption = $conf->exists('encryption'); + $FS::Record::conf_encryptionmodule = $conf->config('encryptionmodule'); + $FS::Record::conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey')); + $FS::Record::conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey')); + } sub populate_numbering { diff --git a/FS/FS/Upgrade.pm b/FS/FS/Upgrade.pm index d06b7d8a7..576cdf072 100644 --- a/FS/FS/Upgrade.pm +++ b/FS/FS/Upgrade.pm @@ -332,7 +332,8 @@ sub upgrade_data { #fix whitespace - before cust_main 'cust_location' => [], - #cust_main (remove paycvv from history) + #cust_main (tokenizes cards, remove paycvv from history, locations, cust_payby, etc) + # (handles payinfo encryption/tokenization across all relevant tables) 'cust_main' => [], #msgcat diff --git a/FS/FS/cust_main.pm b/FS/FS/cust_main.pm index 0165bc479..2343fc67b 100644 --- a/FS/FS/cust_main.pm +++ b/FS/FS/cust_main.pm @@ -5734,6 +5734,90 @@ sub _upgrade_data { #class method $class->_upgrade_otaker(%opts); + # turn on encryption as part of regular upgrade, so all new records are immediately encrypted + # existing records will be encrypted in queueable_upgrade (below) + unless ($conf->exists('encryptionpublickey') || $conf->exists('encryptionprivatekey')) { + eval "use FS::Setup"; + die $@ if $@; + FS::Setup::enable_encryption(); + } + +} + +sub queueable_upgrade { + my $class = shift; + + ### encryption gets turned on in _upgrade_data, above + + eval "use FS::upgrade_journal"; + die $@ if $@; + + # prior to 2013 (commit f16665c9) payinfo was stored in history if not encrypted, + # clear that out before encrypting/tokenizing anything else + if (!FS::upgrade_journal->is_done('clear_payinfo_history')) { + foreach my $table ('cust_main','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') { + my $sql = 'UPDATE h_'.$table.' SET payinfo = NULL WHERE payinfo IS NOT NULL'; + my $sth = dbh->prepare($sql) or die dbh->errstr; + $sth->execute or die $sth->errstr; + } + FS::upgrade_journal->set_done('clear_payinfo_history'); + } + + # encrypt old records + if ($conf->exists('encryption') && !FS::upgrade_journal->is_done('encryption_check')) { + + # allow replacement of closed cust_pay/cust_refund records + local $FS::payinfo_Mixin::allow_closed_replace = 1; + + # because it looks like nothing's changing + local $FS::Record::no_update_diff = 1; + + # commit everything immediately + local $FS::UID::AutoCommit = 1; + + # encrypt what's there + foreach my $table ('cust_main','cust_pay_pending','cust_pay','cust_pay_void','cust_refund') { + my $tclass = 'FS::'.$table; + my $lastrecnum = 0; + my @recnums = (); + while (my $recnum = _upgrade_next_recnum(dbh,$table,\$lastrecnum,\@recnums)) { + my $record = $tclass->by_key($recnum); + next unless $record; # small chance it's been deleted, that's ok + next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby; + # window for possible conflict is practically nonexistant, + # but just in case... + $record = $record->select_for_update; + my $error = $record->replace; + die $error if $error; + } + } + + FS::upgrade_journal->set_done('encryption_check'); + } + +} + +# not entirely false laziness w/ Billing_Realtime::_token_check_next_recnum +# cust_payby might get deleted while this runs +# not a method! +sub _upgrade_next_recnum { + my ($dbh,$table,$lastrecnum,$recnums) = @_; + my $recnum = shift @$recnums; + return $recnum if $recnum; + my $tclass = 'FS::'.$table; + my $sql = 'SELECT '.$tclass->primary_key. + ' FROM '.$table. + ' WHERE '.$tclass->primary_key.' > '.$$lastrecnum. + ' ORDER BY '.$tclass->primary_key.' LIMIT 500';; + my $sth = $dbh->prepare($sql) or die $dbh->errstr; + $sth->execute() or die $sth->errstr; + my @recnums; + while (my $rec = $sth->fetchrow_hashref) { + push @$recnums, $rec->{$tclass->primary_key}; + } + $sth->finish(); + $$lastrecnum = $$recnums[-1]; + return shift @$recnums; } =back diff --git a/FS/t/suite/15-activate_encryption.t b/FS/t/suite/15-activate_encryption.t new file mode 100755 index 000000000..e81ddf48e --- /dev/null +++ b/FS/t/suite/15-activate_encryption.t @@ -0,0 +1,110 @@ +#!/usr/bin/perl + +use strict; +use FS::Test; +use Test::More tests => 14; +use FS::Conf; +use FS::UID qw( dbh ); +use DateTime; +use FS::cust_main; # to load all other tables + +my $fs = FS::Test->new( user => 'admin' ); +my $conf = FS::Conf->new; +my $err; +my @tables = qw(cust_main cust_pay_pending cust_pay cust_pay_void cust_refund); + +### can only run on test database (company name "Freeside Test") +like( $conf->config('company_name'), qr/^Freeside Test/, 'using test database' ) or BAIL_OUT(''); + +### upgrade test db schema +$err = system('freeside-upgrade','-s','admin'); +ok( !$err, 'schema upgrade ran' ) or BAIL_OUT('Error string: '.$!); + +### we need to unencrypt our test db before we can test turning it on + +# temporarily load all payinfo into memory +my %payinfo = (); +foreach my $table (@tables) { + $payinfo{$table} = {}; + foreach my $record ($fs->qsearch({ table => $table })) { + next unless grep { $record->payby eq $_ } @FS::Record::encrypt_payby; + $payinfo{$table}{$record->get($record->primary_key)} = $record->get('payinfo'); + } +} + +# turn off encryption +foreach my $config ( qw(encryption encryptionmodule encryptionpublickey encryptionprivatekey) ) { + $conf->delete($config); + ok( !$conf->exists($config), "deleted $config" ) or BAIL_OUT(''); +} +$FS::Record::conf_encryption = $conf->exists('encryption'); +$FS::Record::conf_encryptionmodule = $conf->config('encryptionmodule'); +$FS::Record::conf_encryptionpublickey = join("\n",$conf->config('encryptionpublickey')); +$FS::Record::conf_encryptionprivatekey = join("\n",$conf->config('encryptionprivatekey')); + +# save unencrypted values +foreach my $table (@tables) { + local $FS::payinfo_Mixin::allow_closed_replace = 1; + local $FS::Record::no_update_diff = 1; + local $FS::UID::AutoCommit = 1; + my $tclass = 'FS::'.$table; + foreach my $key (keys %{$payinfo{$table}}) { + my $record = $tclass->by_key($key); + $record->payinfo($payinfo{$table}{$key}); + $err = $record->replace; + last if $err; + } +} +ok( !$err, "save unencrypted values" ) or BAIL_OUT($err); + +# make sure it worked +CHECKDECRYPT: +foreach my $table (@tables) { + my $tclass = 'FS::'.$table; + foreach my $key (sort {$a <=> $b} keys %{$payinfo{$table}}) { + my $sql = 'SELECT * FROM '.$table. + ' WHERE payinfo LIKE \'M%\''. + ' AND char_length(payinfo) > 80'. + ' AND '.$tclass->primary_key.' = '.$key; + my $sth = dbh->prepare($sql) or BAIL_OUT(dbh->errstr); + $sth->execute or BAIL_OUT($sth->errstr); + if (my $hashrec = $sth->fetchrow_hashref) { + $err = $table.' '.$key.' encrypted'; + last CHECKDECRYPT; + } + } +} +ok( !$err, "all values unencrypted" ) or BAIL_OUT($err); + +### now, run upgrade +$err = system('freeside-upgrade','admin'); +ok( !$err, 'upgrade ran' ) or BAIL_OUT('Error string: '.$!); + +# check that confs got set +foreach my $config ( qw(encryption encryptionmodule encryptionpublickey encryptionprivatekey) ) { + ok( $conf->exists($config), "$config was set" ) or BAIL_OUT(''); +} + +# check that known records got encrypted +CHECKENCRYPT: +foreach my $table (@tables) { + my $tclass = 'FS::'.$table; + foreach my $key (sort {$a <=> $b} keys %{$payinfo{$table}}) { + my $sql = 'SELECT * FROM '.$table. + ' WHERE payinfo LIKE \'M%\''. + ' AND char_length(payinfo) > 80'. + ' AND '.$tclass->primary_key.' = '.$key; + my $sth = dbh->prepare($sql) or BAIL_OUT(dbh->errstr); + $sth->execute or BAIL_OUT($sth->errstr); + unless ($sth->fetchrow_hashref) { + $err = $table.' '.$key.' not encrypted'; + last CHECKENCRYPT; + } + } +} +ok( !$err, "all values encrypted" ) or BAIL_OUT($err); + +exit; + +1; + -- 2.11.0