rt 4.2.16
[freeside.git] / rt / lib / RT / Util.pm
index bd3a228..fefb0b9 100644 (file)
@@ -2,7 +2,7 @@
 #
 # COPYRIGHT:
 #
-# This software is Copyright (c) 1996-2015 Best Practical Solutions, LLC
+# This software is Copyright (c) 1996-2019 Best Practical Solutions, LLC
 #                                          <sales@bestpractical.com>
 #
 # (Except where explicitly superseded by other copyright notices)
@@ -54,6 +54,8 @@ use warnings;
 use base 'Exporter';
 our @EXPORT = qw/safe_run_child mime_recommended_filename/;
 
+use Encode qw/encode/;
+
 sub safe_run_child (&) {
     my $our_pid = $$;
 
@@ -66,11 +68,11 @@ sub safe_run_child (&) {
     # on failure and reset values only in our original
     # process
     my ($oldv_dbh, $oldv_rth);
-    my $dbh = $RT::Handle->dbh;
+    my $dbh = $RT::Handle ? $RT::Handle->dbh : undef;
     $oldv_dbh = $dbh->{'InactiveDestroy'} if $dbh;
     $dbh->{'InactiveDestroy'} = 1 if $dbh;
-    $oldv_rth = $RT::Handle->{'DisconnectHandleOnDestroy'};
-    $RT::Handle->{'DisconnectHandleOnDestroy'} = 0;
+    $oldv_rth = $RT::Handle->{'DisconnectHandleOnDestroy'} if $RT::Handle;
+    $RT::Handle->{'DisconnectHandleOnDestroy'} = 0 if $RT::Handle;
 
     my ($reader, $writer);
     pipe( $reader, $writer );
@@ -94,7 +96,7 @@ sub safe_run_child (&) {
         $err =~ s/^Stack:.*$//ms;
         if ( $our_pid == $$ ) {
             $dbh->{'InactiveDestroy'} = $oldv_dbh if $dbh;
-            $RT::Handle->{'DisconnectHandleOnDestroy'} = $oldv_rth;
+            $RT::Handle->{'DisconnectHandleOnDestroy'} = $oldv_rth if $RT::Handle;
             die "System Error: $err";
         } else {
             print $writer "System Error: $err";
@@ -108,7 +110,7 @@ sub safe_run_child (&) {
     warn $response if $response;
 
     $dbh->{'InactiveDestroy'} = $oldv_dbh if $dbh;
-    $RT::Handle->{'DisconnectHandleOnDestroy'} = $oldv_rth;
+    $RT::Handle->{'DisconnectHandleOnDestroy'} = $oldv_rth if $RT::Handle;
     return $want? (@res) : $res[0];
 }
 
@@ -150,6 +152,70 @@ sub assert_bytes {
 }
 
 
+=head2 C<constant_time_eq($a, $b)>
+
+Compares two strings for equality in constant-time. Replacement for the C<eq>
+operator designed to avoid timing side-channel vulnerabilities. Returns zero
+or one.
+
+This is intended for use in cryptographic subsystems for comparing well-formed
+data such as hashes - not for direct use with user input or as a general
+replacement for the C<eq> operator.
+
+The two string arguments B<MUST> be of equal length. If the lengths differ,
+this function will call C<die()>, as proceeding with execution would create
+a timing vulnerability. Length is defined by characters, not bytes.
+
+Strings that should be treated as binary octets rather than Unicode text
+should pass a true value for the binary flag.
+
+This code has been tested to do what it claims. Do not change it without
+thorough statistical timing analysis to validate the changes.
+
+Added to resolve CVE-2017-5361
+
+For more on timing attacks, see this Wikipedia article:
+B<https://en.wikipedia.org/wiki/Timing_attack>
+
+=cut
+
+sub constant_time_eq {
+    my ($a, $b, $binary) = @_;
+
+    my $result = 0;
+
+    # generic error message avoids potential information leaks
+    my $generic_error = "Cannot compare values";
+    die $generic_error unless defined $a and defined $b;
+    die $generic_error unless length $a == length $b;
+    die $generic_error if ref($a) or ref($b);
+
+    for (my $i = 0; $i < length($a); $i++) {
+        my $a_char = substr($a, $i, 1);
+        my $b_char = substr($b, $i, 1);
+
+        my (@a_octets, @b_octets);
+
+        if ($binary) {
+            @a_octets = ord($a_char);
+            @b_octets = ord($b_char);
+        }
+        else {
+            # encode() is set to die on malformed
+            @a_octets = unpack("C*", encode('UTF-8', $a_char, Encode::FB_CROAK));
+            @b_octets = unpack("C*", encode('UTF-8', $b_char, Encode::FB_CROAK));
+        }
+
+        die $generic_error if (scalar @a_octets) != (scalar @b_octets);
+
+        for (my $j = 0; $j < scalar @a_octets; $j++) {
+            $result |= $a_octets[$j] ^ $b_octets[$j];
+        }
+    }
+    return 0 + not $result;
+}
+
+
 RT::Base->_ImportOverlays();
 
 1;