WHATSNEW: Update release notes.
[Samba.git] / selftest / target / Samba4.pm
blob71dddf69392d99a85aa9f8eb10ec1373b94bcb9d
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.
6 package Samba4;
8 use strict;
9 use Cwd qw(abs_path);
10 use FindBin qw($RealBin);
11 use POSIX;
13 sub new($$$$$) {
14 my ($classname, $bindir, $ldap, $setupdir, $exeext) = @_;
15 $exeext = "" unless defined($exeext);
16 my $self = {
17 vars => {},
18 ldap => $ldap,
19 bindir => $bindir,
20 setupdir => $setupdir,
21 exeext => $exeext
23 bless $self;
24 return $self;
27 sub bindir_path($$) {
28 my ($self, $path) = @_;
30 return "$self->{bindir}/$path$self->{exeext}";
33 sub openldap_start($$$) {
34 my ($slapd_conf, $uri, $logs) = @_;
35 my $oldpath = $ENV{PATH};
36 my $olroot = "";
37 my $olpath = "";
38 if (defined $ENV{OPENLDAP_ROOT}) {
39 $olroot = "$ENV{OPENLDAP_ROOT}";
40 $olpath = "$olroot/libexec:$olroot/sbin:";
42 $ENV{PATH} = "$olpath/usr/local/sbin:/usr/sbin:/sbin:$ENV{PATH}";
43 system("slapd -d0 -f $slapd_conf -h $uri > $logs 2>&1 &");
44 $ENV{PATH} = $oldpath;
47 sub slapd_start($$)
49 my $count = 0;
50 my ($self, $env_vars) = @_;
52 my $uri = $env_vars->{LDAP_URI};
54 # running slapd in the background means it stays in the same process group, so it can be
55 # killed by timelimit
56 if ($self->{ldap} eq "fedora-ds") {
57 system("$ENV{FEDORA_DS_ROOT}/sbin/ns-slapd -D $env_vars->{FEDORA_DS_DIR} -d0 -i $env_vars->{FEDORA_DS_PIDFILE}> $env_vars->{LDAPDIR}/logs 2>&1 &");
58 } elsif ($self->{ldap} eq "openldap") {
59 openldap_start($env_vars->{SLAPD_CONF}, $uri, "$env_vars->{LDAPDIR}/logs");
61 my $ldbsearch = $self->bindir_path("ldbsearch");
62 while (system("$ldbsearch -H $uri -s base -b \"\" supportedLDAPVersion > /dev/null") != 0) {
63 $count++;
64 if ($count > 40) {
65 $self->slapd_stop($env_vars);
66 return 0;
68 sleep(1);
70 return 1;
73 sub slapd_stop($$)
75 my ($self, $envvars) = @_;
76 if ($self->{ldap} eq "fedora-ds") {
77 system("$envvars->{LDAPDIR}/slapd-samba4/stop-slapd");
78 } elsif ($self->{ldap} eq "openldap") {
79 open(IN, "<$envvars->{OPENLDAP_PIDFILE}") or
80 die("unable to open slapd pid file: $envvars->{OPENLDAP_PIDFILE}");
81 kill 9, <IN>;
82 close(IN);
84 return 1;
87 sub check_or_start($$$)
89 my ($self, $env_vars, $max_time) = @_;
90 return 0 if ( -p $env_vars->{SAMBA_TEST_FIFO});
92 unlink($env_vars->{SAMBA_TEST_FIFO});
93 POSIX::mkfifo($env_vars->{SAMBA_TEST_FIFO}, 0700);
94 unlink($env_vars->{SAMBA_TEST_LOG});
96 print "STARTING SAMBA... ";
97 my $pid = fork();
98 if ($pid == 0) {
99 open STDIN, $env_vars->{SAMBA_TEST_FIFO};
100 open STDOUT, ">$env_vars->{SAMBA_TEST_LOG}";
101 open STDERR, '>&STDOUT';
103 SocketWrapper::set_default_iface($env_vars->{SOCKET_WRAPPER_DEFAULT_IFACE});
105 my $valgrind = "";
106 if (defined($ENV{SMBD_VALGRIND})) {
107 $valgrind = $ENV{SMBD_VALGRIND};
110 $ENV{KRB5_CONFIG} = $env_vars->{KRB5_CONFIG};
112 $ENV{NSS_WRAPPER_PASSWD} = $env_vars->{NSS_WRAPPER_PASSWD};
113 $ENV{NSS_WRAPPER_GROUP} = $env_vars->{NSS_WRAPPER_GROUP};
115 # Start slapd before samba, but with the fifo on stdin
116 if (defined($self->{ldap})) {
117 $self->slapd_start($env_vars) or
118 die("couldn't start slapd (2nd time)");
121 my $optarg = "";
122 if (defined($max_time)) {
123 $optarg = "--maximum-runtime=$max_time ";
125 if (defined($ENV{SMBD_OPTIONS})) {
126 $optarg.= " $ENV{SMBD_OPTIONS}";
128 my $samba = $self->bindir_path("samba");
129 my $ret = system("$valgrind $samba $optarg $env_vars->{CONFIGURATION} -M single -i --leak-report-full");
130 if ($? == -1) {
131 print "Unable to start $samba: $ret: $!\n";
132 exit 1;
134 unlink($env_vars->{SAMBA_TEST_FIFO});
135 my $exit = $? >> 8;
136 if ( $ret == 0 ) {
137 print "$samba exits with status $exit\n";
138 } elsif ( $ret & 127 ) {
139 print "$samba got signal ".($ret & 127)." and exits with $exit!\n";
140 } else {
141 $ret = $? >> 8;
142 print "$samba failed with status $exit!\n";
144 exit $exit;
146 print "DONE\n";
148 open(DATA, ">$env_vars->{SAMBA_TEST_FIFO}");
150 return $pid;
153 sub wait_for_start($$)
155 my ($self, $testenv_vars) = @_;
156 # give time for nbt server to register its names
157 print "delaying for nbt name registration\n";
158 sleep 2;
160 # This will return quickly when things are up, but be slow if we
161 # need to wait for (eg) SSL init
162 my $nmblookup = $self->bindir_path("nmblookup");
163 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{SERVER}");
164 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{SERVER}");
165 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSNAME}");
166 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSNAME}");
167 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSALIAS}");
168 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSALIAS}");
169 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{SERVER}");
170 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{SERVER}");
171 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSNAME}");
172 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSNAME}");
173 system("$nmblookup $testenv_vars->{CONFIGURATION} $testenv_vars->{NETBIOSALIAS}");
174 system("$nmblookup $testenv_vars->{CONFIGURATION} -U $testenv_vars->{SERVER_IP} $testenv_vars->{NETBIOSALIAS}");
176 print $self->getlog_env($testenv_vars);
179 sub write_ldb_file($$$)
181 my ($self, $file, $ldif) = @_;
183 my $ldbadd = $self->bindir_path("ldbadd");
184 open(LDIF, "|$ldbadd -H $file >/dev/null");
185 print LDIF $ldif;
186 return close(LDIF);
189 sub add_wins_config($$)
191 my ($self, $privatedir) = @_;
193 return $self->write_ldb_file("$privatedir/wins_config.ldb", "
194 dn: name=TORTURE_6,CN=PARTNERS
195 objectClass: wreplPartner
196 name: TORTURE_6
197 address: 127.0.0.6
198 pullInterval: 0
199 pushChangeCount: 0
200 type: 0x3
204 sub mk_fedora_ds($$$)
206 my ($self, $ldapdir, $configuration) = @_;
208 my $fedora_ds_inf = "$ldapdir/fedorads.inf";
209 my $fedora_ds_extra_ldif = "$ldapdir/fedorads-partitions.ldif";
211 #Make the subdirectory be as fedora DS would expect
212 my $fedora_ds_dir = "$ldapdir/slapd-samba4";
214 my $pidfile = "$fedora_ds_dir/logs/slapd-samba4.pid";
216 my $dir = getcwd();
217 chdir "$ENV{FEDORA_DS_ROOT}/bin" || die;
218 if (system("perl $ENV{FEDORA_DS_ROOT}/sbin/setup-ds.pl --silent --file=$fedora_ds_inf >&2") != 0) {
219 chdir $dir;
220 die("perl $ENV{FEDORA_DS_ROOT}/sbin/setup-ds.pl --silent --file=$fedora_ds_inf FAILED: $?");
222 chdir $dir || die;
224 return ($fedora_ds_dir, $pidfile);
227 sub mk_openldap($$$)
229 my ($self, $ldapdir, $configuration) = @_;
231 my $slapd_conf = "$ldapdir/slapd.conf";
232 my $pidfile = "$ldapdir/slapd.pid";
233 my $modconf = "$ldapdir/modules.conf";
235 my $oldpath = $ENV{PATH};
236 my $olpath = "";
237 my $olroot = "";
238 if (defined $ENV{OPENLDAP_ROOT}) {
239 $olroot = "$ENV{OPENLDAP_ROOT}";
240 $olpath = "$olroot/libexec:$olroot/sbin:";
242 $ENV{PATH} = "$olpath/usr/local/sbin:/usr/sbin:/sbin:$ENV{PATH}";
244 unlink($modconf);
246 #This code tries to guess what modules we need to load (if any) by trying different combinations in the modules.conf
248 # Try without any slapd modules
249 open(CONF, ">$modconf"); close(CONF);
251 if (system("slaptest -u -f $slapd_conf >&2") != 0) {
252 open(CONF, ">$modconf");
253 # enable slapd modules
254 print CONF "
255 moduleload syncprov
256 moduleload memberof
257 moduleload refint
258 moduleload deref
260 close(CONF);
262 if (system("slaptest -u -f $slapd_conf >&2") != 0) {
263 open(CONF, ">$modconf");
264 # enable slapd modules, and the module for back_hdb
265 print CONF "
266 moduleload back_hdb
267 moduleload syncprov
268 moduleload memberof
269 moduleload refint
270 moduleload deref
272 close(CONF);
275 system("slaptest -u -f $slapd_conf") == 0 or die("slaptest still fails after adding modules");
278 $ENV{PATH} = $oldpath;
280 return ($slapd_conf, $pidfile);
283 sub mk_keyblobs($$)
285 my ($self, $tlsdir) = @_;
287 #TLS and PKINIT crypto blobs
288 my $dhfile = "$tlsdir/dhparms.pem";
289 my $cafile = "$tlsdir/ca.pem";
290 my $certfile = "$tlsdir/cert.pem";
291 my $reqkdc = "$tlsdir/req-kdc.der";
292 my $kdccertfile = "$tlsdir/kdc.pem";
293 my $keyfile = "$tlsdir/key.pem";
294 my $adminkeyfile = "$tlsdir/adminkey.pem";
295 my $reqadmin = "$tlsdir/req-admin.der";
296 my $admincertfile = "$tlsdir/admincert.pem";
298 mkdir($tlsdir, 0777);
300 #This is specified here to avoid draining entropy on every run
301 open(DHFILE, ">$dhfile");
302 print DHFILE <<EOF;
303 -----BEGIN DH PARAMETERS-----
304 MGYCYQC/eWD2xkb7uELmqLi+ygPMKyVcpHUo2yCluwnbPutEueuxrG/Cys8j8wLO
305 svCN/jYNyR2NszOmg7ZWcOC/4z/4pWDVPUZr8qrkhj5MRKJc52MncfaDglvEdJrv
306 YX70obsCAQI=
307 -----END DH PARAMETERS-----
309 close(DHFILE);
311 #Likewise, we pregenerate the key material. This allows the
312 #other certificates to be pre-generated
313 open(KEYFILE, ">$keyfile");
314 print KEYFILE <<EOF;
315 -----BEGIN RSA PRIVATE KEY-----
316 MIICXQIBAAKBgQDKg6pAwCHUMA1DfHDmWhZfd+F0C+9Jxcqvpw9ii9En3E1uflpc
317 ol3+S9/6I/uaTmJHZre+DF3dTzb/UOZo0Zem8N+IzzkgoGkFafjXuT3BL5UPY2/H
318 6H+pPqVIRLOmrWImai359YyoKhFyo37Y6HPeU8QcZ+u2rS9geapIWfeuowIDAQAB
319 AoGAAqDLzFRR/BF1kpsiUfL4WFvTarCe9duhwj7ORc6fs785qAXuwUYAJ0Uvzmy6
320 HqoGv3t3RfmeHDmjcpPHsbOKnsOQn2MgmthidQlPBMWtQMff5zdoYNUFiPS0XQBq
321 szNW4PRjaA9KkLQVTwnzdXGkBSkn/nGxkaVu7OR3vJOBoo0CQQDO4upypesnbe6p
322 9/xqfZ2uim8IwV1fLlFClV7WlCaER8tsQF4lEi0XSzRdXGUD/dilpY88Nb+xok/X
323 8Z8OvgAXAkEA+pcLsx1gN7kxnARxv54jdzQjC31uesJgMKQXjJ0h75aUZwTNHmZQ
324 vPxi6u62YiObrN5oivkixwFNncT9MxTxVQJBAMaWUm2SjlLe10UX4Zdm1MEB6OsC
325 kVoX37CGKO7YbtBzCfTzJGt5Mwc1DSLA2cYnGJqIfSFShptALlwedot0HikCQAJu
326 jNKEKnbf+TdGY8Q0SKvTebOW2Aeg80YFkaTvsXCdyXrmdQcifw4WdO9KucJiDhSz
327 Y9hVapz7ykEJtFtWjLECQQDIlfc63I5ZpXfg4/nN4IJXUW6AmPVOYIA5215itgki
328 cSlMYli1H9MEXH0pQMGv5Qyd0OYIx2DDg96mZ+aFvqSG
329 -----END RSA PRIVATE KEY-----
331 close(KEYFILE);
333 open(ADMINKEYFILE, ">$adminkeyfile");
335 print ADMINKEYFILE <<EOF;
336 -----BEGIN RSA PRIVATE KEY-----
337 MIICXQIBAAKBgQD0+OL7TQBj0RejbIH1+g5GeRaWaM9xF43uE5y7jUHEsi5owhZF
338 5iIoHZeeL6cpDF5y1BZRs0JlA1VqMry1jjKlzFYVEMMFxB6esnXhl0Jpip1JkUMM
339 XLOP1m/0dqayuHBWozj9f/cdyCJr0wJIX1Z8Pr+EjYRGPn/MF0xdl3JRlwIDAQAB
340 AoGAP8mjCP628Ebc2eACQzOWjgEvwYCPK4qPmYOf1zJkArzG2t5XAGJ5WGrENRuB
341 cm3XFh1lpmaADl982UdW3gul4gXUy6w4XjKK4vVfhyHj0kZ/LgaXUK9BAGhroJ2L
342 osIOUsaC6jdx9EwSRctwdlF3wWJ8NK0g28AkvIk+FlolW4ECQQD7w5ouCDnf58CN
343 u4nARx4xv5XJXekBvOomkCQAmuOsdOb6b9wn3mm2E3au9fueITjb3soMR31AF6O4
344 eAY126rXAkEA+RgHzybzZEP8jCuznMqoN2fq/Vrs6+W3M8/G9mzGEMgLLpaf2Jiz
345 I9tLZ0+OFk9tkRaoCHPfUOCrVWJZ7Y53QQJBAMhoA6rw0WDyUcyApD5yXg6rusf4
346 ASpo/tqDkqUIpoL464Qe1tjFqtBM3gSXuhs9xsz+o0bzATirmJ+WqxrkKTECQHt2
347 OLCpKqwAspU7N+w32kaUADoRLisCEdrhWklbwpQgwsIVsCaoEOpt0CLloJRYTANE
348 yoZeAErTALjyZYZEPcECQQDlUi0N8DFxQ/lOwWyR3Hailft+mPqoPCa8QHlQZnlG
349 +cfgNl57YHMTZFwgUVFRdJNpjH/WdZ5QxDcIVli0q+Ko
350 -----END RSA PRIVATE KEY-----
353 #generated with
354 # hxtool issue-certificate --self-signed --issue-ca \
355 # --ca-private-key="FILE:$KEYFILE" \
356 # --subject="CN=CA,DC=samba,DC=example,DC=com" \
357 # --certificate="FILE:$CAFILE" --lifetime="25 years"
359 open(CAFILE, ">$cafile");
360 print CAFILE <<EOF;
361 -----BEGIN CERTIFICATE-----
362 MIICcTCCAdqgAwIBAgIUaBPmjnPVqyFqR5foICmLmikJTzgwCwYJKoZIhvcNAQEFMFIxEzAR
363 BgoJkiaJk/IsZAEZDANjb20xFzAVBgoJkiaJk/IsZAEZDAdleGFtcGxlMRUwEwYKCZImiZPy
364 LGQBGQwFc2FtYmExCzAJBgNVBAMMAkNBMCIYDzIwMDgwMzAxMTIyMzEyWhgPMjAzMzAyMjQx
365 MjIzMTJaMFIxEzARBgoJkiaJk/IsZAEZDANjb20xFzAVBgoJkiaJk/IsZAEZDAdleGFtcGxl
366 MRUwEwYKCZImiZPyLGQBGQwFc2FtYmExCzAJBgNVBAMMAkNBMIGfMA0GCSqGSIb3DQEBAQUA
367 A4GNADCBiQKBgQDKg6pAwCHUMA1DfHDmWhZfd+F0C+9Jxcqvpw9ii9En3E1uflpcol3+S9/6
368 I/uaTmJHZre+DF3dTzb/UOZo0Zem8N+IzzkgoGkFafjXuT3BL5UPY2/H6H+pPqVIRLOmrWIm
369 ai359YyoKhFyo37Y6HPeU8QcZ+u2rS9geapIWfeuowIDAQABo0IwQDAOBgNVHQ8BAf8EBAMC
370 AaYwHQYDVR0OBBYEFMLZufegDKLZs0VOyFXYK1L6M8oyMA8GA1UdEwEB/wQFMAMBAf8wDQYJ
371 KoZIhvcNAQEFBQADgYEAAZJbCAAkaqgFJ0xgNovn8Ydd0KswQPjicwiODPgw9ZPoD2HiOUVO
372 yYDRg/dhFF9y656OpcHk4N7qZ2sl3RlHkzDu+dseETW+CnKvQIoXNyeARRJSsSlwrwcoD4JR
373 HTLk2sGigsWwrJ2N99sG/cqSJLJ1MFwLrs6koweBnYU0f/g=
374 -----END CERTIFICATE-----
377 #generated with GNUTLS internally in Samba.
379 open(CERTFILE, ">$certfile");
380 print CERTFILE <<EOF;
381 -----BEGIN CERTIFICATE-----
382 MIICYTCCAcygAwIBAgIE5M7SRDALBgkqhkiG9w0BAQUwZTEdMBsGA1UEChMUU2Ft
383 YmEgQWRtaW5pc3RyYXRpb24xNDAyBgNVBAsTK1NhbWJhIC0gdGVtcG9yYXJ5IGF1
384 dG9nZW5lcmF0ZWQgY2VydGlmaWNhdGUxDjAMBgNVBAMTBVNhbWJhMB4XDTA2MDgw
385 NDA0MzY1MloXDTA4MDcwNDA0MzY1MlowZTEdMBsGA1UEChMUU2FtYmEgQWRtaW5p
386 c3RyYXRpb24xNDAyBgNVBAsTK1NhbWJhIC0gdGVtcG9yYXJ5IGF1dG9nZW5lcmF0
387 ZWQgY2VydGlmaWNhdGUxDjAMBgNVBAMTBVNhbWJhMIGcMAsGCSqGSIb3DQEBAQOB
388 jAAwgYgCgYDKg6pAwCHUMA1DfHDmWhZfd+F0C+9Jxcqvpw9ii9En3E1uflpcol3+
389 S9/6I/uaTmJHZre+DF3dTzb/UOZo0Zem8N+IzzkgoGkFafjXuT3BL5UPY2/H6H+p
390 PqVIRLOmrWImai359YyoKhFyo37Y6HPeU8QcZ+u2rS9geapIWfeuowIDAQABoyUw
391 IzAMBgNVHRMBAf8EAjAAMBMGA1UdJQQMMAoGCCsGAQUFBwMBMAsGCSqGSIb3DQEB
392 BQOBgQAmkN6XxvDnoMkGcWLCTwzxGfNNSVcYr7TtL2aJh285Xw9zaxcm/SAZBFyG
393 LYOChvh6hPU7joMdDwGfbiLrBnMag+BtGlmPLWwp/Kt1wNmrRhduyTQFhN3PP6fz
394 nBr9vVny2FewB2gHmelaPS//tXdxivSXKz3NFqqXLDJjq7P8wA==
395 -----END CERTIFICATE-----
397 close(CERTFILE);
399 #KDC certificate
400 # hxtool request-create \
401 # --subject="CN=krbtgt,CN=users,DC=samba,DC=example,DC=com" \
402 # --key="FILE:$KEYFILE" $KDCREQ
404 # hxtool issue-certificate --ca-certificate=FILE:$CAFILE,$KEYFILE \
405 # --type="pkinit-kdc" \
406 # --pk-init-principal="krbtgt/SAMBA.EXAMPLE.COM@SAMBA.EXAMPLE.COM" \
407 # --req="PKCS10:$KDCREQ" --certificate="FILE:$KDCCERTFILE" \
408 # --lifetime="25 years"
410 open(KDCCERTFILE, ">$kdccertfile");
411 print KDCCERTFILE <<EOF;
412 -----BEGIN CERTIFICATE-----
413 MIIDDDCCAnWgAwIBAgIUI2Tzj+JnMzMcdeabcNo30rovzFAwCwYJKoZIhvcNAQEFMFIxEzAR
414 BgoJkiaJk/IsZAEZDANjb20xFzAVBgoJkiaJk/IsZAEZDAdleGFtcGxlMRUwEwYKCZImiZPy
415 LGQBGQwFc2FtYmExCzAJBgNVBAMMAkNBMCIYDzIwMDgwMzAxMTMxOTIzWhgPMjAzMzAyMjQx
416 MzE5MjNaMGYxEzARBgoJkiaJk/IsZAEZDANjb20xFzAVBgoJkiaJk/IsZAEZDAdleGFtcGxl
417 MRUwEwYKCZImiZPyLGQBGQwFc2FtYmExDjAMBgNVBAMMBXVzZXJzMQ8wDQYDVQQDDAZrcmJ0
418 Z3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMqDqkDAIdQwDUN8cOZaFl934XQL70nF
419 yq+nD2KL0SfcTW5+WlyiXf5L3/oj+5pOYkdmt74MXd1PNv9Q5mjRl6bw34jPOSCgaQVp+Ne5
420 PcEvlQ9jb8fof6k+pUhEs6atYiZqLfn1jKgqEXKjftjoc95TxBxn67atL2B5qkhZ966jAgMB
421 AAGjgcgwgcUwDgYDVR0PAQH/BAQDAgWgMBIGA1UdJQQLMAkGBysGAQUCAwUwVAYDVR0RBE0w
422 S6BJBgYrBgEFAgKgPzA9oBMbEVNBTUJBLkVYQU1QTEUuQ09NoSYwJKADAgEBoR0wGxsGa3Ji
423 dGd0GxFTQU1CQS5FWEFNUExFLkNPTTAfBgNVHSMEGDAWgBTC2bn3oAyi2bNFTshV2CtS+jPK
424 MjAdBgNVHQ4EFgQUwtm596AMotmzRU7IVdgrUvozyjIwCQYDVR0TBAIwADANBgkqhkiG9w0B
425 AQUFAAOBgQBmrVD5MCmZjfHp1nEnHqTIh8r7lSmVtDx4s9MMjxm9oNrzbKXynvdhwQYFVarc
426 ge4yRRDXtSebErOl71zVJI9CVeQQpwcH+tA85oGA7oeFtO/S7ls581RUU6tGgyxV4veD+lJv
427 KPH5LevUtgD+q9H4LU4Sq5N3iFwBaeryB0g2wg==
428 -----END CERTIFICATE-----
431 # hxtool request-create \
432 # --subject="CN=Administrator,CN=users,DC=samba,DC=example,DC=com" \
433 # --key="FILE:$ADMINKEYFILE" $ADMINREQFILE
435 # hxtool issue-certificate --ca-certificate=FILE:$CAFILE,$KEYFILE \
436 # --type="pkinit-client" \
437 # --pk-init-principal="administrator@SAMBA.EXAMPLE.COM" \
438 # --req="PKCS10:$ADMINREQFILE" --certificate="FILE:$ADMINCERTFILE" \
439 # --lifetime="25 years"
441 open(ADMINCERTFILE, ">$admincertfile");
442 print ADMINCERTFILE <<EOF;
443 -----BEGIN CERTIFICATE-----
444 MIIDHTCCAoagAwIBAgIUC0W5dW/N9kE+NgD0mKK34YgyqQ0wCwYJKoZIhvcNAQEFMFIxEzAR
445 BgoJkiaJk/IsZAEZDANjb20xFzAVBgoJkiaJk/IsZAEZDAdleGFtcGxlMRUwEwYKCZImiZPy
446 LGQBGQwFc2FtYmExCzAJBgNVBAMMAkNBMCIYDzIwMDgwMzAxMTMyMzAwWhgPMjAzMzAyMjQx
447 MzIzMDBaMG0xEzARBgoJkiaJk/IsZAEZDANjb20xFzAVBgoJkiaJk/IsZAEZDAdleGFtcGxl
448 MRUwEwYKCZImiZPyLGQBGQwFc2FtYmExDjAMBgNVBAMMBXVzZXJzMRYwFAYDVQQDDA1BZG1p
449 bmlzdHJhdG9yMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD0+OL7TQBj0RejbIH1+g5G
450 eRaWaM9xF43uE5y7jUHEsi5owhZF5iIoHZeeL6cpDF5y1BZRs0JlA1VqMry1jjKlzFYVEMMF
451 xB6esnXhl0Jpip1JkUMMXLOP1m/0dqayuHBWozj9f/cdyCJr0wJIX1Z8Pr+EjYRGPn/MF0xd
452 l3JRlwIDAQABo4HSMIHPMA4GA1UdDwEB/wQEAwIFoDAoBgNVHSUEITAfBgcrBgEFAgMEBggr
453 BgEFBQcDAgYKKwYBBAGCNxQCAjBIBgNVHREEQTA/oD0GBisGAQUCAqAzMDGgExsRU0FNQkEu
454 RVhBTVBMRS5DT02hGjAYoAMCAQGhETAPGw1hZG1pbmlzdHJhdG9yMB8GA1UdIwQYMBaAFMLZ
455 ufegDKLZs0VOyFXYK1L6M8oyMB0GA1UdDgQWBBQg81bLyfCA88C2B/BDjXlGuaFaxjAJBgNV
456 HRMEAjAAMA0GCSqGSIb3DQEBBQUAA4GBAHsqSqul0hZCXn4t8Kfp3v/JLMiUMJihR1XOgzoa
457 ufLOQ1HNzFUHKuo1JEQ1+i5gHT/arLu/ZBF4BfQol7vW27gKIEt0fkRV8EvoPxXvSokHq0Ku
458 HCuPOhYNEP3wYiwB3g93NMCinWVlz0mh5aijEU7y/XrjlZxBKFFrTE+BJi1o
459 -----END CERTIFICATE-----
461 close(ADMINCERTFILE);
465 # provision_raw_prepare() is also used by Samba34.pm!
467 sub provision_raw_prepare($$$$$$$)
469 my ($self, $prefix, $server_role, $netbiosname, $netbiosalias, $swiface, $password, $kdc_ipv4) = @_;
470 my $ctx;
472 -d $prefix or mkdir($prefix, 0777) or die("Unable to create $prefix");
473 my $prefix_abs = abs_path($prefix);
475 die ("prefix=''") if $prefix_abs eq "";
476 die ("prefix='/'") if $prefix_abs eq "/";
478 (system("rm -rf $prefix_abs/*") == 0) or die("Unable to clean up");
480 $ctx->{prefix} = $prefix;
481 $ctx->{prefix_abs} = $prefix_abs;
482 $ctx->{server_role} = $server_role;
483 $ctx->{netbiosname} = $netbiosname;
484 $ctx->{netbiosalias} = $netbiosalias;
485 $ctx->{swiface} = $swiface;
486 $ctx->{password} = $password;
487 $ctx->{kdc_ipv4} = $kdc_ipv4;
489 $ctx->{server_loglevel} = 1;
490 $ctx->{username} = "administrator";
491 $ctx->{domain} = "SAMBADOMAIN";
492 $ctx->{realm} = "SAMBA.EXAMPLE.COM";
493 $ctx->{dnsname} = "samba.example.com";
494 $ctx->{basedn} = "dc=samba,dc=example,dc=com";
496 my $unix_name = ($ENV{USER} or $ENV{LOGNAME} or `whoami`);
497 chomp $unix_name;
498 $ctx->{unix_name} = $unix_name;
499 $ctx->{unix_uid} = $>;
500 $ctx->{unix_gids_str} = $);
501 @{$ctx->{unix_gids}} = split(" ", $ctx->{unix_gids_str});
503 $ctx->{etcdir} = "$prefix_abs/etc";
504 $ctx->{piddir} = "$prefix_abs/pid";
505 $ctx->{smb_conf} = "$ctx->{etcdir}/smb.conf";
506 $ctx->{krb5_conf} = "$ctx->{etcdir}/krb5.conf";
507 $ctx->{privatedir} = "$prefix_abs/private";
508 $ctx->{ncalrpcdir} = "$prefix_abs/ncalrpc";
509 $ctx->{lockdir} = "$prefix_abs/lockdir";
510 $ctx->{winbindd_socket_dir} = "$prefix_abs/winbindd_socket";
511 $ctx->{winbindd_privileged_socket_dir} = "$prefix_abs/winbindd_privileged_socket";
512 $ctx->{ntp_signd_socket_dir} = "$prefix_abs/ntp_signd_socket";
513 $ctx->{nsswrap_passwd} = "$ctx->{etcdir}/passwd";
514 $ctx->{nsswrap_group} = "$ctx->{etcdir}/group";
516 $ctx->{tlsdir} = "$ctx->{privatedir}/tls";
518 $ctx->{ipv4} = "127.0.0.$swiface";
519 $ctx->{interfaces} = "$ctx->{ipv4}/8";
521 $ctx->{localbasedn} = $ctx->{basedn};
522 $ctx->{localbasedn} = "CN=$netbiosname" if $server_role eq "member server";
524 push(@{$ctx->{directories}}, $ctx->{privatedir});
525 push(@{$ctx->{directories}}, $ctx->{etcdir});
526 push(@{$ctx->{directories}}, $ctx->{piddir});
527 push(@{$ctx->{directories}}, $ctx->{ncalrpcdir});
528 push(@{$ctx->{directories}}, $ctx->{lockdir});
530 $ctx->{smb_conf_extra_options} = "";
532 my @provision_options = ();
533 push (@provision_options, "NSS_WRAPPER_PASSWD=\"$ctx->{nsswrap_passwd}\"");
534 push (@provision_options, "NSS_WRAPPER_GROUP=\"$ctx->{nsswrap_group}\"");
535 if (defined($ENV{GDB_PROVISION})) {
536 push (@provision_options, "gdb --args");
538 if (defined($ENV{VALGRIND_PROVISION})) {
539 push (@provision_options, "valgrind");
541 if (defined($ENV{PYTHON})) {
542 push (@provision_options, $ENV{PYTHON});
544 push (@provision_options, "$self->{setupdir}/provision");
545 push (@provision_options, "--configfile=$ctx->{smb_conf}");
546 push (@provision_options, "--host-name=$ctx->{netbiosname}");
547 push (@provision_options, "--host-ip=$ctx->{ipv4}");
548 push (@provision_options, "--quiet");
549 push (@provision_options, "--domain=$ctx->{domain}");
550 push (@provision_options, "--realm=$ctx->{realm}");
551 push (@provision_options, "--adminpass=$ctx->{password}");
552 push (@provision_options, "--krbtgtpass=krbtgt$ctx->{password}");
553 push (@provision_options, "--machinepass=machine$ctx->{password}");
554 push (@provision_options, "--root=$ctx->{unix_name}");
555 push (@provision_options, "--server-role=\"$ctx->{server_role}\"");
557 @{$ctx->{provision_options}} = @provision_options;
559 return $ctx;
563 # provision_raw_step1() is also used by Samba34.pm!
565 # Step1 creates the basic configuration
567 sub provision_raw_step1($$)
569 my ($self, $ctx) = @_;
571 mkdir($_, 0777) foreach (@{$ctx->{directories}});
573 open(CONFFILE, ">$ctx->{smb_conf}")
574 or die("can't open $ctx->{smb_conf}$?");
575 print CONFFILE "
576 [global]
577 netbios name = $ctx->{netbiosname}
578 netbios aliases = $ctx->{netbiosalias}
579 workgroup = $ctx->{domain}
580 realm = $ctx->{realm}
581 private dir = $ctx->{privatedir}
582 pid directory = $ctx->{piddir}
583 ncalrpc dir = $ctx->{ncalrpcdir}
584 lock dir = $ctx->{lockdir}
585 setup directory = $self->{setupdir}
586 modules dir = $self->{bindir}/modules
587 winbindd socket directory = $ctx->{winbindd_socket_dir}
588 winbindd privileged socket directory = $ctx->{winbindd_privileged_socket_dir}
589 ntp signd socket directory = $ctx->{ntp_signd_socket_dir}
590 winbind separator = /
591 name resolve order = bcast
592 interfaces = $ctx->{interfaces}
593 tls dh params file = $ctx->{tlsdir}/dhparms.pem
594 panic action = $RealBin/gdb_backtrace \%PID% \%PROG%
595 wins support = yes
596 server role = $ctx->{server_role}
597 notify:inotify = false
598 ldb:nosync = true
599 #We don't want to pass our self-tests if the PAC code is wrong
600 gensec:require_pac = true
601 log level = $ctx->{server_loglevel}
602 lanman auth = Yes
604 # Begin extra options
605 $ctx->{smb_conf_extra_options}
606 # End extra options
608 close(CONFFILE);
610 $self->mk_keyblobs($ctx->{tlsdir});
612 open(KRB5CONF, ">$ctx->{krb5_conf}")
613 or die("can't open $ctx->{krb5_conf}$?");
614 print KRB5CONF "
615 #Generated krb5.conf for $ctx->{realm}
617 [libdefaults]
618 default_realm = $ctx->{realm}
619 dns_lookup_realm = false
620 dns_lookup_kdc = false
621 ticket_lifetime = 24h
622 forwardable = yes
624 [realms]
625 $ctx->{realm} = {
626 kdc = $ctx->{kdc_ipv4}:88
627 admin_server = $ctx->{kdc_ipv4}:88
628 default_domain = $ctx->{dnsname}
630 $ctx->{dnsname} = {
631 kdc = $ctx->{kdc_ipv4}:88
632 admin_server = $ctx->{kdc_ipv4}:88
633 default_domain = $ctx->{dnsname}
635 $ctx->{domain} = {
636 kdc = $ctx->{kdc_ipv4}:88
637 admin_server = $ctx->{kdc_ipv4}:88
638 default_domain = $ctx->{dnsname}
641 [appdefaults]
642 pkinit_anchors = FILE:$ctx->{tlsdir}/ca.pem
644 [kdc]
645 enable-pkinit = true
646 pkinit_identity = FILE:$ctx->{tlsdir}/kdc.pem,$ctx->{tlsdir}/key.pem
647 pkinit_anchors = FILE:$ctx->{tlsdir}/ca.pem
649 [domain_realm]
650 .$ctx->{dnsname} = $ctx->{realm}
652 close(KRB5CONF);
654 open(PWD, ">$ctx->{nsswrap_passwd}");
655 print PWD "
656 root:x:0:0:root gecos:$ctx->{prefix_abs}:/bin/false
657 $ctx->{unix_name}:x:$ctx->{unix_uid}:@{$ctx->{unix_gids}}[0]:$ctx->{unix_name} gecos:$ctx->{prefix_abs}:/bin/false
658 nobody:x:65534:65533:nobody gecos:$ctx->{prefix_abs}:/bin/false
660 close(PWD);
662 open(GRP, ">$ctx->{nsswrap_group}");
663 print GRP "
664 root:x:0:
665 wheel:x:10:
666 users:x:100:
667 nobody:x:65533:
668 nogroup:x:65534:nobody
670 close(GRP);
672 my $configuration = "--configfile=$ctx->{smb_conf}";
674 #Ensure the config file is valid before we start
675 my $testparm = $self->bindir_path("testparm");
676 if (system("$testparm $configuration -v --suppress-prompt >/dev/null 2>&1") != 0) {
677 system("$testparm -v --suppress-prompt $configuration >&2");
678 die("Failed to create a valid smb.conf configuration $testparm!");
681 (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) or die("Failed to create a valid smb.conf configuration! $self->{bindir}/testparm $configuration -v --suppress-prompt --parameter-name=\"netbios name\" --section-name=global");
683 my $ret = {
684 KRB5_CONFIG => $ctx->{krb5_conf},
685 PIDDIR => $ctx->{piddir},
686 SERVER => $ctx->{netbiosname},
687 SERVER_IP => $ctx->{ipv4},
688 NETBIOSNAME => $ctx->{netbiosname},
689 NETBIOSALIAS => $ctx->{netbiosalias},
690 DOMAIN => $ctx->{domain},
691 USERNAME => $ctx->{username},
692 REALM => $ctx->{realm},
693 PASSWORD => $ctx->{password},
694 LDAPDIR => $ctx->{ldapdir},
695 WINBINDD_SOCKET_DIR => $ctx->{winbindd_socket_dir},
696 NCALRPCDIR => $ctx->{ncalrpcdir},
697 LOCKDIR => $ctx->{lockdir},
698 SERVERCONFFILE => $ctx->{smb_conf},
699 CONFIGURATION => $configuration,
700 SOCKET_WRAPPER_DEFAULT_IFACE => $ctx->{swiface},
701 NSS_WRAPPER_PASSWD => $ctx->{nsswrap_passwd},
702 NSS_WRAPPER_GROUP => $ctx->{nsswrap_group},
703 SAMBA_TEST_FIFO => "$ctx->{prefix}/samba_test.fifo",
704 SAMBA_TEST_LOG => "$ctx->{prefix}/samba_test.log",
705 SAMBA_TEST_LOG_POS => 0,
708 return $ret;
712 # provision_raw_step2() is also used by Samba34.pm!
714 # Step2 runs the provision script
716 sub provision_raw_step2($$$)
718 my ($self, $ctx, $ret) = @_;
720 my $provision_cmd = join(" ", @{$ctx->{provision_options}});
721 (system($provision_cmd) == 0) or die("Unable to provision: \n$provision_cmd\n");
723 return $ret;
726 sub provision($$$$$$$)
728 my ($self, $prefix, $server_role, $netbiosname, $netbiosalias, $swiface, $password, $kdc_ipv4) = @_;
730 my $ctx = $self->provision_raw_prepare($prefix, $server_role,
731 $netbiosname, $netbiosalias,
732 $swiface, $password, $kdc_ipv4);
734 $ctx->{tmpdir} = "$ctx->{prefix_abs}/tmp";
735 push(@{$ctx->{directories}}, "$ctx->{tmpdir}");
736 push(@{$ctx->{directories}}, "$ctx->{tmpdir}/test1");
737 push(@{$ctx->{directories}}, "$ctx->{tmpdir}/test2");
739 $ctx->{smb_conf_extra_options} = "
741 max xmit = 32K
742 server max protocol = SMB2
744 [tmp]
745 path = $ctx->{tmpdir}
746 read only = no
747 ntvfs handler = posix
748 posix:sharedelay = 100000
749 posix:eadb = $ctx->{lockdir}/eadb.tdb
750 posix:oplocktimeout = 3
751 posix:writetimeupdatedelay = 500000
753 [test1]
754 path = $ctx->{tmpdir}/test1
755 read only = no
756 ntvfs handler = posix
757 posix:sharedelay = 100000
758 posix:eadb = $ctx->{lockdir}/eadb.tdb
759 posix:oplocktimeout = 3
760 posix:writetimeupdatedelay = 500000
762 [test2]
763 path = $ctx->{tmpdir}/test2
764 read only = no
765 ntvfs handler = posix
766 posix:sharedelay = 100000
767 posix:eadb = $ctx->{lockdir}/eadb.tdb
768 posix:oplocktimeout = 3
769 posix:writetimeupdatedelay = 500000
771 [cifs]
772 read only = no
773 ntvfs handler = cifs
774 cifs:server = $ctx->{netbiosname}
775 cifs:share = tmp
776 #There is no username specified here, instead the client is expected
777 #to log in with kerberos, and the serverwill use delegated credentials.
779 [simple]
780 path = $ctx->{tmpdir}
781 read only = no
782 ntvfs handler = simple
784 [sysvol]
785 path = $ctx->{lockdir}/sysvol
786 read only = yes
788 [netlogon]
789 path = $ctx->{lockdir}/sysvol/$ctx->{dnsname}/scripts
790 read only = no
792 [cifsposix]
793 copy = simple
794 ntvfs handler = cifsposix
797 if (defined($self->{ldap})) {
798 $ctx->{ldapdir} = "$ctx->{privatedir}/ldap";
799 push(@{$ctx->{directories}}, "$ctx->{ldapdir}");
801 my $ldap_uri= "$ctx->{ldapdir}/ldapi";
802 $ldap_uri =~ s|/|%2F|g;
803 $ldap_uri = "ldapi://$ldap_uri";
804 $ctx->{ldap_uri} = $ldap_uri;
807 my $ret = $self->provision_raw_step1($ctx);
809 if (defined($self->{ldap})) {
810 my $configuration = "--configfile=$ctx->{smb_conf}";
812 $ret->{LDAP_URI} = $ctx->{ldap_uri};
813 push (@{$ctx->{provision_options}},"--ldap-backend=$ctx->{ldap_uri}");
815 system("$self->{setupdir}/provision-backend $configuration --ldap-admin-pass=$ctx->{password} --root=$ctx->{unix_name} --realm=$ctx->{realm} --domain=$ctx->{domain} --host-name=$ctx->{netbiosname} --ldap-backend-type=$self->{ldap}>&2") == 0 or die("backend provision failed");
817 push (@{$ctx->{provision_options}}, "--password=$ctx->{password}");
819 if ($self->{ldap} eq "openldap") {
820 push (@{$ctx->{provision_options}}, "--username=samba-admin");
821 push (@{$ctx->{provision_options}}, "--ldap-backend-type=openldap");
823 ($ret->{SLAPD_CONF}, $ret->{OPENLDAP_PIDFILE}) = $self->mk_openldap($ctx->{ldapdir}, $configuration) or die("Unable to create openldap directories");
825 } elsif ($self->{ldap} eq "fedora-ds") {
826 push (@{$ctx->{provision_options}}, "--simple-bind-dn=cn=Manager,$ctx->{localbasedn}");
827 push (@{$ctx->{provision_options}}, "--ldap-backend-type=fedora-ds");
829 ($ret->{FEDORA_DS_DIR}, $ret->{FEDORA_DS_PIDFILE}) = $self->mk_fedora_ds($ctx->{ldapdir}, $configuration) or die("Unable to create fedora ds directories");
832 $self->slapd_start($ret) or die("couldn't start slapd");
835 $ret = $self->provision_raw_step2($ctx, $ret);
837 if (defined($self->{ldap})) {
838 $self->slapd_stop($ret) or die("couldn't stop slapd");
841 return $ret;
844 sub provision_member($$$)
846 my ($self, $prefix, $dcvars) = @_;
847 print "PROVISIONING MEMBER...";
849 my $ret = $self->provision($prefix,
850 "member server",
851 "localmember3",
852 "localmember",
854 "localmemberpass",
855 $dcvars->{SERVER_IP});
857 $ret or die("Unable to provision");
859 my $net = $self->bindir_path("net");
860 my $cmd = "";
861 $cmd .= "SOCKET_WRAPPER_DEFAULT_IFACE=\"$ret->{SOCKET_WRAPPER_DEFAULT_IFACE}\" ";
862 $cmd .= "KRB5_CONFIG=\"$ret->{KRB5_CONFIG}\" ";
863 $cmd .= "$net join $ret->{CONFIGURATION} $dcvars->{DOMAIN} member";
864 $cmd .= " -U$dcvars->{USERNAME}\%$dcvars->{PASSWORD}";
866 system($cmd) == 0 or die("Join failed\n$cmd");
868 $ret->{DC_SERVER} = $dcvars->{SERVER};
869 $ret->{DC_SERVER_IP} = $dcvars->{SERVER_IP};
870 $ret->{DC_NETBIOSNAME} = $dcvars->{NETBIOSNAME};
871 $ret->{DC_NETBIOSALIAS} = $dcvars->{NETBIOSALIAS};
872 $ret->{DC_USERNAME} = $dcvars->{USERNAME};
873 $ret->{DC_PASSWORD} = $dcvars->{PASSWORD};
875 return $ret;
878 sub provision_dc($$)
880 my ($self, $prefix) = @_;
882 print "PROVISIONING DC...";
883 my $ret = $self->provision($prefix,
884 "domain controller",
885 "localdc1",
886 "localdc",
888 "localdcpass",
889 "127.0.0.1");
891 $self->add_wins_config("$prefix/private") or
892 die("Unable to add wins configuration");
894 return $ret;
897 sub teardown_env($$)
899 my ($self, $envvars) = @_;
900 my $pid;
902 close(DATA);
904 if (-f "$envvars->{PIDDIR}/samba.pid" ) {
905 open(IN, "<$envvars->{PIDDIR}/samba.pid") or die("unable to open server pid file");
906 $pid = <IN>;
907 close(IN);
909 # Give the process 20 seconds to exit. gcov needs
910 # this time to write out the covarge data
911 my $count = 0;
912 until (kill(0, $pid) == 0) {
913 # if no process sucessfully signalled, then we are done
914 sleep(1);
915 $count++;
916 last if $count > 20;
919 # If it is still around, kill it
920 if ($count > 20) {
921 print "server process $pid took more than $count seconds to exit, killing\n";
922 kill 9, $pid;
926 my $failed = $? >> 8;
928 $self->slapd_stop($envvars) if ($self->{ldap});
930 print $self->getlog_env($envvars);
932 return $failed;
935 sub getlog_env($$)
937 my ($self, $envvars) = @_;
938 my $title = "SAMBA LOG of: $envvars->{NETBIOSNAME}\n";
939 my $out = $title;
941 open(LOG, "<$envvars->{SAMBA_TEST_LOG}");
943 seek(LOG, $envvars->{SAMBA_TEST_LOG_POS}, SEEK_SET);
944 while (<LOG>) {
945 $out .= $_;
947 $envvars->{SAMBA_TEST_LOG_POS} = tell(LOG);
948 close(LOG);
950 return "" if $out eq $title;
952 return $out;
955 sub check_env($$)
957 my ($self, $envvars) = @_;
959 return 1 if (-p $envvars->{SAMBA_TEST_FIFO});
961 print $self->getlog_env($envvars);
963 return 0;
966 sub setup_env($$$)
968 my ($self, $envname, $path) = @_;
970 if ($envname eq "dc") {
971 return $self->setup_dc("$path/dc");
972 } elsif ($envname eq "member") {
973 if (not defined($self->{vars}->{dc})) {
974 $self->setup_dc("$path/dc");
976 return $self->setup_member("$path/member", $self->{vars}->{dc});
977 } else {
978 die("Samba4 can't provide environment '$envname'");
982 sub setup_member($$$$)
984 my ($self, $path, $dc_vars) = @_;
986 my $env = $self->provision_member($path, $dc_vars);
988 $self->check_or_start($env, ($ENV{SMBD_MAXTIME} or 7500));
990 $self->wait_for_start($env);
992 return $env;
995 sub setup_dc($$)
997 my ($self, $path) = @_;
999 my $env = $self->provision_dc($path);
1001 $self->check_or_start($env,
1002 ($ENV{SMBD_MAXTIME} or 7500));
1004 $self->wait_for_start($env);
1006 $self->{vars}->{dc} = $env;
1008 return $env;
1011 sub stop($)
1013 my ($self) = @_;