infra/dgit-repos-server

   1 #!/usr/bin/perl -w
   2 # dgit-repos-server
   3 #
   4 # usages:
   5 #  .../dgit-repos-server DISTRO SUITES KEYRING-AUTH-SPEC \
   6 #      DGIT-REPOS-DIR POLICY-HOOK-SCRIPT --ssh
   7 # internal usage:
   8 #  .../dgit-repos-server --pre-receive-hook PACKAGE
   9 #
  10 # Invoked as the ssh restricted command
  11 #
  12 # Works like git-receive-pack
  13 #
  14 # SUITES is the name of a file which lists the permissible suites
  15 # one per line (#-comments and blank lines ignored)
  16 #
  17 # KEYRING-AUTH-SPEC is a :-separated list of
  18 #   KEYRING.GPG,AUTH-SPEC
  19 # where AUTH-SPEC is one of
  20 #   a
  21 #   mDM.TXT
  22
  23 use strict;
  24
  25 # What we do is this:
  26 #  - extract the destination repo name
  27 #  - make a hardlink clone of the destination repo
  28 #  - provide the destination with a stunt pre-receive hook
  29 #  - run actual git-receive-pack with that new destination
  30 #   as a result of this the stunt pre-receive hook runs; it does this:
  31 #    + understand what refs we are allegedly updating and
  32 #      check some correspondences:
  33 #        * we are updating only refs/tags/debian/* and refs/dgit/*
  34 #        * and only one of each
  35 #        * and the tag does not already exist
  36 #      and
  37 #        * recover the suite name from the destination refs/dgit/ ref
  38 #    + disassemble the signed tag into its various fields and signature
  39 #      including:
  40 #        * parsing the first line of the tag message to recover
  41 #          the package name, version and suite
  42 #        * checking that the package name corresponds to the dest repo name
  43 #        * checking that the suite name is as recovered above
  44 #    + verify the signature on the signed tag
  45 #      and if necessary check that the keyid and package are listed in dm.txt
  46 #    + check various correspondences:
  47 #        * the suite is one of those permitted
  48 #        * the signed tag must refer to a commit
  49 #        * the signed tag commit must be the refs/dgit value
  50 #        * the name in the signed tag must correspond to its ref name
  51 #        * the tag name must be debian/<version> (massaged as needed)
  52 #        * the signed tag has a suitable name
  53 #        * the commit is a fast forward
  54 #    + push the signed tag and new dgit branch to the actual repo
  55 #
  56 # If the destination repo does not already exist, we need to make
  57 # sure that we create it reasonably atomically, and also that
  58 # we don't every have a destination repo containing no refs at all
  59 # (because such a thing causes git-fetch-pack to barf).  So then we
  60 # do as above, except:
  61 #  - before starting, we take out our own lock for the destination repo
  62 #  - we create a prospective new destination repo by making a copy
  63 #    of _template
  64 #  - we use the prospective new destination repo instead of the
  65 #    actual new destination repo (since the latter doesn't exist)
  66 #  - we set up a post-receive hook as well, which
  67 #    + touches a stamp file
  68 #  - after git-receive-pack exits, we
  69 #    + check that the prospective repo contains a tag and head
  70 #    + rename the prospective destination repo into place
  71 #
  72 # Cleanup strategy:
  73 #  - We are crash-only
  74 #  - Temporary working trees and their locks are cleaned up
  75 #    opportunistically by a program which tries to take each lock and
  76 #    if successful deletes both the tree and the lockfile
  77 #  - Prospective working trees and their locks are cleaned up by
  78 #    a program which tries to take each lock and if successful
  79 #    deletes any prospective working tree and the lock (but not
  80 #    of course any actual tree)
  81 #  - It is forbidden to _remove_ the lockfile without removing
  82 #    the corresponding temporary tree, as the lockfile is also
  83 #    a stampfile whose presence indicates that there may be
  84 #    cleanup to do
  85
  86 use POSIX;
  87 use Fcntl qw(:flock);
  88 use File::Path qw(rmtree);
  89
  90 use Debian::Dgit qw(:DEFAULT :policyflags);
  91
  92 open DEBUG, ">/dev/null" or die $!;
  93
  94 our $func;
  95 our $dgitrepos;
  96 our $package;
  97 our $suitesfile;
  98 our $policyhook;
  99 our $realdestrepo;
 100 our $destrepo;
 101 our $workrepo;
 102 our $keyrings;
 103 our @lockfhs;
 104 our $debug='';
 105 our @deliberatelies;
 106 our $policy;
 107
 108 #----- utilities -----
 109
 110 sub debug {
 111     print DEBUG "$debug @_\n";
 112 }
 113
 114 sub acquirelock ($$) {
 115     my ($lock, $must) = @_;
 116     my $fh;
 117     printf DEBUG "$debug locking %s %d\n", $lock, $must;
 118     for (;;) {
 119         close $fh if $fh;
 120         $fh = new IO::File $lock, ">" or die "open $lock: $!";
 121         my $ok = flock $fh, $must ? LOCK_EX : (LOCK_EX|LOCK_NB);
 122         if (!$ok) {
 123             die "flock $lock: $!" if $must;
 124             debug " locking $lock failed";
 125             return undef;
 126         }
 127         if (!stat $lock) {
 128             next if $! == ENOENT;
 129             die "stat $lock: $!";
 130         }
 131         my $want = (stat _)[1];
 132         stat $fh or die $!;
 133         my $got = (stat _)[1];
 134         last if $got == $want;
 135     }
 136     return $fh;
 137 }
 138
 139 sub acquiretree ($$) {
 140     my ($tree, $must) = @_;
 141     my $fh = acquirelock("$tree.lock", $must);
 142     if ($fh) {
 143         push @lockfhs, $fh;
 144         rmtree $tree;
 145     }
 146     return $fh;
 147 }
 148
 149 sub mkrepotmp () {
 150     my $tmpdir = "$dgitrepos/_tmp";
 151     return if mkdir $tmpdir;
 152     return if $! == EEXIST;
 153     die $!;
 154 }
 155
 156 sub recorderror ($) {
 157     my ($why) = @_;
 158     my $w = $ENV{'DGIT_DRS_WORK'}; # we are in stunthook
 159     if (defined $w) {
 160         chomp $why;
 161         open ERR, ">", "$w/drs-error" or die $!;
 162         print ERR $why, "\n" or die $!;
 163         close ERR or die $!;
 164         return 1;
 165     }
 166     return 0;
 167 }
 168
 169 sub reject ($) {
 170     my ($why) = @_;
 171     recorderror "reject: $why";
 172     die "dgit-repos-server: reject: $why\n";
 173 }
 174
 175 sub debugcmd {
 176     if ($debug) {
 177         use Data::Dumper;
 178         local $Data::Dumper::Indent = 0;
 179         local $Data::Dumper::Terse = 1;
 180         debug "|".Dumper(\@_);
 181     }
 182 }
 183
 184 sub runcmd {
 185     debugcmd @_;
 186     $!=0; $?=0;
 187     my $r = system @_;
 188     die "@_ $? $!" if $r;
 189 }
 190
 191 sub policyhook {
 192     my ($policyallowbits, @polargs) = @_;
 193     # => ($exitstatuspolicybitmap, $policylockfh);
 194     die if $policyallowbits & ~0x3e;
 195     my @cmd = ($policyhook,$distro,$repos,@polargs);
 196     debugcmd @_;
 197     my $r = system @_;
 198     die "system: $!" if $r < 0;
 199     die "hook (@cmd) failed ($?)" if $r & ~($policyallowbits << 8);
 200     return $r >> 8;
 201 }
 202
 203 sub mkemptyrepo ($$) {
 204     my ($dir,$sharedperm) = @_;
 205     runcmd qw(git init --bare --quiet), "--shared=$sharedperm", $dir;
 206 }
 207
 208 #----- git-receive-pack -----
 209
 210 sub fixmissing__git_receive_pack () {
 211     mkrepotmp();
 212     $destrepo = "$dgitrepos/_tmp/${package}_prospective";
 213     acquiretree($destrepo, 1);
 214     my $template = "$dgitrepos/_template";
 215     debug "fixmissing copy tempalate $template -> $destrepo";
 216     my $r = system qw(cp -a --), $template, $destrepo;
 217     !$r or die "create new repo failed failed: $r $!";
 218 }
 219
 220 sub makeworkingclone () {
 221     mkrepotmp();
 222     $workrepo = "$dgitrepos/_tmp/${package}_incoming$$";
 223     acquiretree($workrepo, 1);
 224     runcmd qw(git clone -l -q --mirror), $destrepo, $workrepo;
 225 }
 226
 227 sub setupstunthook () {
 228     my $prerecv = "$workrepo/hooks/pre-receive";
 229     my $fh = new IO::File $prerecv, O_WRONLY|O_CREAT|O_TRUNC, 0777
 230         or die "$prerecv: $!";
 231     print $fh <<END or die "$prerecv: $!";
 232 #!/bin/sh
 233 set -e
 234 exec $0 --pre-receive-hook $package
 235 END
 236     close $fh or die "$prerecv: $!";
 237     $ENV{'DGIT_DRS_WORK'}= $workrepo;
 238     $ENV{'DGIT_DRS_DEST'}= $destrepo;
 239     debug " stunt hook set up $prerecv";
 240 }
 241
 242 sub maybeinstallprospective () {
 243     return if $destrepo eq $realdestrepo;
 244
 245     if (open REJ, "<", "$workrepo/drs-error") {
 246         local $/ = undef;
 247         my $msg = <REJ>;
 248         REJ->error and die $!;
 249         print STDERR $msg;
 250         exit 1;
 251     } else {
 252         $!==&ENOENT or die $!;
 253     }
 254
 255     debug " show-ref ($destrepo) ...";
 256
 257     my $child = open SR, "-|";
 258     defined $child or die $!;
 259     if (!$child) {
 260         chdir $destrepo or die $!;
 261         exec qw(git show-ref);
 262         die $!;
 263     }
 264     my %got = qw(tag 0 head 0);
 265     while (<SR>) {
 266         chomp or die;
 267         debug " show-refs| $_";
 268         s/^\S*[1-9a-f]\S* (\S+)$/$1/ or die;
 269         my $wh =
 270             m{^refs/tags/} ? 'tag' :
 271             m{^refs/dgit/} ? 'head' :
 272             die;
 273         die if $got{$wh}++;
 274     }
 275     $!=0; $?=0; close SR or $?==256 or die "$? $!";
 276
 277     debug "installprospective ?";
 278     die Dumper(\%got)." -- missing refs in new repo"
 279         if grep { !$_ } values %got;
 280
 281     debug "install $destrepo => $realdestrepo";
 282     rename $destrepo, $realdestrepo or die $!;
 283     remove "$destrepo.lock" or die $!;
 284 }
 285
 286 sub main__git_receive_pack () {
 287     makeworkingclone();
 288     setupstunthook();
 289     runcmd qw(git receive-pack), $workrepo;
 290     maybeinstallprospective();
 291 }
 292
 293 #----- stunt post-receive hook -----
 294
 295 our ($tagname, $tagval, $suite, $oldcommit, $commit);
 296 our ($version, %tagh);
 297
 298 sub readupdates () {
 299     debug " updates ...";
 300     while (<STDIN>) {
 301         chomp or die;
 302         debug " upd.| $_";
 303         m/^(\S+) (\S+) (\S+)$/ or die "$_ ?";
 304         my ($old, $sha1, $refname) = ($1, $2, $3);
 305         if ($refname =~ m{^refs/tags/(?=debian/)}) {
 306             reject "pushing multiple tags!" if defined $tagname;
 307             $tagname = $'; #';
 308             $tagval = $sha1;
 309             reject "tag $tagname already exists -".
 310                 " not replacing previously-pushed version"
 311                 if $old =~ m/[^0]/;
 312         } elsif ($refname =~ m{^refs/dgit/}) {
 313             reject "pushing multiple heads!" if defined $suite;
 314             $suite = $'; #';
 315             $oldcommit = $old;
 316             $commit = $sha1;
 317         } else {
 318             reject "pushing unexpected ref!";
 319         }
 320     }
 321     STDIN->error and die $!;
 322
 323     reject "push is missing tag ref update" unless defined $tagname;
 324     reject "push is missing head ref update" unless defined $suite;
 325     debug " updates ok.";
 326 }
 327
 328 sub parsetag () {
 329     debug " parsetag...";
 330     open PT, ">dgit-tmp/plaintext" or die $!;
 331     open DS, ">dgit-tmp/plaintext.asc" or die $!;
 332     open T, "-|", qw(git cat-file tag), $tagval or die $!;
 333     for (;;) {
 334         $!=0; $_=<T>; defined or die $!;
 335         print PT or die $!;
 336         if (m/^(\S+) (.*)/) {
 337             push @{ $tagh{$1} }, $2;
 338         } elsif (!m/\S/) {
 339             last;
 340         } else {
 341             die;
 342         }
 343     }
 344     $!=0; $_=<T>; defined or die $!;
 345     m/^($package_re) release (\S+) for \S+ \((\S+)\) \[dgit\]$/ or
 346         reject "tag message not in expected format";
 347
 348     die unless $1 eq $package;
 349     $version = $2;
 350     die "$3 != $suite " unless $3 eq $suite;
 351
 352     for (;;) {
 353         print PT or die $!;
 354         $!=0; $_=<T>; defined or die "missing signature? $!";
 355         if (m/^\[dgit ([^"].*)\]$/) { # [dgit "something"] is for future
 356             $_ = $1." ";
 357             for (;;) {
 358                 if (s/^distro\=(\S+) //) {
 359                     die "$1 != $distro" unless $1 eq $distro;
 360                 } elsif (s/^(--deliberately-$package_re) //) {
 361                     push @deliberatelies, $1;
 362                 } elsif (s/^[-+.=0-9a-z]\S* //) {
 363                 } else {
 364                     die "unknown dgit info in tag";
 365                 }
 366             }
 367             next;
 368         }
 369         last if m/^-----BEGIN PGP/;
 370     }
 371     for (;;) {
 372         print DS or die $!;
 373         $!=0; $_=<T>;
 374         last if !defined;
 375     }
 376     T->error and die $!;
 377     close PT or die $!;
 378     close DS or die $!;
 379     debug " parsetag ok.";
 380 }
 381
 382 sub checksig_keyring ($) {
 383     my ($keyringfile) = @_;
 384     # returns primary-keyid if signed by a key in this keyring
 385     # or undef if not
 386     # or dies on other errors
 387
 388     my $ok = undef;
 389
 390     debug " checksig keyring $keyringfile...";
 391
 392     our @cmd = (qw(gpgv --status-fd=1 --keyring),
 393                    $keyringfile,
 394                    qw(dgit-tmp/plaintext.asc dgit-tmp/plaintext));
 395     debugcmd @cmd;
 396
 397     open P, "-|", @cmd
 398         or die $!;
 399
 400     while (<P>) {
 401         next unless s/^\[GNUPG:\] //;
 402         chomp or die;
 403         debug " checksig| $_";
 404         my @l = split / /, $_;
 405         if ($l[0] eq 'NO_PUBKEY') {
 406             last;
 407         } elsif ($l[0] eq 'VALIDSIG') {
 408             my $sigtype = $l[9];
 409             $sigtype eq '00' or reject "signature is not of type 00!";
 410             $ok = $l[10];
 411             die unless defined $ok;
 412             last;
 413         }
 414     }
 415     close P;
 416
 417     debug sprintf " checksig ok=%d", !!$ok;
 418
 419     return $ok;
 420 }
 421
 422 sub dm_txt_check ($$) {
 423     my ($keyid, $dmtxtfn) = @_;
 424     debug " dm_txt_check $keyid $dmtxtfn";
 425     open DT, '<', $dmtxtfn or die "$dmtxtfn $!";
 426     while (<DT>) {
 427         m/^fingerprint:\s+$keyid$/oi
 428             ..0 or next;
 429         if (s/^allow:/ /i..0) {
 430         } else {
 431             m/^./
 432                 or reject "key $keyid missing Allow section in permissions!";
 433             next;
 434         }
 435         # in right stanza...
 436         s/^[ \t]+//
 437             or reject "package $package not allowed for key $keyid";
 438         # in allow field...
 439         s/\([^()]+\)//;
 440         s/\,//;
 441         chomp or die;
 442         debug " dm_txt_check allow| $_";
 443         foreach my $p (split /\s+/) {
 444             if ($p eq $package) {
 445                 # yay!
 446                 debug " dm_txt_check ok";
 447                 return;
 448             }
 449         }
 450     }
 451     DT->error and die $!;
 452     close DT or die $!;
 453     reject "key $keyid not in permissions list although in keyring!";
 454 }
 455
 456 sub verifytag () {
 457     foreach my $kas (split /:/, $keyrings) {
 458         debug "verifytag $kas...";
 459         $kas =~ s/^([^,]+),// or die;
 460         my $keyid = checksig_keyring $1;
 461         if (defined $keyid) {
 462             if ($kas =~ m/^a$/) {
 463                 debug "verifytag a ok";
 464                 return; # yay
 465             } elsif ($kas =~ m/^m([^,]+)$/) {
 466                 dm_txt_check($keyid, $1);
 467                 debug "verifytag m ok";
 468                 return;
 469             } else {
 470                 die;
 471             }
 472         }
 473     }
 474     reject "key not found in keyrings";
 475 }
 476
 477 sub checksuite () {
 478     debug "checksuite ($suitesfile)";
 479     open SUITES, "<", $suitesfile or die $!;
 480     while (<SUITES>) {
 481         chomp;
 482         next unless m/\S/;
 483         next if m/^\#/;
 484         s/\s+$//;
 485         return if $_ eq $suite;
 486     }
 487     die $! if SUITES->error;
 488     reject "unknown suite";
 489 }
 490
 491 sub tagh1 ($) {
 492     my ($tag) = @_;
 493     my $vals = $tagh{$tag};
 494     reject "missing header $tag in signed tag object" unless $vals;
 495     reject "multiple headers $tag in signed tag object" unless @$vals == 1;
 496     return $vals->[0];
 497 }
 498
 499 sub checks () {
 500     debug "checks";
 501
 502     tagh1('type') eq 'commit' or reject "tag refers to wrong kind of object";
 503     tagh1('object') eq $commit or reject "tag refers to wrong commit";
 504     tagh1('tag') eq $tagname or reject "tag name in tag is wrong";
 505
 506     my $v = $version;
 507     $v =~ y/~:/_%/;
 508
 509     debug "translated version $v";
 510     $tagname eq "debian/$v" or die;
 511
 512     my ($policy) = policyhook(NOFFCHECK, 'push',$package,
 513                               $version,$suite,$tagname,
 514                               join(",",@delberatelies));
 515
 516     checksuite();
 517
 518     # check that our ref is being fast-forwarded
 519     debug "oldcommit $oldcommit";
 520     if (!($policy & NOFFCHECK) && $oldcommit =~ m/[^0]/) {
 521         $?=0; $!=0; my $mb = `git merge-base $commit $oldcommit`;
 522         chomp $mb;
 523         $mb eq $oldcommit or reject "not fast forward on dgit branch";
 524     }
 525 }
 526
 527 sub onwardpush () {
 528     my @cmd = (qw(git send-pack), $destrepo,
 529                "$commit:refs/dgit/$suite",
 530                "$tagval:refs/tags/$tagname");
 531     debugcmd @cmd;
 532     $!=0;
 533     my $r = system @cmd;
 534     !$r or die "onward push failed: $r $!";
 535 }
 536
 537 sub stunthook () {
 538     debug "stunthook";
 539     chdir $workrepo or die "chdir $workrepo: $!";
 540     mkdir "dgit-tmp" or $!==EEXIST or die $!;
 541     readupdates();
 542     parsetag();
 543     verifytag();
 544     checks();
 545     onwardpush();
 546     debug "stunthook done.";
 547 }
 548
 549 #----- git-upload-pack -----
 550
 551 sub fixmissing__git_upload_pack () {
 552     $destrepo = "$dgitrepos/_empty";
 553     my $lfh = acquiretree($destrepo,1);
 554     return if stat $destrepo;
 555     die $! unless $!==ENOENT;
 556     rmtree "$destrepo.new";
 557     mkemptyrepo "$destrepo.new", "0644";
 558     rename "$destrepo.new", $destrepo or die $!;
 559     unlink "$destrepo.lock" or die $!;
 560     close $lfh;
 561 }
 562
 563 sub main__git_upload_pack () {
 564     runcmd qw(git upload-pack), $destrepo;
 565 }
 566
 567 #----- arg parsing and main program -----
 568
 569 sub argval () {
 570     die unless @ARGV;
 571     my $v = shift @ARGV;
 572     die if $v =~ m/^-/;
 573     return $v;
 574 }
 575
 576 sub parseargsdispatch () {
 577     die unless @ARGV;
 578
 579     delete $ENV{'GIT_DIR'}; # if not run via ssh, our parent git process
 580     delete $ENV{'GIT_PREFIX'}; # sets these and they mess things up
 581
 582     if ($ENV{'DGIT_DRS_DEBUG'}) {
 583         $debug='=';
 584         open DEBUG, ">&STDERR" or die $!;
 585     }
 586
 587     if ($ARGV[0] eq '--pre-receive-hook') {
 588         if ($debug) { $debug.="="; }
 589         shift @ARGV;
 590         @ARGV == 1 or die;
 591         $package = shift @ARGV;
 592         defined($distro = $ENV{'DGIT_DRS_DISTRO'}) or die;
 593         defined($suitesfile = $ENV{'DGIT_DRS_SUITES'}) or die;
 594         defined($workrepo = $ENV{'DGIT_DRS_WORK'}) or die;
 595         defined($destrepo = $ENV{'DGIT_DRS_DEST'}) or die;
 596         defined($keyrings = $ENV{'DGIT_DRS_KEYRINGS'}) or die $!;
 597         defined($policyhook = $ENV{'DGIT_DRS_POLICYHOOK'}) or die $!;
 598         open STDOUT, ">&STDERR" or die $!;
 599         eval {
 600             stunthook();
 601         };
 602         if ($@) {
 603             recorderror "$@" or die;
 604             die $@;
 605         }
 606         exit 0;
 607     }
 608
 609     $ENV{'DGIT_DRS_DISTRO'} = argval();
 610     $ENV{'DGIT_DRS_SUITES'} = argval();
 611     $ENV{'DGIT_DRS_KEYRINGS'} = argval();
 612     $dgitrepos = argval();
 613     $ENV{'DGIT_DRS_POLICYHOOK'} = $policyhook = argval();
 614
 615     die unless @ARGV==1 && $ARGV[0] eq '--ssh';
 616
 617     my $cmd = $ENV{'SSH_ORIGINAL_COMMAND'};
 618     $cmd =~ m{
 619         ^
 620         (?: \S* / )?
 621         ( [-0-9a-z]+ )
 622         \s+
 623         '? (?: \S* / )?
 624         ($package_re) \.git
 625         '?$
 626     }ox
 627     or reject "command string not understood";
 628     my $method = $1;
 629     $package = $2;
 630     $realdestrepo = "$dgitrepos/$package.git";
 631
 632     my $funcn = $method;
 633     $funcn =~ y/-/_/;
 634     my $mainfunc = $main::{"main__$funcn"};
 635
 636     reject "unknown method" unless $mainfunc;
 637
 638     my ($policy, $pollock) = policyhook(FRESHREPO,'check-package',$package);
 639     if ($policy & FRESHREPO) {
 640         my $garbagerepo = "$dgitrepos/_tmp/${package}_garbage";
 641         acquiretree($garbagerepo,1);
 642         rmtree $garbagerepo;
 643         rename $realdestrepo, $garbagerepo
 644             or $! == ENOENT
 645             or die "rename repo $destrepo to $garbagerepo: $!";
 646     }
 647     close $pollock or die $!;
 648
 649     if (stat $realdestrepo) {
 650         $destrepo = $realdestrepo;
 651     } else {
 652         $! == ENOENT or die "stat dest repo $destrepo: $!";
 653         debug " fixmissing $funcn";
 654         my $fixfunc = $main::{"fixmissing__$funcn"};
 655         &$fixfunc;
 656     }
 657
 658     debug " running main $funcn";
 659     &$mainfunc;
 660 }
 661
 662 sub unlockall () {
 663     while (my $fh = pop @lockfhs) { close $fh; }
 664 }
 665
 666 sub cleanup () {
 667     unlockall();
 668     if (!chdir "$dgitrepos/_tmp") {
 669         $!==ENOENT or die $!;
 670         return;
 671     }
 672     foreach my $lf (<*.lock>) {
 673         my $tree = $lf;
 674         $tree =~ s/\.lock$//;
 675         next unless acquiretree($tree, 0);
 676         remove $lf or warn $!;
 677         unlockall();
 678     }
 679 }
 680
 681 parseargsdispatch();
 682 cleanup();