File: validate-repo

package info (click to toggle)
extrepo-data 1.0.5
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 1,748 kB
  • sloc: perl: 777; makefile: 5
file content (389 lines) | stat: -rwxr-xr-x 13,322 bytes parent folder | download
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
#!/usr/bin/perl -w

use strict;
use warnings;
use feature "say";

use Hash::Case::Lower;
use LWP::UserAgent;
use YAML::XS qw/LoadFile/;
use File::Temp qw/tempfile tempdir/;
use File::Basename;
use IPC::Open2;
use XML::Writer;
use DateTime::HiRes;

use lib join('/', dirname($0), "lib");

use ExtRepoData;

use feature 'signatures';
no warnings 'experimental::signatures';

my $ua = LWP::UserAgent->new;
$ua->env_proxy;
$ua->agent("extrepo-data-validator/1.0; see https://salsa.debian.org/extrepo-team/extrepo-data");

my $data;

my $dir = tempdir(CLEANUP => 1);

sub success($name, $file, $msg, $data=undef) {
	say $msg;
	my $rv = {result => 1, name => $name, msg => $msg, ts => DateTime::HiRes->now, file => $file};
	if(defined $data) {
		$rv->{data} = $data;
	}
	return $rv;
}

sub failure($name, $file, $msg) {
	say STDERR $msg;
	return {result => 0, name => $name, msg => $msg, ts => DateTime::HiRes->now, file => $file};
}

sub skipped($name, $file, $msg) {
	say "Skipping test: $msg";
	return {result => 77, skipped => 1, name => $name, msg => $msg, ts => DateTime::HiRes->now, file => $file};
}

sub get($name, $file, $url) {
	my $resp = $ua->get($url);
	if(!$resp->is_success) {
		return failure($name, $file, "Could not download $url: " . $resp->status_line);
	}
	if (defined $resp->decoded_content) {
		return success($name, $file, "retrieved $url", $resp->decoded_content);
	} else {
		return success($name, $file, "retrieved $url", $resp->content);
	}
}

sub url_exists($name, $file, $url) {
	my $resp =$ua->head($url);
	if($resp->is_success) {
		return success($name, $file, "found $url");
	}
	return failure($name, $file, "$url not found");
}

sub head_from_list($name, $file, @urls) {
	my $url;
	my $resp;

	foreach $url(@urls) {
		$resp = $ua->head($url);
		if($resp->is_success) {
			return success($name, $file, "found $url");
		} elsif($resp->code == 400) { # Bad Request, probably because HEAD is not supported
                        $resp = $ua->get($url);
                        if($resp->is_success) {
                                return success($name, $file, "found $url");
                        }
                }
	}
	$url = $urls[0];
	return failure($name, $file, "Could not find anything like $url: " . $resp->status_line);
}

my %algos;

sub parse_gpgv($pipe, $file, $url, $repostring) {
	my $expired = 0;
	my $found = 0;
	my $lines;

	while(<$pipe>) {
		$lines .= $_;
		if (/^\[GNUPG:\] EXPKEYSIG (?<keyid>[A-F0-9]+) (?<keyname>.*)$/) {
			$expired = 1;
		}
		if (/^\[GNUPG:\] GOODSIG (?<keyid>[A-F0-9]+) (?<keyname>.*)$/) {
			$expired = 0;
			$found++;
		}
		if (/VALIDSIG (?<fpr>[A-F0-9]+) (?<sigdate>[0-9]{4}-[0-9]{2}-[0-9]{2}) (?<sigts>\S+) (?<expts>\S+) (?<sigversion>[0-9]+) (?<reserved>[0-9]+) (?<pubkeyalg>[0-9]+) (?<hashalg>[0-9]+) (?<sigclass>[0-9]+)( (?<prikeyfpr>[A-F0-9]+))?/) {
			if($expired) {
				print "found valid signature by expired key " . $+{fpr} . " using algorithm " . $+{pubkeyalg} . "\n";
			} else {
				print "found good signature by key " . $+{fpr} . " using algorithm " . $+{pubkeyalg} . "\n";
				if(!exists($algos{$+{pubkeyalg}})) {
					$algos{$+{pubkeyalg}} = 0;
				}
				$algos{$+{pubkeyalg}}++;
			}
		}
		if(/ERRSIG (?<keyid>[A-F0-9]+) (?<pkgalg>[0-9]+) (?<hashalg>[0-9]+) (?<sigclass>[0-9]+) (?<time>(\S+) (?<rc>[0-9]+) (?<fpr>[A-F0-9]+))/) {
			print "found invalid signature by key " . $+{keyid} . " using algorithm " . $+{pkgalg} . "; rc = " . $+{rc} . "\n";
		}
	}
	if(!$found) {
		print STDERR "gpgv output:\n\n";
		print STDERR $lines;
		return failure("$repostring, signature", $file, "No good signature found for $url");
	}
	return success("$repostring, signature", $file, "found $found good signature(s)");
}

