-
Notifications
You must be signed in to change notification settings - Fork 102
/
Request.pm
1168 lines (867 loc) · 32.2 KB
/
Request.pm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package Catalyst::Request;
use Socket qw( getaddrinfo getnameinfo AI_NUMERICHOST NI_NAMEREQD NIx_NOSERV );
use Carp;
use utf8;
use URI::http;
use URI::https;
use URI::QueryParam;
use HTTP::Headers;
use Stream::Buffered;
use Hash::MultiValue;
use Scalar::Util;
use HTTP::Body;
use Catalyst::Exception;
use Catalyst::Request::PartData;
use Moose;
use namespace::clean -except => 'meta';
with 'MooseX::Emulate::Class::Accessor::Fast';
has env => (is => 'ro', writer => '_set_env', predicate => '_has_env');
# XXX Deprecated crap here - warn?
has action => (is => 'rw');
# XXX: Deprecated in docs ages ago (2006), deprecated with warning in 5.8000 due
# to confusion between Engines and Plugin::Authentication. Remove in 5.8100?
has user => (is => 'rw');
sub snippets { shift->captures(@_) }
has _read_position => (
# FIXME: work around Moose bug RT#75367
# init_arg => undef,
is => 'ro',
writer => '_set_read_position',
default => 0,
);
has _read_length => (
# FIXME: work around Moose bug RT#75367
# init_arg => undef,
is => 'ro',
default => sub {
my $self = shift;
$self->header('Content-Length') || 0;
},
lazy => 1,
);
has address => (is => 'rw');
has arguments => (is => 'rw', default => sub { [] });
has cookies => (is => 'ro', builder => 'prepare_cookies', lazy => 1);
sub prepare_cookies {
my ( $self ) = @_;
if ( my $header = $self->header('Cookie') ) {
return { CGI::Simple::Cookie->parse($header) };
}
{};
}
has query_keywords => (is => 'rw');
has match => (is => 'rw');
has method => (is => 'rw');
has protocol => (is => 'rw');
has query_parameters => (is => 'rw', lazy=>1, default => sub { shift->_use_hash_multivalue ? Hash::MultiValue->new : +{} });
has secure => (is => 'rw', default => 0);
has captures => (is => 'rw', default => sub { [] });
has uri => (is => 'rw', predicate => 'has_uri');
has remote_user => (is => 'rw');
has headers => (
is => 'rw',
isa => 'HTTP::Headers',
handles => [qw(content_encoding content_length content_type header referer user_agent)],
builder => 'prepare_headers',
lazy => 1,
);
sub prepare_headers {
my ($self) = @_;
my $env = $self->env;
my $headers = HTTP::Headers->new();
for my $header (keys %{ $env }) {
next unless $header =~ /^(HTTP|CONTENT|COOKIE)/i;
(my $field = $header) =~ s/^HTTPS?_//;
$field =~ tr/_/-/;
$headers->header($field => $env->{$header});
}
return $headers;
}
has _log => (
is => 'ro',
weak_ref => 1,
required => 1,
);
has io_fh => (
is=>'ro',
predicate=>'_has_io_fh',
lazy=>1,
builder=>'_build_io_fh');
sub _build_io_fh {
my $self = shift;
return $self->env->{'psgix.io'}
|| (
$self->env->{'net.async.http.server.req'} &&
$self->env->{'net.async.http.server.req'}->stream) ## Until I can make ioasync cabal see the value of supportin psgix.io (jnap)
|| die "Your Server does not support psgix.io";
};
has data_handlers => ( is=>'ro', isa=>'HashRef', default=>sub { +{} } );
has body_data => (
is=>'ro',
lazy=>1,
builder=>'_build_body_data');
sub _build_body_data {
my ($self) = @_;
# Not sure if these returns should not be exceptions...
my $content_type = $self->content_type || return;
return unless ($self->method eq 'POST' || $self->method eq 'PUT' || $self->method eq 'PATCH' || $self->method eq 'DELETE');
my ($match) = grep { $content_type =~/$_/i }
keys(%{$self->data_handlers});
if($match) {
my $fh = $self->body;
local $_ = $fh;
return $self->data_handlers->{$match}->($fh, $self);
} else {
Catalyst::Exception->throw(
sprintf '%s does not have an available data handler. Valid data_handlers are %s.',
$content_type, join ', ', sort keys %{$self->data_handlers}
);
}
}
has _use_hash_multivalue => (
is=>'ro',
required=>1,
default=> sub {0});
# Amount of data to read from input on each pass
our $CHUNKSIZE = 64 * 1024;
sub read {
my ($self, $maxlength) = @_;
my $remaining = $self->_read_length - $self->_read_position;
$maxlength ||= $CHUNKSIZE;
# Are we done reading?
if ( $remaining <= 0 ) {
return;
}
my $readlen = ( $remaining > $maxlength ) ? $maxlength : $remaining;
my $rc = $self->read_chunk( my $buffer, $readlen );
if ( defined $rc ) {
if (0 == $rc) { # Nothing more to read even though Content-Length
# said there should be.
return;
}
$self->_set_read_position( $self->_read_position + $rc );
return $buffer;
}
else {
Catalyst::Exception->throw(
message => "Unknown error reading input: $!" );
}
}
sub read_chunk {
my $self = shift;
return $self->env->{'psgi.input'}->read(@_);
}
has body_parameters => (
is => 'rw',
required => 1,
lazy => 1,
predicate => 'has_body_parameters',
builder => 'prepare_body_parameters',
);
has uploads => (
is => 'rw',
required => 1,
default => sub { {} },
);
has parameters => (
is => 'rw',
lazy => 1,
builder => '_build_parameters',
clearer => '_clear_parameters',
);
# TODO:
# - Can we lose the before modifiers which just call prepare_body ?
# they are wasteful, slow us down and feel cluttery.
# Can we make _body an attribute, have the rest of
# these lazy build from there and kill all the direct hash access
# in Catalyst.pm and Engine.pm?
sub prepare_parameters {
my ( $self ) = @_;
$self->_clear_parameters;
return $self->parameters;
}
sub _build_parameters {
my ( $self ) = @_;
my $parameters = {};
my $body_parameters = $self->body_parameters;
my $query_parameters = $self->query_parameters;
if($self->_use_hash_multivalue) {
return Hash::MultiValue->new($query_parameters->flatten, $body_parameters->flatten);
}
# We copy, no references
foreach my $name (keys %$query_parameters) {
my $param = $query_parameters->{$name};
$parameters->{$name} = ref $param eq 'ARRAY' ? [ @$param ] : $param;
}
# Merge query and body parameters
foreach my $name (keys %$body_parameters) {
my $param = $body_parameters->{$name};
my @values = ref $param eq 'ARRAY' ? @$param : ($param);
if ( my $existing = $parameters->{$name} ) {
unshift(@values, (ref $existing eq 'ARRAY' ? @$existing : $existing));
}
$parameters->{$name} = @values > 1 ? \@values : $values[0];
}
$parameters;
}
has _uploadtmp => (
is => 'ro',
predicate => '_has_uploadtmp',
);
sub prepare_body {
my ( $self ) = @_;
# If previously applied middleware created the HTTP::Body object, then we
# just use that one.
if(my $plack_body = $self->_has_env ? $self->env->{'plack.request.http.body'} : undef) {
$self->_body($plack_body);
$self->_body->cleanup(1);
return;
}
# If there is nothing to read, set body to naught and return. This
# will cause all body code to be skipped
return $self->_body(0) unless my $length = $self->_read_length;
# Unless the body has already been set, create it. Not sure about this
# code, how else might it be set, but this was existing logic.
unless ($self->_body) {
my $type = $self->header('Content-Type');
$self->_body(HTTP::Body->new( $type, $length ));
$self->_body->cleanup(1);
# JNAP: I'm not sure this is doing what we expect, but it also doesn't
# seem to be hurting (seems ->_has_uploadtmp is true more than I would
# expect.
$self->_body->tmpdir( $self->_uploadtmp )
if $self->_has_uploadtmp;
}
# Ok if we get this far, we have to read psgi.input into the new body
# object. Lets play nice with any plack app or other downstream, so
# we create a buffer unless one exists.
my $stream_buffer;
if ($self->env->{'psgix.input.buffered'}) {
# Be paranoid about previous psgi middleware or apps that read the
# input but didn't return the buffer to the start.
$self->env->{'psgi.input'}->seek(0, 0);
} else {
$stream_buffer = Stream::Buffered->new($length);
}
# Check for definedness as you could read '0'
while ( defined ( my $chunk = $self->read() ) ) {
$self->prepare_body_chunk($chunk);
next unless $stream_buffer;
$stream_buffer->print($chunk)
|| die sprintf "Failed to write %d bytes to psgi.input file: $!", length( $chunk );
}
# Ok, we read the body. Lets play nice for any PSGI app down the pipe
if ($stream_buffer) {
$self->env->{'psgix.input.buffered'} = 1;
$self->env->{'psgi.input'} = $stream_buffer->rewind;
} else {
$self->env->{'psgi.input'}->seek(0, 0); # Reset the buffer for downstream middleware or apps
}
# paranoia against wrong Content-Length header
my $remaining = $length - $self->_read_position;
if ( $remaining > 0 ) {
Catalyst::Exception->throw("Wrong Content-Length value: $length" );
}
}
sub prepare_body_chunk {
my ( $self, $chunk ) = @_;
$self->_body->add($chunk);
}
sub prepare_body_parameters {
my ( $self, $c ) = @_;
return $self->body_parameters if $self->has_body_parameters;
$self->prepare_body if ! $self->_has_body;
unless($self->_body) {
my $return = $self->_use_hash_multivalue ? Hash::MultiValue->new : {};
$self->body_parameters($return);
return $return;
}
my $params;
my %part_data = %{$self->_body->part_data};
if(scalar %part_data && !$c->config->{skip_complex_post_part_handling}) {
foreach my $key (keys %part_data) {
my $proto_value = $part_data{$key};
my ($val, @extra) = (ref($proto_value)||'') eq 'ARRAY' ? @$proto_value : ($proto_value);
$key = $c->_handle_param_unicode_decoding($key)
if ($c and $c->encoding and !$c->config->{skip_body_param_unicode_decoding});
if(@extra) {
$params->{$key} = [map { Catalyst::Request::PartData->build_from_part_data($c, $_) } ($val,@extra)];
} else {
$params->{$key} = Catalyst::Request::PartData->build_from_part_data($c, $val);
}
}
} else {
$params = $self->_body->param;
# If we have an encoding configured (like UTF-8) in general we expect a client
# to POST with the encoding we fufilled the request in. Otherwise don't do any
# encoding (good change wide chars could be in HTML entity style llike the old
# days -JNAP
# so, now that HTTP::Body prepared the body params, we gotta 'walk' the structure
# and do any needed decoding.
# This only does something if the encoding is set via the encoding param. Remember
# this is assuming the client is not bad and responds with what you provided. In
# general you can just use utf8 and get away with it.
#
# I need to see if $c is here since this also doubles as a builder for the object :(
if($c and $c->encoding and !$c->config->{skip_body_param_unicode_decoding}) {
$params = $c->_handle_unicode_decoding($params);
}
}
my $return = $self->_use_hash_multivalue ?
Hash::MultiValue->from_mixed($params) :
$params;
$self->body_parameters($return) unless $self->has_body_parameters;
return $return;
}
sub prepare_connection {
my ($self) = @_;
my $env = $self->env;
$self->address( $env->{REMOTE_ADDR} );
$self->hostname( $env->{REMOTE_HOST} )
if exists $env->{REMOTE_HOST};
$self->protocol( $env->{SERVER_PROTOCOL} );
$self->remote_user( $env->{REMOTE_USER} );
$self->method( $env->{REQUEST_METHOD} );
$self->secure( $env->{'psgi.url_scheme'} eq 'https' ? 1 : 0 );
}
# XXX - FIXME - method is here now, move this crap...
around parameters => sub {
my ($orig, $self, $params) = @_;
if ($params) {
if ( !ref $params ) {
$self->_log->warn(
"Attempt to retrieve '$params' with req->params(), " .
"you probably meant to call req->param('$params')"
);
$params = undef;
}
return $self->$orig($params);
}
$self->$orig();
};
has base => (
is => 'rw',
required => 1,
lazy => 1,
default => sub {
my $self = shift;
return $self->path if $self->has_uri;
},
);
has _body => (
is => 'rw', clearer => '_clear_body', predicate => '_has_body',
);
# Eugh, ugly. Should just be able to rename accessor methods to 'body'
# and provide a custom reader..
sub body {
my $self = shift;
$self->prepare_body unless $self->_has_body;
croak 'body is a reader' if scalar @_;
return blessed $self->_body ? $self->_body->body : $self->_body;
}
has hostname => (
is => 'rw',
lazy => 1,
default => sub {
my ($self) = @_;
my ( $err, $sockaddr ) = getaddrinfo(
$self->address,
# no service
'',
{ flags => AI_NUMERICHOST }
);
if ( $err ) {
$self->_log->warn("resolve of hostname failed: $err");
return $self->address;
}
( $err, my $hostname ) = getnameinfo(
$sockaddr->{addr},
NI_NAMEREQD,
# we are only interested in the hostname, not the servicename
NIx_NOSERV
);
if ( $err ) {
$self->_log->warn("resolve of hostname failed: $err");
return $self->address;
}
return $hostname;
},
);
has _path => ( is => 'rw', predicate => '_has_path', clearer => '_clear_path' );
sub args { shift->arguments(@_) }
sub body_params { shift->body_parameters(@_) }
sub input { shift->body(@_) }
sub params { shift->parameters(@_) }
sub query_params { shift->query_parameters(@_) }
sub path_info { shift->path(@_) }
=for stopwords param params
=head1 NAME
Catalyst::Request - provides information about the current client request
=head1 SYNOPSIS
$req = $c->request;
$req->address eq "127.0.0.1";
$req->arguments;
$req->args;
$req->base;
$req->body;
$req->body_data;
$req->body_parameters;
$req->content_encoding;
$req->content_length;
$req->content_type;
$req->cookie;
$req->cookies;
$req->header;
$req->headers;
$req->hostname;
$req->input;
$req->query_keywords;
$req->match;
$req->method;
$req->param;
$req->parameters;
$req->params;
$req->path;
$req->protocol;
$req->query_parameters;
$req->read;
$req->referer;
$req->secure;
$req->captures;
$req->upload;
$req->uploads;
$req->uri;
$req->user;
$req->user_agent;
$req->env;
See also L<Catalyst>, L<Catalyst::Request::Upload>.
=head1 DESCRIPTION
This is the Catalyst Request class, which provides an interface to data for the
current client request. The request object is prepared by L<Catalyst::Engine>,
thus hiding the details of the particular engine implementation.
=head1 METHODS
=head2 $req->address
Returns the IP address of the client.
=head2 $req->arguments
Returns a reference to an array containing the arguments.
print $c->request->arguments->[0];
For example, if your action was
package MyApp::Controller::Foo;
sub moose : Local {
...
}
and the URI for the request was C<http://.../foo/moose/bah>, the string C<bah>
would be the first and only argument.
Arguments get automatically URI-unescaped for you.
=head2 $req->args
Shortcut for L</arguments>.
=head2 $req->base
Contains the URI base. This will always have a trailing slash. Note that the
URI scheme (e.g., http vs. https) must be determined through heuristics;
depending on your server configuration, it may be incorrect. See $req->secure
for more info.
If your application was queried with the URI
C<http://localhost:3000/some/path> then C<base> is C<http://localhost:3000/>.
=head2 $req->body
Returns the message body of the request, as returned by L<HTTP::Body>: a string,
unless Content-Type is C<application/x-www-form-urlencoded>, C<text/xml>, or
C<multipart/form-data>, in which case a L<File::Temp> object is returned.
=head2 $req->body_data
Returns a Perl representation of body data that is not classic HTML
form data, such as JSON, XML, etc. By default, Catalyst will parse incoming
data of the type 'application/json' for POST, PUT, PATCH or DELETE methods,
and return access to that data via this method.
You may define addition data_handlers via a global configuration
setting. See L<Catalyst\DATA HANDLERS> for more information.
If the body is malformed in some way (such as undefined or not content that
matches the content-type) we raise a L<Catalyst::Exception> with the error
text as the message.
If the body content type does not match an available data handler, this
will also raise an exception.
=head2 $req->body_parameters
Returns a reference to a hash containing body (POST) parameters. Values can
be either a scalar or an arrayref containing scalars.
print $c->request->body_parameters->{field};
print $c->request->body_parameters->{field}->[0];
These are the parameters from the POST part of the request, if any.
B<NOTE> If your POST is multipart, but contains non file upload parts (such
as an line part with an alternative encoding or content type) we do our best to
try and figure out how the value should be presented. If there's a specified character
set we will use that to decode rather than the default encoding set by the application.
However if there are complex headers and we cannot determine
the correct way to extra a meaningful value from the upload, in this case any
part like this will be represented as an instance of L<Catalyst::Request::PartData>.
Patches and review of this part of the code welcomed.
=head2 $req->body_params
Shortcut for body_parameters.
=head2 $req->content_encoding
Shortcut for $req->headers->content_encoding.
=head2 $req->content_length
Shortcut for $req->headers->content_length.
=head2 $req->content_type
Shortcut for $req->headers->content_type.
=head2 $req->cookie
A convenient method to access $req->cookies.
$cookie = $c->request->cookie('name');
@cookies = $c->request->cookie;
=cut
sub cookie {
my $self = shift;
if ( @_ == 0 ) {
return keys %{ $self->cookies };
}
if ( @_ == 1 ) {
my $name = shift;
unless ( exists $self->cookies->{$name} ) {
return undef;
}
return $self->cookies->{$name};
}
}
=head2 $req->cookies
Returns a reference to a hash containing the cookies.
print $c->request->cookies->{mycookie}->value;
The cookies in the hash are indexed by name, and the values are L<CGI::Simple::Cookie>
objects.
=head2 $req->header
Shortcut for $req->headers->header.
=head2 $req->headers
Returns an L<HTTP::Headers> object containing the headers for the current request.
print $c->request->headers->header('X-Catalyst');
=head2 $req->hostname
Returns the hostname of the client. Use C<< $req->uri->host >> to get the hostname of the server.
=head2 $req->input
Alias for $req->body.
=head2 $req->query_keywords
Contains the keywords portion of a query string, when no '=' signs are
present.
http://localhost/path?some+keywords
$c->request->query_keywords will contain 'some keywords'
=head2 $req->match
This contains the matching part of a Regex action. Otherwise
it returns the same as 'action', except for default actions,
which return an empty string.
=head2 $req->method
Contains the request method (C<GET>, C<POST>, C<HEAD>, etc).
=head2 $req->param
Returns GET and POST parameters with a CGI.pm-compatible param method. This
is an alternative method for accessing parameters in $c->req->parameters.
$value = $c->request->param( 'foo' );
@values = $c->request->param( 'foo' );
@params = $c->request->param;
Like L<CGI>, and B<unlike> earlier versions of Catalyst, passing multiple
arguments to this method, like this:
$c->request->param( 'foo', 'bar', 'gorch', 'quxx' );
will set the parameter C<foo> to the multiple values C<bar>, C<gorch> and
C<quxx>. Previously this would have added C<bar> as another value to C<foo>
(creating it if it didn't exist before), and C<quxx> as another value for
C<gorch>.
B<NOTE> this is considered a legacy interface and care should be taken when
using it. C<< scalar $c->req->param( 'foo' ) >> will return only the first
C<foo> param even if multiple are present; C<< $c->req->param( 'foo' ) >> will
return a list of as many are present, which can have unexpected consequences
when writing code of the form:
$foo->bar(
a => 'b',
baz => $c->req->param( 'baz' ),
);
If multiple C<baz> parameters are provided this code might corrupt data or
cause a hash initialization error. For a more straightforward interface see
C<< $c->req->parameters >>.
B<NOTE> Interfaces like this, which are based on L<CGI> and the C<param> method
are known to cause demonstrated exploits. It is highly recommended that you
avoid using this method, and migrate existing code away from it. Here's a
whitepaper of the exploit:
L<http://blog.gerv.net/2014/10/new-class-of-vulnerability-in-perl-web-applications/>
B<NOTE> Further discussion on IRC indicate that the L<Catalyst> core team from 'back then'
were well aware of this hack and this is the main reason we added the new approach to
getting parameters in the first place.
Basically this is an exploit that takes advantage of how L<\param> will do one thing
in scalar context and another thing in list context. This is combined with how Perl
chooses to deal with duplicate keys in a hash definition by overwriting the value of
existing keys with a new value if the same key shows up again. Generally you will be
vulnerable to this exploit if you are using this method in a direct assignment in a
hash, such as with a L<DBIx::Class> create statement. For example, if you have
parameters like:
user?user=123&foo=a&foo=user&foo=456
You could end up with extra parameters injected into your method calls:
$c->model('User')->create({
user => $c->req->param('user'),
foo => $c->req->param('foo'),
});
Which would look like:
$c->model('User')->create({
user => 123,
foo => qw(a user 456),
});
(or to be absolutely clear if you are not seeing it):
$c->model('User')->create({
user => 456,
foo => 'a',
});
Possible remediations include scrubbing your parameters with a form validator like
L<HTML::FormHandler> or being careful to force scalar context using the scalar
keyword:
$c->model('User')->create({
user => scalar($c->req->param('user')),
foo => scalar($c->req->param('foo')),
});
Upcoming versions of L<Catalyst> will disable this interface by default and require
you to positively enable it should you require it for backwards compatibility reasons.
=cut
sub param {
my $self = shift;
if ( @_ == 0 ) {
return keys %{ $self->parameters };
}
# If anything in @_ is undef, carp about that, and remove it from
# the list;
my @params = grep { defined($_) ? 1 : do {carp "You called ->params with an undefined value"; 0} } @_;
if ( @params == 1 ) {
defined(my $param = shift @params) ||
carp "You called ->params with an undefined value 2";
unless ( exists $self->parameters->{$param} ) {
return wantarray ? () : undef;
}
if ( ref $self->parameters->{$param} eq 'ARRAY' ) {
return (wantarray)
? @{ $self->parameters->{$param} }
: $self->parameters->{$param}->[0];
}
else {
return (wantarray)
? ( $self->parameters->{$param} )
: $self->parameters->{$param};
}
}
elsif ( @params > 1 ) {
my $field = shift @params;
$self->parameters->{$field} = [@params];
}
}
=head2 $req->parameters
Returns a reference to a hash containing GET and POST parameters. Values can
be either a scalar or an arrayref containing scalars.
print $c->request->parameters->{field};
print $c->request->parameters->{field}->[0];
This is the combination of C<query_parameters> and C<body_parameters>.
=head2 $req->params
Shortcut for $req->parameters.
=head2 $req->path
Returns the path, i.e. the part of the URI after $req->base, for the current request.
http://localhost/path/foo
$c->request->path will contain 'path/foo'
=head2 $req->path_info
Alias for path, added for compatibility with L<CGI>.
=cut
sub path {
my ( $self, @params ) = @_;
if (@params) {
$self->uri->path(@params);
$self->_clear_path;
}
elsif ( $self->_has_path ) {
return $self->_path;
}
else {
my $path = $self->uri->path;
my $location = $self->base->path;
$path =~ s/^(\Q$location\E)?//;
$path =~ s/^\///;
$self->_path($path);
return $path;
}
}
=head2 $req->protocol
Returns the protocol (HTTP/1.0 or HTTP/1.1) used for the current request.
=head2 $req->query_parameters
=head2 $req->query_params
Returns a reference to a hash containing query string (GET) parameters. Values can
be either a scalar or an arrayref containing scalars.
print $c->request->query_parameters->{field};
print $c->request->query_parameters->{field}->[0];
=head2 $req->read( [$maxlength] )
Reads a chunk of data from the request body. This method is intended to be
used in a while loop, reading $maxlength bytes on every call. $maxlength
defaults to the size of the request if not specified.
=head2 $req->read_chunk(\$buff, $max)
Reads a chunk.
You have to set MyApp->config(parse_on_demand => 1) to use this directly.
=head2 $req->referer
Shortcut for $req->headers->referer. Returns the referring page.
=head2 $req->secure
Returns true or false, indicating whether the connection is secure
(https). The reliability of $req->secure may depend on your server
configuration; Catalyst relies on PSGI to determine whether or not a
request is secure (Catalyst looks at psgi.url_scheme), and different
PSGI servers may make this determination in different ways (as by
directly passing along information from the server, interpreting any of
several HTTP headers, or using heuristics of their own).
=head2 $req->captures
Returns a reference to an array containing captured args from chained
actions or regex captures.
my @captures = @{ $c->request->captures };
=head2 $req->upload
A convenient method to access $req->uploads.
$upload = $c->request->upload('field');
@uploads = $c->request->upload('field');
@fields = $c->request->upload;
for my $upload ( $c->request->upload('field') ) {
print $upload->filename;
}
=cut
sub upload {
my $self = shift;
if ( @_ == 0 ) {
return keys %{ $self->uploads };
}
if ( @_ == 1 ) {
my $upload = shift;
unless ( exists $self->uploads->{$upload} ) {
return wantarray ? () : undef;
}
if ( ref $self->uploads->{$upload} eq 'ARRAY' ) {
return (wantarray)
? @{ $self->uploads->{$upload} }
: $self->uploads->{$upload}->[0];
}
else {
return (wantarray)
? ( $self->uploads->{$upload} )
: $self->uploads->{$upload};
}
}
if ( @_ > 1 ) {
while ( my ( $field, $upload ) = splice( @_, 0, 2 ) ) {
if ( exists $self->uploads->{$field} ) {
for ( $self->uploads->{$field} ) {
$_ = [$_] unless ref($_) eq "ARRAY";
push( @$_, $upload );
}
}
else {
$self->uploads->{$field} = $upload;
}
}
}
}
=head2 $req->uploads
Returns a reference to a hash containing uploads. Values can be either a
L<Catalyst::Request::Upload> object, or an arrayref of
L<Catalyst::Request::Upload> objects.
my $upload = $c->request->uploads->{field};
my $upload = $c->request->uploads->{field}->[0];
=head2 $req->uri
Returns a L<URI> object for the current request. Stringifies to the URI text.
=head2 $req->mangle_params( { key => 'value' }, $appendmode);
Returns a hashref of parameters stemming from the current request's params,
plus the ones supplied. Keys for which no current param exists will be
added, keys with undefined values will be removed and keys with existing
params will be replaced. Note that you can supply a true value as the final
argument to change behavior with regards to existing parameters, appending