Managing the Samba AD DC Service Using an Init Script: Difference between revisions

From SambaWiki
(Initial content for Debian and RedHat)
 
mNo edit summary
 
(26 intermediate revisions by 12 users not shown)
Line 1: Line 1:
<noinclude>= Introduction =
= Samba4 Init Scripts =


The following describes how to use an init script to manage the Samba Active Directory (AD) domain controller (DC) service. Depending on your operating system, the location of the init script, its content, and the procedures how to manage the service can be different. For details, see your operating system's documentation.
This is a topic which pops every so often -- ''where are the Init scripts for Samba4?'' The problem is that init scripts are very distribution specific. The HOWTO states, "Samba4 alpha13 doesn't yet have init scripts included for each platform, but making one for your platform should not be difficult." Well, they may not be rocket science, but not everyone knows how to build a robust startup script and then integrate it with their particular startup infrastructure. This gets even more weird when distributions like Fedora radically overhaul their approach to init!


{{Imbox
The intent of this page is to provide a sample of at least a few init scripts, listed by their distribution family (eg., Debian based systems and Red Hat/Fedora).
| type = important
| text = If you operating system uses a different system to manage services, such as <code>systemd</code>, see [[Managing_the_Samba_AD_DC_Service|Managing the Samba AD DC Service]].
}}</noinclude>




== Red Hat based systems ==
For SysV style service init scripts, Red Hat puts the init scripts in the /etc/rc.d/init.d directory, and then links to these scripts from the various run level directories (eg, link in /etc/rc3.d/S80samba4 -> ../rc.d/init.d/samba4)


Fedora has gone to a systemd based startup for Init. You can still use SysV style scripts such as this one, and configure the automatic startup of the Samba4 server ad different run levels through the "chkconfig" tool.



#! /bin/bash
= Creating the Init Script =
#

# samba4 Bring up/down samba4 service
== Red Hat Enterprise Linux 6 ==
#

# chkconfig: - 90 10
{{Imbox
# description: Activates/Deactivates all samba4 interfaces configured to \
| type = note
# start at boot time.
| text = On Red Hat Enterprise Linux later than version 6, use <code>systemd</code> to manage the Samba service. For details, see [[Managing_the_Samba_AD_DC_Service_Using_Systemd|Managing the Samba AD DC Service Using Systemd]].
#
}}
### BEGIN INIT INFO

# Provides:
* Create the <code>/etc/init.d/samba-ad-dc</code> file with the following content:
# Should-Start:

# Short-Description: Bring up/down samba4
#!/bin/bash
# Description: Bring up/down samba4
#
### END INIT INFO
# samba-ad-dc This shell script takes care of starting and stopping
# Source function library.
# samba AD daemons.
. /etc/init.d/functions
#
# chkconfig: - 58 74
# description: Samba Active Directory Domain Controller
### BEGIN INIT INFO
# Provides: samba-ad-dc
# Required-Start: $network $local_fs $remote_fs
# Required-Stop: $network $local_fs $remote_fs
# Should-Start: $syslog $named
# Should-Stop: $syslog $named
# Short-Description: start and stop samba-ad-dc
# Description: Samba Active Directory Domain Controller
### END INIT INFO
# Source function library.
. /etc/init.d/functions
# Source networking configuration.
if [ -f /etc/sysconfig/samba4 ]; then
. /etc/sysconfig/samba4
. /etc/sysconfig/network
fi
prog=samba
CWD=$(pwd)
prog_dir=/usr/local/samba/sbin/
prog="samba4"
lockfile=/var/lock/subsys/$prog
start() {
start() {
[ "$NETWORKING" = "no" ] && exit 1
# Attach irda device
echo -n $"Starting $prog: "
echo -n $"Starting Samba AD DC: "
daemon $prog_dir/$prog -D
/usr/local/samba/sbin/samba
RETVAL=$?
sleep 2
echo
if ps ax | grep -v "grep" | grep -q /samba/sbin/samba ; then success $"samba4 startup"; else failure $"samba4 startup"; fi
echo
[ $RETVAL -eq 0 ] && touch $lockfile
return $RETVAL
}
}
stop() {
stop() {
[ "$EUID" != "0" ] && exit 4
# Stop service.
echo -n $"Shutting down $prog: "
echo -n $"Shutting down Samba AD DC: "
killproc $prog_dir/$prog
killall samba
RETVAL=$?
sleep 2
echo
if ps ax | grep -v "grep" | grep -q /samba/sbin/samba ; then failure $"samba4 shutdown"; else success $"samba4 shutdown"; fi
echo
[ $RETVAL -eq 0 ] && rm -f $lockfile
return $RETVAL
}
}
status() {
/usr/local/samba/sbin/samba --show-build
}
case "$1" in
# See how we were called.
start)
case "$1" in
start)
start
start
;;
stop)
;;
stop)
stop
stop
;;
status)
;;
status)
status $prog
;;
status irattach
restart)
;;
stop
restart|reload)
stop
start
start
;;
*)
;;
echo $"Usage: $0 {start|stop|status|restart}"
*)
exit 2
echo $"Usage: $0 {start|stop|restart|status}"
esac
exit 1
esac
exit 0


