www: qs_html: fix escaping of `q' param

Our use of MID_ESC characters was only intended for the pathname
component of URIs and not appropriate for the query string
component.  So use a different $unsafe parameter list for
uri_escape to make the result appropriate for query strings by
disallowing [\&\'\+=] characters.  Most notably, this change
also allows us to accept `/' (slash) unescaped to make dfn: queries
nicer to look at.

Finally, we'll also add a ascii_html call on the URI-escaped
result as an extra safety measure even though it's not really
needed.

As far as I can tell, the code without this fix didn't result in
in an HTML injection since all our uses of uri_escape did escape
angle brackets.

Reported-by: Ricardo Cañuelo <ricardo.canuelo@collabora.com>
Link: https://public-inbox.org/meta/87o7ff4nlk.fsf@collabora.com/
Tested-by: Ricardo Cañuelo <ricardo.canuelo@collabora.com>

diff --git a/lib/PublicInbox/MID.pm b/lib/PublicInbox/MID.pm
index b1ae9939e92d6e430938aecc101b04f718248c00..97cf3a54225b6e6841e8c5d6c034d3e3f239a280 100644 (file)
--- a/lib/PublicInbox/MID.pm
+++ b/lib/PublicInbox/MID.pm
@@ -125,7 +125,7 @@ sub uniq_mids ($;$) {
        \@ret;
 }
 
-# RFC3986, section 3.3:
+# RFC3986, section 3.3 (pathnames only):
 sub MID_ESC () { '^A-Za-z0-9\-\._~!\$\&\'\(\)\*\+,;=:@' }
 sub mid_escape ($) { uri_escape_utf8($_[0], MID_ESC) }
 

diff --git a/lib/PublicInbox/SearchQuery.pm b/lib/PublicInbox/SearchQuery.pm
index 96246c5385d8c0ca8fcc18191be2b4e1b34d71a2..747e32493ba2146b520ea01de1ab7584710fe0f2 100644 (file)
--- a/lib/PublicInbox/SearchQuery.pm
+++ b/lib/PublicInbox/SearchQuery.pm
@@ -6,7 +6,7 @@ package PublicInbox::SearchQuery;
 use strict;
 use v5.10.1;
 use URI::Escape qw(uri_escape);
-use PublicInbox::MID qw(MID_ESC);
+use PublicInbox::Hval qw(ascii_html);
 our $LIM = 200;
 
 sub new {
@@ -35,9 +35,13 @@ sub qs_html {
        }
        my $qs = '';
        if (defined(my $q = $self->{'q'})) {
-               $q = uri_escape($q, MID_ESC);
+               # not using MID_ESC since that's for the path component and
+               # this is for the query component.  Unlike MID_ESC,
+               # this disallows [\&\'\+=] and allows slash [/] for
+               # nicer looking dfn: queries
+               $q = uri_escape($q, '^A-Za-z0-9\-\._~!\$\(\)\*,;:@/');
                $q =~ s/%20/+/g; # improve URL readability
-               $qs .= "q=$q";
+               $qs .= 'q='.ascii_html($q);
        }
        if (my $o = $self->{o}) { # ignore o == 0
                $qs .= "&o=$o";

diff --git a/t/psgi_search.t b/t/psgi_search.t
index 289c34e7b6feef22572c4efe00409cb52f5ddace..8c981c6cc593e78252335ac2c9bfdfcfbd4e1e03 100644 (file)
--- a/t/psgi_search.t
+++ b/t/psgi_search.t
@@ -18,7 +18,8 @@ local $ENV{TZ} = 'UTC';
 my $digits = '10010260936330';
 my $ua = 'Pine.LNX.4.10';
 my $mid = "$ua.$digits.2460-100000\@penguin.transmeta.com";
-my $ibx = create_inbox 'git', indexlevel => 'full', tmpdir => "$tmpdir/1", sub {
+my $ibx = create_inbox '26-git', indexlevel => 'full', tmpdir => "$tmpdir/1",
+sub {
        my ($im) = @_;
        # n.b. these headers are not properly RFC2047-encoded
        $im->add(PublicInbox::Eml->new(<<EOF)) or BAIL_OUT;
@@ -48,6 +49,17 @@ Message-ID: <no-subject-at-all@example.com>
 From: no subject at all <no-subject-at-all@example.com>
 To: git@vger.kernel.org
 
+EOF
+       $im->add(PublicInbox::Eml->new(<<'EOF')) or BAIL_OUT;
+Message-ID: <ampersand@example.com>
+From: <e@example.com>
+To: git@vger.kernel.org
+Subject: git & ampersand
+
+hi +++ b/foo
+x=y
+s'more
+
 EOF
 };
 
@@ -155,6 +167,19 @@ test_psgi(sub { $www->call(@_) }, sub {
        is($res->code, 200, 'successful mbox download w/ threads');
        gunzip(\($res->content) => \(my $after));
        isnt($before, $after);
+
+       $res = $cb->(GET('/test/?q=git+%26+ampersand&x=A'));
+       is $res->code, 200, 'Atom hit with ampersand';
+       unlike $res->content, qr/git\+&\+ampersand/, '& is HTML-escaped';
+
+       $res = $cb->(GET('/test/?q=%22hi+%2b%2b%2b+b/foo%22&x=A'));
+       is $res->code, 200, 'slashes and plusses search hit';
+       like $res->content, qr!q=%22hi\+(?:%2[bB]){3}\+b/foo%22!,
+               '+ and " escaped, but slash not escaped in query';
+
+       $res = $cb->(GET(q{/test/?q=%22s'more%22&x=A}));
+       is $res->code, 200, 'single quote inside phrase';
+       # TODO: more tests and odd cases
 });
 
 done_testing();