sub verify_inrelease($url, $file, $gpg, $repostring) {
	my $inrelease = get("$repostring, InRelease file", $file, $url);
	if(!$inrelease->{result}) {
		return $inrelease;
	}
	$inrelease = $inrelease->{data};
	unlink("$dir/Release.gpg");
	open RELEASE, ">", "$dir/Release" or die $!;
	my $pid = open2(">&RELEASE", my $child_in, "pgpainless-cli", "inline-detach", "--signatures-out=$dir/Release.gpg", "--stacktrace") or die $!;
	print $child_in $inrelease;
	close $child_in;
	close RELEASE;
	open my $inrelease_file, ">", "$dir/InRelease" or die $!;
	print $inrelease_file $inrelease;
	close $inrelease_file;
	# For some reason, the close above does not always reflect on
	# the file system immediately. Add a short delay as a workaround
	sleep 1;
	return verify_release_gpg($url, $file, $gpg, $repostring, 0);
}

sub verify_release_gpg($relurl, $file, $gpg, $repostring, $fetch=1) {
	my $gpgurl = "$relurl.gpg";
	my $relfilename;
	my $sigfilename;

	if($fetch) {
		my ($relfh, $sigfh);
		my $release = get("$repostring, Release file", $file, $relurl);
		if(!$release->{result}) {
			return $release;
		}
		$release = $release->{data};
		($relfh, $relfilename) = tempfile(DIR => $dir) or die $!;
		print $relfh $release;
		close $relfh;
		my $signature = get("$repostring, Release.gpg file", $file, $gpgurl);
		if (!$signature->{result}) {
			return $signature;
		}
		$signature = $signature->{data};
		($sigfh, $sigfilename) = tempfile(DIR => $dir) or die $!;
		print $sigfh $signature;
		close $sigfh;
	} else {
		$sigfilename = "$dir/Release.gpg";
		$relfilename = "$dir/Release";
	}
	my ($gpgfh, $gpgfilename) = tempfile(DIR => $dir);
	print $gpgfh $gpg;
	close $gpgfh;
	system("/usr/bin/gpg", "--dearmor", $gpgfilename);
	open my $validate, "gpgv --status-fd 1 --keyring $gpgfilename.gpg $sigfilename $relfilename 2>/dev/null|";
	return parse_gpgv($validate, $file, $relurl, $repostring);
}

my @invalids;
my $starttime = DateTime::HiRes->now;
my @testcases;
my $parallel_counter = 0;
if(exists($ENV{CI_NODE_INDEX})) {
	say "Running parallel job " . $ENV{CI_NODE_INDEX} . " of " . $ENV{CI_NODE_TOTAL};
} else {
	say "Not running in parallel";
}

