Cookie.pm

filter: Statementstmt 52.1% 209 / 401 Branchbran 36.5% 79 / 216 Conditioncond 15.6% 28 / 179 MC/DCmcdc 7.3% 7 / 95 Subroutinesub 57.8% 37 / 64 Podpod 100% 46 / 46 totaltotal 40.5% 406 / 1001 CC 180 SCAR 46.3
CC
180
Cov
40%
_encrypt_objects
306.0
decrypt
210.0
is_valid
210.0
CRAP 102.9
« Cookie/Domain.pm ↑ Summary Cookies.pm »
1 ##----------------------------------------------------------------------------
2 ## Cookies API for Server & Client - ~/lib/Cookie.pm
3 ## Version v0.4.1
4 ## Copyright(c) 2026 DEGUEST Pte. Ltd.
5 ## Author: Jacques Deguest <jack@deguest.jp>
6 ## Created 2019/10/08
7 ## Modified 2026/11/12
8 ## You can use, copy, modify and redistribute this package and associated
9 ## files under the same terms as Perl itself.
10 ##----------------------------------------------------------------------------
11 package Cookie;
12 BEGIN
13 9 ▶{
Subroutine BEGIN: called CC=1 SCAR=0.0
14 9 ▶ use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
15 9 ▶ use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
16 9 ▶ use warnings::register;
Subroutine BEGIN: called CC=1 SCAR=0.0
17 9 ▶ use parent qw( Module::Generic );
Subroutine BEGIN: called CC=1 SCAR=0.0
18 9 ▶ use vars qw( $VERSION $SUBS $COOKIE_DEBUG );
Subroutine BEGIN: called CC=1 SCAR=0.0
19 9 ▶ use DateTime::Lite;
Subroutine BEGIN: called CC=1 SCAR=0.0
20 9 ▶ use DateTime::Format::Lite;
Subroutine BEGIN: called CC=1 SCAR=0.0
21 9 ▶ use Module::Generic::DateTime;
Subroutine BEGIN: called CC=1 SCAR=0.0
22 9 ▶ use URI::Escape ();
Subroutine BEGIN: called CC=1 SCAR=0.0
23 9 ▶ use overload (
Subroutine BEGIN: called CC=1 SCAR=0.0
24 '""' => \&as_string,
25 5 ▶ bool => sub{ return( $_[0] ) },
Subroutine __ANON__: called CC=1 SCAR=0.0
26 # '""' => sub{ $_[0]->as_string },
27 9 'eq' => \&same_as,
28 '==' => \&same_as,
29 fallback => 1,
30 9 );
31 9 our $VERSION = 'v0.4.1';
32 9 our $SUBS;
33 9 our $COOKIE_DEBUG = 0;
34 9 ▶ use constant CRYPTX_VERSION => '0.074';
Subroutine BEGIN: called CC=1 SCAR=0.0
35 };
36  
37 9 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
38 9 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
39  
40 sub init
41 33 ▶{
Subroutine init: called CC=2 SCAR=6.9
Pod documented
42 33 my $self = shift( @_ );
43 9 ▶ no overloading;
Subroutine BEGIN: called CC=1 SCAR=0.0
44 33 $self->{name} = undef;
45 33 $self->{value} = undef;
46 33 $self->{comment} = undef;
47 33 $self->{commentURL} = undef;
48 33 $self->{discard} = 0;
49 33 $self->{domain} = undef;
50 33 $self->{expires} = undef;
51 33 $self->{http_only} = 0;
52 # In the case of cookie sent from the server and no domain was set
53 # This domain, which we need anyway, was provided implicitly or explicitly
54 33 $self->{implicit} = 0;
55 33 $self->{max_age} = undef;
56 33 $self->{path} = undef;
57 33 $self->{port} = undef;
58 33 $self->{same_site} = undef;
59 33 $self->{secure} = 0;
60 33 $self->{accessed} = time();
61 33 $self->{created} = time();
62 # Ref: <https://stackoverflow.com/questions/41467012/what-is-the-difference-between-signed-and-encrypted-cookies-in-rails>
63 # Integrity protection with Message Authentication Code (MAC)
64 # e.g. Crypt::Mac::HMAC::hmac("SHA256","plop","Oh boy, this is cool")
65 33 $self->{sign} = 0;
66 # Crypt::Cipher::AES
67 # Crypt::Cipher
68 # one of 'AES', 'Anubis', 'Blowfish', 'CAST5', 'Camellia', 'DES', 'DES_EDE',
69 # 'KASUMI', 'Khazad', 'MULTI2', 'Noekeon', 'RC2', 'RC5', 'RC6',
70 # 'SAFERP', 'SAFER_K128', 'SAFER_K64', 'SAFER_SK128', 'SAFER_SK64',
71 # 'SEED', 'Skipjack', 'Twofish', 'XTEA', 'IDEA', 'Serpent'
72 # simply any <NAME> for which there exists Crypt::Cipher::<NAME>
73 # Encryption algorithm
74 # Ref: <https://stackoverflow.com/questions/4147451/aes-vs-blowfish-for-file-encryption>
75 33 $self->{algo} = 'AES';
76 33 $self->{encrypt} = 0;
77 33 $self->{initialisation_vector} = undef;
78 33 $self->{key} = undef;
79 # Should this API be strict about the cookie names?
80 # When true, this will reject cookie names with invalid characters.
81 33 $self->{strict} = 0;
82 # Needs to be an empty string or it would be overriden by Module::Generic who would put here the package version instead
83 33 $self->{version} = '';
84 33 $self->{_init_strict_use_sub} = 1;
85 33 ▶ $self->SUPER::init( @_ ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->SUPER::init(@_) or return $self->pass_error 32 1 33
86 32 $self->{fields} = [qw( name value comment commentURL discard domain expires http_only implicit max_age path port same_site secure version )];
87 32 return( $self );
88 }
89  
90 12 ▶sub accessed_on { return( shift->_set_get_datetime( 'accessed', @_ ) ); }
Subroutine accessed_on: called CC=1 SCAR=0.0
Pod documented
91  
92 sub algo
93 0 ▶{
Subroutine algo: not called CC=7 SCAR=40.3
Pod documented
94 0 my $self = shift( @_ );
95 0 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 0 0 0
96 {
97 0 my $algo = shift( @_ );
98 0 ▶ if( defined( $algo ) && CORE::length( $algo ) )
Branch: 1 branch
BranchTrueFalseTotal
if (defined $algo and length $algo) { } 0 0 0
Condition0%0/3
defined $algo and length $algo
!ll&&!rl&&r
000
MC/DC0%0/2
defined $algo and length $algo
defined $algo length $algo
Truth table0%0/3
A and B
A= defined $algoB= length $algo
ABresult
0X0
100
111
99 {
100 0 ▶ $self->_load_class( 'Crypt::Mode::CBC', { version => CRYPTX_VERSION } ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Crypt::Mode::CBC", {"version", "0.074"}) or return $self->pass_error 0 0 0
101 # try-catch
102 0 local $@;
103 eval
104 0 {
105 # Crypt::Mode::CBC dies when it is unhappy, but we catch a null return
106 # value anyway just in case
107 0 ▶ my $o = Crypt::Mode::CBC->new( $algo ) ||
Condition0%0/2
'Crypt::Mode::CBC'->new($algo) || die(qq[Unsupported algorithm "$algo"\n])
l!l
00
MC/DC0%0/1
'Crypt::Mode::CBC'->new($algo) || die(qq[Unsupported algorithm "$algo"\n])
'Crypt::Mode::CBC'->new($algo)
Truth table0%0/2
A
A= 'Crypt::Mode::CBC'->new($algo)
Aresult
11
00
108 die( "Unsupported algorithm \"$algo\"\n" );
109 0 $self->_set_get_scalar_as_object( 'algo', $algo );
110 0 $self->reset(1);
111 };
112 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
113 {
114 0 return( $self->error( "Unsupported algorithm \"$algo\": $@" ) );
115 }
116 }
117 else
118 {
119 0 $self->{algo} = undef;
120 }
121 }
122 0 return( $self->_set_get_scalar_as_object( 'algo' ) );
123 }
124  
125 sub apply
126 7 ▶{
Subroutine apply: called CC=10 SCAR=23.2
Pod documented
127 7 my $self = shift( @_ );
128 7 my $hash = $self->_get_args_as_hash( @_ );
129 7 ▶ return( $self ) if( !scalar( keys( %$hash ) ) );
Branch: 1 branch
BranchTrueFalseTotal
unless scalar keys %$hash 0 7 7
130 7 ▶ if( !defined( $SUBS ) ||
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $Cookie::SUBS or ref $Cookie::SUBS ne "ARRAY" or not scalar @$Cookie::SUBS) 2 5 7
Condition66%4/6
not defined $Cookie::SUBS or ref $Cookie::SUBS ne "ARRAY" or not scalar @$Cookie::SUBS
l!l&&r!l&&!r
205
not defined $Cookie::SUBS or ref $Cookie::SUBS ne "ARRAY"
l!l&&r!l&&!r
205
MC/DC33%1/3
not defined $Cookie::SUBS or ref $Cookie::SUBS ne "ARRAY" or not scalar @$Cookie::SUBS
not defined $Cookie::SUBS ref $Cookie::SUBS ne "ARRAY" not scalar @$Cookie::SUBS
Truth table50%2/4
not(A) or B or not(C)
A= not defined $Cookie::SUBSB= ref $Cookie::SUBS ne "ARRAY"C= not scalar @$Cookie::SUBS
ABCresult
1XX1
01X1
0011
0000
131 ref( $SUBS ) ne 'ARRAY' ||
132 !scalar( @$SUBS ) )
133 {
134 2 $SUBS = [grep( /^(?!apply|as_hash|as_string|can|fields|import|init|reset)(?:[a-z][a-z\_]+)$/, keys( %Cookie:: ) )];
135 }
136  
137 7 foreach( @$SUBS )
138 {
139 # Value could be undef
140 # Passing an empty string to Module::Generic::Number will trigger an error (undef)
141 # So if the value is empty, we simply set it directly.
142 280 ▶ if( $_ eq 'version' && !CORE::length( $hash->{ $_ } ) )
Branch: 1 branch
BranchTrueFalseTotal
if ($_ eq "version" and not length $hash->{$_}) 7 273 280
Condition66%2/3
$_ eq "version" and not length $hash->{$_}
!ll&&!rl&&r
27307
MC/DC50%1/2
$_ eq "version" and not length $hash->{$_}
$_ eq "version" not length $hash->{$_}
Truth table66%2/3
A and not(B)
A= $_ eq "version"B= not length $hash->{$_}
ABresult
0X0
100
111
143 {
144 7 $self->{ $_ } = $hash->{ $_ };
145 7 next;
146 }
147  
148 273 ▶ if( CORE::exists( $hash->{ $_ } ) )
Branch: 1 branch
BranchTrueFalseTotal
if (exists $hash->{$_}) 69 204 273
149 {
150 69 ▶ if( !defined( $hash->{ $_ } ) )
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $hash->{$_}) { } 1 68 69
151 {
152 1 $self->{ $_ } = undef;
153 }
154 else
155 {
156 68 $self->$_( $hash->{ $_ } );
157 }
158 }
159 }
160 7 return( $self );
161 }
162  
163 sub as_hash
164 0 ▶{
Subroutine as_hash: not called CC=2 SCAR=17.9
Pod documented
165 0 my $self = shift( @_ );
166 0 my $ref = {};
167 0 foreach my $m ( qw( name value comment commentURL domain expires http_only implicit max_age path port same_site secure version created_on accessed_on ) )
168 {
169 0 $ref->{ $m } = $self->$m;
170 }
171 0 return( $ref );
172 }
173  
174 # sub as_string { return( shift->APR::Request::Cookie::as_string ); }
175 # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie
176 sub as_string
177 25 ▶{
Subroutine as_string: called CC=34 SCAR=51.3
Pod documented
178 25 my $self = shift( @_ );
179 # If is_request is true, we only send the name and value
180 25 my $opts = $self->_get_args_as_hash( @_ );
181 25 ▶ $opts->{is_request} //= 0;
Condition50%1/2
$opts->{"is_request"} //= 0
l!l
025
MC/DC0%0/1
$opts->{"is_request"} //= 0
$opts->{"is_request"}
Truth table50%1/2
A
A= $opts->{"is_request"}
Aresult
11
00
182 25 ▶ return( $self->{_cache_value} ) if( $self->{_cache_value} && !CORE::length( $self->{_reset} ) && !$opts->{is_request} );
Branch: 1 branch
BranchTrueFalseTotal
if $self->{"_cache_value"} and not length $self->{"_reset"} and not $opts->{"is_request"} 0 25 25
Condition33%2/6
$self->{"_cache_value"} and not length $self->{"_reset"} and not $opts->{"is_request"}
!ll&&!rl&&r
2500
$self->{"_cache_value"} and not length $self->{"_reset"}
!ll&&!rl&&r
2500
MC/DC0%0/3
$self->{"_cache_value"} and not length $self->{"_reset"} and not $opts->{"is_request"}
$self->{"_cache_value"} not length $self->{"_reset"} not $opts->{"is_request"}
Truth table25%1/4
A and not(B) and not(C)
A= $self->{"_cache_value"}B= not length $self->{"_reset"}C= not $opts->{"is_request"}
ABCresult
0XX0
10X0
1100
1111
183 25 my $name = $self->name;
184 25 ▶ return( $self->error( "No cookie is name in this cookie object." ) ) if( !defined( $name ) || !length( $name ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $name and length $name 0 25 25
Condition33%1/3
defined $name and length $name
!ll&&!rl&&r
0025
MC/DC0%0/2
defined $name and length $name
defined $name length $name
Truth table33%1/3
A and B
A= defined $nameB= length $name
ABresult
0X0
100
111
185 25 ▶ if( $name =~ m/[^a-zA-Z\-\.\_\~]/ )
Branch: 1 branch
BranchTrueFalseTotal
if ($name =~ /[^a-zA-Z\-\.\_\~]/) 0 25 25
186 {
187 0 $name = URI::Escape::uri_escape( $name );
188 }
189 25 my $value = $self->value;
190  
191 25 ▶ if( $self->sign || $self->encrypt )
Branch: 1 branch
BranchTrueFalseTotal
if ($self->sign or $self->encrypt) 0 25 25
Condition33%1/3
$self->sign or $self->encrypt
l!l&&r!l&&!r
0025
MC/DC0%0/2
$self->sign or $self->encrypt
$self->sign $self->encrypt
Truth table33%1/3
A or B
A= $self->signB= $self->encrypt
ABresult
1X1
011
000
192 {
193 0 ▶ my $key = $self->key ||
Condition0%0/2
$self->key || (return $self->error('Signature or encryption has been enabled, but no key was provided.'))
l!l
00
MC/DC0%0/1
$self->key || (return $self->error('Signature or encryption has been enabled, but no key was provided.'))
$self->key
Truth table0%0/2
A
A= $self->key
Aresult
11
00
194 return( $self->error( "Signature or encryption has been enabled, but no key was provided." ) );
195 0 ▶ if( $self->sign->is_true )
Branch: 2 branches
BranchTrueFalseTotal
if ($self->sign->is_true) { } 0 0 0
elsif ($self->encrypt) { } 0 0 0
196 {
197 0 ▶ $self->_load_class( 'Crypt::Mac::HMAC', { version => CRYPTX_VERSION } ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Crypt::Mac::HMAC", {"version", "0.074"}) or return $self->pass_error 0 0 0
198 # try-catch
199 0 local $@;
200 my $signature = eval
201 0 {
202 0 Crypt::Mac::HMAC::hmac_b64( "SHA256", "$key", "$value" );
203 };
204 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
205 {
206 0 ▶ return( $self->error( "An error occurred while trying to ", ( $self->sign ? 'sign' : 'encrypt' ), " cookie value: $@" ) );
Branch: 1 branch
BranchTrueFalseTotal
$self->sign ? : 0 0 0
207 }
208 0 $value = "$value.$signature";
209 }
210 elsif( $self->encrypt )
211 {
212 0 ▶ $self->_load_class( 'Crypt::Misc', { version => CRYPTX_VERSION } ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Crypt::Misc", {"version", "0.074"}) or return $self->pass_error 0 0 0
213 0 my $algo = $self->algo;
214 0 ▶ my $p = $self->_encrypt_objects( $key => $algo ) || return( $self->pass_error );
Condition0%0/2
$self->_encrypt_objects($key, $algo) || (return $self->pass_error)
l!l
00
MC/DC0%0/1
$self->_encrypt_objects($key, $algo) || (return $self->pass_error)
$self->_encrypt_objects($key, $algo)
Truth table0%0/2
A
A= $self->_encrypt_objects($key, $algo)
Aresult
11
00
215 0 my $crypt = $p->{crypt};
216 # $value = Crypt::Misc::encode_b64( $crypt->encrypt( "$value", $p->{key}, $p->{iv} ) );
217 # try-catch
218 0 local $@;
219 my $encrypted = eval
220 0 {
221 0 $crypt->encrypt( "$value", $p->{key}, $p->{iv} );
222 };
223 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
224 {
225 0 ▶ return( $self->error( "An error occurred while trying to ", ( $self->sign ? 'sign' : 'encrypt' ), " cookie value: $@" ) );
Branch: 1 branch
BranchTrueFalseTotal
$self->sign ? : 0 0 0
226 }
227 0 $value = Crypt::Misc::encode_b64( $encrypted );
228 }
229 }
230  
231 # Not necessary to encode, but customary and practical
232 25 ▶ if( CORE::length( $value ) )
Branch: 1 branch
BranchTrueFalseTotal
if (length $value) 25 0 25
233 {
234 25 my $wrapped_in_double_quotes = 0;
235 25 ▶ if( $value =~ /^\"([^\"]+)\"$/ )
Branch: 1 branch
BranchTrueFalseTotal
if ($value =~ /^\"([^\"]+)\"$/) 0 25 25
236 {
237 0 $value = $1;
238 0 $wrapped_in_double_quotes = 1;
239 }
240 25 $value = URI::Escape::uri_escape( $value );
241 25 ▶ $value = sprintf( '"%s"', $value ) if( $wrapped_in_double_quotes );
Branch: 1 branch
BranchTrueFalseTotal
if $wrapped_in_double_quotes 0 25 25
242 }
243 25 my @parts = ( "${name}=${value}" );
244 25 ▶ return( $parts[0] ) if( $opts->{is_request} );
Branch: 1 branch
BranchTrueFalseTotal
if $opts->{"is_request"} 0 25 25
245 25 ▶ push( @parts, sprintf( 'Domain=%s', $self->domain ) ) if( $self->domain );
Branch: 1 branch
BranchTrueFalseTotal
if $self->domain 0 25 25
246 25 ▶ push( @parts, sprintf( 'Port=%d', $self->port ) ) if( $self->port );
Branch: 1 branch
BranchTrueFalseTotal
if $self->port 0 25 25
247 25 ▶ push( @parts, sprintf( 'Path=%s', $self->path ) ) if( $self->path );
Branch: 1 branch
BranchTrueFalseTotal
if $self->path 4 21 25
248 # Could be empty. If not specified, it would be a session cookie
249 25 ▶ if( ( my $t = $self->expires ) && !$self->max_age->length )
Branch: 1 branch
BranchTrueFalseTotal
if (my $t = $self->expires and not $self->max_age->length) 13 12 25
Condition100%3/3
my $t = $self->expires and not $self->max_age->length
!ll&&!rl&&r
10213
MC/DC100%2/2
my $t = $self->expires and not $self->max_age->length
my $t = $self->expires not $self->max_age->length
Truth table100%3/3
A and not(B)
A= my $t = $self->expiresB= not $self->max_age->length
ABresult
0X0
100
111
250 {
251 13 ( my $dt_str = "$t" ) =~ s/\bUTC\b/GMT/;
252 13 push( @parts, sprintf( 'Expires=%s', $dt_str ) );
253 }
254 # Number of seconds until the cookie expires
255 # A zero or negative number will expire the cookie immediately.
256 # If both Expires and Max-Age are set, Max-Age has precedence.
257 25 ▶ push( @parts, sprintf( 'Max-Age=%d', $self->max_age ) ) if( CORE::length( $self->max_age ) );
Branch: 1 branch
BranchTrueFalseTotal
if length $self->max_age 2 23 25
258 25 ▶ if( $self->same_site->defined && $self->same_site =~ /^(?:lax|strict|none)/i )
Branch: 1 branch
BranchTrueFalseTotal
if ($self->same_site->defined and $self->same_site =~ /^(?:lax|strict|none)/i) 3 22 25
Condition100%3/3
$self->same_site->defined and $self->same_site =~ /^(?:lax|strict|none)/i
!ll&&!rl&&r
2113
MC/DC100%2/2
$self->same_site->defined and $self->same_site =~ /^(?:lax|strict|none)/i
$self->same_site->defined $self->same_site =~ /^(?:lax|strict|none)/i
Truth table100%3/3
A and B
A= $self->same_site->definedB= $self->same_site =~ /^(?:lax|strict|none)/i
ABresult
0X0
100
111
259 {
260 3 push( @parts, sprintf( 'SameSite=%s', ucfirst( lc( $self->same_site ) ) ) );
261 }
262 25 ▶ push( @parts, 'Secure' ) if( $self->secure );
Branch: 1 branch
BranchTrueFalseTotal
if $self->secure 1 24 25
263 25 ▶ push( @parts, 'HttpOnly' ) if( $self->http_only );
Branch: 1 branch
BranchTrueFalseTotal
if $self->http_only 1 24 25
264 25 my $c = join( '; ', @parts );
265 25 $self->{_cache_value} = $c;
266 25 CORE::delete( $self->{_reset} );
267 25 return( $c );
268 }
269  
270 # A Version 2 cookie, which has been deprecated by protocol
271 # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie2
272 0 ▶sub comment { return( shift->_set_get_scalar_as_object( 'comment', @_ ) ); }
Subroutine comment: not called CC=1 SCAR=6.9
Pod documented
273  
274 # A Version 2 cookie, which has been deprecated by protocol
275 # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie2
276 0 ▶sub commentURL { return( shift->_set_get_uri( 'commentURL', @_ ) ); }
Subroutine commentURL: not called CC=1 SCAR=6.9
Pod documented
277  
278 14 ▶sub created_on { return( shift->_set_get_datetime( 'created', @_ ) ); }
Subroutine created_on: called CC=1 SCAR=0.0
Pod documented
279  
280 sub decrypt
281 0 ▶{
Subroutine decrypt: not called CC=14 SCAR=53.5
Pod documented
282 0 my $self = shift( @_ );
283 0 my $opts = $self->_get_args_as_hash( @_ );
284 0 my $value = $self->value;
285 0 ▶ return( $value ) if( !$value->length );
Branch: 1 branch
BranchTrueFalseTotal
unless $value->length 0 0 0
286 0 ▶ $opts->{key} //= '';
Condition0%0/2
$opts->{"key"} //= ""
l!l
00
MC/DC0%0/1
$opts->{"key"} //= ""
$opts->{"key"}
Truth table0%0/2
A
A= $opts->{"key"}
Aresult
11
00
287 0 ▶ $opts->{algo} //= '';
Condition0%0/2
$opts->{"algo"} //= ""
l!l
00
MC/DC0%0/1
$opts->{"algo"} //= ""
$opts->{"algo"}
Truth table0%0/2
A
A= $opts->{"algo"}
Aresult
11
00
288 0 ▶ $opts->{iv} //= '';
Condition0%0/2
$opts->{"iv"} //= ""
l!l
00
MC/DC0%0/1
$opts->{"iv"} //= ""
$opts->{"iv"}
Truth table0%0/2
A
A= $opts->{"iv"}
Aresult
11
00
289 0 ▶ my $key = $opts->{key} || $self->key;
Condition0%0/3
$opts->{'key'} || $self->key
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts->{'key'} || $self->key
$opts->{'key'} $self->key
Truth table0%0/3
A || B
A= $opts->{'key'}B= $self->key
ABresult
1X1
011
000
290 0 ▶ my $algo = $opts->{algo} || $self->algo;
Condition0%0/3
$opts->{'algo'} || $self->algo
l!l&&r!l&&!r
000
MC/DC0%0/2
$opts->{'algo'} || $self->algo
$opts->{'algo'} $self->algo
Truth table0%0/3
A || B
A= $opts->{'algo'}B= $self->algo
ABresult
1X1
011
000
291 0 ▶ return( $self->error( "Cookie encryption was enabled, but no key was set to decrypt it." ) ) if( !defined( $key ) || !CORE::length( "$key" ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $key and length "$key" 0 0 0
Condition0%0/3
defined $key and length "$key"
!ll&&!rl&&r
000
MC/DC0%0/2
defined $key and length "$key"
defined $key length "$key"
Truth table0%0/3
A and B
A= defined $keyB= length "$key"
ABresult
0X0
100
111
292 0 ▶ return( $self->error( "Cookie encryption was enabled, but no algorithm was set to decrypt it." ) ) if( !defined( $algo ) || !CORE::length( "$algo" ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $algo and length "$algo" 0 0 0
Condition0%0/3
defined $algo and length "$algo"
!ll&&!rl&&r
000
MC/DC0%0/2
defined $algo and length "$algo"
defined $algo length "$algo"
Truth table0%0/3
A and B
A= defined $algoB= length "$algo"
ABresult
0X0
100
111
293 0 ▶ $self->_load_class( 'Crypt::Misc', { version => CRYPTX_VERSION } ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Crypt::Misc", {"version", "0.074"}) or return $self->pass_error 0 0 0
294 # If IV is not provided, _encrypt_objects will generate one and save it for next time
295 0 ▶ my $p = $self->_encrypt_objects( $key => $algo, $opts->{iv} ) || return( $self->pass_error );
Condition0%0/2
$self->_encrypt_objects($key, $algo, $opts->{'iv'}) || (return $self->pass_error)
l!l
00
MC/DC0%0/1
$self->_encrypt_objects($key, $algo, $opts->{'iv'}) || (return $self->pass_error)
$self->_encrypt_objects($key, $algo, $opts->{'iv'})
Truth table0%0/2
A
A= $self->_encrypt_objects($key, $algo, $opts->{'iv'})
Aresult
11
00
296 0 my $crypt = $p->{crypt};
297 # try-catch
298 0 local $@;
299 my $rv = eval
300 0 {
301 0 my $bin = Crypt::Misc::decode_b64( "$value" );
302 0 return( $crypt->decrypt( "$bin", $p->{key}, $p->{iv} ) );
303 };
304 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
305 {
306 0 return( $self->error( "An error occurred while trying to decrypt cookie value: $@" ) );
307 }
308 0 return( $rv );
309 }
310  
311 4 ▶sub discard { return( shift->_set_get_boolean( 'discard', @_ ) ); }
Subroutine discard: called CC=1 SCAR=0.0
Pod documented
312  
313 41 ▶sub domain { return( shift->reset(@_)->_set_get_scalar_as_object( 'domain', @_ ) ); }
Subroutine domain: called CC=1 SCAR=0.0
Pod documented
314  
315 # To expire a cookie, the domain and path must match that was previously set
316 # <https://datatracker.ietf.org/doc/html/rfc6265#section-3.1>
317 sub elapse
318 0 ▶{
Subroutine elapse: not called CC=1 SCAR=6.9
Pod documented
319 0 my $self = shift( @_ );
320 0 $self->expires(0);
321 0 return( $self );
322 }
323  
324 25 ▶sub encrypt { return( shift->reset(@_)->_set_get_boolean( 'encrypt', @_ ) ); }
Subroutine encrypt: called CC=1 SCAR=0.0
Pod documented
325  
326 # sub expires { return( shift->APR::Request::Cookie::expires( @_ ) ); }
327 # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Date
328 # Example: Fri, 13 Dec 2019 02:27:28 GMT
329 sub expires
330 64 ▶{
Subroutine expires: called CC=28 SCAR=39.2
Pod documented
331 64 my $self = shift( @_ );
332 64 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 23 41 64
333 {
334 23 $self->reset(1);
335 23 my $exp = shift( @_ );
336 23 my $tz;
337 # DateTime::Lite::TimeZone::Local will return an error if the local timezone is not set.
338 # try-catch
339 23 local $@;
340 $tz = eval
341 23 {
342 23 DateTime::Lite::TimeZone->new( name => 'local' );
343 };
344 23 ▶ if( $@ || !defined( $tz ) )
Branch: 1 branch
BranchTrueFalseTotal
if ($@ or not defined $tz) 23 0 23
Condition33%1/3
$@ or not defined $tz
l!l&&r!l&&!r
0230
MC/DC0%0/2
$@ or not defined $tz
$@ not defined $tz
Truth table33%1/3
A or not(B)
A= $@B= not defined $tz
ABresult
1X1
011
000
345 {
346 23 $tz = DateTime::Lite::TimeZone->new( name => 'UTC' );
347 }
348 23 my $dt;
349 # unsets the value
350 23 ▶ if( !defined( $exp ) )
Branch: 6 branches
BranchTrueFalseTotal
if (not defined $exp) { } 1 22 23
elsif ($exp =~ /^\d{1,10}$/) { } 7 15 22
elsif ($self->_is_a($exp, ['DateTime::Lite', 'DateTime', 'Module::Generic::DateTime'])) { } 2 13 15
elsif ($exp =~ /^([\+\-]?\d+)([YyMDdhms])?$/) { } 10 3 13
elsif (lc $exp eq 'now') { } 1 2 3
elsif (defined $exp and length $exp) { } 2 0 2
351 {
352 1 $self->{expires} = undef;
353 }
354 elsif( $exp =~ /^\d{1,10}$/ )
355 {
356 # try-catch
357 7 local $@;
358 $dt = eval
359 7 {
360 # Warning: DateTime::Lite sets the time zone ONLY after having instantiated the
361 # object and set its time zone to UTC.
362 # Thus, here setting to 'local' (e.g. corresponding to Asia/Tokyo) would
363 # actually set the epoch to GMT+9 instead of treating the epoch time provided
364 # to being in Asia/Tokyo time zone.
365 7 DateTime::Lite->from_epoch( epoch => $exp, time_zone => $tz );
366 };
367 7 ▶ if( $@ )
Branch: 2 branches
BranchTrueFalseTotal
if ($@) { } 0 7 7
elsif (not defined $dt) { } 0 7 7
368 {
369 0 return( $self->error( "An error occurred while setting the cookie expiration date time based on the unix timestamp '$exp': $@" ) );
370 }
371 elsif( !defined( $dt ) )
372 {
373 0 return( $self->pass_error( DateTime::Lite->error ) );
374 }
375 }
376 elsif( $self->_is_a( $exp => [qw( DateTime::Lite DateTime Module::Generic::DateTime )] ) )
377 {
378 2 ▶ if( $exp->isa( 'DateTime' ) )
Branch: 2 branches
BranchTrueFalseTotal
if ($exp->isa('DateTime')) { } 0 2 2
elsif ($exp->isa('Module::Generic::DateTime')) { } 0 2 2
379 {
380 0 ▶ $dt = DateTime::Lite->from_object( object => $exp ) ||
Condition0%0/2
'DateTime::Lite'->from_object('object', $exp) || (return $self->pass_error('DateTime::Lite'->error))
l!l
00
MC/DC0%0/1
'DateTime::Lite'->from_object('object', $exp) || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->from_object('object', $exp)
Truth table0%0/2
A
A= 'DateTime::Lite'->from_object('object', $exp)
Aresult
11
00
381 return( $self->pass_error( DateTime::Lite->error ) );
382 }
383 elsif( $exp->isa( 'Module::Generic::DateTime' ) )
384 {
385 0 $dt = $exp->datetime;
386 0 ▶ if( $self->_is_a( $dt => [qw( DateTime )] ) )
Branch: 1 branch
BranchTrueFalseTotal
if ($self->_is_a($dt, ["DateTime"])) 0 0 0
387 {
388 0 ▶ $dt = DateTime::Lite->from_object( object => $dt ) ||
Condition0%0/2
'DateTime::Lite'->from_object('object', $dt) || (return $self->pass_error('DateTime::Lite'->error))
l!l
00
MC/DC0%0/1
'DateTime::Lite'->from_object('object', $dt) || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->from_object('object', $dt)
Truth table0%0/2
A
A= 'DateTime::Lite'->from_object('object', $dt)
Aresult
11
00
389 return( $self->pass_error( DateTime::Lite->error ) );
390 }
391 }
392 else
393 {
394 2 $dt = $exp;
395 }
396 }
397 elsif( $exp =~ /^([\+\-]?\d+)([YyMDdhms])?$/ )
398 {
399 10 my( $num, $unit ) = ( $1, $2 );
400 10 ▶ $unit = 's' if( !length( $unit ) );
Branch: 1 branch
BranchTrueFalseTotal
unless length $unit 2 8 10
401 10 my $interval =
402 {
403 's' => 1,
404 'm' => 60,
405 'h' => 3600,
406 'D' => 86400,
407 'd' => 86400,
408 'M' => 86400 * 30,
409 'Y' => 86400 * 365,
410 'y' => 86400 * 365,
411 };
412 10 ▶ my $offset = ( $interval->{ $unit } || 1 ) * int( $num );
Condition50%1/2
$interval->{$unit} || 1
l!l
100
MC/DC0%0/1
$interval->{$unit} || 1
$interval->{$unit}
Truth table50%1/2
A
A= $interval->{$unit}
Aresult
11
00
413 10 my $ts = time() + $offset;
414 10 ▶ $dt = DateTime::Lite->from_epoch( epoch => $ts, time_zone => $tz ) ||
Condition50%1/2
'DateTime::Lite'->from_epoch('epoch', $ts, 'time_zone', $tz) || (return $self->pass_error('DateTime::Lite'->error))
l!l
100
MC/DC0%0/1
'DateTime::Lite'->from_epoch('epoch', $ts, 'time_zone', $tz) || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->from_epoch('epoch', $ts, 'time_zone', $tz)
Truth table50%1/2
A
A= 'DateTime::Lite'->from_epoch('epoch', $ts, 'time_zone', $tz)
Aresult
11
00
415 return( $self->pass_error( DateTime::Lite->error ) );
416 }
417 elsif( lc( $exp ) eq 'now' )
418 {
419 1 ▶ $dt = DateTime::Lite->now( time_zone => $tz ) ||
Condition50%1/2
'DateTime::Lite'->now('time_zone', $tz) || (return $self->pass_error('DateTime::Lite'->error))
l!l
10
MC/DC0%0/1
'DateTime::Lite'->now('time_zone', $tz) || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->now('time_zone', $tz)
Truth table50%1/2
A
A= 'DateTime::Lite'->now('time_zone', $tz)
Aresult
11
00
420 return( $self->pass_error( DateTime::Lite->error ) );
421 }
422 ▶ elsif( defined( $exp ) && CORE::length( $exp ) )
Condition33%1/3
defined $exp and length $exp
!ll&&!rl&&r
002
MC/DC0%0/2
defined $exp and length $exp
defined $exp length $exp
Truth table33%1/3
A and B
A= defined $expB= length $exp
ABresult
0X0
100
111
423 {
424 2 $dt = $self->_parse_timestamp( $exp );
425 2 ▶ return( $self->pass_error ) if( !defined( $dt ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $dt 0 2 2
426 2 ▶ return( $self->error( "Provided expires value '$exp' (", overload::StrVal( $exp // 'undef' ), ") is an invalid expression." ) ) if( !CORE::length( $dt ) );
Branch: 1 branch
BranchTrueFalseTotal
unless length $dt 1 1 2
Condition50%1/2
$exp // "undef"
l!l
10
MC/DC0%0/1
$exp // "undef"
$exp
Truth table50%1/2
A
A= $exp
Aresult
11
00
427 }
428 else
429 {
430 # Don't know what to do with '$exp'.
431 }
432  
433 22 ▶ if( defined( $dt ) )
Branch: 1 branch
BranchTrueFalseTotal
if (defined $dt) 21 1 22
434 {
435 21 ▶ $dt = $self->_header_datetime( $dt ) if( $self->_is_a( $dt, [qw( DateTime::Lite DateTime )] ) );
Branch: 1 branch
BranchTrueFalseTotal
if $self->_is_a($dt, ["DateTime::Lite", "DateTime"]) 21 0 21
436 21 ▶ $self->{expires} = $dt->isa( 'Module::Generic::DateTime' ) ? $dt : Module::Generic::DateTime->new( $dt );
Branch: 1 branch
BranchTrueFalseTotal
$dt->isa('Module::Generic::DateTime') ? : 0 21 21
437 }
438 }
439 63 return( $self->_set_get_datetime( 'expires' ) );
440 }
441  
442 0 ▶sub fields { return( shift->_set_get_array_as_object( 'fields', @_ ) ); }
Subroutine fields: not called CC=1 SCAR=6.9
Pod documented
443  
444 0 ▶sub host { return( shift->domain( @_ ) ); }
Subroutine host: not called CC=1 SCAR=6.9
Pod documented
445  
446 0 ▶sub host_only { return( shift->implicit( @_ ) ); }
Subroutine host_only: not called CC=1 SCAR=6.9
Pod documented
447  
448 37 ▶sub http_only { return( shift->reset(@_)->_set_get_boolean( 'http_only', @_ ) ); }
Subroutine http_only: called CC=1 SCAR=0.0
Pod documented
449  
450 0 ▶sub httponly { return( shift->http_only( @_ ) ); }
Subroutine httponly: not called CC=1 SCAR=6.9
Pod documented
451  
452 0 ▶sub implicit { return( shift->reset(@_)->_set_get_boolean( 'implicit', @_ ) ); }
Subroutine implicit: not called CC=1 SCAR=6.9
Pod documented
453  
454 # For cookie encryption
455 0 ▶sub initialisation_vector { return( shift->_set_get_scalar_as_object( 'initialisation_vector', @_ ) ); }
Subroutine initialisation_vector: not called CC=1 SCAR=6.9
Pod documented
456  
457 sub is_expired
458 0 ▶{
Subroutine is_expired: not called CC=13 SCAR=52.0
Pod documented
459 0 my $self = shift( @_ );
460 0 my $exp = $self->expires;
461 0 my $max_age = $self->max_age;
462 0 ▶ return( $self->false ) if( !defined( $exp ) && !defined( $max_age ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $exp or defined $max_age 0 0 0
Condition0%0/3
defined $exp or defined $max_age
l!l&&r!l&&!r
000
MC/DC0%0/2
defined $exp or defined $max_age
defined $exp defined $max_age
Truth table0%0/3
A or B
A= defined $expB= defined $max_age
ABresult
1X1
011
000
463 0 ▶ if( ( defined( $exp ) && !$self->_is_a( $exp, 'Module::Generic::DateTime' ) && !$self->_is_a( $exp, [qw( DateTime::Lite DateTime )] ) ) ||
Branch: 1 branch
BranchTrueFalseTotal
if (defined $exp and not $self->_is_a($exp, "Module::Generic::DateTime") and not $self->_is_a($exp, ["DateTime::Lite", "DateTime"]) or defined $max_age and not $max_age =~ /\-?\d+$/) 0 0 0
Condition0%0/12
defined $exp and not $self->_is_a($exp, "Module::Generic::DateTime") and not $self->_is_a($exp, ["DateTime::Lite", "DateTime"]) or defined $max_age and not $max_age =~ /\-?\d+$/
l!l&&r!l&&!r
000
defined $exp and not $self->_is_a($exp, "Module::Generic::DateTime") and not $self->_is_a($exp, ["DateTime::Lite", "DateTime"])
!ll&&!rl&&r
000
defined $exp and not $self->_is_a($exp, "Module::Generic::DateTime")
!ll&&!rl&&r
000
defined $max_age and not $max_age =~ /\-?\d+$/
!ll&&!rl&&r
000
MC/DC0%0/5
defined $exp and not $self->_is_a($exp, "Module::Generic::DateTime") and not $self->_is_a($exp, ["DateTime::Lite", "DateTime"]) or defined $max_age and not $max_age =~ /\-?\d+$/
defined $exp not $self->_is_a($exp, "Module::Generic::DateTime") not $self->_is_a($exp, ["DateTime::Lite", "DateTime"]) defined $max_age not $max_age =~ /\-?\d+$/
Truth table0%0/10
A and not(B) and not(C) or D and not(E)
A= defined $expB= not $self->_is_a($exp, "Module::Generic::DateTime")C= not $self->_is_a($exp, ["DateTime::Lite", "DateTime"])D= defined $max_ageE= not $max_age =~ /\-?\d+$/
ABCDEresult
111XX1
0XX111
10X111
110111
0XX0X0
0XX100
10X0X0
10X100
1100X0
110100
464 ( defined( $max_age ) && $max_age !~ /\-?\d+$/ ) )
465 {
466 0 return( $self->false );
467 }
468 0 ▶ my $now = DateTime::Lite->now ||
Condition0%0/2
'DateTime::Lite'->now || (return $self->pass_error('DateTime::Lite'->error))
l!l
00
MC/DC0%0/1
'DateTime::Lite'->now || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->now
Truth table0%0/2
A
A= 'DateTime::Lite'->now
Aresult
11
00
469 return( $self->pass_error( DateTime::Lite->error ) );
470 0 ▶ if( ( defined( $max_age ) && $max_age <= 0 ) ||
Branch: 1 branch
BranchTrueFalseTotal
if (defined $max_age and $max_age <= 0 or defined $exp and $exp < $now) { } 0 0 0
Condition0%0/9
defined $max_age and $max_age <= 0 or defined $exp and $exp < $now
l!l&&r!l&&!r
000
defined $max_age and $max_age <= 0
!ll&&!rl&&r
000
defined $exp and $exp < $now
!ll&&!rl&&r
000
MC/DC0%0/4
defined $max_age and $max_age <= 0 or defined $exp and $exp < $now
defined $max_age $max_age <= 0 defined $exp $exp < $now
Truth table0%0/7
A and B or C and D
A= defined $max_ageB= $max_age <= 0C= defined $expD= $exp < $now
ABCDresult
11XX1
0X111
10111
0X0X0
0X100
100X0
10100
471 ( defined( $exp ) && $exp < $now ) )
472 {
473 0 return( $self->true );
474 }
475 else
476 {
477 0 return( $self->false );
478 }
479 }
480  
481 0 ▶sub is_persistent { return( !shift->is_session ); }
Subroutine is_persistent: not called CC=1 SCAR=6.9
Pod documented
482  
483 sub is_session
484 0 ▶{
Subroutine is_session: not called CC=3 SCAR=24.8
Pod documented
485 0 my $self = shift( @_ );
486 0 ▶ return( defined( $self->expires ) || defined( $self->max_age ) ? $self->false : $self->true );
Branch: 1 branch
BranchTrueFalseTotal
defined $self->expires || defined $self->max_age ? : 0 0 0
Condition0%0/3
defined $self->expires or defined $self->max_age
l!l&&r!l&&!r
000
MC/DC0%0/2
defined $self->expires or defined $self->max_age
defined $self->expires defined $self->max_age
Truth table0%0/3
A or B
A= defined $self->expiresB= defined $self->max_age
ABresult
1X1
011
000
487 }
488  
489 0 ▶sub is_tainted { return( shift->_set_get_boolean( 'is_tainted', @_ ) ); }
Subroutine is_tainted: not called CC=1 SCAR=6.9
Pod documented
490  
491 sub is_valid
492 0 ▶{
Subroutine is_valid: not called CC=14 SCAR=53.5
Pod documented
493 0 my $self = shift( @_ );
494 0 my $opts = $self->_get_args_as_hash( @_ );
495 0 ▶ $opts->{key} ||= $self->key || '';
Condition0%0/5
$opts->{"key"} ||= $self->key || ""
l!l&&r!l&&!r
000
$self->key || ''
l!l
00
MC/DC0%0/2
$opts->{"key"} ||= $self->key || ""
$opts->{"key"} $self->key
Truth table0%0/3
A ||= B
A= $opts->{"key"}B= $self->key
ABresult
1X1
011
000
496 0 ▶ return( $self->true ) if( !$self->sign && !CORE::length( $opts->{key} ) );
Branch: 1 branch
BranchTrueFalseTotal
unless $self->sign or length $opts->{"key"} 0 0 0
Condition0%0/3
$self->sign or length $opts->{"key"}
l!l&&r!l&&!r
000
MC/DC0%0/2
$self->sign or length $opts->{"key"}
$self->sign length $opts->{"key"}
Truth table0%0/3
A or B
A= $self->signB= length $opts->{"key"}
ABresult
1X1
011
000
497 0 ▶ return( $self->error( "Signature validation is required, but no key has been set." ) ) if( !$self->key->length && !CORE::exists( $opts->{key} ) || ( CORE::exists( $opts->{key} ) && !CORE::length( $opts->{key} ) ) );
Branch: 1 branch
BranchTrueFalseTotal
if not $self->key->length || exists $opts->{"key"} or exists $opts->{"key"} and not length $opts->{"key"} 0 0 0
Condition0%0/9
not $self->key->length || exists $opts->{"key"} or exists $opts->{"key"} and not length $opts->{"key"}
l!l&&r!l&&!r
000
$self->key->length || exists $opts->{'key'}
l!l&&r!l&&!r
000
exists $opts->{"key"} and not length $opts->{"key"}
!ll&&!rl&&r
000
MC/DC0%0/4
not $self->key->length || exists $opts->{"key"} or exists $opts->{"key"} and not length $opts->{"key"}
$self->key->length exists $opts->{'key'} exists $opts->{"key"} not length $opts->{"key"}
Truth table0%0/7
not(A || B) or C and not(D)
A= $self->key->lengthB= exists $opts->{'key'}C= exists $opts->{"key"}D= not length $opts->{"key"}
ABCDresult
00XX1
1X111
01111
1X0X0
1X100
010X0
01100
498 0 my $value = $self->value;
499 0 ▶ return( $self->true ) if( !$value->length );
Branch: 1 branch
BranchTrueFalseTotal
unless $value->length 0 0 0
500 0 ▶ if( $value->index( '.' ) == -1 )
Branch: 1 branch
BranchTrueFalseTotal
if ($value->index(".") == -1) 0 0 0
501 {
502 # Not an error, so we only issue a warning if warnings are enabled
503 0 ▶ warnings::warn( "The cookie does not have a signature attached to it." ) if( warnings::enabled() );
Branch: 1 branch
BranchTrueFalseTotal
if warnings::enabled() 0 0 0
504 0 return( $self->false );
505 }
506 0 my @parts = $value->split( '.' );
507 # We take the last one, because the cookie name, itself, could potentially contain dots.
508 # The value must be an uri unescaped value
509 0 my $sig = pop( @parts );
510 0 my $orig = join( '.', @parts );
511 0 my $key = $opts->{key};
512 0 ▶ $self->_load_class( 'Crypt::Mac::HMAC', { version => CRYPTX_VERSION } ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Crypt::Mac::HMAC", {"version", "0.074"}) or return $self->pass_error 0 0 0
513 # try-catch
514 0 local $@;
515 my $check = eval
516 0 {
517 0 Crypt::Mac::HMAC::hmac_b64( 'SHA256', "$key", "$orig" );
518 };
519 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
520 {
521 0 return( $self->error( "An error occurred while trying to check the cookie signature validation: $@" ) );
522 }
523 0 return( "$check" eq "$sig" );
524 }
525  
526 0 ▶sub iv { return( shift->initialisation_vector( @_ ) ); }
Subroutine iv: not called CC=1 SCAR=6.9
Pod documented
527  
528 0 ▶sub key { return( shift->_set_get_scalar_as_object( 'key', @_ ) ); }
Subroutine key: not called CC=1 SCAR=6.9
Pod documented
529  
530 # Check if the cookie domain is within the host provided, i.e.
531 # wether this cookie should be sent as part of the request
532 sub match_host
533 0 ▶{
Subroutine match_host: not called CC=6 SCAR=37.4
Pod documented
534 0 my $self = shift( @_ );
535 # e.g. www.example.com
536 0 ▶ my $host = shift( @_ ) || return(0);
Condition0%0/2
shift @_ || (return 0)
l!l
00
MC/DC0%0/1
shift @_ || (return 0)
shift @_
Truth table0%0/2
A
A= shift @_
Aresult
11
00
537 0 $host = lc( $host );
538 # and ours could be just example.com
539 0 my $dom = $self->domain;
540 0 ▶ return(1) if( $host eq $dom );
Branch: 1 branch
BranchTrueFalseTotal
if $host eq $dom 0 0 0
541 # if our domain is longer than $host, then we are not a match as we should be a subset
542 # e.g. ours www.ja.example.com vs $host ja.example.com
543 0 ▶ return(0) if( CORE::length( $dom ) > CORE::length( $host ) );
Branch: 1 branch
BranchTrueFalseTotal
if length $dom > length $host 0 0 0
544 # our cookie domain has been set implicitly and since we are not an exact match,
545 # no need to go further.
546 0 ▶ unless( $self->implicit )
Branch: 1 branch
BranchTrueFalseTotal
unless ($self->implicit) 0 0 0
547 {
548 0 ▶ return( $host =~ /\.${dom}$/ ? 1 : 0 );
Branch: 1 branch
BranchTrueFalseTotal
$host =~ /\.$dom$/ ? : 0 0 0
549 }
550 0 return(0);
551 }
552  
553 # sub max_age { return( shift->reset(@_)->_set_get_scalar( 'max_age', @_ ) ); }
554 sub max_age
555 44 ▶{
Subroutine max_age: called CC=8 SCAR=21.3
Pod documented
556 44 my $self = shift( @_ );
557 44 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 2 42 44
558 {
559 2 $self->reset( @_ );
560 2 my $v = shift( @_ );
561 2 ▶ if( !defined( $v ) )
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $v) { } 0 2 2
562 {
563 0 $self->{max_age} = undef;
564 }
565 else
566 {
567 2 ▶ return( $self->error( "Invalid max-age value '$v'" ) ) if( $v !~ /^\-?\d+$/ );
Branch: 1 branch
BranchTrueFalseTotal
unless $v =~ /^\-?\d+$/ 0 2 2
568 2 $v = int( $v );
569 # "If both Expires and Max-Age are set, Max-Age has precedence"
570 # <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie>
571 2 my $exp;
572 2 ▶ if( $v <= 0 )
Branch: 1 branch
BranchTrueFalseTotal
if ($v <= 0) { } 1 1 2
573 {
574 1 $exp = DateTime::Lite->new(
575 year => 1970,
576 month => 1,
577 day => 1,
578 hour => 0,
579 minute => 0,
580 second => 0,
581 time_zone => 'GMT',
582 );
583 }
584 else
585 {
586 1 my $tz;
587 # DateTime::Lite::TimeZone::Local will return an error if the local timezone is not set.
588 # try-catch
589 1 local $@;
590 $tz = eval
591 1 {
592 1 DateTime::Lite::TimeZone->new( name => 'local' );
593 };
594 1 ▶ if( $@ || !defined( $tz ) )
Branch: 1 branch
BranchTrueFalseTotal
if ($@ or not defined $tz) 1 0 1
Condition33%1/3
$@ or not defined $tz
l!l&&r!l&&!r
010
MC/DC0%0/2
$@ or not defined $tz
$@ not defined $tz
Truth table33%1/3
A or not(B)
A= $@B= not defined $tz
ABresult
1X1
011
000
595 {
596 1 $tz = DateTime::Lite::TimeZone->new( name => 'UTC' );
597 }
598 1 ▶ $exp = DateTime::Lite->now( time_zone => $tz ) ||
Condition50%1/2
'DateTime::Lite'->now('time_zone', $tz) || (return $self->pass_error('DateTime::Lite'->error))
l!l
10
MC/DC0%0/1
'DateTime::Lite'->now('time_zone', $tz) || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->now('time_zone', $tz)
Truth table50%1/2
A
A= 'DateTime::Lite'->now('time_zone', $tz)
Aresult
11
00
599 return( $self->pass_error( DateTime::Lite->error ) );
600 1 $exp->add( seconds => $v );
601 }
602 2 $self->expires( $exp );
603 2 return( $self->_set_get_number( 'max_age' => $v ) );
604 }
605 }
606 42 return( $self->_set_get_number( 'max_age' ) );
607 }
608  
609 0 ▶sub maxage { return( shift->max_age( @_ ) ); }
Subroutine maxage: not called CC=1 SCAR=6.9
Pod documented
610  
611 sub name
612 74 ▶{
Subroutine name: called CC=7 SCAR=24.1
Pod documented
613 74 my $self = shift( @_ );
614 74 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 32 42 74
615 {
616 32 $self->reset( @_ );
617 32 my $name = shift( @_ );
618 # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie
619 32 ▶ if( $name =~ /[\(\)\<\>\@\,\;\:\\\"\/\[\]\?\=\{\}]/ && $self->strict )
Branch: 1 branch
BranchTrueFalseTotal
if ($name =~ m#[\(\)\<\>\@\,\;\:\\\"/\[\]\?\=\{\}]# and $self->strict) 0 32 32
Condition33%1/3
$name =~ m#[\(\)\<\>\@\,\;\:\\\"/\[\]\?\=\{\}]# and $self->strict
!ll&&!rl&&r
3200
MC/DC0%0/2
$name =~ m#[\(\)\<\>\@\,\;\:\\\"/\[\]\?\=\{\}]# and $self->strict
$name =~ m#[\(\)\<\>\@\,\;\:\\\"/\[\]\?\=\{\}]# $self->strict
Truth table33%1/3
A and B
A= $name =~ m#[\(\)\<\>\@\,\;\:\\\"/\[\]\?\=\{\}]#B= $self->strict
ABresult
0X0
100
111
620 {
621 0 return( $self->error( "A cookie name can only contain US ascii characters. Cookie name provided was '$name'." ) );
622 }
623 32 ▶ if( $name =~ s/^__Secure\-// )
Branch: 2 branches
BranchTrueFalseTotal
if ($name =~ s/^__Secure\-//) { } 0 32 32
elsif ($name =~ s/^__Host\-//) { } 0 32 32
624 {
625 0 $self->secure(1);
626 }
627 elsif( $name =~ s/^__Host\-// )
628 {
629 0 $self->secure(1);
630 0 ▶ $self->path( '/' ) if( !$self->path->length );
Branch: 1 branch
BranchTrueFalseTotal
unless $self->path->length 0 0 0
631 }
632 32 $self->_set_get_scalar_as_object( 'name' => $name );
633 }
634 74 return( $self->_set_get_scalar_as_object( 'name' ) );
635 }
636  
637 49 ▶sub path { return( shift->reset(@_)->_set_get_scalar_as_object( 'path', @_ ) ); }
Subroutine path: called CC=1 SCAR=0.0
Pod documented
638  
639 25 ▶sub port { return( shift->reset(@_)->_set_get_number( 'port', @_ ) ); }
Subroutine port: called CC=1 SCAR=0.0
Pod documented
640  
641 sub reset
642 403 ▶{
Subroutine reset: called CC=3 SCAR=11.0
Pod documented
643 403 my $self = shift( @_ );
644 403 ▶ $self->{_reset} = scalar( @_ ) if( !CORE::length( $self->{_reset} ) && scalar( @_ ) );
Branch: 1 branch
BranchTrueFalseTotal
if not length $self->{"_reset"} and scalar @_ 32 371 403
Condition100%2/2
not length $self->{"_reset"} and scalar @_
!ll
37132
MC/DC100%1/1
not length $self->{"_reset"} and scalar @_
not length $self->{"_reset"}
Truth table100%2/2
not(A)
A= not length $self->{"_reset"}
Aresult
00
11
645 403 return( $self );
646 }
647  
648 sub same_as
649 0 ▶{
Subroutine same_as: not called CC=14 SCAR=53.5
Pod documented
650 0 my $self = shift( @_ );
651 0 my $this = shift( @_ );
652 0 ▶ return(0) if( !$this || !$self->_is_object( $this ) );
Branch: 1 branch
BranchTrueFalseTotal
unless $this and $self->_is_object($this) 0 0 0
Condition0%0/3
$this and $self->_is_object($this)
!ll&&!rl&&r
000
MC/DC0%0/2
$this and $self->_is_object($this)
$this $self->_is_object($this)
Truth table0%0/3
A and B
A= $thisB= $self->_is_object($this)
ABresult
0X0
100
111
653 0 my $fields = $self->fields;
654 0 foreach my $f ( @$fields )
655 {
656 0 my $v = $self->$f;
657 0 my $code = $this->can( $f );
658 0 ▶ return(0) if( !$code );
Branch: 1 branch
BranchTrueFalseTotal
unless $code 0 0 0
659 0 my $v2 = $code->( $this );
660 0 ▶ if( ( !defined( $v ) && defined( $v2 ) ) ||
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $v and defined $v2 or defined $v and not defined $v2 or defined $v and length "$v" != length "$v2" or defined $v and defined $v2 and "$v" ne "$v2") 0 0 0
Condition0%0/24
not defined $v and defined $v2 or defined $v and not defined $v2 or defined $v and length "$v" != length "$v2" or defined $v and defined $v2 and "$v" ne "$v2"
l!l&&r!l&&!r
000
not defined $v and defined $v2 or defined $v and not defined $v2 or defined $v and length "$v" != length "$v2"
l!l&&r!l&&!r
000
not defined $v and defined $v2 or defined $v and not defined $v2
l!l&&r!l&&!r
000
not defined $v and defined $v2
!ll&&!rl&&r
000
defined $v and not defined $v2
!ll&&!rl&&r
000
defined $v and length "$v" != length "$v2"
!ll&&!rl&&r
000
defined $v and defined $v2 and "$v" ne "$v2"
!ll&&!rl&&r
000
defined $v and defined $v2
!ll&&!rl&&r
000
MC/DC0%0/9
not defined $v and defined $v2 or defined $v and not defined $v2 or defined $v and length "$v" != length "$v2" or defined $v and defined $v2 and "$v" ne "$v2"
not defined $v defined $v2 defined $v not defined $v2 defined $v length "$v" != length "$v2" defined $v defined $v2 "$v" ne "$v2"
Truth table0%0/39
not(A) and B or C and not(D) or E and F or G and H and I
A= not defined $vB= defined $v2C= defined $vD= not defined $v2E= defined $vF= length "$v" != length "$v2"G= defined $vH= defined $v2I= "$v" ne "$v2"
ABCDEFGHIresult
11XXXXXXX1
0X11XXXXX1
1011XXXXX1
0X0X11XXX1
0X1011XXX1
100X11XXX1
101011XXX1
0X0X0X1111
0X0X101111
0X100X1111
0X10101111
100X0X1111
100X101111
10100X1111
1010101111
0X0X0X0XX0
0X0X0X10X0
0X0X0X1100
0X0X100XX0
0X0X1010X0
0X0X101100
0X100X0XX0
0X100X10X0
0X100X1100
0X10100XX0
0X101010X0
0X10101100
100X0X0XX0
100X0X10X0
100X0X1100
100X100XX0
100X1010X0
100X101100
10100X0XX0
10100X10X0
10100X1100
1010100XX0
10101010X0
1010101100
661 ( defined( $v ) && !defined( $v2 ) ) ||
662 ( defined( $v ) && length( "$v" ) != length( "$v2" ) ) ||
663 ( defined( $v ) && defined( $v2 ) && "$v" ne "$v2" ) )
664 {
665 0 return(0);
666 }
667 }
668 0 return(1);
669 }
670  
671 44 ▶sub same_site { return( shift->reset(@_)->_set_get_scalar_as_object( 'same_site', @_ ) ); }
Subroutine same_site: called CC=1 SCAR=0.0
Pod documented
672  
673 0 ▶sub samesite { return( shift->same_site( @_ ) ); }
Subroutine samesite: not called CC=1 SCAR=6.9
Pod documented
674  
675 37 ▶sub secure { return( shift->reset(@_)->_set_get_boolean( 'secure', @_ ) ); }
Subroutine secure: called CC=1 SCAR=0.0
Pod documented
676  
677 25 ▶sub sign { return( shift->reset(@_)->_set_get_boolean( 'sign', @_ ) ); }
Subroutine sign: called CC=1 SCAR=0.0
Pod documented
678  
679 2 ▶sub strict { return( shift->reset(@_)->_set_get_boolean( 'strict', @_ ) ); }
Subroutine strict: called CC=1 SCAR=0.0
Pod documented
680  
681 sub uri
682 0 ▶{
Subroutine uri: not called CC=7 SCAR=40.3
Pod documented
683 0 my $self = shift( @_ );
684 0 ▶ if( @_ )
Branch: 2 branches
BranchTrueFalseTotal
if (@_) { } 0 0 0
elsif ($self->domain) { } 0 0 0
685 {
686 0 $self->reset( @_ );
687 0 ▶ my $uri = $self->_set_get_uri( 'uri', @_ ) || return;
Condition0%0/2
$self->_set_get_uri('uri', @_) || (return)
l!l
00
MC/DC0%0/1
$self->_set_get_uri('uri', @_) || (return)
$self->_set_get_uri('uri', @_)
Truth table0%0/2
A
A= $self->_set_get_uri('uri', @_)
Aresult
11
00
688 0 $self->port( $uri->port );
689 0 $self->path( $uri->path );
690 0 $self->domain( $uri->host );
691 }
692 elsif( $self->domain )
693 {
694 0 ▶ my $uri =
Branch: 3 branches
BranchTrueFalseTotal
$self->secure ? : 0 0 0
$self->port ? : 0 0 0
$self->path ? : 0 0 0
695 ( $self->secure ? 'https' : 'http' ) . '://' .
696 $self->domain .
697 ( $self->port ? ':' . $self->port : '' ) .
698 ( $self->path ? $self->path : '/' );
699 0 return( $self->_set_get_uri( 'uri' => $uri ) );
700 }
701 0 return( $self->_set_get_uri( 'uri' ) );
702 }
703  
704 61 ▶sub value { return( shift->reset(@_)->_set_get_scalar_as_object( 'value', @_ ) ); }
Subroutine value: called CC=1 SCAR=0.0
Pod documented
705  
706 # Deprecated. Was a version 2 cookie spec: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie2
707 0 ▶sub version { return( shift->_set_get_number( 'version', @_ ) ); }
Subroutine version: not called CC=1 SCAR=6.9
Pod documented
708  
709 sub _encrypt_objects
710 0 ▶{
Subroutine _encrypt_objects: not called CC=17 SCAR=57.2
711 0 my $self = shift( @_ );
712 0 my( $key, $algo, $iv ) = @_;
713 0 ▶ return( $self->error( "Key provided is empty!" ) ) if( !defined( $key ) || !CORE::length( "$key" ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $key and length "$key" 0 0 0
Condition0%0/3
defined $key and length "$key"
!ll&&!rl&&r
000
MC/DC0%0/2
defined $key and length "$key"
defined $key length "$key"
Truth table0%0/3
A and B
A= defined $keyB= length "$key"
ABresult
0X0
100
111
714 0 ▶ return( $self->error( "No algorithm was provided to encrypt cookie value. You can choose any <NAME> for which there exists Crypt::Cipher::<NAME>" ) ) if( !defined( $algo ) || !CORE::length( "$algo" ) );
Branch: 1 branch
BranchTrueFalseTotal
unless defined $algo and length "$algo" 0 0 0
Condition0%0/3
defined $algo and length "$algo"
!ll&&!rl&&r
000
MC/DC0%0/2
defined $algo and length "$algo"
defined $algo length "$algo"
Truth table0%0/3
A and B
A= defined $algoB= length "$algo"
ABresult
0X0
100
111
715 0 ▶ $iv //= '';
Condition0%0/2
$iv //= ""
l!l
00
MC/DC0%0/1
$iv //= ""
$iv
Truth table0%0/2
A
A= $iv
Aresult
11
00
716  
717 0 ▶ $self->_load_class( 'Crypt::Mode::CBC', { version => CRYPTX_VERSION } ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Crypt::Mode::CBC", {"version", "0.074"}) or return $self->pass_error 0 0 0
718 0 ▶ $self->_load_class( 'Bytes::Random::Secure' ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class("Bytes::Random::Secure") or return $self->pass_error 0 0 0
719 my $crypt = eval
720 0 {
721 0 Crypt::Mode::CBC->new( "$algo" );
722 };
723 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
724 {
725 0 return( $self->error( "Error getting the encryption objects for algorithm \"$algo\": $@" ) );
726 }
727 0 ▶ $crypt or return( $self->error( "Unable to create a Crypt::Mode::CBC object." ) );
Branch: 1 branch
BranchTrueFalseTotal
$crypt or return $self->error("Unable to create a Crypt::Mode::CBC object.") 0 0 0
728 0 my $class = "Crypt::Cipher::${algo}";
729 0 ▶ $self->_load_class( $class ) || return( $self->pass_error );
Branch: 1 branch
BranchTrueFalseTotal
$self->_load_class($class) or return $self->pass_error 0 0 0
730 0 my $key_len = $class->keysize;
731 0 my $block_len = $class->blocksize;
732 0 ▶ return( $self->error( "The size of the key provided (", CORE::length( $key ), ") does not match the minimum key size required for this algorithm \"$algo\" (${key_len})." ) ) if( CORE::length( $key ) < $key_len );
Branch: 1 branch
BranchTrueFalseTotal
if length $key < $key_len 0 0 0
733 # Generate an "IV", i.e. Initialisation Vector based on the required block size
734 0 ▶ $iv ||= $self->initialisation_vector;
Condition0%0/3
$iv ||= $self->initialisation_vector
l!l&&r!l&&!r
000
MC/DC0%0/2
$iv ||= $self->initialisation_vector
$iv $self->initialisation_vector
Truth table0%0/3
A ||= B
A= $ivB= $self->initialisation_vector
ABresult
1X1
011
000
735 0 ▶ if( defined( $iv ) && CORE::length( "$iv" ) )
Branch: 1 branch
BranchTrueFalseTotal
if (defined $iv and length "$iv") { } 0 0 0
Condition0%0/3
defined $iv and length "$iv"
!ll&&!rl&&r
000
MC/DC0%0/2
defined $iv and length "$iv"
defined $iv length "$iv"
Truth table0%0/3
A and B
A= defined $ivB= length "$iv"
ABresult
0X0
100
111
736 {
737 0 ▶ if( CORE::length( "$iv" ) != $block_len )
Branch: 1 branch
BranchTrueFalseTotal
if (length "$iv" != $block_len) 0 0 0
738 {
739 0 return( $self->error( "The Initialisation Vector provided for cookie encryption has a length (", CORE::length( "$iv" ), ") which does not match the algorithm ($algo) size requirement ($block_len). Please refer to the cookie documentation Cookie" ) );
740 }
741 }
742 else
743 {
744 $iv = eval
745 0 {
746 0 Bytes::Random::Secure::random_bytes( $block_len );
747 };
748 0 ▶ if( $@ )
Branch: 1 branch
BranchTrueFalseTotal
if ($@) 0 0 0
749 {
750 0 return( $self->error( "Error getting $block_len random secure bytes for algorithm \"$algo\": $@" ) );
751 }
752 # Save it for decryption
753 0 $self->initialisation_vector( $iv );
754 }
755 0 my $key_pack = pack( 'H' x $key_len, $key );
756 0 my $iv_pack = pack( 'H' x $block_len, $iv );
757 0 return({ 'crypt' => $crypt, key => $key_pack, iv => $iv_pack });
758 }
759  
760 sub _header_datetime
761 21 ▶{
Subroutine _header_datetime: called CC=7 SCAR=22.3
762 21 my $self = shift( @_ );
763 21 my $dt;
764 21 ▶ if( @_ )
Branch: 1 branch
BranchTrueFalseTotal
if (@_) 21 0 21
765 {
766 21 ▶ return( $self->error( "Date time provided ($dt) is not an object." ) ) if( !$self->_is_object( $_[0] ) );
Branch: 1 branch
BranchTrueFalseTotal
unless $self->_is_object($_[0]) 0 21 21
767 21 ▶ return( $self->error( "Object provided (", ref( $_[0] ), ") is not a DateTime::Lite or DateTime object." ) ) if( !$self->_is_a( $_[0] => [qw( DateTime::Lite DateTime )] ) );
Branch: 1 branch
BranchTrueFalseTotal
unless $self->_is_a($_[0], ["DateTime::Lite", "DateTime"]) 0 21 21
768 21 $dt = shift( @_ );
769 }
770 21 ▶ if( !defined( $dt ) )
Branch: 2 branches
BranchTrueFalseTotal
if (not defined $dt) { } 0 21 21
elsif ($self->_is_a($dt, ['DateTime'])) { } 0 21 21
771 {
772 0 $dt = DateTime::Lite->now;
773 }
774 elsif( $self->_is_a( $dt => [qw( DateTime )] ) )
775 {
776 0 ▶ $dt = DateTime::Lite->from_object( object => $dt ) ||
Condition0%0/2
'DateTime::Lite'->from_object('object', $dt) || (return $self->pass_error('DateTime::Lite'->error))
l!l
00
MC/DC0%0/1
'DateTime::Lite'->from_object('object', $dt) || (return $self->pass_error('DateTime::Lite'->error))
'DateTime::Lite'->from_object('object', $dt)
Truth table0%0/2
A
A= 'DateTime::Lite'->from_object('object', $dt)
Aresult
11
00
777 return( $self->pass_error( DateTime::Lite->error ) );
778 }
779 21 $dt->set_time_zone( 'GMT' );
780 21 my $fmt = DateTime::Format::Lite->new(
781 pattern => '%a, %d %b %Y %H:%M:%S GMT',
782 locale => 'en_GB',
783 time_zone => 'GMT',
784 );
785 21 $dt->set_formatter( $fmt );
786 21 return( $dt );
787 }
788  
789 sub TO_JSON
790 0 ▶{
Subroutine TO_JSON: not called CC=2 SCAR=17.9
Pod documented
791 0 my $self = shift( @_ );
792 0 my $fields = $self->fields;
793 0 my $ref = {};
794 0 foreach my $m ( @$fields )
795 {
796 0 $ref->{ $m } = $self->$m;
797 }
798 0 return( $ref );
799 }
800  
801 9 1;
802 # NOTE: POD
803 __END__
« Cookie/Domain.pm ↑ Summary Cookies.pm »