Skilletor/Tar.pm

filter: Statementstmt 99.0% 108 / 109 Branchbran 92.3% 48 / 52 Conditioncond 79.1% 38 / 48 MC/DCmcdc 58.6% 17 / 29 Subroutinesub 100% 16 / 16 Podpod 100% 3 / 3 totaltotal 89.4% 230 / 257 CC 45 SCAR 23.8
CC
45
Cov
93%
parse_tar
22.1
strip_top_level
8.2
_assert_safe
6.0
CRAP 10.8
« Skilletor/Gzip.pm ↑ Summary Skilletor/Frontmatter.pm »
1 package Skilletor::Tar;
2 # ABSTRACT: The reference's minimal tar reader: safe file and dir entries only
3  
4 37 ▶use strict;
Subroutine BEGIN: called CC=1 SCAR=0.0
5 37 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
6  
7 37 ▶use Exporter qw( import );
Subroutine BEGIN: called CC=1 SCAR=0.0
8 37 ▶use Skilletor::Error;
Subroutine BEGIN: called CC=1 SCAR=0.0
9 37 ▶use Skilletor::Error::Tar;
Subroutine BEGIN: called CC=1 SCAR=0.0
10 37 ▶use Skilletor::FSUtil qw( decode_utf8_lossy is_executable );
Subroutine BEGIN: called CC=1 SCAR=0.0
11 37 ▶use Skilletor::JSString qw( js_trim );
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 37 our $VERSION = '0.001';
14  
15 37 our @EXPORT_OK = qw( parse_tar strip_top_level is_reserved VERSION_FILE );
16  
17 # The version of a url cache's tree, at the root of the tree (reserved there).
18 37 ▶use constant VERSION_FILE => '.skilletor-version';
Subroutine BEGIN: called CC=1 SCAR=0.0
19  
20 289 ▶sub _read_string {
Subroutine _read_string: called CC=2 SCAR=7.0
21 289 my ( $bytes, $offset, $length ) = @_;
22 289 my $raw = substr $bytes, $offset, $length;
23 289 my $end = index $raw, "\0";
24 289 ▶ return decode_utf8_lossy( $end == -1 ? $raw : substr( $raw, 0, $end ) );
Branch: 1 branch
BranchTrueFalseTotal
$end == -1 ? : 0 289 289
25 }
26  
27 # parseInt(s, 8) of the trimmed field: NaN (undef) when no octal digit leads it.
28 144 ▶sub _read_octal {
Subroutine _read_octal: called CC=4 SCAR=13.9
29 144 my ( $bytes, $offset, $length ) = @_;
30 144 my $s = js_trim( _read_string( $bytes, $offset, $length ) );
31 144 ▶ return 0 if $s eq '';
Branch: 1 branch
BranchTrueFalseTotal
if $s eq "" 1 143 144
32 143 ▶ return undef unless $s =~ /\A([-+]?)([0-7]+)/;
Branch: 1 branch
BranchTrueFalseTotal
unless $s =~ /\A([-+]?)([0-7]+)/ 3 140 143
33 140 my $v = oct $2;
34 140 ▶ return $1 eq '-' ? -$v : $v;
Branch: 1 branch
BranchTrueFalseTotal
$1 eq '-' ? : 4 136 140
35 }
36  
37 2 ▶sub _pax_path {
Subroutine _pax_path: called CC=3 SCAR=12.0
38 2 my ( $data ) = @_;
39 2 for my $line ( split /\n/, decode_utf8_lossy($data), -1 ) {
40 2 ▶ return $1 if $line =~ /\A[0-9]+ path=([^\n\r\x{2028}\x{2029}]*)\z/;
Branch: 1 branch
BranchTrueFalseTotal
if $line =~ /\A[0-9]+ path=([^\n\r\x{2028}\x{2029}]*)\z/ 2 0 2
41 }
42 0 return undef;
43 }
44  
45 54 ▶sub _assert_safe {
Subroutine _assert_safe: called CC=6 SCAR=17.9
46 54 my ( $name ) = @_;
47 54 ▶ if ( $name eq '' || $name =~ m{\A[/\\]} || $name =~ /\A[a-zA-Z]:/ ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($name eq "" or $name =~ m(\A[/\\]) or $name =~ /\A[a-zA-Z]:/) 4 50 54
Condition100%6/6
$name eq "" or $name =~ m(\A[/\\]) or $name =~ /\A[a-zA-Z]:/
l!l&&r!l&&!r
3150
$name eq "" or $name =~ m(\A[/\\])
l!l&&r!l&&!r
1251
MC/DC100%3/3
$name eq "" or $name =~ m(\A[/\\]) or $name =~ /\A[a-zA-Z]:/
$name eq "" $name =~ m(\A[/\\]) $name =~ /\A[a-zA-Z]:/
Truth table100%4/4
A or B or C
A= $name eq ""B= $name =~ m(\A[/\\])C= $name =~ /\A[a-zA-Z]:/
ABCresult
1XX1
01X1
0011
0000
48 4 ▶ Skilletor::Error::Tar->throw( 'unsafe tar entry (absolute path): '.( length $name ? $name : '<empty>' ) );
Branch: 1 branch
BranchTrueFalseTotal
length $name ? : 3 1 4
49 }
50 50 ▶ if ( grep { $_ eq '..' } split m{/}, $name, -1 ) {
Branch: 1 branch
BranchTrueFalseTotal
if (grep {$_ eq "..";} split(m[/], $name, -1)) 1 49 50
51 1 Skilletor::Error::Tar->throw( 'unsafe tar entry (path traversal): '.$name );
52 }
53 }
54  
55 # A decompressed tar as safe entries: { name, type => 'file' | 'dir', data, executable }.
56 34 ▶sub parse_tar {
Subroutine parse_tar: called CC=22 SCAR=30.9
Pod documented
57 34 my ( $buf ) = @_;
58 34 my @entries;
59 34 my $len = length $buf;
60 34 my $offset = 0;
61 34 my ( $long_name, $pax_path );
62 34 my $ended = 0;
63 34 ▶ while ( $offset + 512 <= $len ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($offset + 512 <= $len) 85 3 88
64 85 my $block = substr $buf, $offset, 512;
65 85 ▶ if ( $block !~ /[^\0]/ ) { # end of archive
Branch: 1 branch
BranchTrueFalseTotal
unless ($block =~ /[^\0]/) 13 72 85
66 13 $ended = 1;
67 13 last;
68 }
69  
70 72 my $raw_name = _read_string( $block, 0, 100 );
71 72 my $mode = _read_octal( $block, 100, 8 );
72 72 my $prefix = _read_string( $block, 345, 155 );
73 72 my $size = _read_octal( $block, 124, 12 );
74 72 my $typeflag = substr $block, 156, 1;
75 # A size that parses negative would step back over this header for ever, a non-octal one
76 # (NaN) would end the walk quietly: corrupt like a failed gunzip, not unsafe – a plain error, so
77 # a url source falls back to its cache.
78 72 ▶ Skilletor::Error->throw( 'corrupt tar entry (size): '.$raw_name ) unless defined $size && $size >= 0;
Branch: 1 branch
BranchTrueFalseTotal
unless defined $size and $size >= 0 7 65 72
Condition100%3/3
defined $size and $size >= 0
!ll&&!rl&&r
3465
MC/DC100%2/2
defined $size and $size >= 0
defined $size $size >= 0
Truth table100%3/3
A and B
A= defined $sizeB= $size >= 0
ABresult
0X0
100
111
79 65 $offset += 512;
80 # k145: a stream cut short inside an entry's data (or its padding) is no smaller archive.
81 65 ▶ Skilletor::Error->throw( 'corrupt tar (truncated): '.$raw_name ) if $offset + _ceil_blocks($size) > $len;
Branch: 1 branch
BranchTrueFalseTotal
if $offset + _ceil_blocks($size) > $len 2 63 65
82 63 ▶ my $data = $size > 0 ? substr( $buf, $offset, $size ) : '';
Branch: 1 branch
BranchTrueFalseTotal
$size > 0 ? : 47 16 63
83 63 $offset += _ceil_blocks($size);
84  
85 63 ▶ if ( $typeflag eq 'L' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($typeflag eq "L") 1 62 63
86 1 ( $long_name = _read_string( $data, 0, length $data ) ) =~ s/\0+\z//;
87 1 next;
88 }
89 62 ▶ if ( $typeflag eq 'x' || $typeflag eq 'g' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($typeflag eq "x" or $typeflag eq "g") 2 60 62
Condition66%2/3
$typeflag eq "x" or $typeflag eq "g"
l!l&&r!l&&!r
2060
MC/DC50%1/2
$typeflag eq "x" or $typeflag eq "g"
$typeflag eq "x" $typeflag eq "g"
Truth table66%2/3
A or B
A= $typeflag eq "x"B= $typeflag eq "g"
ABresult
1X1
011
000
90 2 ▶ $pax_path = _pax_path($data) // $pax_path;
Condition33%1/3
_pax_path($data) // $pax_path
l!l&&r!l&&!r
200
MC/DC0%0/2
_pax_path($data) // $pax_path
_pax_path($data) $pax_path
Truth table33%1/3
A // B
A= _pax_path($data)B= $pax_path
ABresult
1X1
011
000
91 2 next;
92 }
93 60 ▶ if ( $typeflag eq '2' || $typeflag eq '1' ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($typeflag eq 2 or $typeflag eq 1) 4 56 60
Condition100%3/3
$typeflag eq 2 or $typeflag eq 1
l!l&&r!l&&!r
3156
MC/DC100%2/2
$typeflag eq 2 or $typeflag eq 1
$typeflag eq 2 $typeflag eq 1
Truth table100%3/3
A or B
A= $typeflag eq 2B= $typeflag eq 1
ABresult
1X1
011
000
94 4 Skilletor::Error::Tar->throw( 'unsafe tar entry (symlink/hardlink): '.$raw_name );
95 }
96 56 ▶ my $name = $pax_path // $long_name // ( length $prefix ? $prefix.'/'.$raw_name : $raw_name );
Branch: 1 branch
BranchTrueFalseTotal
length $prefix ? : 1 52 53
Condition83%5/6
($pax_path // $long_name) // (length $prefix ? $prefix . '/' . $raw_name : $raw_name)
l!l&&r!l&&!r
3530
$pax_path // $long_name
l!l&&r!l&&!r
2153
MC/DC0%0/3
($pax_path // $long_name) // (length $prefix ? $prefix . '/' . $raw_name : $raw_name)
$pax_path $long_name (length $prefix ? $prefix . '/' . $raw_name : $raw_name)
Truth table75%3/4
A // B // C
A= $pax_pathB= $long_nameC= (length $prefix ? $prefix . '/' . $raw_name : $raw_name)
ABCresult
1XX1
01X1
0011
0000
97 56 undef $long_name;
98 56 undef $pax_path;
99  
100 56 ▶ next if $typeflag ne '0' && $typeflag ne "\0" && $typeflag ne '5'; # devices etc.
Branch: 1 branch
BranchTrueFalseTotal
if $typeflag ne 0 and $typeflag ne "\0" and $typeflag ne 5 2 54 56
Condition83%5/6
$typeflag ne 0 and $typeflag ne "\0" and $typeflag ne 5
!ll&&!rl&&r
4682
$typeflag ne 0 and $typeflag ne "\0"
!ll&&!rl&&r
46010
MC/DC66%2/3
$typeflag ne 0 and $typeflag ne "\0" and $typeflag ne 5
$typeflag ne 0 $typeflag ne "\0" $typeflag ne 5
Truth table75%3/4
A and B and C
A= $typeflag ne 0B= $typeflag ne "\0"C= $typeflag ne 5
ABCresult
0XX0
10X0
1100
1111
101 54 _assert_safe($name);
102 49 ▶ if ( $typeflag eq '5' || $name =~ m{/\z} ) {
Branch: 1 branch
BranchTrueFalseTotal
if ($typeflag eq '5' or $name =~ m[/\z]) { } 9 40 49
Condition100%3/3
$typeflag eq 5 or $name =~ m[/\z]
l!l&&r!l&&!r
8140
MC/DC100%2/2
$typeflag eq 5 or $name =~ m[/\z]
$typeflag eq 5 $name =~ m[/\z]
Truth table100%3/3
A or B
A= $typeflag eq 5B= $name =~ m[/\z]
ABresult
1X1
011
000
103 9 ( my $dir = $name ) =~ s{/+\z}{};
104 9 push @entries, { name => $dir, type => 'dir', data => '', executable => 0 };
105 }
106 else {
107 40 push @entries, { name => $name, type => 'file', data => $data, executable => is_executable($mode) };
108 }
109 }
110 # k145: every archive ends with a zero block; running out of bytes first is a truncated one.
111 16 ▶ Skilletor::Error->throw('corrupt tar (truncated: no end-of-archive marker)') unless $ended;
Branch: 1 branch
BranchTrueFalseTotal
unless $ended 3 13 16
112 13 return \@entries;
113 }
114  
115 128 ▶sub _ceil_blocks {
Subroutine _ceil_blocks: called CC=3 SCAR=11.0
116 128 my ( $size ) = @_;
117 128 my $blocks = int( $size / 512 );
118 128 ▶ $blocks++ if $size > 0 && $size % 512;
Branch: 1 branch
BranchTrueFalseTotal
if $size > 0 and $size % 512 96 32 128
Condition66%2/3
$size > 0 and $size % 512
!ll&&!rl&&r
32096
MC/DC50%1/2
$size > 0 and $size % 512
$size > 0 $size % 512
Truth table66%2/3
A and B
A= $size > 0B= $size % 512
ABresult
0X0
100
111
119 128 return $blocks * 512;
120 }
121  
122 # Strip a single GitHub-style top-level directory, if there is one.
123 12 ▶sub strip_top_level {
Subroutine strip_top_level: called CC=8 SCAR=21.0
Pod documented
124 12 my ( $entries ) = @_;
125 12 my %tops;
126 12 for my $e (@$entries) {
127 39 my ($top) = split m{/}, $e->{name}, 2;
128 39 ▶ $tops{$top} = 1 if defined $top && length $top;
Branch: 1 branch
BranchTrueFalseTotal
if defined $top and length $top 39 0 39
Condition33%1/3
defined $top and length $top
!ll&&!rl&&r
0039
MC/DC0%0/2
defined $top and length $top
defined $top length $top
Truth table33%1/3
A and B
A= defined $topB= length $top
ABresult
0X0
100
111
129 }
130 12 my $nested = grep { index( $_->{name}, '/' ) >= 0 } @$entries;
131 12 ▶ return $entries if keys(%tops) != 1 || !$nested;
Branch: 1 branch
BranchTrueFalseTotal
if keys %tops != 1 or not $nested 2 10 12
Condition100%3/3
keys %tops != 1 or not $nested
l!l&&r!l&&!r
1110
MC/DC100%2/2
keys %tops != 1 or not $nested
keys %tops != 1 not $nested
Truth table100%3/3
A or not(B)
A= keys %tops != 1B= not $nested
ABresult
1X1
011
000
132 10 my ($top) = keys %tops;
133 10 my $prefix = $top.'/';
134 return [
135 36 grep { length $_->{name} }
136 map {
137 10 my $n = $_->{name};
138 36 ▶ +{ %$_, name => $n eq $top ? '' : index( $n, $prefix ) == 0 ? substr( $n, length $prefix ) : $n };
Branch: 2 branches
BranchTrueFalseTotal
$n eq $top ? : 9 27 36
index($n, $prefix) == 0 ? : 27 0 27
139 } @$entries
140 ];
141 }
142  
143 # An archive entry at the version file's path, or under it: never extracted.
144 27 ▶sub is_reserved {
Subroutine is_reserved: called CC=4 SCAR=14.0
Pod documented
145 27 my ( $name ) = @_;
146 27 ▶ my ($first) = grep { $_ ne '' && $_ ne '.' } split m{/}, $name, -1;
Condition66%2/3
$_ ne '' && $_ ne '.'
!ll&&!rl&&r
0161
MC/DC50%1/2
$_ ne '' && $_ ne '.'
$_ ne '' $_ ne '.'
Truth table66%2/3
A && B
A= $_ ne ''B= $_ ne '.'
ABresult
0X0
100
111
147 27 ▶ return ( defined $first && $first eq VERSION_FILE ) ? 1 : 0;
Branch: 1 branch
BranchTrueFalseTotal
defined $first && $first eq '.skilletor-version' ? : 10 17 27
Condition66%2/3
defined $first and $first eq ".skilletor-version"
!ll&&!rl&&r
01710
MC/DC50%1/2
defined $first and $first eq ".skilletor-version"
defined $first $first eq ".skilletor-version"
Truth table66%2/3
A and B
A= defined $firstB= $first eq ".skilletor-version"
ABresult
0X0
100
111
148 }
149  
150 37 1;
151  
152 __END__
« Skilletor/Gzip.pm ↑ Summary Skilletor/Frontmatter.pm »