foreach my $file(sort @ARGV) {
	die "invalid filename $file" unless $file =~ /\.yaml$/;

	if(! -f $file) {
		# ignore, probably a merge request that removes one or more file(s)
		print "$file does not exist -- ignoring\n";
		next;
	}
	$data = LoadFile($file);

	REPO:
	foreach my $repo(sort(keys %$data)) {
		next REPO if $repo =~ /^\./;
		if(exists($ENV{CI_NODE_INDEX})) {
			my $parallel_test = ($parallel_counter++ % $ENV{CI_NODE_TOTAL}) + 1;
			print "$parallel_test -> " . ($ENV{CI_NODE_INDEX}) . ": ";
			if ($parallel_test != ($ENV{CI_NODE_INDEX})) {
				say "skipping $repo: will run in different parallel job";
				next REPO;
			}
		}
		my $tieobj = tie my(%hash), 'ExtRepoData', $data->{$repo};
		$data->{$repo} = \%hash;

		if(exists($ENV{VALIDATE_ONIONS})) {
			next REPO unless exists($data->{$repo}{"onion-uris"});
			delete $data->{$repo}{source}{uris};
			$data->{$repo}{source}{uris} = $data->{$repo}{"onion-uris"};
		}

		if (exists($data->{$repo}{Disabled})) {
			push @testcases, skipped("check if repository $repo is enabled", $file, "$repo disabled");
			next REPO;
		}
		push @testcases, success("check if repository $repo is enabled", $file, "$repo enabled");

		my $printed = 0;

		my %types;
		foreach my $type(split(" ", $data->{$repo}{source}{types})) {
			$types{$type} = 1;
		}
		foreach my $ssuite(@{$data->{$repo}{suites}}) {
			$tieobj->suite(ExtRepoData::Suite->new($ssuite));
			foreach my $suite(split(" ", $data->{$repo}{source}{suites})) {
				my $vers = ExtRepoData::Suite::version_of($ssuite);
				$suite =~ s/<SUITE>/$ssuite/g;
				$suite =~ s/<VERSION>/$vers/g;
				my $repostring = "repo $repo, suite $suite";
				say $repostring . ", repository metadata";
				my $scomponents;
				my $urlbase;
				if(exists($data->{$repo}{source}{components})) {
					$urlbase = join("/", $data->{$repo}{source}{uris}, "dists", $suite);
				} else {
					$urlbase = join("/", $data->{$repo}{source}{uris}, $suite);
				}
				$urlbase =~ s/<SUITE>/$ssuite/g;
				$urlbase =~ s/<VERSION>/$vers/g;
				if(!exists($ENV{SKIP_INRELEASE}) && (url_exists("", $file, join("/", $urlbase, "InRelease")))->{result}) {
					push @testcases, verify_inrelease(join("/", $urlbase, "InRelease"), $file, $data->{$repo}{"gpg-key"}, $repostring);
				} elsif((url_exists("", $file, join("/", $urlbase, "Release")))->{result}) {
					push @testcases, verify_release_gpg(join("/", $urlbase, "Release"), $file, $data->{$repo}{"gpg-key"}, $repostring);
				} else {
					$urlbase = join("/", $data->{$repo}{source}{uris}, "dists", $suite);
					if(!exists($ENV{SKIP_INRELEASE}) && (url_exists("", $file, join("/", $urlbase, "InRelease")))->{result}) {
						push @testcases, verify_inrelease(join("/", $urlbase, "InRelease"), $file, $data->{$repo}{"gpg-key"}, $repostring);
					} elsif((url_exists("", $file, join("/", $urlbase, "Release"))->{result})) {
						push @testcases, verify_release_gpg(join("/", $urlbase, "Release"), $file, $data->{$repo}{"gpg-key"}, $repostring);
					} else {
						push @testcases, failure("$repostring, signature", $file, "Release file not found under $urlbase, cannot verify repository");
					}
				}
				if(!($testcases[-1]{result})) {
					say STDERR "FAILED -- " . $testcases[-1]{msg};
					push @invalids, "while validating repository $repo: " . $testcases[-1]{result};
					next REPO;
				}
				if(!exists($data->{$repo}{components})) {
					$scomponents = [ "<unspecified>" ];
				} else {
					$scomponents = $data->{$repo}{components};
				}
				foreach my $scomponent(@$scomponents) {
					my $components;
					if(exists($data->{$repo}{source}{"suite-$ssuite-components"})) {
						$components = $data->{$repo}{source}{"suite-$ssuite-components"};
					} elsif(exists($data->{$repo}{source}{components})) {
						$components = $data->{$repo}{source}{components};
					} else {
						$components = ".";
					}
					foreach my $component(split(" ", $components)) {
						$component =~ s/<SUITE>/$ssuite/g;
						$component =~ s/<VERSION>/$vers/g;
						$component =~ s/<COMPONENTS>/$scomponent/g;
						$repostring = "repo $repo, suite $ssuite, component $component";
						my $urlsuite = join("/", $urlbase, $component);
						$urlsuite =~ s/<COMPONENTS>/$scomponent/g;
						say $repostring;

						if($types{"deb-src"}) {
							my $srcurl;
							if($component ne ".") {
								$srcurl = join("/", $urlsuite, "source", "Sources");
							} else {
								$srcurl = join("/", $urlsuite, "Sources");
							}
							my @sources = ($srcurl, "$srcurl.gz", "$srcurl.xz");
							push @testcases, head_from_list("$repostring, source metadata", $file, @sources);
							if(!$testcases[-1]{result}) {
								say STDERR "FAILED -- " . $testcases[-1]{msg};
								push @invalids, "while validating $repostring:" . $testcases[-1]{result};
								next REPO;
							}
						}
						next REPO unless $types{deb};
						my $architectures;
						if(exists($data->{$repo}{source}{"suite-$ssuite-architectures"})) {
							$architectures = $data->{$repo}{source}{"suite-$ssuite-architectures"};
						} elsif(!exists($data->{$repo}{source}{architectures})) {
							print STDERR "WARNING: no Architectures key in $repo:source:. This is not recommended.\n" unless $printed;
							$printed = 1;
							next REPO;
						} else {
							$architectures = $data->{$repo}{source}{architectures};
						}
						foreach my $arch(split(" ", $architectures)) {
							my $burl;
							if($component ne ".") {
								$burl = join("/", $urlsuite, "binary-$arch", "Packages");
							} else {
								$burl = join("/", $urlsuite, "Packages");
							}
							my @burls = ($burl, "$burl.gz", "$burl.xz");
							push @testcases, head_from_list("$repostring, Packages file for architecture $arch", $file, @burls);
							if(!$testcases[-1]{result}) {
								say STDERR "FAILED -- " . $testcases[-1]{msg};
								push @invalids, "while validating repository $repostring, architecture $arch: " . $testcases[-1]{msg};
								next REPO;
							}
						}
					}
				}
			}
		}
	}
}

