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.
6 # NOTE: Refer to the README for more details about the various testenvs,
7 # and tips about adding new testenvs.
13 use FindBin qw($RealBin);
19 use File::Path 'make_path';
22 my ($classname, $bindir, $srcdir, $server_maxtime) = @_;
28 server_maxtime => $server_maxtime,
29 target3 => new Samba3($bindir, $srcdir, $server_maxtime)
35 sub scriptdir_path($$) {
36 my ($self, $path) = @_;
37 return "$self->{srcdir}/source4/scripting/$path";
40 sub check_or_start($$$)
42 my ($self, $env_vars, $process_model) = @_;
45 my $env_ok = $self->check_env($env_vars);
47 return $env_vars->{SAMBA_PID};
48 } elsif (defined($env_vars->{SAMBA_PID})) {
49 warn("SAMBA PID $env_vars->{SAMBA_PID} is not running (died)");
53 # use a pipe for stdin in the child processes. This allows
54 # those processes to monitor the pipe for EOF to ensure they
55 # exit when the test script exits
56 pipe($STDIN_READER, $env_vars->{STDIN_PIPE});
58 # build up the command to run samba
61 if (defined($ENV{SAMBA_OPTIONS})) {
62 @optargs = split(/ /, $ENV{SAMBA_OPTIONS});
64 if(defined($ENV{SAMBA_VALGRIND})) {
65 @preargs = split(/ /,$ENV{SAMBA_VALGRIND});
68 if (defined($process_model)) {
69 push @optargs, ("-M", $process_model);
71 my $binary = Samba::bindir_path($self, "samba");
72 my @full_cmd = (@preargs, $binary, "-i",
73 "--no-process-group", "--maximum-runtime=$self->{server_maxtime}",
74 $env_vars->{CONFIGURATION}, @optargs);
76 # the samba process takes some additional env variables (compared to s3)
77 my $samba_envs = Samba::get_env_for_process("samba", $env_vars);
78 $samba_envs->{RESOLV_CONF} = $env_vars->{RESOLV_CONF};
79 $samba_envs->{UID_WRAPPER} = "1";
80 if (defined($ENV{MITKRB5})) {
81 $samba_envs->{KRB5_KDC_PROFILE} = $env_vars->{MITKDC_CONFIG};
84 # fork a child process and exec() samba
87 BINARY_PATH => $binary,
88 FULL_CMD => [ @full_cmd ],
89 LOG_FILE => $env_vars->{SAMBA_TEST_LOG},
91 ENV_VARS => $samba_envs,
93 my $pid = Samba::fork_and_exec($self, $env_vars, $daemon_ctx, $STDIN_READER);
95 $env_vars->{SAMBA_PID} = $pid;
97 # close the parent's read-end of the pipe
100 if ($self->wait_for_start($env_vars) != 0) {
101 warn("Samba $pid failed to start up");
108 sub wait_for_start($$)
110 my ($self, $testenv_vars) = @_;
114 if (not $self->check_env($testenv_vars)) {
115 warn("unable to confirm Samba $testenv_vars->{SAMBA_PID} is running");
119 # This will return quickly when things are up, but be slow if we
120 # need to wait for (eg) SSL init
121 my $nmblookup = Samba::bindir_path($self, "nmblookup4");
124 $ret = system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{SERVER}");
128 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{SERVER}");
129 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSNAME}");
130 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSNAME}");
131 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSNAME}");
132 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSNAME}");
133 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{SERVER}");
134 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{SERVER}");
135 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSNAME}");
136 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSNAME}");
137 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSNAME}");
138 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSNAME}");
141 } while ($ret != 0 && $count < 20);
143 teardown_env($self, $testenv_vars);
144 warn("nbt not reachable after 20 retries\n");
148 # Ensure we have the first RID Set before we start tests. This makes the tests more reliable.
149 if ($testenv_vars->{SERVER_ROLE} eq "domain controller") {
150 print "waiting for working LDAP and a RID Set to be allocated\n";
151 my $ldbsearch = Samba::bindir_path($self, "ldbsearch");
153 my $base_dn = "DC=".join(",DC=", split(/\./, $testenv_vars->{REALM}));
155 my $search_dn = $base_dn;
156 if ($testenv_vars->{NETBIOSNAME} ne "RODC") {
157 # TODO currently no check for actual rIDAllocationPool
158 $search_dn = "cn=RID Set,cn=$testenv_vars->{NETBIOSNAME},ou=domain controllers,$base_dn";
162 # Add hosts file for name lookups
163 my $cmd = "NSS_WRAPPER_HOSTS='$testenv_vars->{NSS_WRAPPER_HOSTS}' ";
164 if (defined($testenv_vars->{RESOLV_WRAPPER_CONF})) {
165 $cmd .= "RESOLV_WRAPPER_CONF='$testenv_vars->{RESOLV_WRAPPER_CONF}' ";
167 $cmd .= "RESOLV_WRAPPER_HOSTS='$testenv_vars->{RESOLV_WRAPPER_HOSTS}' ";
169 $cmd .= "RESOLV_CONF='$testenv_vars->{RESOLV_CONF}' ";
171 $cmd .= "$ldbsearch ";
172 $cmd .= "$testenv_vars->{CONFIGURATION} ";
173 $cmd .= "-H ldap://$testenv_vars->{SERVER} ";
174 $cmd .= "-U$testenv_vars->{USERNAME}%$testenv_vars->{PASSWORD} ";
176 $cmd .= "-b '$search_dn' ";
177 while (system("$cmd >/dev/null") != 0) {
179 if ($count > $max_wait) {
180 teardown_env($self, $testenv_vars);
181 warn("Timed out ($max_wait sec) waiting for working LDAP and a RID Set to be allocated by $testenv_vars->{NETBIOSNAME} PID $testenv_vars->{SAMBA_PID}");
184 print "Waiting for working LDAP...\n";
189 my $wbinfo = Samba::bindir_path($self, "wbinfo");
193 my $cmd = "NSS_WRAPPER_PASSWD=$testenv_vars->{NSS_WRAPPER_PASSWD} ";
194 $cmd .= "NSS_WRAPPER_GROUP=$testenv_vars->{NSS_WRAPPER_GROUP} ";
195 $cmd .= "SELFTEST_WINBINDD_SOCKET_DIR=$testenv_vars->{SELFTEST_WINBINDD_SOCKET_DIR} ";
196 $cmd .= "$wbinfo -P";
203 } while ($ret != 0 && $count < 20);
205 teardown_env($self, $testenv_vars);
206 warn("winbind not reachable after 20 retries\n");
210 # Ensure we registered all our names
211 if ($testenv_vars->{SERVER_ROLE} eq "domain controller") {
213 print "Waiting for dns_update_cache to be created.\n";
215 while (not -e "$testenv_vars->{PRIVATEDIR}/dns_update_cache") {
217 if ($count > $max_wait) {
218 teardown_env($self, $testenv_vars);
219 warn("Timed out ($max_wait sec) waiting for dns_update_cache PID $testenv_vars->{SAMBA_PID}");
222 print "Waiting for dns_update_cache to be created...\n";
225 print "Waiting for dns_update_cache to be filled.\n";
227 while ((-s "$testenv_vars->{PRIVATEDIR}/dns_update_cache") == 0) {
229 if ($count > $max_wait) {
230 teardown_env($self, $testenv_vars);
231 warn("Timed out ($max_wait sec) waiting for dns_update_cache PID $testenv_vars->{SAMBA_PID}");
234 print "Waiting for dns_update_cache to be filled...\n";
239 print $self->getlog_env($testenv_vars);
241 print "READY ($testenv_vars->{SAMBA_PID})\n";
246 sub write_ldb_file($$$)
248 my ($self, $file, $ldif) = @_;
250 my $ldbadd = Samba::bindir_path($self, "ldbadd");
251 open(LDIF, "|$ldbadd -H $file >/dev/null");
256 sub add_wins_config($$)
258 my ($self, $privatedir) = @_;
259 my $client_ip = Samba::get_ipv4_addr("client");
261 return $self->write_ldb_file("$privatedir/wins_config.ldb", "
262 dn: name=TORTURE_11,CN=PARTNERS
263 objectClass: wreplPartner
272 sub setup_dns_hub_internal($$$)
274 my ($self, $hostname, $prefix) = @_;
277 unless(-d $prefix or make_path($prefix, 0777)) {
278 warn("Unable to create $prefix");
281 my $prefix_abs = abs_path($prefix);
283 die ("prefix=''") if $prefix_abs eq "";
284 die ("prefix='/'") if $prefix_abs eq "/";
286 unless (system("rm -rf $prefix_abs/*") == 0) {
287 warn("Unable to clean up");
291 $env->{NETBIOSNAME} = $hostname;
293 $env->{SERVER_IP} = Samba::get_ipv4_addr($hostname);
294 $env->{SERVER_IPV6} = Samba::get_ipv6_addr($hostname);
295 $env->{SOCKET_WRAPPER_DEFAULT_IFACE} = Samba::get_interface($hostname);
296 $env->{DNS_HUB_LOG} = "$prefix_abs/dns_hub.log";
297 $env->{RESOLV_CONF} = "$prefix_abs/resolv.conf";
298 $env->{TESTENV_DIR} = $prefix_abs;
300 open(RESOLV_CONF, ">$env->{RESOLV_CONF}");
301 print RESOLV_CONF "nameserver $env->{SERVER_IP}\n";
302 print RESOLV_CONF "nameserver $env->{SERVER_IPV6}\n";
307 if (!defined($ENV{PYTHON})) {
308 push (@preargs, "env");
309 push (@preargs, "python");
311 push (@preargs, $ENV{PYTHON});
313 my $binary = "$self->{srcdir}/selftest/target/dns_hub.py";
314 push (@args, "$self->{server_maxtime}");
315 push (@args, "$env->{SERVER_IP}");
316 push (@args, Samba::realm_to_ip_mappings());
317 my @full_cmd = (@preargs, $binary, @args);
321 BINARY_PATH => $binary,
322 FULL_CMD => [ @full_cmd ],
323 LOG_FILE => $env->{DNS_HUB_LOG},
325 PCAP_FILE => "$ENV{SOCKET_WRAPPER_PCAP_DIR}/env-$hostname$.pcap",
329 # use a pipe for stdin in the child processes. This allows
330 # those processes to monitor the pipe for EOF to ensure they
331 # exit when the test script exits
332 pipe($STDIN_READER, $env->{STDIN_PIPE});
334 my $pid = Samba::fork_and_exec($self, $env, $daemon_ctx, $STDIN_READER);
336 $env->{SAMBA_PID} = $pid;
337 $env->{KRB5_CONFIG} = "$prefix_abs/no_krb5.conf";
339 # close the parent's read-end of the pipe
340 close($STDIN_READER);
347 my ($self, $prefix) = @_;
349 my $hostname = "rootdnsforwarder";
351 my $env = $self->setup_dns_hub_internal("$hostname", "$prefix/$hostname");
353 $self->{dns_hub_env} = $env;
358 sub get_dns_hub_env($)
360 my ($self, $prefix) = @_;
362 if (defined($self->{dns_hub_env})) {
363 return $self->{dns_hub_env};
366 die("get_dns_hub_env() not setup 'dns_hub_env'");
370 # Returns the environmental variables that we pass to samba-tool commands
373 my ($self, $localenv) = @_;
375 my $cmd_env = "NSS_WRAPPER_HOSTS='$localenv->{NSS_WRAPPER_HOSTS}' ";
376 $cmd_env .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$localenv->{SOCKET_WRAPPER_DEFAULT_IFACE}\" ";
377 if (defined($localenv->{RESOLV_WRAPPER_CONF})) {
378 $cmd_env .= "RESOLV_WRAPPER_CONF=\"$localenv->{RESOLV_WRAPPER_CONF}\" ";
380 $cmd_env .= "RESOLV_WRAPPER_HOSTS=\"$localenv->{RESOLV_WRAPPER_HOSTS}\" ";
382 $cmd_env .= " KRB5_CONFIG=\"$localenv->{KRB5_CONFIG}\" ";
383 $cmd_env .= "KRB5CCNAME=\"$localenv->{KRB5_CCACHE}\" ";
384 $cmd_env .= "RESOLV_CONF=\"$localenv->{RESOLV_CONF}\" ";
389 # Sets up a forest trust namespace.
390 # (Note this is different to kernel namespaces, setup by the
391 # USE_NAMESPACES=1 option)
392 sub setup_namespaces($$:$$)
394 my ($self, $localenv, $upn_array, $spn_array) = @_;
396 @{$upn_array} = [] unless defined($upn_array);
398 foreach my $upn (@{$upn_array}) {
399 $upn_args .= " --add-upn-suffix=$upn";
402 @{$spn_array} = [] unless defined($spn_array);
404 foreach my $spn (@{$spn_array}) {
405 $spn_args .= " --add-spn-suffix=$spn";
408 my $samba_tool = Samba::bindir_path($self, "samba-tool");
410 my $cmd_env = $self->get_cmd_env_vars($localenv);
412 my $cmd_config = " $localenv->{CONFIGURATION}";
414 my $namespaces = $cmd_env;
415 $namespaces .= " $samba_tool domain trust namespaces $upn_args $spn_args";
416 $namespaces .= $cmd_config;
417 unless (system($namespaces) == 0) {
418 warn("Failed to add namespaces \n$namespaces");
425 sub setup_trust($$$$$)
427 my ($self, $localenv, $remoteenv, $type, $extra_args) = @_;
429 $localenv->{TRUST_SERVER} = $remoteenv->{SERVER};
431 $localenv->{TRUST_USERNAME} = $remoteenv->{USERNAME};
432 $localenv->{TRUST_PASSWORD} = $remoteenv->{PASSWORD};
433 $localenv->{TRUST_DOMAIN} = $remoteenv->{DOMAIN};
434 $localenv->{TRUST_REALM} = $remoteenv->{REALM};
435 $localenv->{TRUST_DOMSID} = $remoteenv->{DOMSID};
437 my $samba_tool = Samba::bindir_path($self, "samba-tool");
440 my $cmd_env = $self->get_cmd_env_vars($localenv);
442 my $cmd_config = " $localenv->{CONFIGURATION}";
443 my $cmd_creds = $cmd_config;
444 $cmd_creds .= " -U$localenv->{TRUST_DOMAIN}\\\\$localenv->{TRUST_USERNAME}\%$localenv->{TRUST_PASSWORD}";
446 my $create = $cmd_env;
447 $create .= " $samba_tool domain trust create --type=${type} $localenv->{TRUST_REALM}";
448 $create .= " $extra_args";
449 $create .= $cmd_creds;
450 unless (system($create) == 0) {
451 warn("Failed to create trust \n$create");
455 my $groupname = "g_$localenv->{TRUST_DOMAIN}";
456 my $groupadd = $cmd_env;
457 $groupadd .= " $samba_tool group add '$groupname' --group-scope=Domain $cmd_config";
458 unless (system($groupadd) == 0) {
459 warn("Failed to create group \n$groupadd");
462 my $groupmem = $cmd_env;
463 $groupmem .= " $samba_tool group addmembers '$groupname' '$localenv->{TRUST_DOMSID}-513' $cmd_config";
464 unless (system($groupmem) == 0) {
465 warn("Failed to add group member \n$groupmem");
472 sub provision_raw_prepare($$$$$$$$$$$$)
474 my ($self, $prefix, $server_role, $hostname,
475 $domain, $realm, $samsid, $functional_level,
476 $password, $kdc_ipv4, $kdc_ipv6) = @_;
479 if (defined $ENV{PYTHON}) {
480 $python_cmd = $ENV{PYTHON} . " ";
482 $ctx->{python} = $python_cmd;
483 my $netbiosname = uc($hostname);
485 unless(-d $prefix or mkdir($prefix, 0777)) {
486 warn("Unable to create $prefix");
489 my $prefix_abs = abs_path($prefix);
491 die ("prefix=''") if $prefix_abs eq "";
492 die ("prefix='/'") if $prefix_abs eq "/";
494 unless (system("rm -rf $prefix_abs/*") == 0) {
495 warn("Unable to clean up");
499 my $swiface = Samba::get_interface($hostname);
501 $ctx->{prefix} = $prefix;
502 $ctx->{prefix_abs} = $prefix_abs;
504 $ctx->{server_role} = $server_role;
505 $ctx->{hostname} = $hostname;
506 $ctx->{netbiosname} = $netbiosname;
507 $ctx->{swiface} = $swiface;
508 $ctx->{password} = $password;
509 $ctx->{kdc_ipv4} = $kdc_ipv4;
510 $ctx->{kdc_ipv6} = $kdc_ipv6;
511 $ctx->{krb5_ccname} = "$prefix_abs/krb5cc_%{uid}";
512 if ($functional_level eq "2000") {
513 $ctx->{supported_enctypes} = "arcfour-hmac-md5 des-cbc-md5 des-cbc-crc"
517 # Set smbd log level here.
519 $ctx->{server_loglevel} =$ENV{SERVER_LOG_LEVEL} || 1;
520 $ctx->{username} = "Administrator";
521 $ctx->{domain} = $domain;
522 $ctx->{realm} = uc($realm);
523 $ctx->{dnsname} = lc($realm);
524 $ctx->{samsid} = $samsid;
526 $ctx->{functional_level} = $functional_level;
528 my $unix_name = ($ENV{USER} or $ENV{LOGNAME} or `whoami`);
530 $ctx->{unix_name} = $unix_name;
531 $ctx->{unix_uid} = $>;
532 my @mygid = split(" ", $();
533 $ctx->{unix_gid} = $mygid[0];
534 $ctx->{unix_gids_str} = $);
535 @{$ctx->{unix_gids}} = split(" ", $ctx->{unix_gids_str});
537 $ctx->{etcdir} = "$prefix_abs/etc";
538 $ctx->{piddir} = "$prefix_abs/pid";
539 $ctx->{smb_conf} = "$ctx->{etcdir}/smb.conf";
540 $ctx->{krb5_conf} = "$ctx->{etcdir}/krb5.conf";
541 $ctx->{krb5_ccache} = "$prefix_abs/krb5_ccache";
542 $ctx->{mitkdc_conf} = "$ctx->{etcdir}/mitkdc.conf";
543 $ctx->{privatedir} = "$prefix_abs/private";
544 $ctx->{binddnsdir} = "$prefix_abs/bind-dns";
545 $ctx->{ncalrpcdir} = "$prefix_abs/ncalrpc";
546 $ctx->{lockdir} = "$prefix_abs/lockdir";
547 $ctx->{logdir} = "$prefix_abs/logs";
548 $ctx->{statedir} = "$prefix_abs/statedir";
549 $ctx->{cachedir} = "$prefix_abs/cachedir";
550 $ctx->{winbindd_socket_dir} = "$prefix_abs/winbindd_socket";
551 $ctx->{ntp_signd_socket_dir} = "$prefix_abs/ntp_signd_socket";
552 $ctx->{nsswrap_passwd} = "$ctx->{etcdir}/passwd";
553 $ctx->{nsswrap_group} = "$ctx->{etcdir}/group";
554 $ctx->{nsswrap_hosts} = "$ENV{SELFTEST_PREFIX}/hosts";
555 $ctx->{nsswrap_hostname} = "$ctx->{hostname}.$ctx->{dnsname}";
556 if ($ENV{SAMBA_DNS_FAKING}) {
557 $ctx->{dns_host_file} = "$ENV{SELFTEST_PREFIX}/dns_host_file";
558 $ctx->{samba_dnsupdate} = "$ENV{SRCDIR_ABS}/source4/scripting/bin/samba_dnsupdate -s $ctx->{smb_conf} --all-interfaces --use-file=$ctx->{dns_host_file}";
559 $ctx->{samba_dnsupdate} = $python_cmd . $ctx->{samba_dnsupdate};
561 $ctx->{samba_dnsupdate} = "$ENV{SRCDIR_ABS}/source4/scripting/bin/samba_dnsupdate -s $ctx->{smb_conf} --all-interfaces";
562 $ctx->{samba_dnsupdate} = $python_cmd . $ctx->{samba_dnsupdate};
563 $ctx->{use_resolv_wrapper} = 1;
566 my $dns_hub = $self->get_dns_hub_env();
567 $ctx->{resolv_conf} = $dns_hub->{RESOLV_CONF};
569 $ctx->{tlsdir} = "$ctx->{privatedir}/tls";
571 $ctx->{ipv4} = Samba::get_ipv4_addr($hostname);
572 $ctx->{ipv6} = Samba::get_ipv6_addr($hostname);
574 push(@{$ctx->{directories}}, $ctx->{privatedir});
575 push(@{$ctx->{directories}}, $ctx->{binddnsdir});
576 push(@{$ctx->{directories}}, $ctx->{etcdir});
577 push(@{$ctx->{directories}}, $ctx->{piddir});
578 push(@{$ctx->{directories}}, $ctx->{lockdir});
579 push(@{$ctx->{directories}}, $ctx->{logdir});
580 push(@{$ctx->{directories}}, $ctx->{statedir});
581 push(@{$ctx->{directories}}, $ctx->{cachedir});
583 $ctx->{smb_conf_extra_options} = "";
585 my @provision_options = ();
586 push (@provision_options, "KRB5_CONFIG=\"$ctx->{krb5_conf}\"");
587 push (@provision_options, "KRB5_CCACHE=\"$ctx->{krb5_ccache}\"");
588 push (@provision_options, "NSS_WRAPPER_PASSWD=\"$ctx->{nsswrap_passwd}\"");
589 push (@provision_options, "NSS_WRAPPER_GROUP=\"$ctx->{nsswrap_group}\"");
590 push (@provision_options, "NSS_WRAPPER_HOSTS=\"$ctx->{nsswrap_hosts}\"");
591 push (@provision_options, "NSS_WRAPPER_HOSTNAME=\"$ctx->{nsswrap_hostname}\"");
592 if (defined($ctx->{use_resolv_wrapper})) {
593 push (@provision_options, "RESOLV_WRAPPER_CONF=\"$ctx->{resolv_conf}\"");
594 push (@provision_options, "RESOLV_CONF=\"$ctx->{resolv_conf}\"");
596 push (@provision_options, "RESOLV_WRAPPER_HOSTS=\"$ctx->{dns_host_file}\"");
598 if (defined($ENV{GDB_PROVISION})) {
599 push (@provision_options, "gdb --args");
600 if (!defined($ENV{PYTHON})) {
601 push (@provision_options, "env");
602 push (@provision_options, "python");
605 if (defined($ENV{VALGRIND_PROVISION})) {
606 push (@provision_options, "valgrind");
607 if (!defined($ENV{PYTHON})) {
608 push (@provision_options, "env");
609 push (@provision_options, "python");
613 my $samba_tool = Samba::bindir_path($self, "samba-tool");
615 push (@provision_options, $samba_tool);
616 push (@provision_options, "domain");
617 push (@provision_options, "provision");
618 push (@provision_options, "--configfile=$ctx->{smb_conf}");
619 push (@provision_options, "--host-name=$ctx->{hostname}");
620 push (@provision_options, "--host-ip=$ctx->{ipv4}");
621 push (@provision_options, "--quiet");
622 push (@provision_options, "--domain=$ctx->{domain}");
623 push (@provision_options, "--realm=$ctx->{realm}");
624 if (defined($ctx->{samsid})) {
625 push (@provision_options, "--domain-sid=$ctx->{samsid}");
627 push (@provision_options, "--adminpass=$ctx->{password}");
628 push (@provision_options, "--krbtgtpass=krbtgt$ctx->{password}");
629 push (@provision_options, "--machinepass=machine$ctx->{password}");
630 push (@provision_options, "--root=$ctx->{unix_name}");
631 push (@provision_options, "--server-role=\"$ctx->{server_role}\"");
632 push (@provision_options, "--function-level=\"$ctx->{functional_level}\"");
634 @{$ctx->{provision_options}} = @provision_options;
641 my ($self, $keyword, @options_list) = @_;
643 # convert the options-list to a hash-map for easy keyword lookup
644 my %options_dict = map { $_ => 1 } @options_list;
646 return exists $options_dict{$keyword};
650 # Step1 creates the basic configuration
652 sub provision_raw_step1($$)
654 my ($self, $ctx) = @_;
656 mkdir($_, 0777) foreach (@{$ctx->{directories}});
659 ## lockdir and piddir must be 0755
661 chmod 0755, $ctx->{lockdir};
662 chmod 0755, $ctx->{piddir};
664 unless (open(CONFFILE, ">$ctx->{smb_conf}")) {
665 warn("can't open $ctx->{smb_conf}$?");
669 Samba::prepare_keyblobs($ctx);
670 my $crlfile = "$ctx->{tlsdir}/crl.pem";
671 $crlfile = "" unless -e ${crlfile};
673 # work out which file server to use. Default to source3 smbd (s3fs),
674 # unless the source4 NTVFS (smb) file server has been specified
675 my $services = "-smb +s3fs";
676 if ($self->has_option("--use-ntvfs", @{$ctx->{provision_options}})) {
677 $services = "+smb -s3fs";
680 my $interfaces = Samba::get_interfaces_config($ctx->{netbiosname});
684 netbios name = $ctx->{netbiosname}
685 posix:eadb = $ctx->{statedir}/eadb.tdb
686 workgroup = $ctx->{domain}
687 realm = $ctx->{realm}
688 private dir = $ctx->{privatedir}
689 binddns dir = $ctx->{binddnsdir}
690 pid directory = $ctx->{piddir}
691 ncalrpc dir = $ctx->{ncalrpcdir}
692 lock dir = $ctx->{lockdir}
693 state directory = $ctx->{statedir}
694 cache directory = $ctx->{cachedir}
695 winbindd socket directory = $ctx->{winbindd_socket_dir}
696 ntp signd socket directory = $ctx->{ntp_signd_socket_dir}
697 winbind separator = /
698 interfaces = $interfaces
699 tls dh params file = $ctx->{tlsdir}/dhparms.pem
700 tls crlfile = ${crlfile}
701 tls verify peer = no_check
702 panic action = $RealBin/gdb_backtrace \%d
704 server role = $ctx->{server_role}
705 server services = +echo $services
706 dcerpc endpoint servers = +winreg +srvsvc
707 notify:inotify = false
709 ldap server require strong auth = yes
710 #We don't want to pass our self-tests if the PAC code is wrong
711 gensec:require_pac = true
712 log file = $ctx->{logdir}/log.\%m
713 log level = $ctx->{server_loglevel}
716 client min protocol = CORE
717 server min protocol = LANMAN1
719 dns update command = $ctx->{samba_dnsupdate}
720 spn update command = $ctx->{python} $ENV{SRCDIR_ABS}/source4/scripting/bin/samba_spnupdate -s $ctx->{smb_conf}
721 gpo update command = $ctx->{python} $ENV{SRCDIR_ABS}/source4/scripting/bin/samba-gpupdate -s $ctx->{smb_conf} --target=Computer
722 samba kcc command = $ctx->{python} $ENV{SRCDIR_ABS}/source4/scripting/bin/samba_kcc
723 dreplsrv:periodic_startup_interval = 0
724 dsdb:schema update allowed = yes
726 vfs objects = dfs_samba4 acl_xattr fake_acls xattr_tdb streams_depot
728 idmap_ldb:use rfc2307=yes
729 winbind enum users = yes
730 winbind enum groups = yes
732 rpc server port:netlogon = 1026
733 include system krb5 conf = no
739 # Begin extra options
740 $ctx->{smb_conf_extra_options}
745 #Default the KDC IP to the server's IP
746 if (not defined($ctx->{kdc_ipv4})) {
747 $ctx->{kdc_ipv4} = $ctx->{ipv4};
749 if (not defined($ctx->{kdc_ipv6})) {
750 $ctx->{kdc_ipv6} = $ctx->{ipv6};
753 Samba::mk_krb5_conf($ctx);
754 Samba::mk_mitkdc_conf($ctx, abs_path(Samba::bindir_path($self, "shared")));
756 open(PWD, ">$ctx->{nsswrap_passwd}");
757 if ($ctx->{unix_uid} != 0) {
758 print PWD "root:x:0:0:root gecos:$ctx->{prefix_abs}:/bin/false\n";
760 print PWD "$ctx->{unix_name}:x:$ctx->{unix_uid}:65531:$ctx->{unix_name} gecos:$ctx->{prefix_abs}:/bin/false\n";
761 print PWD "nobody:x:65534:65533:nobody gecos:$ctx->{prefix_abs}:/bin/false
762 pdbtest:x:65533:65533:pdbtest gecos:$ctx->{prefix_abs}:/bin/false
763 pdbtest2:x:65532:65533:pdbtest gecos:$ctx->{prefix_abs}:/bin/false
764 pdbtest3:x:65531:65533:pdbtest gecos:$ctx->{prefix_abs}:/bin/false
765 pdbtest4:x:65530:65533:pdbtest gecos:$ctx->{prefix_abs}:/bin/false
768 my $uid_rfc2307test = 65533;
770 open(GRP, ">$ctx->{nsswrap_group}");
771 if ($ctx->{unix_gid} != 0) {
772 print GRP "root:x:0:\n";
774 print GRP "$ctx->{unix_name}:x:$ctx->{unix_gid}:\n";
775 print GRP "wheel:x:10:
778 nogroup:x:65534:nobody
781 my $gid_rfc2307test = 65532;
783 my $hostname = lc($ctx->{hostname});
784 open(HOSTS, ">>$ctx->{nsswrap_hosts}");
785 if ($hostname eq "localdc") {
786 print HOSTS "$ctx->{ipv4} ${hostname}.$ctx->{dnsname} $ctx->{dnsname} ${hostname}\n";
787 print HOSTS "$ctx->{ipv6} ${hostname}.$ctx->{dnsname} $ctx->{dnsname} ${hostname}\n";
789 print HOSTS "$ctx->{ipv4} ${hostname}.$ctx->{dnsname} ${hostname}\n";
790 print HOSTS "$ctx->{ipv6} ${hostname}.$ctx->{dnsname} ${hostname}\n";
794 my $configuration = "--configfile=$ctx->{smb_conf}";
796 #Ensure the config file is valid before we start
797 my $testparm = Samba::bindir_path($self, "samba-tool") . " testparm";
798 if (system("$testparm $configuration -v --suppress-prompt >/dev/null 2>&1") != 0) {
799 system("$testparm -v --suppress-prompt $configuration >&2");
800 warn("Failed to create a valid smb.conf configuration $testparm!");
803 unless (system("($testparm $configuration -v --suppress-prompt --parameter-name=\"netbios name\" --section-name=global 2> /dev/null | grep -i \"^$ctx->{netbiosname}\" ) >/dev/null 2>&1") == 0) {
804 warn("Failed to create a valid smb.conf configuration! $testparm $configuration -v --suppress-prompt --parameter-name=\"netbios name\" --section-name=global");
808 # Return the environment variables for the new testenv DC.
809 # Note that we have SERVER_X and DC_SERVER_X variables (which have the same
810 # value initially). In a 2 DC setup, $DC_SERVER_X will always be the PDC.
812 KRB5_CONFIG => $ctx->{krb5_conf},
813 KRB5_CCACHE => $ctx->{krb5_ccache},
814 MITKDC_CONFIG => $ctx->{mitkdc_conf},
815 PIDDIR => $ctx->{piddir},
816 SERVER => $ctx->{hostname},
817 DC_SERVER => $ctx->{hostname},
818 SERVER_IP => $ctx->{ipv4},
819 DC_SERVER_IP => $ctx->{ipv4},
820 SERVER_IPV6 => $ctx->{ipv6},
821 DC_SERVER_IPV6 => $ctx->{ipv6},
822 NETBIOSNAME => $ctx->{netbiosname},
823 DC_NETBIOSNAME => $ctx->{netbiosname},
824 DOMAIN => $ctx->{domain},
825 USERNAME => $ctx->{username},
826 DC_USERNAME => $ctx->{username},
827 REALM => $ctx->{realm},
828 DNSNAME => $ctx->{dnsname},
829 SAMSID => $ctx->{samsid},
830 PASSWORD => $ctx->{password},
831 DC_PASSWORD => $ctx->{password},
832 LDAPDIR => $ctx->{ldapdir},
833 LDAP_INSTANCE => $ctx->{ldap_instance},
834 SELFTEST_WINBINDD_SOCKET_DIR => $ctx->{winbindd_socket_dir},
835 NCALRPCDIR => $ctx->{ncalrpcdir},
836 LOCKDIR => $ctx->{lockdir},
837 STATEDIR => $ctx->{statedir},
838 CACHEDIR => $ctx->{cachedir},
839 PRIVATEDIR => $ctx->{privatedir},
840 BINDDNSDIR => $ctx->{binddnsdir},
841 SERVERCONFFILE => $ctx->{smb_conf},
842 TESTENV_DIR => $ctx->{prefix_abs},
843 CONFIGURATION => $configuration,
844 SOCKET_WRAPPER_DEFAULT_IFACE => $ctx->{swiface},
845 NSS_WRAPPER_PASSWD => $ctx->{nsswrap_passwd},
846 NSS_WRAPPER_GROUP => $ctx->{nsswrap_group},
847 NSS_WRAPPER_HOSTS => $ctx->{nsswrap_hosts},
848 NSS_WRAPPER_HOSTNAME => $ctx->{nsswrap_hostname},
849 SAMBA_TEST_FIFO => "$ctx->{prefix}/samba_test.fifo",
850 SAMBA_TEST_LOG => "$ctx->{prefix}/samba_test.log",
851 SAMBA_TEST_LOG_POS => 0,
852 NSS_WRAPPER_MODULE_SO_PATH => Samba::nss_wrapper_winbind_so_path($self),
853 NSS_WRAPPER_MODULE_FN_PREFIX => "winbind",
854 LOCAL_PATH => $ctx->{share},
855 UID_RFC2307TEST => $uid_rfc2307test,
856 GID_RFC2307TEST => $gid_rfc2307test,
857 SERVER_ROLE => $ctx->{server_role},
858 RESOLV_CONF => $ctx->{resolv_conf}
861 if (defined($ctx->{use_resolv_wrapper})) {
862 $ret->{RESOLV_WRAPPER_CONF} = $ctx->{resolv_conf};
864 $ret->{RESOLV_WRAPPER_HOSTS} = $ctx->{dns_host_file};
867 if ($ctx->{server_role} eq "domain controller") {
868 $ret->{DOMSID} = $ret->{SAMSID};
875 # Step2 runs the provision script
877 sub provision_raw_step2($$$)
879 my ($self, $ctx, $ret) = @_;
881 my $provision_cmd = join(" ", @{$ctx->{provision_options}});
882 unless (system($provision_cmd) == 0) {
883 warn("Unable to provision: \n$provision_cmd\n");
887 my $testallowed_account = "testallowed";
888 my $samba_tool_cmd = "";
889 $samba_tool_cmd .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
890 $samba_tool_cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
891 $samba_tool_cmd .= Samba::bindir_path($self, "samba-tool")
892 . " user create --configfile=$ctx->{smb_conf} $testallowed_account $ctx->{password}";
893 unless (system($samba_tool_cmd) == 0) {
894 warn("Unable to add testallowed user: \n$samba_tool_cmd\n");
899 $ldbmodify .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
900 $ldbmodify .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
901 $ldbmodify .= Samba::bindir_path($self, "ldbmodify");
902 $ldbmodify .= " --configfile=$ctx->{smb_conf}";
903 my $base_dn = "DC=".join(",DC=", split(/\./, $ctx->{realm}));
905 if ($ctx->{server_role} ne "domain controller") {
906 $base_dn = "DC=$ctx->{netbiosname}";
909 my $user_dn = "cn=$testallowed_account,cn=users,$base_dn";
910 $testallowed_account = "testallowed account";
911 open(LDIF, "|$ldbmodify -H $ctx->{privatedir}/sam.ldb");
912 print LDIF "dn: $user_dn
914 replace: samAccountName
915 samAccountName: $testallowed_account
920 open(LDIF, "|$ldbmodify -H $ctx->{privatedir}/sam.ldb");
921 print LDIF "dn: $user_dn
923 replace: userPrincipalName
924 userPrincipalName: testallowed upn\@$ctx->{realm}
925 replace: servicePrincipalName
926 servicePrincipalName: host/testallowed
931 $samba_tool_cmd = "";
932 $samba_tool_cmd .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
933 $samba_tool_cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
934 $samba_tool_cmd .= Samba::bindir_path($self, "samba-tool")
935 . " user create --configfile=$ctx->{smb_conf} testdenied $ctx->{password}";
936 unless (system($samba_tool_cmd) == 0) {
937 warn("Unable to add testdenied user: \n$samba_tool_cmd\n");
941 my $user_dn = "cn=testdenied,cn=users,$base_dn";
942 open(LDIF, "|$ldbmodify -H $ctx->{privatedir}/sam.ldb");
943 print LDIF "dn: $user_dn
945 replace: userPrincipalName
946 userPrincipalName: testdenied_upn\@$ctx->{realm}.upn
951 $samba_tool_cmd = "";
952 $samba_tool_cmd .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
953 $samba_tool_cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
954 $samba_tool_cmd .= Samba::bindir_path($self, "samba-tool")
955 . " user create --configfile=$ctx->{smb_conf} testupnspn $ctx->{password}";
956 unless (system($samba_tool_cmd) == 0) {
957 warn("Unable to add testupnspn user: \n$samba_tool_cmd\n");
961 my $user_dn = "cn=testupnspn,cn=users,$base_dn";
962 open(LDIF, "|$ldbmodify -H $ctx->{privatedir}/sam.ldb");
963 print LDIF "dn: $user_dn
965 replace: userPrincipalName
966 userPrincipalName: http/testupnspn.$ctx->{dnsname}\@$ctx->{realm}
967 replace: servicePrincipalName
968 servicePrincipalName: http/testupnspn.$ctx->{dnsname}
973 $samba_tool_cmd = "";
974 $samba_tool_cmd .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
975 $samba_tool_cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
976 $samba_tool_cmd .= Samba::bindir_path($self, "samba-tool")
977 . " group addmembers --configfile=$ctx->{smb_conf} 'Allowed RODC Password Replication Group' '$testallowed_account'";
978 unless (system($samba_tool_cmd) == 0) {
979 warn("Unable to add '$testallowed_account' user to 'Allowed RODC Password Replication Group': \n$samba_tool_cmd\n");
983 # Create to users alice and bob!
984 my $user_account_array = ["alice", "bob", "jane"];
986 foreach my $user_account (@{$user_account_array}) {
987 my $samba_tool_cmd = "";
989 $samba_tool_cmd .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
990 $samba_tool_cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
991 $samba_tool_cmd .= Samba::bindir_path($self, "samba-tool")
992 . " user create --configfile=$ctx->{smb_conf} $user_account Secret007";
993 unless (system($samba_tool_cmd) == 0) {
994 warn("Unable to create user: $user_account\n$samba_tool_cmd\n");
1000 $ldbmodify .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
1001 $ldbmodify .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
1002 $ldbmodify .= Samba::bindir_path($self, "ldbmodify");
1003 $ldbmodify .= " --configfile=$ctx->{smb_conf}";
1004 my $base_dn = "DC=".join(",DC=", split(/\./, $ctx->{realm}));
1005 my $user_dn = "cn=jane,cn=users,$base_dn";
1007 open(LDIF, "|$ldbmodify -H $ctx->{privatedir}/sam.ldb");
1008 print LDIF "dn: $user_dn
1010 replace: userPrincipalName
1011 userPrincipalName: jane.doe\@$ctx->{realm}
1019 sub provision($$$$$$$$$$)
1021 my ($self, $prefix, $server_role, $hostname,
1022 $domain, $realm, $functional_level,
1023 $password, $kdc_ipv4, $kdc_ipv6, $extra_smbconf_options, $extra_smbconf_shares,
1024 $extra_provision_options) = @_;
1026 my $samsid = Samba::random_domain_sid();
1028 my $ctx = $self->provision_raw_prepare($prefix, $server_role,
1033 $password, $kdc_ipv4, $kdc_ipv6);
1035 if (defined($extra_provision_options)) {
1036 push (@{$ctx->{provision_options}}, @{$extra_provision_options});
1039 $ctx->{share} = "$ctx->{prefix_abs}/share";
1040 push(@{$ctx->{directories}}, "$ctx->{share}");
1041 push(@{$ctx->{directories}}, "$ctx->{share}/test1");
1042 push(@{$ctx->{directories}}, "$ctx->{share}/test2");
1044 # precreate directories for printer drivers
1045 push(@{$ctx->{directories}}, "$ctx->{share}/W32X86");
1046 push(@{$ctx->{directories}}, "$ctx->{share}/x64");
1047 push(@{$ctx->{directories}}, "$ctx->{share}/WIN40");
1050 $msdfs = "yes" if ($server_role eq "domain controller");
1051 $ctx->{smb_conf_extra_options} = "
1054 server max protocol = SMB2
1058 # fruit:copyfile is a global option
1059 fruit:copyfile = yes
1061 $extra_smbconf_options
1064 path = $ctx->{share}
1066 posix:sharedelay = 100000
1067 posix:oplocktimeout = 3
1068 posix:writetimeupdatedelay = 500000
1071 path = $ctx->{share}
1073 posix:sharedelay = 100000
1074 posix:oplocktimeout = 3
1075 posix:writetimeupdatedelay = 500000
1077 force create mode = 777
1080 path = $ctx->{share}
1083 force create mode = 0
1084 directory mask = 0777
1085 force directory mode = 0
1088 path = $ctx->{share}/test1
1090 posix:sharedelay = 100000
1091 posix:oplocktimeout = 3
1092 posix:writetimeupdatedelay = 500000
1095 path = $ctx->{share}/test2
1097 posix:sharedelay = 100000
1098 posix:oplocktimeout = 3
1099 posix:writetimeupdatedelay = 500000
1102 path = $ctx->{share}/_ignore_cifs_
1104 ntvfs handler = cifs
1105 cifs:server = $ctx->{netbiosname}
1107 cifs:use-s4u2proxy = yes
1108 # There is no username specified here, instead the client is expected
1109 # to log in with kerberos, and the serverwill use delegated credentials.
1110 # Or the server tries s4u2self/s4u2proxy to impersonate the client
1113 path = $ctx->{share}
1115 ntvfs handler = simple
1118 path = $ctx->{statedir}/sysvol
1122 path = $ctx->{statedir}/sysvol/$ctx->{dnsname}/scripts
1127 ntvfs handler = cifsposix
1130 path = $ctx->{share}
1131 vfs objects = catia fruit streams_xattr acl_xattr
1133 fruit:resource = file
1134 fruit:metadata = netatalk
1135 fruit:locking = netatalk
1136 fruit:encoding = native
1139 path = $ctx->{share}
1140 # This can be used for testing real fs xattr stuff
1141 vfs objects = streams_xattr acl_xattr
1143 $extra_smbconf_shares
1146 my $ret = $self->provision_raw_step1($ctx);
1147 unless (defined $ret) {
1151 return $self->provision_raw_step2($ctx, $ret);
1154 # For multi-DC testenvs, we want $DC_SERVER to always be the PDC (i.e. the
1155 # original DC) in the testenv. $SERVER is always the joined DC that we are
1156 # actually running the test against
1157 sub set_pdc_env_vars
1159 my ($self, $env, $dcvars) = @_;
1161 $env->{DC_SERVER} = $dcvars->{DC_SERVER};
1162 $env->{DC_SERVER_IP} = $dcvars->{DC_SERVER_IP};
1163 $env->{DC_SERVER_IPV6} = $dcvars->{DC_SERVER_IPV6};
1164 $env->{DC_SERVERCONFFILE} = $dcvars->{SERVERCONFFILE};
1165 $env->{DC_NETBIOSNAME} = $dcvars->{DC_NETBIOSNAME};
1166 $env->{DC_USERNAME} = $dcvars->{DC_USERNAME};
1167 $env->{DC_PASSWORD} = $dcvars->{DC_PASSWORD};
1170 sub provision_s4member($$$$$)
1172 my ($self, $prefix, $dcvars, $hostname, $more_conf) = @_;
1173 print "PROVISIONING MEMBER...\n";
1174 my $extra_smb_conf = "
1175 passdb backend = samba_dsdb
1176 winbindd:use external pipes = true
1178 # the source4 smb server doesn't allow signing by default
1179 server signing = enabled
1180 raw NTLMv2 auth = yes
1182 rpc_server:default = external
1183 rpc_server:svcctl = embedded
1184 rpc_server:srvsvc = embedded
1185 rpc_server:eventlog = embedded
1186 rpc_server:ntsvcs = embedded
1187 rpc_server:winreg = embedded
1188 rpc_server:spoolss = embedded
1189 rpc_daemon:spoolssd = embedded
1190 rpc_server:tcpip = no
1193 $extra_smb_conf = $extra_smb_conf . $more_conf . "\n";
1195 my $extra_provision_options = ["--use-ntvfs"];
1196 my $ret = $self->provision($prefix,
1203 $dcvars->{SERVER_IP},
1204 $dcvars->{SERVER_IPV6},
1205 $extra_smb_conf, "",
1206 $extra_provision_options);
1211 my $samba_tool = Samba::bindir_path($self, "samba-tool");
1212 my $cmd = $self->get_cmd_env_vars($ret);
1213 $cmd .= "$samba_tool domain join $ret->{CONFIGURATION} $dcvars->{REALM} member";
1214 $cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
1215 $cmd .= " --machinepass=machine$ret->{PASSWORD}";
1217 unless (system($cmd) == 0) {
1218 warn("Join failed\n$cmd");
1222 $ret->{DOMSID} = $dcvars->{DOMSID};
1223 $self->set_pdc_env_vars($ret, $dcvars);
1228 sub provision_rpc_proxy($$$)
1230 my ($self, $prefix, $dcvars) = @_;
1231 print "PROVISIONING RPC PROXY...\n";
1233 my $extra_smbconf_options = "
1234 passdb backend = samba_dsdb
1237 dcerpc_remote:binding = ncacn_ip_tcp:$dcvars->{SERVER}
1238 dcerpc endpoint servers = epmapper, remote
1239 dcerpc_remote:interfaces = rpcecho
1240 dcerpc_remote:allow_anonymous_fallback = yes
1243 path = /tmp/_ignore_cifs_to_dc_/_none_
1245 ntvfs handler = cifs
1246 cifs:server = $dcvars->{SERVER}
1248 cifs:use-s4u2proxy = yes
1249 # There is no username specified here, instead the client is expected
1250 # to log in with kerberos, and the serverwill use delegated credentials.
1251 # Or the server tries s4u2self/s4u2proxy to impersonate the client
1255 my $extra_provision_options = ["--use-ntvfs"];
1256 my $ret = $self->provision($prefix,
1263 $dcvars->{SERVER_IP},
1264 $dcvars->{SERVER_IPV6},
1265 $extra_smbconf_options, "",
1266 $extra_provision_options);
1271 my $samba_tool = Samba::bindir_path($self, "samba-tool");
1273 # The joind runs in the context of the rpc_proxy/member for now
1274 my $cmd = $self->get_cmd_env_vars($ret);
1275 $cmd .= "$samba_tool domain join $ret->{CONFIGURATION} $dcvars->{REALM} member";
1276 $cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
1277 $cmd .= " --machinepass=machine$ret->{PASSWORD}";
1279 unless (system($cmd) == 0) {
1280 warn("Join failed\n$cmd");
1284 # Setting up delegation runs in the context of the DC for now
1286 $cmd .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$dcvars->{SOCKET_WRAPPER_DEFAULT_IFACE}\" ";
1287 $cmd .= "KRB5_CONFIG=\"$dcvars->{KRB5_CONFIG}\" ";
1288 $cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
1289 $cmd .= "RESOLV_CONF=\"$dcvars->{RESOLV_CONF}\" ";
1290 $cmd .= "$samba_tool delegation for-any-protocol '$ret->{NETBIOSNAME}\$' on";
1291 $cmd .= " $dcvars->{CONFIGURATION}";
1294 unless (system($cmd) == 0) {
1295 warn("Delegation failed\n$cmd");
1299 # Setting up delegation runs in the context of the DC for now
1301 $cmd .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$dcvars->{SOCKET_WRAPPER_DEFAULT_IFACE}\" ";
1302 $cmd .= "KRB5_CONFIG=\"$dcvars->{KRB5_CONFIG}\" ";
1303 $cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
1304 $cmd .= "RESOLV_CONF=\"$dcvars->{RESOLV_CONF}\" ";
1305 $cmd .= "$samba_tool delegation add-service '$ret->{NETBIOSNAME}\$' cifs/$dcvars->{SERVER}";
1306 $cmd .= " $dcvars->{CONFIGURATION}";
1308 unless (system($cmd) == 0) {
1309 warn("Delegation failed\n$cmd");
1313 $ret->{DOMSID} = $dcvars->{DOMSID};
1314 $self->set_pdc_env_vars($ret, $dcvars);
1319 sub provision_promoted_dc($$$)
1321 my ($self, $prefix, $dcvars) = @_;
1322 print "PROVISIONING PROMOTED DC...\n";
1324 # We do this so that we don't run the provision. That's the job of 'samba-tool domain dcpromo'.
1325 my $ctx = $self->provision_raw_prepare($prefix, "domain controller",
1331 $dcvars->{PASSWORD},
1332 $dcvars->{SERVER_IP},
1333 $dcvars->{SERVER_IPV6});
1335 push (@{$ctx->{provision_options}}, "--use-ntvfs");
1337 $ctx->{smb_conf_extra_options} = "
1339 server max protocol = SMB2
1341 ntlm auth = ntlmv2-only
1344 path = $ctx->{statedir}/sysvol
1348 path = $ctx->{statedir}/sysvol/$ctx->{dnsname}/scripts
1353 my $ret = $self->provision_raw_step1($ctx);
1358 my $samba_tool = Samba::bindir_path($self, "samba-tool");
1359 my $cmd = $self->get_cmd_env_vars($ret);
1360 $cmd .= "$samba_tool domain join $ret->{CONFIGURATION} $dcvars->{REALM} MEMBER --realm=$dcvars->{REALM}";
1361 $cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
1362 $cmd .= " --machinepass=machine$ret->{PASSWORD}";
1364 unless (system($cmd) == 0) {
1365 warn("Join failed\n$cmd");
1369 my $samba_tool = Samba::bindir_path($self, "samba-tool");
1370 my $cmd = $self->get_cmd_env_vars($ret);
1371 $cmd .= "$samba_tool domain dcpromo $ret->{CONFIGURATION} $dcvars->{REALM} DC --realm=$dcvars->{REALM}";
1372 $cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
1373 $cmd .= " --machinepass=machine$ret->{PASSWORD} --use-ntvfs --dns-backend=BIND9_DLZ";
1375 unless (system($cmd) == 0) {
1376 warn("Join failed\n$cmd");
1380 $self->set_pdc_env_vars($ret, $dcvars);
1385 sub provision_vampire_dc($$$)
1387 my ($self, $prefix, $dcvars, $fl) = @_;
1388 print "PROVISIONING VAMPIRE DC @ FL $fl...\n";
1389 my $name = "localvampiredc";
1390 my $extra_conf = "";
1392 if ($fl == "2000") {
1393 $name = "vampire2000dc";
1395 $extra_conf = "drs: immediate link sync = yes
1396 drs: max link sync = 250";
1399 # We do this so that we don't run the provision. That's the job of 'net vampire'.
1400 my $ctx = $self->provision_raw_prepare($prefix, "domain controller",
1406 $dcvars->{PASSWORD},
1407 $dcvars->{SERVER_IP},
1408 $dcvars->{SERVER_IPV6});
1410 push (@{$ctx->{provision_options}}, "--use-ntvfs");
1412 $ctx->{smb_conf_extra_options} = "
1414 server max protocol = SMB2
1416 ntlm auth = mschapv2-and-ntlmv2-only
1420 path = $ctx->{statedir}/sysvol
1424 path = $ctx->{statedir}/sysvol/$ctx->{dnsname}/scripts
1429 my $ret = $self->provision_raw_step1($ctx);
1434 my $samba_tool = Samba::bindir_path($self, "samba-tool");
1435 my $cmd = $self->get_cmd_env_vars($ret);
1436 $cmd .= "$samba_tool domain join $ret->{CONFIGURATION} $dcvars->{REALM} DC --realm=$dcvars->{REALM}";
1437 $cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD} --domain-critical-only";
1438 $cmd .= " --machinepass=machine$ret->{PASSWORD} --use-ntvfs";
1439 $cmd .= " --backend-store=mdb";
1441 unless (system($cmd) == 0) {
1442 warn("Join failed\n$cmd");
1446 $self->set_pdc_env_vars($ret, $dcvars);
1447 $ret->{DC_REALM} = $dcvars->{DC_REALM};
1452 sub provision_ad_dc_ntvfs($$$)
1454 my ($self, $prefix, $extra_provision_options) = @_;
1456 # We keep the old 'winbind' name here in server services to
1457 # ensure upgrades which used that name still work with the now
1460 print "PROVISIONING AD DC (NTVFS)...\n";
1461 my $extra_conf_options = "netbios aliases = localDC1-a
1462 server services = +winbind -winbindd
1463 ldap server require strong auth = allow_sasl_over_tls
1464 allow nt4 crypto = yes
1465 raw NTLMv2 auth = yes
1466 lsa over netlogon = yes
1467 rpc server port = 1027
1468 auth event notification = true
1469 dsdb event notification = true
1470 dsdb password event notification = true
1471 dsdb group change notification = true
1472 server schannel = auto
1474 push (@{$extra_provision_options}, "--use-ntvfs");
1475 my $ret = $self->provision($prefix,
1476 "domain controller",
1479 "samba.example.com",
1484 $extra_conf_options,
1486 $extra_provision_options);
1491 unless($self->add_wins_config("$prefix/private")) {
1492 warn("Unable to add wins configuration");
1495 $ret->{NETBIOSALIAS} = "localdc1-a";
1496 $ret->{DC_REALM} = $ret->{REALM};
1501 sub provision_fl2000dc($$)
1503 my ($self, $prefix) = @_;
1505 print "PROVISIONING DC WITH FOREST LEVEL 2000...\n";
1506 my $extra_conf_options = "
1507 spnego:simulate_w2k=yes
1508 ntlmssp_client:force_old_spnego=yes
1509 ntlmssp_server:force_old_spnego=yes
1511 my $extra_provision_options = ["--use-ntvfs", "--base-schema=2008_R2"];
1512 # This environment uses plain text secrets
1513 # i.e. secret attributes are not encrypted on disk.
1514 # This allows testing of the --plaintext-secrets option for
1516 push (@{$extra_provision_options}, "--plaintext-secrets");
1517 my $ret = $self->provision($prefix,
1518 "domain controller",
1521 "samba2000.example.com",
1526 $extra_conf_options,
1528 $extra_provision_options);
1533 unless($self->add_wins_config("$prefix/private")) {
1534 warn("Unable to add wins configuration");
1537 $ret->{DC_REALM} = $ret->{REALM};
1542 sub provision_fl2003dc($$$)
1544 my ($self, $prefix, $dcvars) = @_;
1545 my $ip_addr1 = Samba::get_ipv4_addr("fakednsforwarder1");
1546 my $ip_addr2 = Samba::get_ipv4_addr("fakednsforwarder2");
1548 print "PROVISIONING DC WITH FOREST LEVEL 2003...\n";
1549 my $extra_conf_options = "allow dns updates = nonsecure and secure
1550 dcesrv:header signing = no
1551 dcesrv:max auth states = 0
1552 dns forwarder = $ip_addr1 $ip_addr2";
1553 my $extra_provision_options = ["--use-ntvfs", "--base-schema=2008_R2"];
1554 my $ret = $self->provision($prefix,
1555 "domain controller",
1558 "samba2003.example.com",
1563 $extra_conf_options,
1565 $extra_provision_options);
1566 unless (defined $ret) {
1570 $ret->{DNS_FORWARDER1} = $ip_addr1;
1571 $ret->{DNS_FORWARDER2} = $ip_addr2;
1573 my @samba_tool_options;
1574 push (@samba_tool_options, Samba::bindir_path($self, "samba-tool"));
1575 push (@samba_tool_options, "domain");
1576 push (@samba_tool_options, "passwordsettings");
1577 push (@samba_tool_options, "set");
1578 push (@samba_tool_options, "--configfile=$ret->{SERVERCONFFILE}");
1579 push (@samba_tool_options, "--min-pwd-age=0");
1580 push (@samba_tool_options, "--history-length=1");
1582 my $samba_tool_cmd = join(" ", @samba_tool_options);
1584 unless (system($samba_tool_cmd) == 0) {
1585 warn("Unable to set min password age to 0: \n$samba_tool_cmd\n");
1589 unless($self->add_wins_config("$prefix/private")) {
1590 warn("Unable to add wins configuration");
1597 sub provision_fl2008r2dc($$$)
1599 my ($self, $prefix, $dcvars) = @_;
1601 print "PROVISIONING DC WITH FOREST LEVEL 2008r2...\n";
1602 my $extra_conf_options = "ldap server require strong auth = no";
1603 my $extra_provision_options = ["--use-ntvfs", "--base-schema=2008_R2"];
1604 my $ret = $self->provision($prefix,
1605 "domain controller",
1608 "samba2008R2.example.com",
1613 $extra_conf_options,
1615 $extra_provision_options);
1616 unless (defined $ret) {
1620 unless ($self->add_wins_config("$prefix/private")) {
1621 warn("Unable to add wins configuration");
1624 $ret->{DC_REALM} = $ret->{REALM};
1630 sub provision_rodc($$$)
1632 my ($self, $prefix, $dcvars) = @_;
1633 print "PROVISIONING RODC...\n";
1635 # We do this so that we don't run the provision. That's the job of 'net join RODC'.
1636 my $ctx = $self->provision_raw_prepare($prefix, "domain controller",
1642 $dcvars->{PASSWORD},
1643 $dcvars->{SERVER_IP},
1644 $dcvars->{SERVER_IPV6});
1649 push (@{$ctx->{provision_options}}, "--use-ntvfs");
1651 $ctx->{share} = "$ctx->{prefix_abs}/share";
1652 push(@{$ctx->{directories}}, "$ctx->{share}");
1654 $ctx->{smb_conf_extra_options} = "
1656 server max protocol = SMB2
1657 password server = $dcvars->{DC_SERVER}
1660 path = $ctx->{statedir}/sysvol
1664 path = $ctx->{statedir}/sysvol/$ctx->{dnsname}/scripts
1668 path = $ctx->{share}
1670 posix:sharedelay = 10000
1671 posix:oplocktimeout = 3
1672 posix:writetimeupdatedelay = 50000
1676 my $ret = $self->provision_raw_step1($ctx);
1681 my $samba_tool = Samba::bindir_path($self, "samba-tool");
1682 my $cmd = $self->get_cmd_env_vars($ret);
1683 $cmd .= "$samba_tool domain join $ret->{CONFIGURATION} $dcvars->{REALM} RODC";
1684 $cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
1685 $cmd .= " --server=$dcvars->{DC_SERVER} --use-ntvfs";
1687 unless (system($cmd) == 0) {
1688 warn("RODC join failed\n$cmd");
1692 # This ensures deterministic behaviour for tests that want to have the 'testallowed account'
1693 # user password verified on the RODC
1694 my $testallowed_account = "testallowed account";
1695 $cmd = "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
1696 $cmd .= "KRB5CCNAME=\"$ret->{KRB5_CCACHE}\" ";
1697 $cmd .= "RESOLV_CONF=\"$ret->{RESOLV_CONF}\" ";
1698 $cmd .= "$samba_tool rodc preload '$testallowed_account' $ret->{CONFIGURATION}";
1699 $cmd .= " --server=$dcvars->{DC_SERVER}";
1701 unless (system($cmd) == 0) {
1702 warn("RODC join failed\n$cmd");
1706 # we overwrite the kdc after the RODC join
1707 # so that use the RODC as kdc and test
1709 $ctx->{kdc_ipv4} = $ret->{SERVER_IP};
1710 $ctx->{kdc_ipv6} = $ret->{SERVER_IPV6};
1711 Samba::mk_krb5_conf($ctx);
1712 Samba::mk_mitkdc_conf($ctx, abs_path(Samba::bindir_path($self, "shared")));
1714 $self->set_pdc_env_vars($ret, $dcvars);
1719 sub read_config_h($)
1723 open(LF, "<$name") or die("unable to read $name: $!");
1726 next if not (/^#define /);
1727 if (/^#define (.*?)[ \t]+(.*?)$/) {
1731 if (/^#define (.*?)[ \t]+$/) {
1740 sub provision_ad_dc($$$$$$)
1742 my ($self, $prefix, $hostname, $domain, $realm, $smbconf_args,
1743 $extra_provision_options) = @_;
1745 my $prefix_abs = abs_path($prefix);
1747 my $bindir_abs = abs_path($self->{bindir});
1748 my $lockdir="$prefix_abs/lockdir";
1749 my $conffile="$prefix_abs/etc/smb.conf";
1751 my $require_mutexes = "dbwrap_tdb_require_mutexes:* = yes";
1752 $require_mutexes = "" if ($ENV{SELFTEST_DONT_REQUIRE_TDB_MUTEX_SUPPORT} eq "1");
1756 if (defined($ENV{CONFIG_H})) {
1757 $config_h = read_config_h($ENV{CONFIG_H});
1760 my $password_hash_gpg_key_ids = "password hash gpg key ids = 4952E40301FAB41A";
1761 $password_hash_gpg_key_ids = "" unless defined($config_h->{HAVE_GPGME});
1763 my $extra_smbconf_options = "
1764 xattr_tdb:file = $prefix_abs/statedir/xattr.tdb
1766 dbwrap_tdb_mutexes:* = yes
1769 ${password_hash_gpg_key_ids}
1772 kernel change notify = no
1777 printcap name = /dev/null
1782 smbd:sharedelay = 100000
1783 smbd:writetimeupdatedelay = 500000
1786 check parent directory delete on close = yes
1788 dcerpc endpoint servers = -winreg -srvsvc
1790 printcap name = /dev/null
1792 addprinter command = $ENV{SRCDIR_ABS}/source3/script/tests/printing/modprinter.pl -a -s $conffile --
1793 deleteprinter command = $ENV{SRCDIR_ABS}/source3/script/tests/printing/modprinter.pl -d -s $conffile --
1796 print command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb print %p %s
1797 lpq command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb lpq %p
1798 lp rm command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb lprm %p %j
1799 lp pause command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb lppause %p %j
1800 lp resume command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb lpresume %p %j
1801 queue pause command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb queuepause %p
1802 queue resume command = $bindir_abs/vlp tdbfile=$lockdir/vlp.tdb queueresume %p
1804 print notify backchannel = yes
1806 server schannel = auto
1807 auth event notification = true
1808 dsdb event notification = true
1809 dsdb password event notification = true
1810 dsdb group change notification = true
1814 my $extra_smbconf_shares = "
1818 smb encrypt = required
1822 case sensitive = yes
1830 hide unreadable = yes
1834 kernel share modes = no
1853 push (@{$extra_provision_options}, "--backend-store=mdb");
1854 print "PROVISIONING AD DC...\n";
1855 my $ret = $self->provision($prefix,
1856 "domain controller",
1864 $extra_smbconf_options,
1865 $extra_smbconf_shares,
1866 $extra_provision_options);
1867 unless (defined $ret) {
1871 unless($self->add_wins_config("$prefix/private")) {
1872 warn("Unable to add wins configuration");
1879 sub provision_chgdcpass($$)
1881 my ($self, $prefix) = @_;
1883 print "PROVISIONING CHGDCPASS...\n";
1884 # This environment disallows the use of this password
1885 # (and also removes the default AD complexity checks)
1886 my $unacceptable_password = "Paßßword-widk3Dsle32jxdBdskldsk55klASKQ";
1887 my $extra_smb_conf = "
1888 check password script = $self->{srcdir}/selftest/checkpassword_arg1.sh ${unacceptable_password}
1889 allow dcerpc auth level connect:lsarpc = yes
1890 dcesrv:max auth states = 8
1892 my $extra_provision_options = ["--use-ntvfs"];
1893 push (@{$extra_provision_options}, "--dns-backend=BIND9_DLZ");
1894 my $ret = $self->provision($prefix,
1895 "domain controller",
1898 "chgdcpassword.samba.example.com",
1905 $extra_provision_options);
1906 unless (defined $ret) {
1910 unless($self->add_wins_config("$prefix/private")) {
1911 warn("Unable to add wins configuration");
1915 # Remove secrets.tdb from this environment to test that we
1916 # still start up on systems without the new matching
1917 # secrets.tdb records.
1918 unless (unlink("$ret->{PRIVATEDIR}/secrets.tdb") || unlink("$ret->{PRIVATEDIR}/secrets.ntdb")) {
1919 warn("Unable to remove $ret->{PRIVATEDIR}/secrets.tdb added during provision");
1923 $ret->{UNACCEPTABLE_PASSWORD} = $unacceptable_password;
1928 sub teardown_env_terminate($$)
1930 my ($self, $envvars) = @_;
1933 # This should cause samba to terminate gracefully
1934 my $smbcontrol = Samba::bindir_path($self, "smbcontrol");
1936 $cmd .= "$smbcontrol samba shutdown $envvars->{CONFIGURATION}";
1937 my $ret = system($cmd);
1939 warn "'$cmd' failed with '$ret'\n";
1942 # This should cause samba to terminate gracefully
1943 close($envvars->{STDIN_PIPE});
1945 $pid = $envvars->{SAMBA_PID};
1949 # This should give it time to write out the gcov data
1950 until ($count > 15) {
1951 if (Samba::cleanup_child($pid, "samba") != 0) {
1958 # After 15 Seconds, work out why this thing is still alive
1959 warn "server process $pid took more than $count seconds to exit, showing backtrace:\n";
1960 system("$self->{srcdir}/selftest/gdb_backtrace $pid");
1962 until ($count > 30) {
1963 if (Samba::cleanup_child($pid, "samba") != 0) {
1970 if (kill(0, $pid)) {
1971 warn "server process $pid took more than $count seconds to exit, sending SIGTERM\n";
1975 until ($count > 40) {
1976 if (Samba::cleanup_child($pid, "samba") != 0) {
1982 # If it is still around, kill it
1983 if (kill(0, $pid)) {
1984 warn "server process $pid took more than $count seconds to exit, killing\n with SIGKILL\n";
1990 sub teardown_env($$)
1992 my ($self, $envvars) = @_;
1993 teardown_env_terminate($self, $envvars);
1995 print $self->getlog_env($envvars);
2002 my ($self, $envvars) = @_;
2003 my $title = "SAMBA LOG of: $envvars->{NETBIOSNAME} pid $envvars->{SAMBA_PID}\n";
2006 open(LOG, "<$envvars->{SAMBA_TEST_LOG}");
2008 seek(LOG, $envvars->{SAMBA_TEST_LOG_POS}, SEEK_SET);
2012 $envvars->{SAMBA_TEST_LOG_POS} = tell(LOG);
2015 return "" if $out eq $title;
2022 my ($self, $envvars) = @_;
2023 my $samba_pid = $envvars->{SAMBA_PID};
2025 if (not defined($samba_pid)) {
2027 } elsif ($samba_pid > 0) {
2028 my $childpid = Samba::cleanup_child($samba_pid, "samba");
2030 if ($childpid == 0) {
2039 # Declare the environments Samba4 makes available.
2040 # To be set up, they will be called as
2041 # samba4->setup_$envname($self, $path, $dep_1_vars, $dep_2_vars, ...)
2042 # The interdependencies between the testenvs are declared below. Some testenvs
2043 # are dependent on another testenv running first, e.g. vampire_dc is dependent
2044 # on ad_dc_ntvfs because vampire_dc joins ad_dc_ntvfs's domain. All DCs are
2045 # dependent on dns_hub, which handles resolving DNS queries for the realm.
2046 %Samba4::ENV_DEPS = (
2047 # name => [dep_1, dep_2, ...],
2049 ad_dc_ntvfs => ["dns_hub"],
2050 ad_dc => ["dns_hub"],
2051 ad_dc_no_nss => ["dns_hub"],
2052 ad_dc_no_ntlm => ["dns_hub"],
2054 fl2008r2dc => ["ad_dc"],
2055 fl2003dc => ["ad_dc"],
2056 fl2000dc => ["ad_dc"],
2058 vampire_2000_dc => ["fl2000dc"],
2059 vampire_dc => ["ad_dc_ntvfs"],
2060 promoted_dc => ["ad_dc_ntvfs"],
2062 rodc => ["ad_dc_ntvfs"],
2063 rpc_proxy => ["ad_dc_ntvfs"],
2064 chgdcpass => ["dns_hub"],
2066 s4member_dflt_domain => ["ad_dc_ntvfs"],
2067 s4member => ["ad_dc_ntvfs"],
2069 # envs that test the server process model
2070 proclimitdc => ["dns_hub"],
2071 preforkrestartdc => ["dns_hub"],
2073 # backup/restore testenvs
2074 backupfromdc => ["dns_hub"],
2075 customdc => ["dns_hub"],
2076 restoredc => ["backupfromdc"],
2077 renamedc => ["backupfromdc"],
2078 offlinebackupdc => ["backupfromdc"],
2079 labdc => ["backupfromdc"],
2081 # aliases in order to split autbuild tasks
2082 fl2008dc => ["ad_dc_ntvfs"],
2083 ad_dc_default => ["ad_dc_ntvfs"],
2084 ad_dc_slowtests => ["ad_dc_ntvfs"],
2085 ad_dc_backup => ["ad_dc"],
2087 schema_dc => ["dns_hub"],
2088 schema_pair_dc => ["schema_dc"],
2093 %Samba4::ENV_DEPS_POST = (
2094 schema_dc => ["schema_pair_dc"],
2097 sub return_alias_env
2099 my ($self, $path, $env) = @_;
2107 my ($self, $path) = @_;
2109 my $extra_args = ["--base-schema=2008_R2"];
2110 my $env = $self->provision_ad_dc_ntvfs($path, $extra_args);
2112 if (not defined($self->check_or_start($env, "standard"))) {
2113 warn("Failed to start fl2008dc");
2120 sub setup_ad_dc_default
2122 my ($self, $path, $dep_env) = @_;
2123 return $self->return_alias_env($path, $dep_env)
2126 sub setup_ad_dc_slowtests
2128 my ($self, $path, $dep_env) = @_;
2129 return $self->return_alias_env($path, $dep_env)
2132 sub setup_ad_dc_backup
2134 my ($self, $path, $dep_env) = @_;
2135 return $self->return_alias_env($path, $dep_env)
2140 my ($self, $path, $dc_vars) = @_;
2142 my $env = $self->provision_s4member($path, $dc_vars, "s4member");
2145 if (not defined($self->check_or_start($env, "standard"))) {
2153 sub setup_s4member_dflt_domain
2155 my ($self, $path, $dc_vars) = @_;
2157 my $env = $self->provision_s4member($path, $dc_vars, "s4member_dflt",
2158 "winbind use default domain = yes");
2161 if (not defined($self->check_or_start($env, "standard"))) {
2171 my ($self, $path, $dc_vars) = @_;
2173 my $env = $self->provision_rpc_proxy($path, $dc_vars);
2176 if (not defined($self->check_or_start($env, "standard"))) {
2183 sub setup_ad_dc_ntvfs
2185 my ($self, $path) = @_;
2187 my $env = $self->provision_ad_dc_ntvfs($path, undef);
2189 if (not defined($self->check_or_start($env, "standard"))) {
2190 warn("Failed to start ad_dc_ntvfs");
2199 my ($self, $path) = @_;
2201 my $env = $self->provision_chgdcpass($path);
2203 if (not defined($self->check_or_start($env, "standard"))) {
2212 my ($self, $path, $dc_vars) = @_;
2214 my $env = $self->provision_fl2000dc($path);
2216 if (not defined($self->check_or_start($env, "standard"))) {
2220 $env = $self->setup_trust($env, $dc_vars, "external", "--no-aes-keys --direction=incoming");
2228 my ($self, $path, $dc_vars) = @_;
2230 my $env = $self->provision_fl2003dc($path);
2233 if (not defined($self->check_or_start($env, "standard"))) {
2237 $env = $self->setup_trust($env, $dc_vars, "external", "--no-aes-keys");
2242 sub setup_fl2008r2dc
2244 my ($self, $path, $dc_vars) = @_;
2246 my $env = $self->provision_fl2008r2dc($path);
2249 if (not defined($self->check_or_start($env, "standard"))) {
2253 my $upn_array = ["$env->{REALM}.upn"];
2254 my $spn_array = ["$env->{REALM}.spn"];
2256 $self->setup_namespaces($env, $upn_array, $spn_array);
2258 $env = $self->setup_trust($env, $dc_vars, "forest", "");
2264 sub setup_vampire_dc
2266 return setup_generic_vampire_dc(@_, "2008");
2269 sub setup_vampire_2000_dc
2271 return setup_generic_vampire_dc(@_, "2000");
2274 sub setup_generic_vampire_dc
2276 my ($self, $path, $dc_vars, $fl) = @_;
2278 my $env = $self->provision_vampire_dc($path, $dc_vars, $fl);
2281 if (not defined($self->check_or_start($env, "single"))) {
2285 # force replicated DC to update repsTo/repsFrom
2286 # for vampired partitions
2287 my $samba_tool = Samba::bindir_path($self, "samba-tool");
2289 # as 'vampired' dc may add data in its local replica
2290 # we need to synchronize data between DCs
2291 my $base_dn = "DC=".join(",DC=", split(/\./, $dc_vars->{REALM}));
2292 my $cmd = $self->get_cmd_env_vars($env);
2293 $cmd .= " $samba_tool drs replicate $env->{DC_SERVER} $env->{SERVER}";
2294 $cmd .= " $dc_vars->{CONFIGURATION}";
2295 $cmd .= " -U$dc_vars->{DC_USERNAME}\%$dc_vars->{DC_PASSWORD}";
2296 # replicate Configuration NC
2297 my $cmd_repl = "$cmd \"CN=Configuration,$base_dn\"";
2298 unless(system($cmd_repl) == 0) {
2299 warn("Failed to replicate\n$cmd_repl");
2302 # replicate Default NC
2303 $cmd_repl = "$cmd \"$base_dn\"";
2304 unless(system($cmd_repl) == 0) {
2305 warn("Failed to replicate\n$cmd_repl");
2309 # Pull in a full set of changes from the main DC
2310 my $base_dn = "DC=".join(",DC=", split(/\./, $dc_vars->{REALM}));
2311 $cmd = $self->get_cmd_env_vars($env);
2312 $cmd .= " $samba_tool drs replicate $env->{SERVER} $env->{DC_SERVER}";
2313 $cmd .= " $dc_vars->{CONFIGURATION}";
2314 $cmd .= " -U$dc_vars->{DC_USERNAME}\%$dc_vars->{DC_PASSWORD}";
2315 # replicate Configuration NC
2316 my $cmd_repl = "$cmd \"CN=Configuration,$base_dn\"";
2317 unless(system($cmd_repl) == 0) {
2318 warn("Failed to replicate\n$cmd_repl");
2321 # replicate Default NC
2322 $cmd_repl = "$cmd \"$base_dn\"";
2323 unless(system($cmd_repl) == 0) {
2324 warn("Failed to replicate\n$cmd_repl");
2332 sub setup_promoted_dc
2334 my ($self, $path, $dc_vars) = @_;
2336 my $env = $self->provision_promoted_dc($path, $dc_vars);
2339 if (not defined($self->check_or_start($env, "single"))) {
2343 # force source and replicated DC to update repsTo/repsFrom
2344 # for vampired partitions
2345 my $samba_tool = Samba::bindir_path($self, "samba-tool");
2346 my $cmd = "NSS_WRAPPER_HOSTS='$env->{NSS_WRAPPER_HOSTS}' ";
2347 # as 'vampired' dc may add data in its local replica
2348 # we need to synchronize data between DCs
2349 my $base_dn = "DC=".join(",DC=", split(/\./, $dc_vars->{REALM}));
2350 $cmd = "SOCKET_WRAPPER_DEFAULT_IFACE=\"$env->{SOCKET_WRAPPER_DEFAULT_IFACE}\"";
2351 $cmd .= " KRB5_CONFIG=\"$env->{KRB5_CONFIG}\"";
2352 $cmd .= "KRB5CCNAME=\"$env->{KRB5_CCACHE}\" ";
2353 $cmd .= "RESOLV_CONF=\"$env->{RESOLV_CONF}\" ";
2354 $cmd .= " $samba_tool drs replicate $env->{DC_SERVER} $env->{SERVER}";
2355 $cmd .= " $dc_vars->{CONFIGURATION}";
2356 $cmd .= " -U$dc_vars->{DC_USERNAME}\%$dc_vars->{DC_PASSWORD}";
2357 # replicate Configuration NC
2358 my $cmd_repl = "$cmd \"CN=Configuration,$base_dn\"";
2359 unless(system($cmd_repl) == 0) {
2360 warn("Failed to replicate\n$cmd_repl");
2363 # replicate Default NC
2364 $cmd_repl = "$cmd \"$base_dn\"";
2365 unless(system($cmd_repl) == 0) {
2366 warn("Failed to replicate\n$cmd_repl");
2376 my ($self, $path, $dc_vars) = @_;
2378 my $env = $self->provision_rodc($path, $dc_vars);
2384 if (not defined($self->check_or_start($env, "standard"))) {
2388 my $samba_tool = Samba::bindir_path($self, "samba-tool");
2391 my $base_dn = "DC=".join(",DC=", split(/\./, $dc_vars->{REALM}));
2392 $cmd .= "NSS_WRAPPER_HOSTS='$env->{NSS_WRAPPER_HOSTS}' ";
2393 $cmd .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$env->{SOCKET_WRAPPER_DEFAULT_IFACE}\"";
2394 $cmd .= " KRB5_CONFIG=\"$env->{KRB5_CONFIG}\"";
2395 $cmd .= "KRB5CCNAME=\"$env->{KRB5_CCACHE}\" ";
2396 $cmd .= "RESOLV_CONF=\"$env->{RESOLV_CONF}\" ";
2397 $cmd .= " $samba_tool drs replicate $env->{SERVER} $env->{DC_SERVER}";
2398 $cmd .= " $dc_vars->{CONFIGURATION}";
2399 $cmd .= " -U$dc_vars->{DC_USERNAME}\%$dc_vars->{DC_PASSWORD}";
2400 # replicate Configuration NC
2401 my $cmd_repl = "$cmd \"CN=Configuration,$base_dn\"";
2402 unless(system($cmd_repl) == 0) {
2403 warn("Failed to replicate\n$cmd_repl");
2406 # replicate Default NC
2407 $cmd_repl = "$cmd \"$base_dn\"";
2408 unless(system($cmd_repl) == 0) {
2409 warn("Failed to replicate\n$cmd_repl");
2418 my ($self, $path) = @_;
2420 # If we didn't build with ADS, pretend this env was never available
2421 if (not $self->{target3}->have_ads()) {
2425 my $env = $self->provision_ad_dc($path, "addc", "ADDOMAIN",
2426 "addom.samba.example.com", "", undef);
2431 if (not defined($self->check_or_start($env, "prefork"))) {
2435 my $upn_array = ["$env->{REALM}.upn"];
2436 my $spn_array = ["$env->{REALM}.spn"];
2438 $self->setup_namespaces($env, $upn_array, $spn_array);
2443 sub setup_ad_dc_no_nss
2445 my ($self, $path) = @_;
2447 # If we didn't build with ADS, pretend this env was never available
2448 if (not $self->{target3}->have_ads()) {
2452 my $env = $self->provision_ad_dc($path, "addc_no_nss", "ADNONSSDOMAIN",
2453 "adnonssdom.samba.example.com", "", undef);
2458 $env->{NSS_WRAPPER_MODULE_SO_PATH} = undef;
2459 $env->{NSS_WRAPPER_MODULE_FN_PREFIX} = undef;
2461 if (not defined($self->check_or_start($env, "single"))) {
2465 my $upn_array = ["$env->{REALM}.upn"];
2466 my $spn_array = ["$env->{REALM}.spn"];
2468 $self->setup_namespaces($env, $upn_array, $spn_array);
2473 sub setup_ad_dc_no_ntlm
2475 my ($self, $path) = @_;
2477 # If we didn't build with ADS, pretend this env was never available
2478 if (not $self->{target3}->have_ads()) {
2482 my $env = $self->provision_ad_dc($path, "addc_no_ntlm", "ADNONTLMDOMAIN",
2483 "adnontlmdom.samba.example.com",
2484 "ntlm auth = disabled", undef);
2489 if (not defined($self->check_or_start($env, "prefork"))) {
2493 my $upn_array = ["$env->{REALM}.upn"];
2494 my $spn_array = ["$env->{REALM}.spn"];
2496 $self->setup_namespaces($env, $upn_array, $spn_array);
2502 # AD DC test environment used solely to test pre-fork process restarts.
2503 # As processes get killed off and restarted it should not be used for other
2504 sub setup_preforkrestartdc
2506 my ($self, $path) = @_;
2508 # If we didn't build with ADS, pretend this env was never available
2509 if (not $self->{target3}->have_ads()) {
2513 # note DC name must be <= 15 chars so we use 'prockill' instead of
2515 my $env = $self->provision_ad_dc(
2519 "prockilldom.samba.example.com",
2520 "prefork backoff increment = 5\nprefork maximum backoff=10");
2525 $env->{NSS_WRAPPER_MODULE_SO_PATH} = undef;
2526 $env->{NSS_WRAPPER_MODULE_FN_PREFIX} = undef;
2528 if (not defined($self->check_or_start($env, "prefork"))) {
2532 my $upn_array = ["$env->{REALM}.upn"];
2533 my $spn_array = ["$env->{REALM}.spn"];
2535 $self->setup_namespaces($env, $upn_array, $spn_array);
2541 # ad_dc test environment used solely to test standard process model connection
2542 # process limits. As the limit is set artificially low it should not be used
2544 sub setup_proclimitdc
2546 my ($self, $path) = @_;
2548 # If we didn't build with ADS, pretend this env was never available
2549 if (not $self->{target3}->have_ads()) {
2553 my $env = $self->provision_ad_dc(
2557 "proclimit.samba.example.com",
2558 "max smbd processes = 20");
2563 $env->{NSS_WRAPPER_MODULE_SO_PATH} = undef;
2564 $env->{NSS_WRAPPER_MODULE_FN_PREFIX} = undef;
2566 if (not defined($self->check_or_start($env, "standard"))) {
2570 my $upn_array = ["$env->{REALM}.upn"];
2571 my $spn_array = ["$env->{REALM}.spn"];
2573 $self->setup_namespaces($env, $upn_array, $spn_array);
2578 # Used to test a live upgrade of the schema on a 2 DC network.
2581 my ($self, $path) = @_;
2583 # provision the PDC using an older base schema
2584 my $provision_args = ["--base-schema=2008_R2", "--backend-store=mdb"];
2586 my $env = $self->provision_ad_dc($path, "liveupgrade1dc", "SCHEMADOMAIN",
2587 "schema.samba.example.com",
2588 "drs: max link sync = 2",
2594 if (not defined($self->check_or_start($env, "prefork"))) {
2598 my $upn_array = ["$env->{REALM}.upn"];
2599 my $spn_array = ["$env->{REALM}.spn"];
2601 $self->setup_namespaces($env, $upn_array, $spn_array);
2606 # the second DC in the live schema upgrade pair
2607 sub setup_schema_pair_dc
2609 # note: dcvars contains the env info for the dependent testenv ('schema_dc')
2610 my ($self, $prefix, $dcvars) = @_;
2611 print "Preparing SCHEMA UPGRADE PAIR DC...\n";
2613 my ($env, $ctx) = $self->prepare_dc_testenv($prefix, "liveupgrade2dc",
2616 $dcvars->{PASSWORD},
2619 my $samba_tool = Samba::bindir_path($self, "samba-tool");
2620 my $cmd_vars = "NSS_WRAPPER_HOSTS='$env->{NSS_WRAPPER_HOSTS}' ";
2621 $cmd_vars .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$env->{SOCKET_WRAPPER_DEFAULT_IFACE}\" ";
2622 if (defined($env->{RESOLV_WRAPPER_CONF})) {
2623 $cmd_vars .= "RESOLV_WRAPPER_CONF=\"$env->{RESOLV_WRAPPER_CONF}\" ";
2625 $cmd_vars .= "RESOLV_WRAPPER_HOSTS=\"$env->{RESOLV_WRAPPER_HOSTS}\" ";
2627 $cmd_vars .= "KRB5_CONFIG=\"$env->{KRB5_CONFIG}\" ";
2628 $cmd_vars .= "KRB5CCNAME=\"$env->{KRB5_CCACHE}\" ";
2629 $cmd_vars .= "RESOLV_CONF=\"$env->{RESOLV_CONF}\" ";
2631 my $join_cmd = $cmd_vars;
2632 $join_cmd .= "$samba_tool domain join $env->{CONFIGURATION} $dcvars->{REALM} DC --realm=$dcvars->{REALM}";
2633 $join_cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD} ";
2634 $join_cmd .= " --backend-store=mdb";
2636 my $upgrade_cmd = $cmd_vars;
2637 $upgrade_cmd .= "$samba_tool domain schemaupgrade $dcvars->{CONFIGURATION}";
2638 $upgrade_cmd .= " -U$dcvars->{USERNAME}\%$dcvars->{PASSWORD}";
2640 my $repl_cmd = $cmd_vars;
2641 $repl_cmd .= "$samba_tool drs replicate $env->{SERVER} $dcvars->{SERVER}";
2642 $repl_cmd .= " CN=Schema,CN=Configuration,DC=schema,DC=samba,DC=example,DC=com";
2643 $repl_cmd .= " -U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
2645 unless (system($join_cmd) == 0) {
2646 warn("Join failed\n$join_cmd");
2650 $env->{DC_SERVER} = $dcvars->{SERVER};
2651 $env->{DC_SERVER_IP} = $dcvars->{SERVER_IP};
2652 $env->{DC_SERVER_IPV6} = $dcvars->{SERVER_IPV6};
2653 $env->{DC_NETBIOSNAME} = $dcvars->{NETBIOSNAME};
2655 # start samba for the new DC
2656 if (not defined($self->check_or_start($env, "standard"))) {
2660 unless (system($upgrade_cmd) == 0) {
2661 warn("Schema upgrade failed\n$upgrade_cmd");
2665 unless (system($repl_cmd) == 0) {
2666 warn("Post-update schema replication failed\n$repl_cmd");
2673 # Sets up a DC that's solely used to do a domain backup from. We then use the
2674 # backupfrom-DC to create the restore-DC - this proves that the backup/restore
2675 # process will create a Samba DC that will actually start up.
2676 # We don't use the backup-DC for anything else because its domain will conflict
2677 # with the restore DC.
2678 sub setup_backupfromdc
2680 my ($self, $path) = @_;
2682 # If we didn't build with ADS, pretend this env was never available
2683 if (not $self->{target3}->have_ads()) {
2687 my $provision_args = ["--site=Backup-Site"];
2689 my $env = $self->provision_ad_dc($path, "backupfromdc", "BACKUPDOMAIN",
2690 "backupdom.samba.example.com",
2691 "samba kcc command = /bin/true",
2697 if (not defined($self->check_or_start($env))) {
2701 my $upn_array = ["$env->{REALM}.upn"];
2702 my $spn_array = ["$env->{REALM}.spn"];
2704 $self->setup_namespaces($env, $upn_array, $spn_array);
2709 # returns the server/user-auth params needed to run an online backup cmd
2710 sub get_backup_server_args
2712 # dcvars contains the env info for the backup DC testenv
2713 my ($self, $dcvars) = @_;
2714 my $server = $dcvars->{DC_SERVER_IP};
2715 my $server_args = "--server=$server ";
2716 $server_args .= "-U$dcvars->{DC_USERNAME}\%$dcvars->{DC_PASSWORD}";
2717 $server_args .= " $dcvars->{CONFIGURATION}";
2719 return $server_args;
2722 # Creates a backup of a running testenv DC
2725 # note: dcvars contains the env info for the backup DC testenv
2726 my ($self, $env, $dcvars, $backupdir, $backup_cmd) = @_;
2728 # get all the env variables we pass in with the samba-tool command
2729 my $cmd_env = "NSS_WRAPPER_HOSTS='$env->{NSS_WRAPPER_HOSTS}' ";
2730 $cmd_env .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$env->{SOCKET_WRAPPER_DEFAULT_IFACE}\" ";
2731 if (defined($env->{RESOLV_WRAPPER_CONF})) {
2732 $cmd_env .= "RESOLV_WRAPPER_CONF=\"$env->{RESOLV_WRAPPER_CONF}\" ";
2734 $cmd_env .= "RESOLV_WRAPPER_HOSTS=\"$env->{RESOLV_WRAPPER_HOSTS}\" ";
2736 # Note: use the backupfrom-DC's krb5.conf to do the backup
2737 $cmd_env .= " KRB5_CONFIG=\"$dcvars->{KRB5_CONFIG}\" ";
2738 $cmd_env .= "KRB5CCNAME=\"$env->{KRB5_CCACHE}\" ";
2740 # use samba-tool to create a backup from the 'backupfromdc' DC
2742 my $samba_tool = Samba::bindir_path($self, "samba-tool");
2744 $cmd .= "$cmd_env $samba_tool domain backup $backup_cmd";
2745 $cmd .= " --targetdir=$backupdir";
2747 print "Executing: $cmd\n";
2748 unless(system($cmd) == 0) {
2749 warn("Failed to create backup using: \n$cmd");
2753 # get the name of the backup file created
2754 opendir(DIR, $backupdir);
2755 my @files = grep(/\.tar/, readdir(DIR));
2758 if(scalar @files != 1) {
2759 warn("Backup file not found in directory $backupdir\n");
2762 my $backup_file = "$backupdir/$files[0]";
2763 print "Using backup file $backup_file...\n";
2765 return $backup_file;
2768 # Restores a backup-file to populate a testenv for a new DC
2769 sub restore_backup_file
2771 my ($self, $backup_file, $restore_opts, $restoredir, $smbconf) = @_;
2773 # pass the restore command the testenv's smb.conf that we've already
2774 # generated. But move it to a temp-dir first, so that the restore doesn't
2776 my $tmpdir = File::Temp->newdir();
2777 my $tmpconf = "$tmpdir/smb.conf";
2778 my $cmd = "cp $smbconf $tmpconf";
2779 unless(system($cmd) == 0) {
2780 warn("Failed to backup smb.conf using: \n$cmd");
2784 my $samba_tool = Samba::bindir_path($self, "samba-tool");
2785 $cmd = "$samba_tool domain backup restore --backup-file=$backup_file";
2786 $cmd .= " --targetdir=$restoredir $restore_opts --configfile=$tmpconf";
2788 print "Executing: $cmd\n";
2789 unless(system($cmd) == 0) {
2790 warn("Failed to restore backup using: \n$cmd");
2794 print "Restore complete\n";
2798 # sets up the initial directory and returns the new testenv's env info
2799 # (without actually doing a 'domain join')
2800 sub prepare_dc_testenv
2802 my ($self, $prefix, $dcname, $domain, $realm,
2803 $password, $conf_options) = @_;
2805 my $ctx = $self->provision_raw_prepare($prefix, "domain controller",
2815 # the restore uses a slightly different state-dir location to other testenvs
2816 $ctx->{statedir} = "$ctx->{prefix_abs}/state";
2817 push(@{$ctx->{directories}}, "$ctx->{statedir}");
2819 # add support for sysvol/netlogon/tmp shares
2820 $ctx->{share} = "$ctx->{prefix_abs}/share";
2821 push(@{$ctx->{directories}}, "$ctx->{share}");
2822 push(@{$ctx->{directories}}, "$ctx->{share}/test1");
2824 $ctx->{smb_conf_extra_options} = "
2827 server max protocol = SMB2
2828 samba kcc command = /bin/true
2829 xattr_tdb:file = $ctx->{statedir}/xattr.tdb
2832 path = $ctx->{statedir}/sysvol
2836 path = $ctx->{statedir}/sysvol/$ctx->{dnsname}/scripts
2840 path = $ctx->{share}
2842 posix:sharedelay = 10000
2843 posix:oplocktimeout = 3
2844 posix:writetimeupdatedelay = 50000
2847 path = $ctx->{share}/test1
2849 posix:sharedelay = 100000
2850 posix:oplocktimeout = 3
2851 posix:writetimeupdatedelay = 500000
2854 my $env = $self->provision_raw_step1($ctx);
2856 return ($env, $ctx);
2860 # Set up a DC testenv solely by using the samba-tool domain backup/restore
2861 # commands. This proves that we can backup an online DC ('backupfromdc') and
2862 # use the backup file to create a valid, working samba DC.
2865 # note: dcvars contains the env info for the dependent testenv ('backupfromdc')
2866 my ($self, $prefix, $dcvars) = @_;
2867 print "Preparing RESTORE DC...\n";
2869 # we arbitrarily designate the restored DC as having SMBv1 disabled
2871 server min protocol = SMB2
2872 client min protocol = SMB2
2873 prefork children = 1";
2875 my ($env, $ctx) = $self->prepare_dc_testenv($prefix, "restoredc",
2878 $dcvars->{PASSWORD},
2881 # create a backup of the 'backupfromdc'
2882 my $backupdir = File::Temp->newdir();
2883 my $server_args = $self->get_backup_server_args($dcvars);
2884 my $backup_args = "online $server_args";
2885 my $backup_file = $self->create_backup($env, $dcvars, $backupdir,
2887 unless($backup_file) {
2891 # restore the backup file to populate the restore-DC testenv
2892 my $restore_dir = abs_path($prefix);
2893 my $ret = $self->restore_backup_file($backup_file,
2894 "--newservername=$env->{SERVER}",
2895 $restore_dir, $env->{SERVERCONFFILE});
2896 unless ($ret == 0) {
2900 # start samba for the restored DC
2901 if (not defined($self->check_or_start($env))) {
2908 # Set up a DC testenv solely by using the 'samba-tool domain backup rename' and
2909 # restore commands. This proves that we can backup and rename an online DC
2910 # ('backupfromdc') and use the backup file to create a valid, working samba DC.
2913 # note: dcvars contains the env info for the dependent testenv ('backupfromdc')
2914 my ($self, $prefix, $dcvars) = @_;
2915 print "Preparing RENAME DC...\n";
2916 my $extra_conf = "prefork children = 1";
2918 my $realm = "renamedom.samba.example.com";
2919 my ($env, $ctx) = $self->prepare_dc_testenv($prefix, "renamedc",
2920 "RENAMEDOMAIN", $realm,
2921 $dcvars->{PASSWORD}, $extra_conf);
2923 # create a backup of the 'backupfromdc' which renames the domain
2924 my $backupdir = File::Temp->newdir();
2925 my $server_args = $self->get_backup_server_args($dcvars);
2926 my $backup_args = "rename $env->{DOMAIN} $env->{REALM} $server_args";
2927 $backup_args .= " --backend-store=tdb";
2928 my $backup_file = $self->create_backup($env, $dcvars, $backupdir,
2930 unless($backup_file) {
2934 # restore the backup file to populate the rename-DC testenv
2935 my $restore_dir = abs_path($prefix);
2936 my $restore_opts = "--newservername=$env->{SERVER} --host-ip=$env->{SERVER_IP}";
2937 my $ret = $self->restore_backup_file($backup_file, $restore_opts,
2938 $restore_dir, $env->{SERVERCONFFILE});
2939 unless ($ret == 0) {
2943 # start samba for the restored DC
2944 if (not defined($self->check_or_start($env))) {
2948 my $upn_array = ["$env->{REALM}.upn"];
2949 my $spn_array = ["$env->{REALM}.spn"];
2951 $self->setup_namespaces($env, $upn_array, $spn_array);
2956 # Set up a DC testenv solely by using the 'samba-tool domain backup offline' and
2957 # restore commands. This proves that we do an offline backup of a local DC
2958 # ('backupfromdc') and use the backup file to create a valid, working samba DC.
2959 sub setup_offlinebackupdc
2961 # note: dcvars contains the env info for the dependent testenv ('backupfromdc')
2962 my ($self, $prefix, $dcvars) = @_;
2963 print "Preparing OFFLINE BACKUP DC...\n";
2964 my $extra_conf = "prefork children = 1";
2966 my ($env, $ctx) = $self->prepare_dc_testenv($prefix, "offlinebackupdc",
2969 $dcvars->{PASSWORD}, $extra_conf);
2971 # create an offline backup of the 'backupfromdc' target
2972 my $backupdir = File::Temp->newdir();
2973 my $cmd = "offline -s $dcvars->{SERVERCONFFILE}";
2974 my $backup_file = $self->create_backup($env, $dcvars,
2977 unless($backup_file) {
2981 # restore the backup file to populate the rename-DC testenv
2982 my $restore_dir = abs_path($prefix);
2983 my $restore_opts = "--newservername=$env->{SERVER} --host-ip=$env->{SERVER_IP}";
2984 my $ret = $self->restore_backup_file($backup_file, $restore_opts,
2985 $restore_dir, $env->{SERVERCONFFILE});
2986 unless ($ret == 0) {
2990 # re-create the testenv's krb5.conf (the restore may have overwritten it)
2991 Samba::mk_krb5_conf($ctx);
2993 # start samba for the restored DC
2994 if (not defined($self->check_or_start($env))) {
3001 # Set up a DC testenv solely by using the samba-tool 'domain backup rename' and
3002 # restore commands, using the --no-secrets option. This proves that we can
3003 # create a realistic lab environment from an online DC ('backupfromdc').
3006 # note: dcvars contains the env info for the dependent testenv ('backupfromdc')
3007 my ($self, $prefix, $dcvars) = @_;
3008 print "Preparing LAB-DOMAIN DC...\n";
3009 my $extra_conf = "prefork children = 1";
3011 my ($env, $ctx) = $self->prepare_dc_testenv($prefix, "labdc",
3013 "labdom.samba.example.com",
3014 $dcvars->{PASSWORD}, $extra_conf);
3016 # create a backup of the 'backupfromdc' which renames the domain and uses
3017 # the --no-secrets option to scrub any sensitive info
3018 my $backupdir = File::Temp->newdir();
3019 my $server_args = $self->get_backup_server_args($dcvars);
3020 my $backup_args = "rename $env->{DOMAIN} $env->{REALM} $server_args";
3021 $backup_args .= " --no-secrets --backend-store=mdb";
3022 my $backup_file = $self->create_backup($env, $dcvars, $backupdir,
3024 unless($backup_file) {
3028 # restore the backup file to populate the lab-DC testenv
3029 my $restore_dir = abs_path($prefix);
3030 my $restore_opts = "--newservername=$env->{SERVER} --host-ip=$env->{SERVER_IP}";
3031 my $ret = $self->restore_backup_file($backup_file, $restore_opts,
3032 $restore_dir, $env->{SERVERCONFFILE});
3033 unless ($ret == 0) {
3037 # because we don't include any secrets in the backup, we need to reset the
3038 # admin user's password back to what the testenv expects
3039 my $samba_tool = Samba::bindir_path($self, "samba-tool");
3040 my $cmd = "$samba_tool user setpassword $env->{USERNAME} ";
3041 $cmd .= "--newpassword=$env->{PASSWORD} -H $restore_dir/private/sam.ldb";
3042 $cmd .= " $env->{CONFIGURATION}";
3044 unless(system($cmd) == 0) {
3045 warn("Failed to reset admin's password: \n$cmd");
3049 # start samba for the restored DC
3050 if (not defined($self->check_or_start($env))) {
3054 my $upn_array = ["$env->{REALM}.upn"];
3055 my $spn_array = ["$env->{REALM}.spn"];
3057 $self->setup_namespaces($env, $upn_array, $spn_array);
3062 # Inspects a backup *.tar.bz2 file and determines the realm/domain it contains
3063 sub get_backup_domain_realm
3065 my ($self, $backup_file) = @_;
3067 print "Determining REALM/DOMAIN values in backup...\n";
3069 # The backup will have the correct domain/realm values in the smb.conf.
3070 # So we can work out the env variables the testenv should use based on
3071 # that. Let's start by extracting the smb.conf
3072 my $tar = Archive::Tar->new($backup_file);
3073 my $tmpdir = File::Temp->newdir();
3074 my $smbconf = "$tmpdir/smb.conf";
3076 # note that the filepaths within the tar-file differ slightly for online
3077 # and offline backups
3078 if ($tar->contains_file("etc/smb.conf")) {
3079 $tar->extract_file("etc/smb.conf", $smbconf);
3080 } elsif ($tar->contains_file("./etc/smb.conf")) {
3081 $tar->extract_file("./etc/smb.conf", $smbconf);
3083 warn("Could not find smb.conf in $backup_file");
3084 return undef, undef;
3087 # make sure we don't try to create locks/sockets in the default install
3088 # location (i.e. /usr/local/samba/)
3089 my $options = "--option=\"private dir = $tmpdir\"";
3090 $options .= " --option=\"lock dir = $tmpdir\"";
3092 # now use testparm to read the values we're interested in
3093 my $testparm = Samba::bindir_path($self, "testparm");
3094 my $domain = `$testparm $smbconf -sl --parameter-name=WORKGROUP $options`;
3095 my $realm = `$testparm $smbconf -sl --parameter-name=REALM $options`;
3098 print "Backup-file REALM is $realm, DOMAIN is $domain\n";
3100 return ($domain, $realm);
3103 # This spins up a custom testenv that can be based on any backup-file you want.
3104 # This is just intended for manual testing (rather than automated test-cases)
3107 my ($self, $prefix) = @_;
3108 print "Preparing CUSTOM RESTORE DC...\n";
3109 my $dc_name = "customdc";
3110 my $password = "locDCpass1";
3111 my $backup_file = $ENV{'BACKUP_FILE'};
3113 # user must specify a backup file to restore via an ENV variable, i.e.
3114 # BACKUP_FILE=backup-blah.tar.bz2 SELFTEST_TESTENV=customdc make testenv
3115 if (not defined($backup_file)) {
3116 warn("Please specify BACKUP_FILE");
3120 # work out the correct domain/realm env values from the backup-file
3121 my ($domain, $realm) = $self->get_backup_domain_realm($backup_file);
3122 if ($domain eq '' or $realm eq '') {
3123 warn("Could not determine domain or realm");
3127 # create a placeholder directory and smb.conf, as well as the env vars.
3128 my ($env, $ctx) = $self->prepare_dc_testenv($prefix, $dc_name,
3129 $domain, $realm, $password, "");
3131 # restore the specified backup file to populate the testenv
3132 my $restore_dir = abs_path($prefix);
3133 my $ret = $self->restore_backup_file($backup_file,
3134 "--newservername=$env->{SERVER}",
3135 $restore_dir, $env->{SERVERCONFFILE});
3136 unless ($ret == 0) {
3140 # Change the admin password to the testenv default, just in case it's
3141 # different, or in case this was a --no-secrets backup
3142 my $samba_tool = Samba::bindir_path($self, "samba-tool");
3143 my $cmd = "$samba_tool user setpassword $env->{USERNAME} ";
3144 $cmd .= "--newpassword=$password -H $restore_dir/private/sam.ldb";
3145 $cmd .= " $env->{CONFIGURATION}";
3147 unless(system($cmd) == 0) {
3148 warn("Failed to reset admin's password: \n$cmd");
3152 # re-create the testenv's krb5.conf (the restore may have overwritten it,
3153 # if the backup-file was an offline backup)
3154 Samba::mk_krb5_conf($ctx);
3156 # start samba for the restored DC
3157 if (not defined($self->check_or_start($env))) {
3161 # if this was a backup-rename, then we may need to setup namespaces
3162 my $upn_array = ["$env->{REALM}.upn"];
3163 my $spn_array = ["$env->{REALM}.spn"];
3165 $self->setup_namespaces($env, $upn_array, $spn_array);
3172 my ($self, $path) = @_;
3175 KRB5_CONFIG => abs_path($path) . "/no_krb5.conf",