lib/CGI/Application/Plugin/RemoteIP.pm

filter: Statementstmt 46.5% 20 / 43 Branchbran 0.0% 0 / 10 Conditioncond 0.0% 0 / 4 MC/DCmcdc 0.0% 0 / 2 Subroutinesub 57.1% 4 / 7 Podpod 100% 3 / 3 totaltotal 39.1% 27 / 69 CC 8 SCAR 26.7
CC
8
Cov
35%
remote_ip
30.0
is_ipv6
12.0
is_ipv4
6.0
CRAP 14.4
↑ Summary
1  
2 =head1 NAME
3  
4 CGI::Application::Plugin::RemoteIP - Unified Remote IP handling
5  
6 =head1 SYNOPSIS
7  
8 use CGI::Application::Plugin::RemoteIP;
9  
10  
11 # Your application
12 sub run_mode {
13 my ($self) = ( @_);
14  
15 my $ip = $self->remote_ip();
16 }
17  
18 =cut
19  
20  
21 =head1 DESCRIPTION
22  
23 This module simplifies the detection of the remote IP address of your visitors.
24  
25 =cut
26  
27 =head1 MOTIVATION
28  
29 This module allows you to remove scattered references in your code, such as:
30  
31 =for example begin
32  
33 # Get IP
34 my $ip = $ENV{'REMOTE_ADDR'};
35  
36 # Remove faux IPv6-prefix.
37 $ip =~ s/^::ffff://g;
38 ..
39  
40 =for example end
41  
42 Instead your code and use the simpler expression:
43  
44 =for example begin
45  
46 my $ip = $self->remote_ip();
47  
48 =for example end
49  
50 =cut
51  
52 =head1 SECURITY
53  
54 The code in this module will successfully understand the C<X-Forwarded-For>
55 header and B<trust> it.
56  
57 Unless you have setup any proxy, or webserver, to scrub this header this means
58 the value that is used is at risk of being spoofed, bogus, or otherwise
59 malicious.
60  
61 =cut
62  
63 1 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
64 1 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
65  
66 package CGI::Application::Plugin::RemoteIP;
67  
68  
69 1 our $VERSION = '0.1';
70  
71  
72 =head1 METHODS
73  
74  
75 =head2 import
76  
77 Add our three public-methods into the caller's namespace:
78  
79 =over 8
80  
81 =item remote_ip
82  
83 The remote IP of the client.
84  
85 =item is_ipv4
86  
87 A method to return 1 if the visitor is using IPv4 and 0 otherwise.
88  
89 =item is_ipv6
90  
91 A method to return 1 if the visitor is using IPv6 and 0 otherwise.
92  
93 =back
94  
95 =cut
96  
97 sub import
98 1 ▶{
Subroutine import: called CC=1 SCAR=0.0
99 1 my $pkg = shift;
100 1 my $callpkg = caller;
101  
102 {
103 ## no critic
104 1 ▶ no strict qw(refs);
Subroutine BEGIN: called CC=1 SCAR=0.0
105 ## use critic
106 1 *{ $callpkg . '::remote_ip' } = \&remote_ip;
107 1 *{ $callpkg . '::is_ipv6' } = \&is_ipv6;
108 1 *{ $callpkg . '::is_ipv4' } = \&is_ipv4;
109 }
110 }
111  
112  
113 =head2 remote_ip
114  
115 Return the remote IP of the visitor, whether via the C<X-Forwarded-For> header
116 or via the standard CGI environmental variable C<REMOTE_ADDR>.
117  
118 =cut
119  
120 sub remote_ip
121 0 ▶{
Subroutine remote_ip: not called CC=5 SCAR=34.0
Pod documented
122 0 my $cgi_app = shift;
123  
124 # X-Forwarded-For header is the first thing we look for.
125 0 ▶ my $forwarded = $ENV{ 'HTTP_X_FORWARDED_FOR' } || "";
Condition0%0/2
$ENV{'HTTP_X_FORWARDED_FOR'} || ''
l!l
00
MC/DC0%0/1
$ENV{'HTTP_X_FORWARDED_FOR'} || ''
$ENV{'HTTP_X_FORWARDED_FOR'}
Truth table0%0/2
A
A= $ENV{'HTTP_X_FORWARDED_FOR'}
Aresult
11
00
126 0 ▶ if ( length $forwarded )
Branch: 1 branch
BranchTrueFalseTotal
if (length $forwarded) 0 0 0
127 {
128  
129 # Split in case there are multiple values
130 0 my @vals = split( /[ ,]/, $forwarded );
131  
132 0 ▶ if (@vals)
Branch: 1 branch
BranchTrueFalseTotal
if (@vals) 0 0 0
133 {
134  
135 # Get the first/trusted value.
136 0 my $ip = $vals[0];
137  
138 # drop IPv6 prefix
139 0 $ip =~ s/^::ffff://gi;
140  
141 # Drop any optional port
142 0 $ip =~ s/:([0-9]+)$//g;
143  
144 0 return $ip;
145 }
146 }
147  
148 # This should always work.
149 0 ▶ my $ip = $ENV{ 'REMOTE_ADDR' } || "";
Condition0%0/2
$ENV{'REMOTE_ADDR'} || ''
l!l
00
MC/DC0%0/1
$ENV{'REMOTE_ADDR'} || ''
$ENV{'REMOTE_ADDR'}
Truth table0%0/2
A
A= $ENV{'REMOTE_ADDR'}
Aresult
11
00
150  
151 # drop IPv6 prefix
152 0 $ip =~ s/^::ffff://gi;
153  
154 # Drop any optional port
155 0 $ip =~ s/:([0-9]+)$//g;
156  
157 0 return ($ip);
158  
159 }
160  
161  
162 =head2 is_ipv4
163  
164 Determine whether the remote IP address is IPv4.
165  
166 =cut
167  
168 sub is_ipv4
169 0 ▶{
Subroutine is_ipv4: not called CC=2 SCAR=17.9
Pod documented
170  
171 # Get the IP
172 0 my $self = shift;
173 0 my $ip = $self->remote_ip();
174  
175 # Dotted quad?
176 0 ▶ if ( $ip =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/ )
Branch: 1 branch
BranchTrueFalseTotal
if ($ip =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/) { } 0 0 0
177 {
178 0 return 1;
179 }
180 else
181 {
182 0 return 0;
183 }
184 }
185  
186  
187 =head2 is_ipv6
188  
189 Determine whether the remote IP address is IPv6.
190  
191 =cut
192  
193 sub is_ipv6
194 0 ▶{
Subroutine is_ipv6: not called CC=3 SCAR=24.8
Pod documented
195  
196 # Get the IP
197 0 my $self = shift;
198 0 my $ip = $self->remote_ip();
199  
200 # not IPv6 if IPv4
201 0 ▶ return 0 if ( $ip =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/ );
Branch: 1 branch
BranchTrueFalseTotal
if $ip =~ /^([0-9]+)\.([0-9]+)\.([0-9]+)\.([0-9]+)$/ 0 0 0
202  
203 # Not IPv6 unless it has a colon
204 0 ▶ return 0 unless ( $ip =~ /:/ );
Branch: 1 branch
BranchTrueFalseTotal
unless $ip =~ /:/ 0 0 0
205  
206 # Probably OK
207 0 return 1;
208 }
209  
210  
211  
212 =head1 AUTHOR
213  
214 Steve Kemp <steve@steve.org.uk>
215  
216 =cut
217  
218 =head1 COPYRIGHT AND LICENSE
219  
220 Copyright (C) 2015 Steve Kemp <steve@steve.org.uk>.
221  
222 This library is free software. You can modify and or distribute it under
223 the same terms as Perl itself.
224  
225 =cut
226  
227  
228  
229 1 1;
↑ Summary