# -*- Mode: perl; indent-tabs-mode: nil -*- # # The contents of this file are subject to the Mozilla Public # License Version 1.1 (the "License"); you may not use this file # except in compliance with the License. You may obtain a copy of # the License at http://www.mozilla.org/MPL/ # # Software distributed under the License is distributed on an "AS # IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or # implied. See the License for the specific language governing # rights and limitations under the License. # # The Original Code is the Bugzilla Bug Tracking System. # # The Initial Developer of the Original Code is Netscape Communications # Corporation. Portions created by Netscape are # Copyright (C) 1998 Netscape Communications Corporation. All # Rights Reserved. # # Contributor(s): Terry Weissman # Dan Mosedale # Jacob Steenhagen # Bradley Baetz # Christopher Aillon # Max Kanat-Alexander # Frédéric Buclin # Marc Schumann package Bugzilla::Util; use strict; use base qw(Exporter); @Bugzilla::Util::EXPORT = qw(is_tainted trick_taint detaint_natural detaint_signed html_quote url_quote value_quote xml_quote css_class_quote html_light_quote i_am_cgi get_netaddr correct_urlbase lsearch diff_arrays diff_strings trim wrap_comment find_wrap_point perform_substs format_time format_time_decimal validate_date file_mod_time is_7bit_clean bz_crypt generate_random_password validate_email_syntax clean_text get_text); use Bugzilla::Constants; use Date::Parse; use Date::Format; use Text::Wrap; # This is from the perlsec page, slightly modified to remove a warning # From that page: # This function makes use of the fact that the presence of # tainted data anywhere within an expression renders the # entire expression tainted. # Don't ask me how it works... sub is_tainted { return not eval { my $foo = join('',@_), kill 0; 1; }; } sub trick_taint { require Carp; Carp::confess("Undef to trick_taint") unless defined $_[0]; my $match = $_[0] =~ /^(.*)$/s; $_[0] = $match ? $1 : undef; return (defined($_[0])); } sub detaint_natural { my $match = $_[0] =~ /^(\d+)$/; $_[0] = $match ? $1 : undef; return (defined($_[0])); } sub detaint_signed { my $match = $_[0] =~ /^([-+]?\d+)$/; $_[0] = $match ? $1 : undef; # Remove any leading plus sign. if (defined($_[0]) && $_[0] =~ /^\+(\d+)$/) { $_[0] = $1; } return (defined($_[0])); } sub html_quote { my ($var) = (@_); $var =~ s/\&/\&/g; $var =~ s//\>/g; $var =~ s/\"/\"/g; return $var; } sub html_light_quote { my ($text) = @_; # List of allowed HTML elements having no attributes. my @allow = qw(b strong em i u p br abbr acronym ins del cite code var dfn samp kbd big small sub sup tt dd dt dl ul li ol); # Are HTML::Scrubber and HTML::Parser installed? eval { require HTML::Scrubber; require HTML::Parser; }; # We need utf8_mode() from HTML::Parser 3.40 if running Perl >= 5.8. if ($@ || ($] >= 5.008 && $HTML::Parser::VERSION < 3.40)) { # Package(s) not installed. my $safe = join('|', @allow); my $chr = chr(1); # First, escape safe elements. $text =~ s#<($safe)>#$chr$1$chr#go; $text =~ s##$chr/$1$chr#go; # Now filter < and >. $text =~ s#<#<#g; $text =~ s#>#>#g; # Restore safe elements. $text =~ s#$chr/($safe)$chr##go; $text =~ s#$chr($safe)$chr#<$1>#go; return $text; } else { # Packages installed. # We can be less restrictive. We can accept elements with attributes. push(@allow, qw(a blockquote q span)); # Allowed protocols. my $safe_protocols = join('|', SAFE_PROTOCOLS); my $protocol_regexp = qr{(^(?:$safe_protocols):|^[^:]+$)}i; # Deny all elements and attributes unless explicitly authorized. my @default = (0 => { id => 1, name => 1, class => 1, '*' => 0, # Reject all other attributes. } ); # Specific rules for allowed elements. If no specific rule is set # for a given element, then the default is used. my @rules = (a => { href => $protocol_regexp, title => 1, id => 1, name => 1, class => 1, '*' => 0, # Reject all other attributes. }, blockquote => { cite => $protocol_regexp, id => 1, name => 1, class => 1, '*' => 0, # Reject all other attributes. }, 'q' => { cite => $protocol_regexp, id => 1, name => 1, class => 1, '*' => 0, # Reject all other attributes. }, ); my $scrubber = HTML::Scrubber->new(default => \@default, allow => \@allow, rules => \@rules, comment => 0, process => 0); # Avoid filling the web server error log with Perl 5.8.x. # In HTML::Scrubber 0.08, the HTML::Parser object is stored in # the "_p" key, but this may change in future versions. if ($] >= 5.008 && ref($scrubber->{_p}) eq 'HTML::Parser') { $scrubber->{_p}->utf8_mode(1); } return $scrubber->scrub($text); } } # This originally came from CGI.pm, by Lincoln D. Stein sub url_quote { my ($toencode) = (@_); $toencode =~ s/([^a-zA-Z0-9_\-.])/uc sprintf("%%%02x",ord($1))/eg; return $toencode; } sub css_class_quote { my ($toencode) = (@_); $toencode =~ s/ /_/g; $toencode =~ s/([^a-zA-Z0-9_\-.])/uc sprintf("&#x%x;",ord($1))/eg; return $toencode; } sub value_quote { my ($var) = (@_); $var =~ s/\&/\&/g; $var =~ s//\>/g; $var =~ s/\"/\"/g; # See bug http://bugzilla.mozilla.org/show_bug.cgi?id=4928 for # explanation of why Bugzilla does this linebreak substitution. # This caused form submission problems in mozilla (bug 22983, 32000). $var =~ s/\r\n/\ /g; $var =~ s/\n\r/\ /g; $var =~ s/\r/\ /g; $var =~ s/\n/\ /g; return $var; } sub xml_quote { my ($var) = (@_); $var =~ s/\&/\&/g; $var =~ s//\>/g; $var =~ s/\"/\"/g; $var =~ s/\'/\'/g; return $var; } sub url_decode { my ($todecode) = (@_); $todecode =~ tr/+/ /; # pluses become spaces $todecode =~ s/%([0-9a-fA-F]{2})/pack("c",hex($1))/ge; return $todecode; } sub i_am_cgi { # I use SERVER_SOFTWARE because it's required to be # defined for all requests in the CGI spec. return exists $ENV{'SERVER_SOFTWARE'} ? 1 : 0; } sub correct_urlbase { my $ssl = Bugzilla->params->{'ssl'}; return Bugzilla->params->{'urlbase'} if $ssl eq 'never'; my $sslbase = Bugzilla->params->{'sslbase'}; if ($sslbase) { return $sslbase if $ssl eq 'always'; # Authenticated Sessions return $sslbase if Bugzilla->user->id; } # Set to "authenticated sessions" but nobody's logged in, or # sslbase isn't set. return Bugzilla->params->{'urlbase'}; } sub lsearch { my ($list,$item) = (@_); my $count = 0; foreach my $i (@$list) { if ($i eq $item) { return $count; } $count++; } return -1; } sub diff_arrays { my ($old_ref, $new_ref) = @_; my @old = @$old_ref; my @new = @$new_ref; # For each pair of (old, new) entries: # If they're equal, set them to empty. When done, @old contains entries # that were removed; @new contains ones that got added. foreach my $oldv (@old) { foreach my $newv (@new) { next if ($newv eq ''); if ($oldv eq $newv) { $newv = $oldv = ''; } } } my @removed = grep { $_ ne '' } @old; my @added = grep { $_ ne '' } @new; return (\@removed, \@added); } sub trim { my ($str) = @_; if ($str) { $str =~ s/^\s+//g; $str =~ s/\s+$//g; } return $str; } sub diff_strings { my ($oldstr, $newstr) = @_; # Split the old and new strings into arrays containing their values. $oldstr =~ s/[\s,]+/ /g; $newstr =~ s/[\s,]+/ /g; my @old = split(" ", $oldstr); my @new = split(" ", $newstr); my ($rem, $add) = diff_arrays(\@old, \@new); my $removed = join (", ", @$rem); my $added = join (", ", @$add); return ($removed, $added); } sub wrap_comment { my ($comment) = @_; my $wrappedcomment = ""; # Use 'local', as recommended by Text::Wrap's perldoc. local $Text::Wrap::columns = COMMENT_COLS; # Make words that are longer than COMMENT_COLS not wrap. local $Text::Wrap::huge = 'overflow'; # Don't mess with tabs. local $Text::Wrap::unexpand = 0; # If the line starts with ">", don't wrap it. Otherwise, wrap. foreach my $line (split(/\r\n|\r|\n/, $comment)) { if ($line =~ qr/^>/) { $wrappedcomment .= ($line . "\n"); } else { $wrappedcomment .= (wrap('', '', $line) . "\n"); } } return $wrappedcomment; } sub find_wrap_point { my ($string, $maxpos) = @_; if (!$string) { return 0 } if (length($string) < $maxpos) { return length($string) } my $wrappoint = rindex($string, ",", $maxpos); # look for comma if ($wrappoint < 0) { # can't find comma $wrappoint = rindex($string, " ", $maxpos); # look for space if ($wrappoint < 0) { # can't find space $wrappoint = rindex($string, "-", $maxpos); # look for hyphen if ($wrappoint < 0) { # can't find hyphen $wrappoint = $maxpos; # just truncate it } else { $wrappoint++; # leave hyphen on the left side } } } return $wrappoint; } sub perform_substs { my ($str, $substs) = (@_); $str =~ s/%([a-z]*)%/(defined $substs->{$1} ? $substs->{$1} : Bugzilla->params->{$1})/eg; return $str; } sub format_time { my ($date, $format) = @_; # If $format is undefined, try to guess the correct date format. my $show_timezone; if (!defined($format)) { if ($date =~ m/^(\d{4})[-\.](\d{2})[-\.](\d{2}) (\d{2}):(\d{2})(:(\d{2}))?$/) { my $sec = $7; if (defined $sec) { $format = "%Y-%m-%d %T"; } else { $format = "%Y-%m-%d %R"; } } else { # Default date format. See Date::Format for other formats available. $format = "%Y-%m-%d %R"; } # By default, we want the timezone to be displayed. $show_timezone = 1; } else { # Search for %Z or %z, meaning we want the timezone to be displayed. # Till bug 182238 gets fixed, we assume Bugzilla->params->{'timezone'} # is used. $show_timezone = ($format =~ s/\s?%Z$//i); } # str2time($date) is undefined if $date has an invalid date format. my $time = str2time($date); if (defined $time) { $date = time2str($format, $time); $date .= " " . Bugzilla->params->{'timezone'} if $show_timezone; } else { # Don't let invalid (time) strings to be passed to templates! $date = ''; } return trim($date); } sub format_time_decimal { my ($time) = (@_); my $newtime = sprintf("%.2f", $time); if ($newtime =~ /0\Z/) { $newtime = sprintf("%.1f", $time); } return $newtime; } sub file_mod_time { my ($filename) = (@_); my ($dev,$ino,$mode,$nlink,$uid,$gid,$rdev,$size, $atime,$mtime,$ctime,$blksize,$blocks) = stat($filename); return $mtime; } sub bz_crypt { my ($password) = @_; # The list of characters that can appear in a salt. Salts and hashes # are both encoded as a sequence of characters from a set containing # 64 characters, each one of which represents 6 bits of the salt/hash. # The encoding is similar to BASE64, the difference being that the # BASE64 plus sign (+) is replaced with a forward slash (/). my @saltchars = (0..9, 'A'..'Z', 'a'..'z', '.', '/'); # Generate the salt. We use an 8 character (48 bit) salt for maximum # security on systems whose crypt uses MD5. Systems with older # versions of crypt will just use the first two characters of the salt. my $salt = ''; for ( my $i=0 ; $i < 8 ; ++$i ) { $salt .= $saltchars[rand(64)]; } # Crypt the password. my $cryptedpassword = crypt($password, $salt); # Return the crypted password. return $cryptedpassword; } sub generate_random_password { my $size = shift || 10; # default to 10 chars if nothing specified return join("", map{ ('0'..'9','a'..'z','A'..'Z')[rand 62] } (1..$size)); } sub validate_email_syntax { my ($addr) = @_; my $match = Bugzilla->params->{'emailregexp'}; my $ret = ($addr =~ /$match/ && $addr !~ /[\\\(\)<>&,;:"\[\] \t\r\n]/); return $ret ? 1 : 0; } sub validate_date { my ($date) = @_; my $date2; # $ts is undefined if the parser fails. my $ts = str2time($date); if ($ts) { $date2 = time2str("%Y-%m-%d", $ts); $date =~ s/(\d+)-0*(\d+?)-0*(\d+?)/$1-$2-$3/; $date2 =~ s/(\d+)-0*(\d+?)-0*(\d+?)/$1-$2-$3/; } my $ret = ($ts && $date eq $date2); return $ret ? 1 : 0; } sub is_7bit_clean { return $_[0] !~ /[^\x20-\x7E\x0A\x0D]/; } sub clean_text { my ($dtext) = shift; $dtext =~ s/[\x00-\x1F\x7F]+/ /g; # change control characters into a space return trim($dtext); } sub get_text { my ($name, $vars) = @_; my $template = Bugzilla->template_inner; $vars ||= {}; $vars->{'message'} = $name; my $message; $template->process('global/message.txt.tmpl', $vars, \$message) || ThrowTemplateError($template->error()); # Remove the indenting that exists in messages.html.tmpl. $message =~ s/^ //gm; return $message; } sub get_netaddr { my $ipaddr = shift; # Check for a valid IPv4 addr which we know how to parse if (!$ipaddr || $ipaddr !~ /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/) { return undef; } my $addr = unpack("N", pack("CCCC", split(/\./, $ipaddr))); my $maskbits = Bugzilla->params->{'loginnetmask'}; # Make Bugzilla ignore the IP address if loginnetmask is set to 0 return "0.0.0.0" if ($maskbits == 0); $addr >>= (32-$maskbits); $addr <<= (32-$maskbits); return join(".", unpack("CCCC", pack("N", $addr))); } 1; __END__ =head1 NAME Bugzilla::Util - Generic utility functions for bugzilla =head1 SYNOPSIS use Bugzilla::Util; # Functions for dealing with variable tainting $rv = is_tainted($var); trick_taint($var); detaint_natural($var); detaint_signed($var); # Functions for quoting html_quote($var); url_quote($var); value_quote($var); xml_quote($var); # Functions for decoding $rv = url_decode($var); # Functions that tell you about your environment my $is_cgi = i_am_cgi(); my $net_addr = get_netaddr($ip_addr); my $urlbase = correct_urlbase(); # Functions for searching $loc = lsearch(\@arr, $val); # Data manipulation ($removed, $added) = diff_arrays(\@old, \@new); # Functions for manipulating strings $val = trim(" abc "); ($removed, $added) = diff_strings($old, $new); $wrapped = wrap_comment($comment); $msg = perform_substs($str, $substs); # Functions for formatting time format_time($time); # Functions for dealing with files $time = file_mod_time($filename); # Cryptographic Functions $crypted_password = bz_crypt($password); $new_password = generate_random_password($password_length); # Validation Functions validate_email_syntax($email); validate_date($date); =head1 DESCRIPTION This package contains various utility functions which do not belong anywhere else. B. Do not add methods to this package unless it is intended to be used for a significant number of files, and it does not belong anywhere else. =head1 FUNCTIONS This package provides several types of routines: =head2 Tainting Several functions are available to deal with tainted variables. B to avoid security holes. =over 4 =item C Determines whether a particular variable is tainted =item C Tricks perl into untainting a particular variable. Use trick_taint() when you know that there is no way that the data in a scalar can be tainted, but taint mode still bails on it. B =item C This routine detaints a natural number. It returns a true value if the value passed in was a valid natural number, else it returns false. You B check the result of this routine to avoid security holes. =item C This routine detaints a signed integer. It returns a true value if the value passed in was a valid signed integer, else it returns false. You B check the result of this routine to avoid security holes. =back =head2 Quoting Some values may need to be quoted from perl. However, this should in general be done in the template where possible. =over 4 =item C Returns a value quoted for use in HTML, with &, E, E, and E<34> being replaced with their appropriate HTML entities. =item C Returns a string where only explicitly allowed HTML elements and attributes are kept. All HTML elements and attributes not being in the whitelist are either escaped (if HTML::Scrubber is not installed) or removed. =item C Quotes characters so that they may be included as part of a url. =item C Quotes characters so that they may be used as CSS class names. Spaces are replaced by underscores. =item C As well as escaping html like C, this routine converts newlines into , suitable for use in html attributes. =item C This is similar to C, except that ' is escaped to '. This is kept separate from html_quote partly for compatibility with previous code (for ') and partly for future handling of non-ASCII characters. =item C Converts the %xx encoding from the given URL back to its original form. =back =head2 Environment and Location Functions returning information about your environment or location. =over 4 =item C Tells you whether or not you are being run as a CGI script in a web server. For example, it would return false if the caller is running in a command-line script. =item C Given an IP address, this returns the associated network address, using Cparams->{'loginnetmask'}> as the netmask. This can be used to obtain data in order to restrict weak authentication methods (such as cookies) to only some addresses. =item C Returns either the C or C parameter, depending on the current setting for the C parameter. =back =head2 Searching Functions for searching within a set of values. =over 4 =item C Returns the position of C<$item> in C<$list>. C<$list> must be a list reference. If the item is not in the list, returns -1. =back =head2 Data Manipulation =over 4 =item C Description: Takes two arrayrefs, and will tell you what it takes to get from @old to @new. Params: @old = array that you are changing from @new = array that you are changing to Returns: A list of two arrayrefs. The first is a reference to an array containing items that were removed from @old. The second is a reference to an array containing items that were added to @old. If both returned arrays are empty, @old and @new contain the same values. =back =head2 String Manipulation =over 4 =item C Removes any leading or trailing whitespace from a string. This routine does not modify the existing string. =item C Takes two strings containing a list of comma- or space-separated items and returns what items were removed from or added to the new one, compared to the old one. Returns a list, where the first entry is a scalar containing removed items, and the second entry is a scalar containing added items. =item C Takes a bug comment, and wraps it to the appropriate length. The length is currently specified in C. Lines beginning with ">" are assumed to be quotes, and they will not be wrapped. The intended use of this function is to wrap comments that are about to be displayed or emailed. Generally, wrapped text should not be stored in the database. =item C Search for a comma, a whitespace or a hyphen to split $string, within the first $maxpos characters. If none of them is found, just split $string at $maxpos. The search starts at $maxpos and goes back to the beginning of the string. =item C Performs substitutions for sending out email with variables in it, or for inserting a parameter into some other string. Takes a string and a reference to a hash containing substitution variables and their values. If the hash is not specified, or if we need to substitute something that's not in the hash, then we will use parameters to do the substitution instead. Substitutions are always enclosed with '%' symbols. So they look like: %some_variable_name%. If "some_variable_name" is a key in the hash, then its value will be placed into the string. If it's not a key in the hash, then the value of the parameter called "some_variable_name" will be placed into the string. =item C Returns true is the string contains only 7-bit characters (ASCII 32 through 126, ASCII 10 (LineFeed) and ASCII 13 (Carrage Return). =item C Returns the parameter "cleaned" by exchanging non-printable characters with spaces. Specifically characters (ASCII 0 through 31) and (ASCII 127) will become ASCII 32 (Space). =item C =over =item B This is a method of getting localized strings within Bugzilla code. Use this when you don't want to display a whole template, you just want a particular string. It uses the F template to return a string. =item B =over =item C<$message> - The identifier for the message. =item C<$vars> - A hashref. Any variables you want to pass to the template. =back =item B A string. =back =back =head2 Formatting Time =over 4 =item C Takes a time, converts it to the desired format and appends the timezone as defined in editparams.cgi, if desired. This routine will be expanded in the future to adjust for user preferences regarding what timezone to display times in. This routine is mainly called from templates to filter dates, see "FILTER time" in Templates.pm. In this case, $format is undefined and the routine has to "guess" the date format that was passed to $dbh->sql_date_format(). =item C Returns a number with 2 digit precision, unless the last digit is a 0. Then it returns only 1 digit precision. =back =head2 Files =over 4 =item C Takes a filename and returns the modification time. It returns it in the format of the "mtime" parameter of the perl "stat" function. =back =head2 Cryptography =over 4 =item C Takes a string and returns a Ced value for it, using a random salt. Please always use this function instead of the built-in perl "crypt" when initially encrypting a password. =begin undocumented Random salts are generated because the alternative is usually to use the first two characters of the password itself, and since the salt appears in plaintext at the beginning of the encrypted password string this has the effect of revealing the first two characters of the password to anyone who views the encrypted version. =end undocumented =item C Returns an alphanumeric string with the specified length (10 characters by default). Use this function to generate passwords and tokens. =back =head2 Validation =over 4 =item C Do a syntax checking for a legal email address and returns 1 if the check is successful, else returns 0. =item C Make sure the date has the correct format and returns 1 if the check is successful, else returns 0. =back