my $exit = 0;

foreach my $invalid(@invalids) {
	print "\n\nvalidation failed:\n" unless $exit;
	print "$invalid\n";
	$exit = 1;
}

print "Signatures found per algorithm:\n";
foreach my $algo(keys %algos) {
	print "$algo: $algos{$algo}\n";
}

open my $junitfile, ">", "validate-repo-junit.xml";

my $junit = XML::Writer->new(OUTPUT => $junitfile);

my $total = scalar(@testcases);
my $failed = grep({$_->{result} == 0} @testcases);
my $skipped = grep({exists($_->{skipped})} @testcases);

$junit->startTag("testsuites", time => (DateTime::HiRes->now->hires_epoch - $starttime->hires_epoch), tests => $total, failures => $failed, skipped => $skipped);
$junit->startTag("testsuite", name => "validate-repo", id => "validate-repo", timestamp => $starttime->iso8601);
my $prevtime = $starttime;
foreach my $case(@testcases) {
	$junit->startTag("testcase", time => $case->{ts}->hires_epoch - $prevtime->hires_epoch, name => $case->{name}, file => $case->{file});
        $prevtime = $case->{ts};
	if(exists($case->{skipped})) {
		$junit->startTag("skipped", message => $case->{msg});
		$junit->endTag("skipped");
	} elsif(!$case->{result}) {
		$junit->startTag("failure", message => $case->{msg});
		$junit->endTag("failure");
	} else {
		$junit->startTag("system-out");
		$junit->characters($case->{msg});
		$junit->endTag("system-out");
	}
	$junit->endTag("testcase");
}
$junit->endTag("testsuite");
$junit->endTag("testsuites");
$junit->end;

close $junitfile;

exit $exit;