selftest/target/Samba.pm

   1 #!/usr/bin/perl
   2 # Bootstrap Samba and run a number of tests against it.
   3 # Copyright (C) 2005-2007 Jelmer Vernooij <jelmer@samba.org>
   4 # Published under the GNU GPL, v3 or later.
   5
   6 package Samba;
   7
   8 use strict;
   9 use warnings;
  10 use target::Samba3;
  11 use target::Samba4;
  12 use POSIX;
  13 use Cwd qw(abs_path);
  14 use IO::Poll qw(POLLIN);
  15
  16 sub new($$$$$) {
  17         my ($classname, $bindir, $srcdir, $server_maxtime,
  18             $opt_socket_wrapper_pcap, $opt_socket_wrapper_keep_pcap) = @_;
  19
  20         my $self = {
  21             opt_socket_wrapper_pcap => $opt_socket_wrapper_pcap,
  22             opt_socket_wrapper_keep_pcap => $opt_socket_wrapper_keep_pcap,
  23         };
  24         $self->{samba3} = new Samba3($self, $bindir, $srcdir, $server_maxtime);
  25         $self->{samba4} = new Samba4($self, $bindir, $srcdir, $server_maxtime);
  26         bless $self;
  27         return $self;
  28 }
  29
  30 %Samba::ENV_DEPS = (%Samba3::ENV_DEPS, %Samba4::ENV_DEPS);
  31 our %ENV_DEPS;
  32
  33 %Samba::ENV_DEPS_POST = (%Samba3::ENV_DEPS_POST, %Samba4::ENV_DEPS_POST);
  34 our %ENV_DEPS_POST;
  35
  36 %Samba::ENV_TARGETS = (
  37         (map { $_ => "Samba3" } keys %Samba3::ENV_DEPS),
  38         (map { $_ => "Samba4" } keys %Samba4::ENV_DEPS),
  39 );
  40 our %ENV_TARGETS;
  41
  42 %Samba::ENV_NEEDS_AD_DC = (
  43         (map { $_ => 1 } keys %Samba4::ENV_DEPS)
  44 );
  45 our %ENV_NEEDS_AD_DC;
  46 foreach my $env (keys %Samba3::ENV_DEPS) {
  47     $ENV_NEEDS_AD_DC{$env} = ($env =~ /^ad_/);
  48 }
  49
  50 sub setup_pcap($$)
  51 {
  52         my ($self, $name) = @_;
  53
  54         return unless ($self->{opt_socket_wrapper_pcap});
  55         return unless defined($ENV{SOCKET_WRAPPER_PCAP_DIR});
  56
  57         my $fname = $name;
  58         $fname =~ s%[^abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\-]%_%g;
  59
  60         my $pcap_file = "$ENV{SOCKET_WRAPPER_PCAP_DIR}/$fname.pcap";
  61
  62         SocketWrapper::setup_pcap($pcap_file);
  63
  64         return $pcap_file;
  65 }
  66
  67 sub cleanup_pcap($$$)
  68 {
  69         my ($self, $pcap_file, $exitcode) = @_;
  70
  71         return unless ($self->{opt_socket_wrapper_pcap});
  72         return if ($self->{opt_socket_wrapper_keep_pcap});
  73         return unless ($exitcode == 0);
  74         return unless defined($pcap_file);
  75
  76         unlink($pcap_file);
  77 }
  78
  79 sub setup_env($$$)
  80 {
  81         my ($self, $envname, $path) = @_;
  82
  83         my $targetname = $ENV_TARGETS{$envname};
  84         if (not defined($targetname)) {
  85                 warn("Samba can't provide environment '$envname'");
  86                 return "UNKNOWN";
  87         }
  88
  89         my %targetlookup = (
  90                 "Samba3" => $self->{samba3},
  91                 "Samba4" => $self->{samba4}
  92         );
  93         my $target = $targetlookup{$targetname};
  94
  95         if (defined($target->{vars}->{$envname})) {
  96                 return $target->{vars}->{$envname};
  97         }
  98
  99         $target->{vars}->{$envname} = "";
 100
 101         my @dep_vars;
 102         foreach(@{$ENV_DEPS{$envname}}) {
 103                 my $vars = $self->setup_env($_, $path);
 104                 if (defined($vars)) {
 105                         push(@dep_vars, $vars);
 106                 } else {
 107                         warn("Failed setting up $_ as a dependency of $envname");
 108                         return undef;
 109                 }
 110         }
 111
 112         $ENV{ENVNAME} = $envname;
 113         # Avoid hitting system krb5.conf -
 114         # An env that needs Kerberos will reset this to the real value.
 115         $ENV{KRB5_CONFIG} = "$path/no_krb5.conf";
 116
 117         my $setup_name = $ENV_TARGETS{$envname}."::setup_".$envname;
 118         my $setup_sub = \&$setup_name;
 119         my $setup_pcap_file = $self->setup_pcap("env-$ENV{ENVNAME}-setup");
 120         my $env = &$setup_sub($target, "$path/$envname", @dep_vars);
 121         $self->cleanup_pcap($setup_pcap_file, not defined($env));
 122         SocketWrapper::setup_pcap(undef);
 123
 124         if (not defined($env)) {
 125                 warn("failed to start up environment '$envname'");
 126                 return undef;
 127         }
 128
 129         $target->{vars}->{$envname} = $env;
 130         $target->{vars}->{$envname}->{target} = $target;
 131
 132         foreach(@{$ENV_DEPS_POST{$envname}}) {
 133                 if (not defined $_) {
 134                         continue;
 135                 }
 136                 my $vars = $self->setup_env($_, $path);
 137                 if (not defined($vars)) {
 138                         return undef;
 139                 }
 140         }
 141
 142         return $env;
 143 }
 144
 145 sub bindir_path($$) {
 146         my ($object, $path) = @_;
 147
 148         my $valpath = "$object->{bindir}/$path";
 149         my $python_cmd = "";
 150         my $result = $path;
 151         if (defined $ENV{'PYTHON'}) {
 152                 $python_cmd = $ENV{'PYTHON'} . " ";
 153         }
 154
 155         if (-f $valpath or -d $valpath) {
 156                 $result = $valpath;
 157         }
 158         # make sure we prepend samba-tool with calling $PYTHON python version
 159         if ($path eq "samba-tool") {
 160                 $result = $python_cmd . $result;
 161         }
 162         return $result;
 163 }
 164
 165 sub nss_wrapper_winbind_so_path($) {
 166         my ($object) = @_;
 167         my $ret = $ENV{NSS_WRAPPER_WINBIND_SO_PATH};
 168         if (not defined($ret)) {
 169             $ret = bindir_path($object, "shared/libnss_wrapper_winbind.so.2");
 170             $ret = abs_path($ret);
 171         }
 172         return $ret;
 173 }
 174
 175 sub copy_file_content($$)
 176 {
 177         my ($in, $out) = @_;
 178         open(IN, "${in}") or die("failed to open in[${in}] for reading: $!");
 179         open(OUT, ">${out}") or die("failed to open out[${out}] for writing: $!");
 180         while(<IN>) {
 181                 print OUT $_;
 182         }
 183         close(OUT);
 184         close(IN);
 185 }
 186
 187 sub prepare_keyblobs($)
 188 {
 189         my ($ctx) = @_;
 190
 191         my $cadir = "$ENV{SRCDIR_ABS}/selftest/manage-ca/CA-samba.example.com";
 192         my $cacert = "$cadir/Public/CA-samba.example.com-cert.pem";
 193         my $cacrl_pem = "$cadir/Public/CA-samba.example.com-crl.pem";
 194         my $dcdnsname = "$ctx->{hostname}.$ctx->{dnsname}";
 195         my $dcdir = "$cadir/DCs/$dcdnsname";
 196         my $dccert = "$dcdir/DC-$dcdnsname-cert.pem";
 197         my $dckey_private = "$dcdir/DC-$dcdnsname-private-key.pem";
 198         my $adminprincipalname = "administrator\@$ctx->{dnsname}";
 199         my $admindir = "$cadir/Users/$adminprincipalname";
 200         my $admincert = "$admindir/USER-$adminprincipalname-cert.pem";
 201         my $adminkey_private = "$admindir/USER-$adminprincipalname-private-key.pem";
 202         my $pkinitprincipalname = "pkinit\@$ctx->{dnsname}";
 203         my $ca_pkinitdir = "$cadir/Users/$pkinitprincipalname";
 204         my $pkinitcert = "$ca_pkinitdir/USER-$pkinitprincipalname-cert.pem";
 205         my $pkinitkey_private = "$ca_pkinitdir/USER-$pkinitprincipalname-private-key.pem";
 206
 207         my $tlsdir = "$ctx->{tlsdir}";
 208         my $pkinitdir = "$ctx->{prefix_abs}/pkinit";
 209         #TLS and PKINIT crypto blobs
 210         my $dhfile = "$tlsdir/dhparms.pem";
 211         my $cafile = "$tlsdir/ca.pem";
 212         my $crlfile = "$tlsdir/crl.pem";
 213         my $certfile = "$tlsdir/cert.pem";
 214         my $keyfile = "$tlsdir/key.pem";
 215         my $admincertfile = "$pkinitdir/USER-$adminprincipalname-cert.pem";
 216         my $adminkeyfile = "$pkinitdir/USER-$adminprincipalname-private-key.pem";
 217         my $pkinitcertfile = "$pkinitdir/USER-$pkinitprincipalname-cert.pem";
 218         my $pkinitkeyfile = "$pkinitdir/USER-$pkinitprincipalname-private-key.pem";
 219
 220         mkdir($tlsdir, 0700);
 221         mkdir($pkinitdir, 0700);
 222         my $oldumask = umask;
 223         umask 0077;
 224
 225         # This is specified here to avoid draining entropy on every run
 226         # generate by
 227         # openssl dhparam -out dhparms.pem -text -2 8192
 228         open(DHFILE, ">$dhfile");
 229         print DHFILE <<EOF;
 230 -----BEGIN DH PARAMETERS-----
 231 MIIECAKCBAEAlcpjuJptCzC2bIIApLuyFLw2nODQUztqs/peysY9e3LgWh/xrc87
 232 SWJNSUrqFJFh2m357WH0XGcTdTk0b/8aIYIWjbwEhWR/5hZ+1x2TDrX1awkYayAe
 233 pr0arycmWHaAmhw+m+dBdj2O2jRMe7gn0ha85JALNl+Z3wv2q2eys8TIiQ2dbHPx
 234 XvpMmlAv7QHZnpSpX/XgueQr6T3EYggljppZwk1fe4W2cxBjCv9w/Q83pJXMEVVB
 235 WESEQPZC38v6hVIXIlF4J7jXjV3+NtCLL4nvsy0jrLEntyKz5OB8sNPRzJr0Ju2Y
 236 yXORCSMMXMygP+dxJtQ6txzQYWyaCYN1HqHDZy3cFL9Qy8kTFqIcW56Lti2GsW/p
 237 jSMzEOa1NevhKNFL3dSZJx5m+5ZeMvWXlCqXSptmVdbs5wz5jkMUm/E6pVfM5lyb
 238 Ttlcq2iYPqnJz1jcL5xwhoufID8zSJCPJ7C0jb0Ngy5wLIUZfjXJUXxUyxTnNR9i
 239 N9Sc+UkDvLxnCW+qzjyPXGlQU1SsJwMLWa2ZecL/uYE4bOdcN3g+5WHkevyDnXqR
 240 +yy9x7sGXjBT3bRWK5tVHJWOi6eBu1hp39U6aK8oOJWiUt3vmC2qEdIsT6JaLNNi
 241 YKrSfRGBf19IJBaagen1S19bb3dnmwoU1RaWM0EeJQW1oXOBg7zLisB2yuu5azBn
 242 tse00+0nc+GbH2y+jP0sE7xil1QeilZl+aQ3tX9vL0cnCa+8602kXxU7P5HaX2+d
 243 05pvoHmeZbDV85io36oF976gBYeYN+qAkTUMsIZhuLQDuyn0963XOLyn1Pm6SBrU
 244 OkIZXW7WoKEuO/YSfizUIqXwmAMJjnEMJCWG51MZZKx//9Hsdp1RXSm/bRSbvXB7
 245 MscjvQYWmfCFnIk8LYnEt3Yey40srEiS9xyZqdrvobxz+sU1XcqR38kpVf4gKASL
 246 xURia64s4emuJF+YHIObyydazQ+6/wX/C+m+nyfhuxSO6j1janPwtYbU+Uj3TzeM
 247 04K1mpPQpZcaMdZZiNiu7i8VJlOPKAz7aJT8TnMMF5GMyzyLpSMpc+NF9L/BSocV
 248 /cUM4wQT2PTHrcyYzmTVH7c9bzBkuxqrwVB1BY1jitDV9LIYIVBglKcX88qrfHIM
 249 XiXPAIwGclD59qm2cG8OdM9NA5pNMI119KuUAIJsUdgPbR1LkT2XTT15YVoHmFSQ
 250 DlaWOXn4td031jr0EisX8QtFR7+/0Nfoni6ydFGs5fNH/L1ckq6FEO4OhgucJw9H
 251 YRmiFlsQBQNny78vNchwZne3ZixkShtGW0hWDdi2n+h7St1peNJCNJjMbEhRsPRx
 252 RmNGWh4AL8rho4RO9OBao0MnUdjbbffD+wIBAg==
 253 -----END DH PARAMETERS-----
 254 EOF
 255         close(DHFILE);
 256
 257         if (! -e ${dckey_private}) {
 258                 umask $oldumask;
 259                 return;
 260         }
 261
 262         copy_file_content(${cacert}, ${cafile});
 263         copy_file_content(${cacrl_pem}, ${crlfile});
 264         copy_file_content(${dccert}, ${certfile});
 265         copy_file_content(${dckey_private}, ${keyfile});
 266         if (-e ${adminkey_private}) {
 267                 copy_file_content(${admincert}, ${admincertfile});
 268                 copy_file_content(${adminkey_private}, ${adminkeyfile});
 269         }
 270         if (-e ${pkinitkey_private}) {
 271                 copy_file_content(${pkinitcert}, ${pkinitcertfile});
 272                 copy_file_content(${pkinitkey_private}, ${pkinitkeyfile});
 273         }
 274
 275         # COMPAT stuff to be removed in a later commit
 276         my $kdccertfile = "$tlsdir/kdc.pem";
 277         copy_file_content(${dccert}, ${kdccertfile});
 278
 279         umask $oldumask;
 280 }
 281
 282 sub mk_krb5_conf($$)
 283 {
 284         my ($ctx) = @_;
 285
 286         unless (open(KRB5CONF, ">$ctx->{krb5_conf}")) {
 287                 warn("can't open $ctx->{krb5_conf}$?");
 288                 return undef;
 289         }
 290
 291         my $our_realms_stanza = mk_realms_stanza($ctx->{realm},
 292                                                  $ctx->{dnsname},
 293                                                  $ctx->{domain},
 294                                                  $ctx->{kdc_ipv4});
 295         print KRB5CONF "
 296 #Generated krb5.conf for $ctx->{realm}
 297
 298 [libdefaults]
 299  default_realm = $ctx->{realm}
 300  dns_lookup_realm = false
 301  dns_lookup_kdc = true
 302  ticket_lifetime = 24h
 303  forwardable = yes
 304
 305  # We are running on the same machine, do not correct
 306  # system clock differences
 307  kdc_timesync = 0
 308
 309 ";
 310
 311         if (defined($ENV{MITKRB5})) {
 312                 print KRB5CONF "
 313  # Set the grace clocskew to 5 seconds
 314  # This is especially required by samba3.raw.session krb5 and
 315  # reauth tests when not using Heimdal
 316  clockskew = 5
 317     ";
 318         }
 319
 320         if (defined($ctx->{krb5_ccname})) {
 321                 print KRB5CONF "
 322  default_ccache_name = $ctx->{krb5_ccname}
 323 ";
 324         }
 325
 326
 327         if (defined($ctx->{supported_enctypes})) {
 328                 print KRB5CONF "
 329  default_etypes = $ctx->{supported_enctypes}
 330  default_as_etypes = $ctx->{supported_enctypes}
 331  default_tgs_enctypes = $ctx->{supported_enctypes}
 332  default_tkt_enctypes = $ctx->{supported_enctypes}
 333  permitted_enctypes = $ctx->{supported_enctypes}
 334 ";
 335         }
 336
 337         print KRB5CONF "
 338 [realms]
 339  $our_realms_stanza
 340 ";
 341
 342
 343         if (defined($ctx->{tlsdir})) {
 344                print KRB5CONF "
 345
 346 [appdefaults]
 347         pkinit_anchors = FILE:$ctx->{tlsdir}/ca.pem
 348
 349 [kdc]
 350         enable-pkinit = true
 351         pkinit_identity = FILE:$ctx->{tlsdir}/kdc.pem,$ctx->{tlsdir}/key.pem
 352         pkinit_anchors = FILE:$ctx->{tlsdir}/ca.pem
 353
 354 ";
 355         }
 356         close(KRB5CONF);
 357 }
 358
 359 sub mk_realms_stanza($$$$)
 360 {
 361         my ($realm, $dnsname, $domain, $kdc_ipv4) = @_;
 362         my $lc_domain = lc($domain);
 363
 364         my $realms_stanza = "
 365  $realm = {
 366   kdc = $kdc_ipv4:88
 367   admin_server = $kdc_ipv4:88
 368   default_domain = $dnsname
 369  }
 370  $dnsname = {
 371   kdc = $kdc_ipv4:88
 372   admin_server = $kdc_ipv4:88
 373   default_domain = $dnsname
 374  }
 375  $domain = {
 376   kdc = $kdc_ipv4:88
 377   admin_server = $kdc_ipv4:88
 378   default_domain = $dnsname
 379  }
 380  $lc_domain = {
 381   kdc = $kdc_ipv4:88
 382   admin_server = $kdc_ipv4:88
 383   default_domain = $dnsname
 384  }
 385
 386 ";
 387         return $realms_stanza;
 388 }
 389
 390 sub mk_mitkdc_conf($$)
 391 {
 392         # samba_kdb_dir is the path to mit_samba.so
 393         my ($ctx, $samba_kdb_dir) = @_;
 394
 395         unless (open(KDCCONF, ">$ctx->{mitkdc_conf}")) {
 396                 warn("can't open $ctx->{mitkdc_conf}$?");
 397                 return undef;
 398         }
 399
 400         print KDCCONF "
 401 # Generated kdc.conf for $ctx->{realm}
 402
 403 [kdcdefaults]
 404         kdc_ports = 88
 405         kdc_tcp_ports = 88
 406
 407 [realms]
 408         $ctx->{realm} = {
 409         }
 410
 411         $ctx->{dnsname} = {
 412         }
 413
 414         $ctx->{domain} = {
 415         }
 416
 417 [dbmodules]
 418         db_module_dir = $samba_kdb_dir
 419
 420         $ctx->{realm} = {
 421                 db_library = samba
 422         }
 423
 424         $ctx->{dnsname} = {
 425                 db_library = samba
 426         }
 427
 428         $ctx->{domain} = {
 429                 db_library = samba
 430         }
 431
 432 [logging]
 433         kdc = FILE:$ctx->{logdir}/mit_kdc.log
 434 ";
 435
 436         close(KDCCONF);
 437 }
 438
 439 sub realm_to_ip_mappings
 440 {
 441         # this maps the DNS realms for the various testenvs to the corresponding
 442         # PDC (i.e. the first DC created for that realm).
 443         my %realm_to_pdc_mapping = (
 444                 'adnonssdom.samba.example.com'    => 'addc_no_nss',
 445                 'adnontlmdom.samba.example.com'   => 'addc_no_ntlm',
 446                 'samba2000.example.com'           => 'dc5',
 447                 'samba2003.example.com'           => 'dc6',
 448                 'samba2008r2.example.com'         => 'dc7',
 449                 'addom.samba.example.com'         => 'addc',
 450                 'sub.samba.example.com'           => 'localsubdc',
 451                 'chgdcpassword.samba.example.com' => 'chgdcpass',
 452                 'backupdom.samba.example.com'     => 'backupfromdc',
 453                 'renamedom.samba.example.com'     => 'renamedc',
 454                 'labdom.samba.example.com'        => 'labdc',
 455                 'schema.samba.example.com'        => 'liveupgrade1dc',
 456                 'prockilldom.samba.example.com'   => 'prockilldc',
 457                 'proclimit.samba.example.com'     => 'proclimitdc',
 458                 'samba.example.com'               => 'localdc',
 459         );
 460
 461         my @mapping = ();
 462
 463         # convert the hashmap to a list of key=value strings, where key is the
 464         # realm and value is the IP address
 465         while (my ($realm, $pdc) = each(%realm_to_pdc_mapping)) {
 466                 my $ipaddr = get_ipv4_addr($pdc);
 467                 push(@mapping, "$realm=$ipaddr");
 468         }
 469         # return the mapping as a single comma-separated string
 470         return join(',', @mapping);
 471 }
 472
 473 sub get_interface($)
 474 {
 475         my ($netbiosname) = @_;
 476         $netbiosname = lc($netbiosname);
 477
 478         # this maps the SOCKET_WRAPPER_DEFAULT_IFACE value for each possible
 479         # testenv to the DC's NETBIOS name. This value also corresponds to last
 480         # digit of the DC's IP address. Note that the NETBIOS name may differ from
 481         # the testenv name.
 482         # Note that when adding a DC with a new realm, also update
 483         # get_realm_ip_mappings() above.
 484         my %testenv_iface_mapping = (
 485                 localnt4dc2       => 3,
 486                 localnt4member3   => 4,
 487                 localshare4       => 5,
 488                 # 6 is spare
 489                 localktest6       => 7,
 490                 maptoguest        => 8,
 491                 localnt4dc9       => 9,
 492                 # 10 is spare
 493
 494                 # 11-16 are used by selftest.pl for the client.conf. Most tests only
 495                 # use the first .11 IP. However, some tests (like winsreplication) rely
 496                 # on the client having multiple IPs.
 497                 client            => 11,
 498
 499                 addc_no_nss       => 17,
 500                 addc_no_ntlm      => 18,
 501                 idmapadmember     => 19,
 502                 idmapridmember    => 20,
 503                 localdc           => 21,
 504                 localvampiredc    => 22,
 505                 s4member          => 23,
 506                 localrpcproxy     => 24,
 507                 dc5               => 25,
 508                 dc6               => 26,
 509                 dc7               => 27,
 510                 rodc              => 28,
 511                 localadmember     => 29,
 512                 addc              => 30,
 513                 localsubdc        => 31,
 514                 chgdcpass         => 32,
 515                 promotedvdc       => 33,
 516                 rfc2307member     => 34,
 517                 fileserver        => 35,
 518                 fakednsforwarder1 => 36,
 519                 fakednsforwarder2 => 37,
 520                 s4member_dflt     => 38,
 521                 vampire2000dc     => 39,
 522                 backupfromdc      => 40,
 523                 restoredc         => 41,
 524                 renamedc          => 42,
 525                 labdc             => 43,
 526                 offlinebackupdc   => 44,
 527                 customdc          => 45,
 528                 prockilldc        => 46,
 529                 proclimitdc       => 47,
 530                 liveupgrade1dc    => 48,
 531                 liveupgrade2dc    => 49,
 532                 ctdb0             => 50,
 533                 ctdb1             => 51,
 534                 ctdb2             => 52,
 535
 536                 rootdnsforwarder  => 64,
 537
 538                 # Note: that you also need to update dns_hub.py when adding a new
 539                 # multi-DC testenv
 540                 # update lib/socket_wrapper/socket_wrapper.c
 541                 #  #define MAX_WRAPPED_INTERFACES 64
 542                 # if you wish to have more than 64 interfaces
 543         );
 544
 545         if (not defined($testenv_iface_mapping{$netbiosname})) {
 546                 die();
 547         }
 548
 549         return $testenv_iface_mapping{$netbiosname};
 550 }
 551
 552 sub get_ipv4_addr
 553 {
 554         my ($hostname, $iface_num) = @_;
 555         my $swiface = Samba::get_interface($hostname);
 556
 557         # Handle testenvs with multiple different addresses, i.e. IP multihoming.
 558         # Currently only the selftest client has multiple IPv4 addresses.
 559         if (defined($iface_num)) {
 560                 $swiface += $iface_num;
 561         }
 562
 563         if (use_namespaces()) {
 564                 # use real IPs if selftest is running in its own network namespace
 565                 return "10.0.0.$swiface";
 566         } else {
 567                 # use loopback IPs with socket-wrapper
 568                 return "127.0.0.$swiface";
 569         }
 570 }
 571
 572 sub get_ipv6_addr
 573 {
 574         (my $hostname) = @_;
 575         my $swiface = Samba::get_interface($hostname);
 576
 577         return sprintf("fd00:0000:0000:0000:0000:0000:5357:5f%02x", $swiface);
 578 }
 579
 580 # returns the 'interfaces' setting for smb.conf, i.e. the IPv4/IPv6
 581 # addresses for testenv
 582 sub get_interfaces_config
 583 {
 584         my ($hostname, $num_ips) = @_;
 585         my $interfaces = "";
 586
 587         # We give the client.conf multiple different IPv4 addresses.
 588         # All other testenvs generally just have one IPv4 address.
 589         if (! defined($num_ips)) {
 590                 $num_ips = 1;
 591         }
 592         for (my $i = 0; $i < $num_ips; $i++) {
 593                 my $ipv4_addr = Samba::get_ipv4_addr($hostname, $i);
 594                 if (use_namespaces()) {
 595                         # use a /24 subnet with network namespaces
 596                         $interfaces .= "$ipv4_addr/24 ";
 597                 } else {
 598                         $interfaces .= "$ipv4_addr/8 ";
 599                 }
 600         }
 601
 602         my $ipv6_addr = Samba::get_ipv6_addr($hostname);
 603         $interfaces .= "$ipv6_addr/64";
 604
 605         return $interfaces;
 606 }
 607
 608 sub cleanup_child($$)
 609 {
 610     my ($pid, $name) = @_;
 611
 612     if (!defined($pid)) {
 613         print STDERR "cleanup_child: pid not defined ... not calling waitpid\n";
 614         return -1;
 615     }
 616
 617     my $childpid = waitpid($pid, WNOHANG);
 618
 619     if ($childpid == 0) {
 620     } elsif ($childpid < 0) {
 621         printf STDERR "%s child process %d isn't here any more\n", $name, $pid;
 622         return $childpid;
 623     } elsif ($? & 127) {
 624         printf STDERR "%s child process %d, died with signal %d, %s coredump\n",
 625                 $name, $childpid, ($? & 127),  ($? & 128) ? 'with' : 'without';
 626     } else {
 627         printf STDERR "%s child process %d exited with value %d\n", $name, $childpid, $? >> 8;
 628     }
 629     return $childpid;
 630 }
 631
 632 sub random_domain_sid()
 633 {
 634         my $domain_sid = "S-1-5-21-". int(rand(4294967295)) . "-" . int(rand(4294967295)) . "-" . int(rand(4294967295));
 635         return $domain_sid;
 636 }
 637
 638 # sets the environment variables ready for running a given process
 639 sub set_env_for_process
 640 {
 641         my ($proc_name, $env_vars, $proc_envs) = @_;
 642
 643         if (not defined($proc_envs)) {
 644                 $proc_envs = get_env_for_process($proc_name, $env_vars);
 645         }
 646
 647         foreach my $key (keys %{ $proc_envs }) {
 648                 $ENV{$key} = $proc_envs->{$key};
 649         }
 650 }
 651
 652 sub get_env_for_process
 653 {
 654         my ($proc_name, $env_vars) = @_;
 655         my $proc_envs = {
 656                 KRB5_CONFIG => $env_vars->{KRB5_CONFIG},
 657                 KRB5CCNAME => "$env_vars->{KRB5_CCACHE}.$proc_name",
 658                 SELFTEST_WINBINDD_SOCKET_DIR => $env_vars->{SELFTEST_WINBINDD_SOCKET_DIR},
 659                 NMBD_SOCKET_DIR => $env_vars->{NMBD_SOCKET_DIR},
 660                 NSS_WRAPPER_PASSWD => $env_vars->{NSS_WRAPPER_PASSWD},
 661                 NSS_WRAPPER_GROUP => $env_vars->{NSS_WRAPPER_GROUP},
 662                 NSS_WRAPPER_HOSTS => $env_vars->{NSS_WRAPPER_HOSTS},
 663                 NSS_WRAPPER_HOSTNAME => $env_vars->{NSS_WRAPPER_HOSTNAME},
 664                 NSS_WRAPPER_MODULE_SO_PATH => $env_vars->{NSS_WRAPPER_MODULE_SO_PATH},
 665                 NSS_WRAPPER_MODULE_FN_PREFIX => $env_vars->{NSS_WRAPPER_MODULE_FN_PREFIX},
 666                 UID_WRAPPER_ROOT => "1",
 667                 ENVNAME => "$ENV{ENVNAME}.$proc_name",
 668         };
 669
 670         if (defined($env_vars->{RESOLV_WRAPPER_CONF})) {
 671                 $proc_envs->{RESOLV_WRAPPER_CONF} = $env_vars->{RESOLV_WRAPPER_CONF};
 672         } else {
 673                 $proc_envs->{RESOLV_WRAPPER_HOSTS} = $env_vars->{RESOLV_WRAPPER_HOSTS};
 674         }
 675         return $proc_envs;
 676 }
 677
 678 sub fork_and_exec
 679 {
 680         my ($self, $env_vars, $daemon_ctx, $STDIN_READER, $child_cleanup) = @_;
 681         my $SambaCtx = $self;
 682         $SambaCtx = $self->{SambaCtx} if defined($self->{SambaCtx});
 683
 684         # we close the child's write-end of the pipe and redirect the
 685         # read-end to its stdin. That way the daemon will receive an
 686         # EOF on stdin when parent selftest process closes its
 687         # write-end.
 688         $child_cleanup //= sub { close($env_vars->{STDIN_PIPE}) };
 689
 690         unlink($daemon_ctx->{LOG_FILE});
 691         print "STARTING $daemon_ctx->{NAME} for $ENV{ENVNAME}...";
 692
 693         my $parent_pid = $$;
 694         my $pid = fork();
 695
 696         # exec the daemon in the child process
 697         if ($pid == 0) {
 698                 my @preargs = ();
 699
 700                 # redirect the daemon's stdout/stderr to a log file
 701                 if (defined($daemon_ctx->{TEE_STDOUT})) {
 702                         # in some cases, we want out from samba to go to the log file,
 703                         # but also to the users terminal when running 'make test' on the
 704                         # command line. This puts it on stderr on the terminal
 705                         open STDOUT, "| tee $daemon_ctx->{LOG_FILE} 1>&2";
 706                 } else {
 707                         open STDOUT, ">$daemon_ctx->{LOG_FILE}";
 708                 }
 709                 open STDERR, '>&STDOUT';
 710
 711                 SocketWrapper::set_default_iface($env_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
 712                 if (defined($daemon_ctx->{PCAP_FILE})) {
 713                         $SambaCtx->setup_pcap("$daemon_ctx->{PCAP_FILE}");
 714                 }
 715
 716                 # setup ENV variables in the child process
 717                 set_env_for_process($daemon_ctx->{NAME}, $env_vars,
 718                                     $daemon_ctx->{ENV_VARS});
 719
 720                 $child_cleanup->();
 721
 722                 # not all s3 daemons run in all testenvs (e.g. fileserver doesn't
 723                 # run winbindd). In which case, the child process just sleeps
 724                 if (defined($daemon_ctx->{SKIP_DAEMON})) {
 725                         $SIG{USR1} = $SIG{ALRM} = $SIG{INT} = $SIG{QUIT} = $SIG{TERM} = sub {
 726                                 my $signame = shift;
 727                                 print("Skip $daemon_ctx->{NAME} received signal $signame");
 728                                 exit 0;
 729                         };
 730                         my $poll = IO::Poll->new();
 731                         $poll->mask($STDIN_READER, POLLIN);
 732                         $poll->poll($self->{server_maxtime});
 733                         exit 0;
 734                 }
 735
 736                 $ENV{MAKE_TEST_BINARY} = $daemon_ctx->{BINARY_PATH};
 737
 738                 open STDIN, ">&", $STDIN_READER or die "can't dup STDIN_READER to STDIN: $!";
 739
 740                 # if using kernel namespaces, prepend the command so the process runs in
 741                 # its own namespace
 742                 if (Samba::use_namespaces()) {
 743                         @preargs = ns_exec_preargs($parent_pid, $env_vars);
 744                 }
 745
 746                 # the command args are stored as an array reference (because...Perl),
 747                 # so convert the reference back to an array
 748                 my @full_cmd = @{ $daemon_ctx->{FULL_CMD} };
 749
 750                 exec(@preargs, @full_cmd) or die("Unable to start $ENV{MAKE_TEST_BINARY}: $!");
 751         }
 752
 753         print "DONE ($pid)\n";
 754
 755         # if using kernel namespaces, we now establish a connection between the
 756         # main selftest namespace (i.e. this process) and the new child namespace
 757         if (use_namespaces()) {
 758                 ns_child_forked($pid, $env_vars);
 759         }
 760
 761         return $pid;
 762 }
 763
 764 my @exported_envvars = (
 765         # domain stuff
 766         "DOMAIN",
 767         "DNSNAME",
 768         "REALM",
 769         "DOMSID",
 770
 771         # stuff related to a trusted domain
 772         "TRUST_SERVER",
 773         "TRUST_USERNAME",
 774         "TRUST_PASSWORD",
 775         "TRUST_DOMAIN",
 776         "TRUST_REALM",
 777         "TRUST_DOMSID",
 778
 779         # stuff related to a trusted domain, on a trust_member
 780         # the domain behind a forest trust (two-way)
 781         "TRUST_F_BOTH_SERVER",
 782         "TRUST_F_BOTH_SERVER_IP",
 783         "TRUST_F_BOTH_SERVER_IPV6",
 784         "TRUST_F_BOTH_NETBIOSNAME",
 785         "TRUST_F_BOTH_USERNAME",
 786         "TRUST_F_BOTH_PASSWORD",
 787         "TRUST_F_BOTH_DOMAIN",
 788         "TRUST_F_BOTH_REALM",
 789
 790         # stuff related to a trusted domain, on a trust_member
 791         # the domain behind an external trust (two-way)
 792         "TRUST_E_BOTH_SERVER",
 793         "TRUST_E_BOTH_SERVER_IP",
 794         "TRUST_E_BOTH_SERVER_IPV6",
 795         "TRUST_E_BOTH_NETBIOSNAME",
 796         "TRUST_E_BOTH_USERNAME",
 797         "TRUST_E_BOTH_PASSWORD",
 798         "TRUST_E_BOTH_DOMAIN",
 799         "TRUST_E_BOTH_REALM",
 800
 801         # domain controller stuff
 802         "DC_SERVER",
 803         "DC_SERVER_IP",
 804         "DC_SERVER_IPV6",
 805         "DC_NETBIOSNAME",
 806         "DC_NETBIOSALIAS",
 807
 808         # server stuff
 809         "SERVER",
 810         "SERVER_IP",
 811         "SERVER_IPV6",
 812         "NETBIOSNAME",
 813         "NETBIOSALIAS",
 814         "SAMSID",
 815
 816         # only use these 2 as a last resort. Some tests need to test both client-
 817         # side and server-side. In this case, run as default client, ans access
 818         # server's smb.conf as needed, typically using:
 819         #  param.LoadParm(filename_for_non_global_lp=os.environ['SERVERCONFFILE'])
 820         "SERVERCONFFILE",
 821         "DC_SERVERCONFFILE",
 822
 823         # user stuff
 824         "USERNAME",
 825         "USERID",
 826         "PASSWORD",
 827         "DC_USERNAME",
 828         "DC_PASSWORD",
 829
 830         # UID/GID for rfc2307 mapping tests
 831         "UID_RFC2307TEST",
 832         "GID_RFC2307TEST",
 833
 834         # misc stuff
 835         "KRB5_CONFIG",
 836         "KRB5CCNAME",
 837         "SELFTEST_WINBINDD_SOCKET_DIR",
 838         "NMBD_SOCKET_DIR",
 839         "LOCAL_PATH",
 840         "DNS_FORWARDER1",
 841         "DNS_FORWARDER2",
 842         "RESOLV_CONF",
 843         "UNACCEPTABLE_PASSWORD",
 844         "LOCK_DIR",
 845         "SMBD_TEST_LOG",
 846
 847         # nss_wrapper
 848         "NSS_WRAPPER_PASSWD",
 849         "NSS_WRAPPER_GROUP",
 850         "NSS_WRAPPER_HOSTS",
 851         "NSS_WRAPPER_HOSTNAME",
 852         "NSS_WRAPPER_MODULE_SO_PATH",
 853         "NSS_WRAPPER_MODULE_FN_PREFIX",
 854
 855         # resolv_wrapper
 856         "RESOLV_WRAPPER_CONF",
 857         "RESOLV_WRAPPER_HOSTS",
 858 );
 859
 860 sub exported_envvars_str
 861 {
 862         my ($testenv_vars) = @_;
 863         my $out = "";
 864
 865         foreach (@exported_envvars) {
 866                 next unless defined($testenv_vars->{$_});
 867                 $out .= $_."=".$testenv_vars->{$_}."\n";
 868         }
 869
 870         return $out;
 871 }
 872
 873 sub clear_exported_envvars
 874 {
 875         foreach (@exported_envvars) {
 876                 delete $ENV{$_};
 877         }
 878 }
 879
 880 sub export_envvars
 881 {
 882         my ($testenv_vars) = @_;
 883
 884         foreach (@exported_envvars) {
 885                 if (defined($testenv_vars->{$_})) {
 886                         $ENV{$_} = $testenv_vars->{$_};
 887                 } else {
 888                         delete $ENV{$_};
 889                 }
 890         }
 891 }
 892
 893 sub export_envvars_to_file
 894 {
 895         my ($filepath, $testenv_vars) = @_;
 896         my $env_str = exported_envvars_str($testenv_vars);
 897
 898         open(FILE, "> $filepath");
 899         print FILE "$env_str";
 900         close(FILE);
 901 }
 902
 903 # Returns true if kernel namespaces are being used instead of socket-wrapper.
 904 # The default is false.
 905 sub use_namespaces
 906 {
 907         return defined($ENV{USE_NAMESPACES});
 908 }
 909
 910 # returns a given testenv's interface-name (only when USE_NAMESPACES=1)
 911 sub ns_interface_name
 912 {
 913         my ($hostname) = @_;
 914
 915         # when using namespaces, each testenv has its own vethX interface,
 916         # where X = Samba::get_interface(testenv_name)
 917         my $iface = get_interface($hostname);
 918         return "veth$iface";
 919 }
 920
 921 # Called after a new child namespace has been forked
 922 sub ns_child_forked
 923 {
 924         my ($child_pid, $env_vars) = @_;
 925
 926         # we only need to do this for the first child forked for this testenv
 927         if (defined($env_vars->{NS_PID})) {
 928                 return;
 929         }
 930
 931         # store the child PID. It's the only way the main (selftest) namespace can
 932         # access the new child (testenv) namespace.
 933         $env_vars->{NS_PID} = $child_pid;
 934
 935         # Add the new child namespace's interface to the main selftest bridge.
 936         # This connects together the various testenvs so that selftest can talk to
 937         # them all
 938         my $iface = ns_interface_name($env_vars->{NETBIOSNAME});
 939         system "$ENV{SRCDIR}/selftest/ns/add_bridge_iface.sh $iface-br selftest0";
 940 }
 941
 942 # returns args to prepend to a command in order to execute it the correct
 943 # namespace for the testenv (creating a new namespace if needed).
 944 # This should only used when USE_NAMESPACES=1 is set.
 945 sub ns_exec_preargs
 946 {
 947         my ($parent_pid, $env_vars) = @_;
 948
 949         # NS_PID stores the pid of the first child daemon run in this namespace
 950         if (defined($env_vars->{NS_PID})) {
 951
 952                 # the namespace has already been created previously. So we use nsenter
 953                 # to execute the command in the given testenv's namespace. We need to
 954                 # use the NS_PID to identify this particular namespace
 955                 return ("nsenter", "-t", "$env_vars->{NS_PID}", "--net");
 956         } else {
 957
 958                 # We need to create a new namespace for this daemon (i.e. we're
 959                 # setting up a new testenv). First, write the environment variables to
 960                 # an exports.sh file for this testenv (for convenient access by the
 961                 # namespace scripts).
 962                 my $exports_file = "$env_vars->{TESTENV_DIR}/exports.sh";
 963                 export_envvars_to_file($exports_file, $env_vars);
 964
 965                 # when using namespaces, each testenv has its own veth interface
 966                 my $interface = ns_interface_name($env_vars->{NETBIOSNAME});
 967
 968                 # we use unshare to create a new network namespace. The start_in_ns.sh
 969                 # helper script gets run first to setup the new namespace's interfaces.
 970                 # (This all gets prepended around the actual command to run in the new
 971                 # namespace)
 972                 return ("unshare", "--net", "$ENV{SRCDIR}/selftest/ns/start_in_ns.sh",
 973                                 $interface, $exports_file, $parent_pid);
 974         }
 975 }
 976
 977
 978 sub check_env {
 979         my ($self, $envvars) = @_;
 980         return 1;
 981 }
 982
 983 sub teardown_env {
 984         my ($self, $env) = @_;
 985         return 1;
 986 }
 987
 988
 989 sub getlog_env {
 990         return '';
 991 }
 992
 993 1;