* Make the script executeable:


# chmod 755 /etc/init.d/samba-ad-dc
== Debian Based Systems ==
Debian systems include Ubuntu and its variants.



#!/bin/sh

== Debian ==
### BEGIN INIT INFO

# Provides: samba
* Create the <code>/etc/init.d/samba-ad-dc</code> file with the following content:
# Required-Start: $network $local_fs $remote_fs

# Required-Stop: $network $local_fs $remote_fs
#!/bin/sh
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
### BEGIN INIT INFO
# Should-Start: slapd
# Should-Stop: slapd
# Provides: samba-ad-dc
# Required-Start: $network $local_fs $remote_fs
# Short-Description: start Samba daemon (samba)
# Required-Stop: $network $local_fs $remote_fs
### END INIT INFO
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: start Samba daemons for the AD DC
### END INIT INFO
#
# Start/stops the Samba daemon (samba).
# Adapted from the Samba 3 packages.
#
PATH=/usr/local/samba/sbin:/usr/local/samba/bin:$PATH
PIDDIR=/usr/local/samba/var/run
SAMBAPID=$PIDDIR/samba.pid
# clear conflicting settings from the environment
unset TMPDIR
# See if the daemon and the config file are there
test -x /usr/local/samba/sbin/samba -a -r /usr/local/samba/etc/smb.conf || exit 0
. /lib/lsb/init-functions
case "$1" in
start)
SERVER_ROLE=`samba-tool testparm --parameter-name="server role" 2>/dev/null | tail -1`
if [ "$SERVER_ROLE" != "active directory domain controller" ]; then
exit 0
fi
# CVE-2013-4475
KEYFILE=/usr/local/samba/private/tls/key.pem
if [ -e $KEYFILE ]; then
KEYPERMS=`stat -c %a $KEYFILE`
if [ "$KEYPERMS" != "600" ]; then
echo "wrong permission on $KEYFILE, must be 600"
echo "samba will not start (CVE-2013-4475)"
echo "Removing all tls .pem files will cause an auto-regeneration with the correct permissions."
exit 1
fi
fi
log_daemon_msg "Starting Samba AD DC daemon" "samba"
# Make sure we have our PIDDIR, even if it's on a tmpfs
install -o root -g root -m 755 -d $PIDDIR
if ! start-stop-daemon --start --quiet --oknodo --exec /usr/local/samba/sbin/samba -- -D; then
PIDDIR=/usr/local/samba/var/run
log_end_msg 1
SAMBADPID=$PIDDIR/samba.pid
exit 1
fi
# clear conflicting settings from the environment
unset TMPDIR
log_end_msg 0
# See if the daemons are there
;;
stop)
test -x /usr/local/samba/sbin/samba || exit 0
log_daemon_msg "Stopping Samba AD DC daemon" "samba"
# Starting init-fuctions for Debian -shell script
start-stop-daemon --stop --quiet --pidfile $SAMBAPID
. /lib/lsb/init-functions
# Wait a little and remove stale PID file
sleep 1
case "$1" in
if [ -f $SAMBAPID ] && ! ps h `cat $SAMBAPID` > /dev/null
start)
then
log_daemon_msg "Starting Samba daemon"
# Stale PID file (samba was succesfully stopped),
# Make sure we have our PIDDIR, even if it's on a tmpfs
# remove it (should be removed by samba itself IMHO.)
install -o root -g root -m 755 -d $PIDDIR
rm -f $SAMBAPID
fi
SAMBA_DISABLED=`testparm -s --parameter-name='disable netbios' 2>/dev/null`
if [ "$SAMBA_DISABLED" != 'Yes' ]; then
log_end_msg 0
log_progress_msg "samba"
if ! start-stop-daemon --start --quiet --oknodo --exec /usr/local/samba/sbin/samba -- -D
;;
then
restart|force-reload)
log_end_msg 1
$0 stop
exit 1
sleep 1
fi
$0 start
fi
;;
status)
log_end_msg 0
status_of_proc -p $SAMBAPID /usr/local/samba/sbin/samba samba
;;
exit $?
stop)
;;
log_daemon_msg "Stopping Samba daemon"
*)
log_progress_msg "samba"
echo "Usage: /etc/init.d/samba-ad-dc {start|stop|restart|force-reload|status}"
exit 1
start-stop-daemon --stop --quiet --pidfile $SAMBADPID
# Wait a little and remove stale PID file
;;
esac
sleep 1
if [ -f $SAMBADPID ] && ! ps h `cat $SAMBADPID` > /dev/null
exit 0
then

# Stale PID file (samba was succesfully stopped),

# remove it (should be removed by samba itself IMHO.)
* If necessary, update the locations to the <code>samba</code> service, the <code>samba-tool</code> utility, and the <code>smb.conf</code> file in the <code>/etc/init.d/samba-ad-dc</code> file.
rm -f $SAMBADPID

fi
* Make the script executeable:

log_end_msg 0
# chmod 755 /etc/init.d/samba-ad-dc

;;

reload)

log_daemon_msg "Reloading /usr/local/samba/etc/smb.conf "

start-stop-daemon --stop --signal HUP --pidfile $SAMBADPID

log_end_msg 0
= Managing the Samba AD DC Service =
;;

restart|force-reload)
The following assumes that the Samba Active Directory (AD) domain controller (DC) service is managed by the <code>/etc/init.d/samba-ad-dc</code> init script. If you have not created the script manually, see your operating system's documentation for the name of the Samba AD DC service.
$0 stop

sleep 1
{{Imbox
$0 start
| type = note
;;
| text = Depending on your operating system, there can be different ways to enable or disable a service. See your operating system's documentation for details.
*)
}}
echo "Usage: /etc/init.d/samba4 {start|stop|reload|restart|force-reload}"

exit 1

;;

esac
== Enabling and Disabling the Samba AD DC Service ==

exit 0
To enable the Samba Active Directory (AD) domain controller (DC) service to start automatically when the system boots, enter:

== Red Hat Enterprise Linux 6 ==

# chkconfig samba-ad-dc enable

To disable the automatic start of the Samba AD DC service, enter:

# chkconfig samba-ad-dc disable


== Debian ==

# update-rc.d samba-ad-dc defaults

To disable the automatic start of the Samba AD DC service, enter:

# update-rc.d -f samba-ad-dc remove



== Manually Starting and Stopping the Samba AD DC Service ==

To manually start the Samba Active Directory (AD) domain controller (DC) service, enter:

# service start samba-ad-dc

To manually stop the Samba AD DC service, enter:

# service stop samba-ad-dc

Latest revision as of 13:36, 22 September 2020

Introduction

The following describes how to use an init script to manage the Samba Active Directory (AD) domain controller (DC) service. Depending on your operating system, the location of the init script, its content, and the procedures how to manage the service can be different. For details, see your operating system's documentation.



Creating the Init Script

Red Hat Enterprise Linux 6

  • Create the /etc/init.d/samba-ad-dc file with the following content:
#!/bin/bash
#
# samba-ad-dc	This shell script takes care of starting and stopping
# 		samba AD daemons.
#
# chkconfig: - 58 74
# description: Samba Active Directory Domain Controller

### BEGIN INIT INFO
# Provides: samba-ad-dc
# Required-Start: $network $local_fs $remote_fs
# Required-Stop: $network $local_fs $remote_fs
# Should-Start: $syslog $named
# Should-Stop: $syslog $named
# Short-Description: start and stop samba-ad-dc
# Description: Samba Active Directory Domain Controller
### END INIT INFO

# Source function library.
. /etc/init.d/functions
 
# Source networking configuration.
. /etc/sysconfig/network
 
prog=samba
prog_dir=/usr/local/samba/sbin/
lockfile=/var/lock/subsys/$prog
 
start() {
	[ "$NETWORKING" = "no" ] && exit 1
	echo -n $"Starting Samba AD DC: "
	daemon $prog_dir/$prog -D
	RETVAL=$?
	echo
	[ $RETVAL -eq 0 ] && touch $lockfile
	return $RETVAL
}

 stop() {
	[ "$EUID" != "0" ] && exit 4
	echo -n $"Shutting down Samba AD DC: "
	killproc $prog_dir/$prog
	RETVAL=$?
	echo
	[ $RETVAL -eq 0 ] && rm -f $lockfile
	return $RETVAL
}
 
case "$1" in
start)
	start
	;;
stop)
	stop
	;;
status)
	status $prog
	;;
restart)
	stop
	start
	;;
*)
	echo $"Usage: $0 {start|stop|status|restart}"
	exit 2
esac
  • Make the script executeable:
# chmod 755 /etc/init.d/samba-ad-dc


Debian

  • Create the /etc/init.d/samba-ad-dc file with the following content:
#!/bin/sh

### BEGIN INIT INFO
# Provides:          samba-ad-dc
# Required-Start:    $network $local_fs $remote_fs
# Required-Stop:     $network $local_fs $remote_fs
# Default-Start:     2 3 4 5
# Default-Stop:      0 1 6
# Short-Description: start Samba daemons for the AD DC
### END INIT INFO

#
# Start/stops the Samba daemon (samba).
# Adapted from the Samba 3 packages.
#

PATH=/usr/local/samba/sbin:/usr/local/samba/bin:$PATH

PIDDIR=/usr/local/samba/var/run
SAMBAPID=$PIDDIR/samba.pid

# clear conflicting settings from the environment
unset TMPDIR

# See if the daemon and the config file are there
test -x /usr/local/samba/sbin/samba -a -r /usr/local/samba/etc/smb.conf || exit 0

. /lib/lsb/init-functions

case "$1" in
        start)
                SERVER_ROLE=`samba-tool testparm --parameter-name="server role"  2>/dev/null | tail -1`
                if [ "$SERVER_ROLE" != "active directory domain controller" ]; then
                    exit 0
                fi

                # CVE-2013-4475
                KEYFILE=/usr/local/samba/private/tls/key.pem
                if [ -e $KEYFILE ]; then
                    KEYPERMS=`stat -c %a $KEYFILE`
                    if [ "$KEYPERMS" != "600" ]; then
                        echo "wrong permission on $KEYFILE, must be 600"
                        echo "samba will not start (CVE-2013-4475)"
                        echo "Removing all tls .pem files will cause an auto-regeneration with the correct permissions."
                        exit 1
                    fi
               fi

               log_daemon_msg "Starting Samba AD DC daemon" "samba"
               # Make sure we have our PIDDIR, even if it's on a tmpfs
               install -o root -g root -m 755 -d $PIDDIR
 
               if ! start-stop-daemon --start --quiet --oknodo --exec /usr/local/samba/sbin/samba -- -D; then
                   log_end_msg 1
                   exit 1
               fi

               log_end_msg 0
               ;;
       stop)
               log_daemon_msg "Stopping Samba AD DC daemon" "samba"

              start-stop-daemon --stop --quiet --pidfile $SAMBAPID
               # Wait a little and remove stale PID file
               sleep 1
               if [ -f $SAMBAPID ] && ! ps h `cat $SAMBAPID` > /dev/null
               then
                   # Stale PID file (samba was succesfully stopped),
                   # remove it (should be removed by samba itself IMHO.)
                   rm -f $SAMBAPID
               fi

              log_end_msg 0

               ;;
       restart|force-reload)
               $0 stop
               sleep 1
               $0 start
               ;;
       status)
               status_of_proc -p $SAMBAPID /usr/local/samba/sbin/samba samba
               exit $?
               ;;
       *)
               echo "Usage: /etc/init.d/samba-ad-dc {start|stop|restart|force-reload|status}"
               exit 1
               ;;
esac

exit 0


  • If necessary, update the locations to the samba service, the samba-tool utility, and the smb.conf file in the /etc/init.d/samba-ad-dc file.
  • Make the script executeable:
# chmod 755 /etc/init.d/samba-ad-dc



Managing the Samba AD DC Service

The following assumes that the Samba Active Directory (AD) domain controller (DC) service is managed by the /etc/init.d/samba-ad-dc init script. If you have not created the script manually, see your operating system's documentation for the name of the Samba AD DC service.


Enabling and Disabling the Samba AD DC Service

To enable the Samba Active Directory (AD) domain controller (DC) service to start automatically when the system boots, enter:

Red Hat Enterprise Linux 6

# chkconfig samba-ad-dc enable

To disable the automatic start of the Samba AD DC service, enter:

# chkconfig samba-ad-dc disable


Debian

# update-rc.d samba-ad-dc defaults

To disable the automatic start of the Samba AD DC service, enter:

# update-rc.d -f samba-ad-dc remove


Manually Starting and Stopping the Samba AD DC Service

To manually start the Samba Active Directory (AD) domain controller (DC) service, enter:

# service start samba-ad-dc

To manually stop the Samba AD DC service, enter:

# service stop samba-ad-dc