/usr/share/doc/samhain/manual.html/deployment.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Deployment to remote hosts</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Samhain Host Integrity Monitoring System"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Packing the executable"
HREF="packing-the-executable.html"><LINK
REL="NEXT"
TITLE="Method B: The native package manager"
HREF="native-packages.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="./docbook.css"></HEAD
><BODY
CLASS="CHAPTER"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><!--#if expr="! ($HTTP_USER_AGENT = /MSIE/)"--><!--#include virtual="/resources/ssi/header.html"--><!--#endif --><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Samhain Host Integrity Monitoring System</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="packing-the-executable.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="native-packages.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="CHAPTER"
><H1
><A
NAME="DEPLOYMENT"
></A
>Chapter 10. Deployment to remote hosts</H1
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="DEPLOY.SH"
>10.1. Method A: The deployment system</A
></H1
><P
>	<SPAN
CLASS="APPLICATION"
>samhain</SPAN
> includes a system 
	to facilitate deployment of the
	client to remote hosts. This system enables you to: build and store
	binary packages for different operating systems, install them,
	create baseline databases upon installation, update the
	server configuration, and maintain the client database required
	by the <SPAN
CLASS="APPLICATION"
>beltane</SPAN
> web-based console.</P
><P
>        The system comprises a shell script <B
CLASS="COMMAND"
>deploy.sh</B
>
	that will be installed in the same directory as the 
	<SPAN
CLASS="APPLICATION"
>samhain/yule</SPAN
> (by default,
	<TT
CLASS="FILENAME"
>/usr/local/sbin</TT
>), and a directory tree that
	will be installed below the <SPAN
CLASS="APPLICATION"
>samhain/yule</SPAN
>
	data directory (see <A
HREF="deployment.html#DEPLOY-LAYOUT"
>Section 10.1.2</A
>&#62;). The script
	and the directory tree can be relocated freely. There is a 
	configuration file <TT
CLASS="FILENAME"
>~/.deploy.conf</TT
> that is created
	in the home directory of the user when <B
CLASS="COMMAND"
>deploy.sh</B
>
	is run for the first time, where you can specify the default for
	the top level directory of the system.</P
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Note</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>        In the following, an <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>architecture</I
></SPAN
> is 
        just a label for some group of hosts, typically a
        particular operating system (or some particular installation thereof).
        As long as you know what the label means, you can choose it freely
        (alphanumeric + underscore).
        </P
><P
>        The architecture for a build/install host (i.e. the
	association between a host and the architecture-specific
	configuration data) is currently 
        specified via a command-line option.
        </P
></TD
></TR
></TABLE
></DIV
><P
>        The system allows to use per-architecture customized build 
	options, as well as per-host customized runtime configuration
	files.</P
><P
>        By default, the system will search for a sufficiently 
	advanced incarnation of <SPAN
CLASS="APPLICATION"
>dialog</SPAN
> to
	provide a nice user interface. You can switch this off in favour
	of a plain console interface, if you prefer (or if you want to run
	the script non-interactively).</P
><P
>       To use this system, you must first install it with the command:</P
><PRE
CLASS="SCREEN"
><SAMP
CLASS="PROMPT"
>sh$ </SAMP
><KBD
CLASS="USERINPUT"
>make install-deploy</KBD
></PRE
><DIV
CLASS="TIP"
><P
></P
><TABLE
CLASS="TIP"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Installation tip</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>       This system is somewhat tied to the server (yule). While you can safely
       install it later, installing it together with the server will take care
       that the defaults are already correct. Upon first invocation
       a configuration file <TT
CLASS="FILENAME"
>~/.deploy.conf</TT
> will 
       be written, where you can modify the defaults settings.
       </P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Backward compatibility</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>       The deployment system has been completely revised in version 2.0 of 
       samhain. It will <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>not</I
></SPAN
> work with samhain versions 
       below 2.0 (i.e. you cannot install them
       using this system). However, the default location and format 
       of the client database (used by the <SPAN
CLASS="APPLICATION"
>beltane</SPAN
> 
       web-based console) has not changed.
       </P
><P
>       Installing the new version of the deploy system will not overwrite the
       old version (deploy.sh will be installed as deploy2.sh, if an old 
       version is detected).
       </P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-REQ"
>10.1.1. Requirements</A
></H2
><P
><P
></P
><OL
TYPE="1"
><LI
><P
>	You must have compiled and installed the server 
	(<SPAN
CLASS="APPLICATION"
>yule</SPAN
>) on the local host
	where you use the deploy system.
	</P
></LI
><LI
><P
>	You must have installed the deployment system
	by using <B
CLASS="COMMAND"
>make deploy-install</B
>.
	This will install the script <TT
CLASS="FILENAME"
>deploy.sh</TT
>
	into the <TT
CLASS="FILENAME"
>sbindir</TT
> 
	(default <TT
CLASS="FILENAME"
>/usr/local/sbin</TT
>, 
	but depends on your configure options),
	and the deployment system into 
	<TT
CLASS="FILENAME"
>localstatedir/install_name/profiles</TT
>
	(default <TT
CLASS="FILENAME"
>/var/lib/yule/profiles</TT
>,
	but depends on your configure options).
	</P
><P
>	If you already have installed the deprecated version 1 
	deployment system,
	the script will be installed as <TT
CLASS="FILENAME"
>deploy2.sh</TT
>.
	</P
></LI
><LI
><P
>	For each architecture that you define, there must be (at least)
	one <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>build host</I
></SPAN
> where
	development tools (C compiler, make, strip) are available
	to build the client executable.
	</P
></LI
><LI
><P
>	On each remote where you want to build or install, 
	you should be able to login as root with ssh
	using RSA authentication, such that ssh-agent can be used.
	</P
></LI
></OL
></P
><DIV
CLASS="TIP"
><P
></P
><TABLE
CLASS="TIP"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Tip</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>To use RSA-based authentication in a <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>secure</I
></SPAN
> way, 
you may proceed as follows:</P
><P
>Use <B
CLASS="COMMAND"
>ssh-keygen</B
> to create a public/private key pair. Don't
forget to set a passphrase for the private key (<B
CLASS="COMMAND"
>ssh-keygen</B
>
will ask for it).</P
><P
>Copy the public key (<TT
CLASS="FILENAME"
>HOME/.ssh/identity.pub</TT
> for
the ssh protocol version 1, <TT
CLASS="FILENAME"
>HOME/.ssh/id_rsa.pub</TT
>
for ssh protocol version 2) to
<TT
CLASS="FILENAME"
>HOME/.ssh/authorized_keys</TT
> on any remote host where you
want to log in. <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Do not copy the private key</I
></SPAN
> 
<TT
CLASS="FILENAME"
>HOME/.ssh/identity</TT
> (ssh protocol version 1) or 
<TT
CLASS="FILENAME"
>HOME/.ssh/id_rsa</TT
> (ssh protocol version 2) to 
any untrusted host !</P
><P
>On your central host, execute the commands (use &quot;ssh-agent -c&quot;
if you are using a csh-style shell):</P
><PRE
CLASS="SCREEN"
><SAMP
CLASS="PROMPT"
>bash$</SAMP
><KBD
CLASS="USERINPUT"
>eval `ssh-agent -s`</KBD
>
<SAMP
CLASS="PROMPT"
>bash$</SAMP
><KBD
CLASS="USERINPUT"
>ssh-add</KBD
></PRE
><P
>You can then ssh/scp without typing the passphrase again, until
you exit the current shell.</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-LAYOUT"
>10.1.2. Layout of the deployment system</A
></H2
><PRE
CLASS="PROGRAMLISTING"
>(localstatedir)/(install_name)/profiles/
                      |
                      |
                      |-- source ------------&#62; (tarballs)
                      |
                      |-- configs -----------&#62; (default configs)
                      |
                      |-- archpkg
                      |    | 
                      |    |-- architecture -&#62; (compiled package, setup script)
                      |
                      |-- hosts
                      |    |
                      |    |-- hostname -----&#62; (optional host-specific config)
                      |
                      |-- libexec -----------&#62; (scripts)
                      |
                      |-- private -----------&#62; (gpg key)
                      |
                      |-- tmp</PRE
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-LAYOUT-CONFIGS"
>10.1.2.1. The configs subdirectory</A
></H3
><P
>The 
<TT
CLASS="FILENAME"
>configs</TT
> subdirectory holds for
each architecture at least two files (example files will be placed there upon 
installation of the deployment system): </P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>&lt;architecture&gt;.configure (required)</DT
><DD
><P
>     The configure options for this architecture; one option per line,
     each enclosed in single quotes. 
     </P
><P
>     If this file does not exist, it
     will be copied from <TT
CLASS="FILENAME"
>generic.configure</TT
>, which
     is created upon installation, and holds (only) some minimum options.
     </P
></DD
><DT
>&lt;architecture&gt;.samhainrc (required)</DT
><DD
><P
>     The default runtime configuration file for a client running 
     on this architecture. It is possible to override this on
     installation with a file <TT
CLASS="FILENAME"
>hosts/&lt;hostname&gt;/samhainrc</TT
>.
     </P
></DD
><DT
>&lt;architecture&gt;.preinstall (optional)</DT
><DD
><P
>     The shell script to run before installing a client. Typically
     this script would shutdown the running client, if there is one.
     </P
><P
>     Defaults to <TT
CLASS="FILENAME"
>libexec/preinstall</TT
>.
     </P
></DD
><DT
>&lt;architecture&gt;.postinstall (optional)</DT
><DD
><P
>     The shell script to run after installing a client. This script
     receives the client password as first (and only) argument, and
     typically would set the password in the client binary.
     </P
><P
>     Defaults to <TT
CLASS="FILENAME"
>libexec/postinstall</TT
>.
     </P
></DD
><DT
>&lt;architecture&gt;.initscript (optional)</DT
><DD
><P
>     The shell script to initialize/update the baseline database file
     installing a client.
     </P
><P
>     Defaults to <TT
CLASS="FILENAME"
>libexec/initscript</TT
>.
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-LAYOUT-ARCHPKG"
>10.1.2.2. The archpkg subdirectory</A
></H3
><P
>The 
<TT
CLASS="FILENAME"
>archpkg</TT
> directory holds for
each architecture a subdirectory
<TT
CLASS="FILENAME"
>archpkg/&lt;architecture&gt;</TT
>, where
compiled binary installer packages are stored. </P
><P
>For each build, up to four files will be stored: (a) the binary
installer package <TT
CLASS="FILENAME"
>samhain-&lt;version&gt;.&lt;format&gt;</TT
>, 
(b) the configure options used 
(<TT
CLASS="FILENAME"
>configure-&lt;version&gt;.&lt;format&gt;</TT
>), 
(c) the
samhain-install.sh script generated during the build
(<TT
CLASS="FILENAME"
>install-&lt;version&gt;.&lt;format&gt;</TT
>), and
(only for packed executables) the client password set in the
executable (<TT
CLASS="FILENAME"
>PASSWD-&lt;version&gt;.&lt;format&gt;</TT
>).</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-CUSTOMIZE"
>10.1.3. Customizing the system</A
></H2
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN4314"
>10.1.3.1. Setting default options</A
></H3
><P
>If you want to change the default options, you can set
some of them via a configuration file
<TT
CLASS="FILENAME"
>~/.deploy.conf</TT
>, which is created
upon the first invocation of <B
CLASS="COMMAND"
>deploy.sh</B
>.</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN4319"
>10.1.3.2. Adding support for an architecture</A
></H3
><P
>To add support for another architecture &lt;arch&gt;, 
just create the two files 
<TT
CLASS="FILENAME"
>&lt;arch&gt;.configure</TT
> (configure options)
and 
<TT
CLASS="FILENAME"
>&lt;arch&gt;.samhainrc</TT
> (runtime configuration)
in the
<TT
CLASS="FILENAME"
>configs</TT
> directory of the
deployment system (see <A
HREF="deployment.html#DEPLOY-LAYOUT"
>Section 10.1.2</A
>&#62;).</P
><P
>Upon installation of the system, a template file
<TT
CLASS="FILENAME"
>generic.configure</TT
> is created, which
contains the minimum options for a client.</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN4328"
>10.1.3.3. Per-architecture pre-/postinstallation scripts</A
></H3
><P
></P
><P
>The default scripts for preinstallation (shutting down the running
client) and postinstallation (setting the client password, fixing the
local configuration file), and the script
for database initialization are located in the 
<TT
CLASS="FILENAME"
>libexec</TT
> directory. You can override
them for some (or all) architectures by storing architecture-specific files 
<TT
CLASS="FILENAME"
>&lt;arch&gt;.preinstall</TT
>,
<TT
CLASS="FILENAME"
>&lt;arch&gt;.postinstall</TT
>,
<TT
CLASS="FILENAME"
>&lt;arch&gt;.initscrip</TT
> in the
<TT
CLASS="FILENAME"
>configs</TT
> directory.</P
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="AEN4337"
>10.1.3.4. Per-host runtime configuration</A
></H3
><P
>If you want to override the runtime configuration file
<TT
CLASS="FILENAME"
>configs/&lt;arch&gt;.samhainrc</TT
> on a per-host
basis, you need to store a host-specific runtime configuration file
as <TT
CLASS="FILENAME"
>hosts/&lt;hostname&gt;/samhainrc</TT
>, before
you run <B
CLASS="COMMAND"
>deploy.sh install</B
>.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-SCRIPT"
>10.1.4. Using the deploy.sh script</A
></H2
><DIV
CLASS="TIP"
><P
></P
><TABLE
CLASS="TIP"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Tip</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>When run for the first time, <B
CLASS="COMMAND"
>deploy.sh</B
> 
will create a configuration file
<TT
CLASS="FILENAME"
>~/.deploy.conf</TT
> with some default configuration
options. You may want to review this file. Note that you can override
all options there with command-line options; the configuration file
is just for convenience, if you don't like the defaults and don't want
to type the corresponding option on the command line every time.</P
></TD
></TR
></TABLE
></DIV
><P
><B
CLASS="COMMAND"
>deploy.sh</B
> can be invoked in three ways:</P
><PRE
CLASS="SCREEN"
><SAMP
CLASS="PROMPT"
>bash$</SAMP
><KBD
CLASS="USERINPUT"
>deploy.sh --help</KBD
>
This will provide a general overview.
<SAMP
CLASS="PROMPT"
>bash$</SAMP
><KBD
CLASS="USERINPUT"
>deploy.sh --help command</KBD
>
This will provide help on a specific command (where command can be any of:
'clean', 'download', 'checksrc', 'build', or 'install'.
<SAMP
CLASS="PROMPT"
>bash$</SAMP
><KBD
CLASS="USERINPUT"
>deploy.sh [options] command</KBD
>
This will run 'command' with the specified options.</PRE
><P
>A log of the last run will be kept in
<TT
CLASS="FILENAME"
>tmp/logfile.lastrun</TT
></P
><P
><SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>command</I
></SPAN
> can be any of the following:</P
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>info</DT
><DD
><P
>     Provides information on installed clients, or available installer 
     packages.
     </P
></DD
><DT
>clean</DT
><DD
><P
>     Removes source tarballs from the 
     <TT
CLASS="FILENAME"
>source</TT
> subdirectory of the
     deploy system. Removes unused installer packages from the
     <TT
CLASS="FILENAME"
>archpkg/&lt;arch&gt;</TT
> subdirectories
     of the deploy system. 
     </P
></DD
><DT
>download</DT
><DD
><P
>     Download a source tarball from the distribution site, verify
     the GnuPG signature (gpg must be installed), and install it into
     the <TT
CLASS="FILENAME"
>source</TT
> subdirectory of the
     deploy system. <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>Requires</I
></SPAN
> one of: 
     <B
CLASS="COMMAND"
>wget</B
>,
     <B
CLASS="COMMAND"
>curl</B
>, <B
CLASS="COMMAND"
>links</B
>, 
     <B
CLASS="COMMAND"
>lynx</B
>, <B
CLASS="COMMAND"
>fetch</B
>, or 
     <B
CLASS="COMMAND"
>lwp-request</B
>.
     </P
></DD
><DT
>checksrc</DT
><DD
><P
>     Check the GnuPG signatures of available source tarballs in
     the <TT
CLASS="FILENAME"
>source</TT
> subdirectory of the
     deploy system (gpg must be installed). Optionally delete tarballs
     with no/invalid signature.
     </P
></DD
><DT
>build</DT
><DD
><P
>     Build a binary installer package for the chosen architecture
     from one of the tarballs in the
     <TT
CLASS="FILENAME"
>source</TT
> subdirectory, and 
     store it in the 
     <TT
CLASS="FILENAME"
>archpkg/&lt;architecture&gt;</TT
> 
     subdirectory (which will be created if it does not exist yet).
     Requires a file <TT
CLASS="FILENAME"
>&lt;architecture&gt;.configure</TT
>
     and a file <TT
CLASS="FILENAME"
>&lt;architecture&gt;.samhainrc</TT
> in the
     <TT
CLASS="FILENAME"
>configs</TT
> subdirectory.
     </P
></DD
><DT
>install</DT
><DD
><P
>     Copy a pre-built binary package (built with 
     <B
CLASS="COMMAND"
>deploy.sh build</B
>)
     to a remote host, stop the client running there (if any), install
     the (new) client, update the server configuration
     file and reload the server, initialize the file signature database
     and fetch it from the remote host.
     </P
></DD
><DT
>uninstall</DT
><DD
><P
>     Remove a samhain client that was previously installed
     with
     <B
CLASS="COMMAND"
>deploy.sh install</B
>.
     </P
></DD
></DL
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-SH-GENERAL"
>10.1.4.1. General options</A
></H3
><P
><B
CLASS="COMMAND"
>-q | --quiet | --quiet=2</B
> Produce output suitable for 
logging. Note that --quiet=2 implies --yes (see below).</P
><P
><B
CLASS="COMMAND"
>-s | --simulate</B
> Print what would be done, but do
not actually change the system.</P
><P
><B
CLASS="COMMAND"
>-y | --yes</B
> Assume yes as answer to
        all prompts and run non-interactively.</P
><P
><B
CLASS="COMMAND"
>-o &lt;file&gt; | --logfile=&lt;file&gt;</B
> 
        Specify an output file for messages that would go to stdout
        otherwise. Has no effect on stderr (error messages).</P
><P
><B
CLASS="COMMAND"
> -d &lt;dialog&gt; | --dialog=&lt;dialog&gt;</B
> 
Specify your preferred &quot;dialog&quot;
        clone (e.g. Xdialog). Use &quot;no&quot; to force plain text.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-INFO"
>10.1.5. deploy.sh info</A
></H2
><P
>This command will show information for hosts in the client 
database (default), or for available
binary installer packages.</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-INFO-OPT"
>10.1.5.1. Specific options</A
></H3
><P
><B
CLASS="COMMAND"
>--packages</B
> Show information for
available installer packages rather than for clients.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-CLEAN"
>10.1.6. deploy.sh clean</A
></H2
><P
>This command will clean unused files: source tarballs
in the <TT
CLASS="FILENAME"
>source</TT
> subdirectory, and
unused installer packages in the
<TT
CLASS="FILENAME"
>archpkg/&lt;arch&gt;</TT
> subdirectories.</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-CLEAN-OPT"
>10.1.6.1. Specific options</A
></H3
><P
>There are no specific options for this command.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-DOWNLOAD"
>10.1.7. deploy.sh download</A
></H2
><P
>This command will download a source tarball from the distribution
website, verify its GnuPG signature, and install it into the
<TT
CLASS="FILENAME"
>source</TT
> subdirectory. This command
requires that either <B
CLASS="COMMAND"
>wget</B
> or <B
CLASS="COMMAND"
>lynx</B
>
is in your PATH.</P
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Manual installation of source</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>This note applies if you want to download source manually instead.
Samhain distribution tarballs contain exactly two files: first, a
source tarball with the source code, and second, its GnuPG signature.
For installation into the <TT
CLASS="FILENAME"
>source</TT
> 
subdirectory, the distribution tarball must be unpacked, and both the
source source tarball and its GnuPG signature moved into the
<TT
CLASS="FILENAME"
>source</TT
> subdirectory.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-DOWNLOAD-OPT"
>10.1.7.1. Specific options</A
></H3
><P
><B
CLASS="COMMAND"
>--version=&lt;version&gt;</B
> The version of samhain 
to download. The
default is &quot;current&quot; to download the current version.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-CHECKSRC"
>10.1.8. deploy.sh checksrc</A
></H2
><P
>This command will check the GnuPG signatures of source tarballs in the
<TT
CLASS="FILENAME"
>source</TT
> subdirectory. </P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-CHECKSRC-OPT"
>10.1.8.1. Specific options</A
></H3
><P
><B
CLASS="COMMAND"
>--delete</B
> Delete source tarballs if PGP signature
        cannot be verified.</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-BUILD"
>10.1.9. deploy.sh build</A
></H2
><P
>This command will create a temporary directory on a remote build host,
copy the selected version of the source there, build the selected format
of the binary installer package, retrieve and store the package
into the <TT
CLASS="FILENAME"
>archpkg/&lt;architecture&gt;</TT
> 
subdirectory, and remove the temporary build directory.</P
><P
>For each build, up to four files will be stored: (a) the binary
installer package <TT
CLASS="FILENAME"
>samhain-&lt;version&gt;.&lt;format&gt;</TT
>, 
(b) the configure options used 
(<TT
CLASS="FILENAME"
>configure-&lt;version&gt;.&lt;format&gt;</TT
>), 
(c) the
samhain-install.sh script generated during the build
(<TT
CLASS="FILENAME"
>install-&lt;version&gt;.&lt;format&gt;</TT
>), and
(only for packed executables) the client password set in the
executable (<TT
CLASS="FILENAME"
>PASSWD-&lt;version&gt;.&lt;format&gt;</TT
>).</P
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Package formats</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Note that the build host must provide the required tools if you want
to build a package for the native package manager (i.e. deb, rpm, tbz2,
depot (HP-UX),
or solaris pkg). On RPM-based Linux distributions and Gentoo Linux, building
of RPMs and tbz2s, respectively, should just work. Debian requires additional
packages for building debs.</P
><P
> 
The &quot;run&quot; binary package format does not
require additional tools (it is a self-extracting tar package based on the
<SPAN
CLASS="APPLICATION"
>makeself</SPAN
> application, which is included in the
samhain distribution). Use <B
CLASS="COMMAND"
>/bin/sh &lt;package&gt; --help</B
>
for details.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-BUILD-OPT"
>10.1.9.1. Specific options</A
></H3
><P
><B
CLASS="COMMAND"
>--host=&lt;hostname&gt;</B
> The build host.</P
><P
><B
CLASS="COMMAND"
>--arch=&lt;arch&gt;</B
> The architecture to build for. 
This is used to get the "./configure" options from the file
<TT
CLASS="FILENAME"
>configs/&lt;arch&gt;.configure</TT
>, and to store the binary package
into the directory <TT
CLASS="FILENAME"
>archpkg/&lt;arch&gt;</TT
>.</P
><P
><B
CLASS="COMMAND"
>--version=&lt;version&gt;</B
> The version of samhain you 
want to build. Must be in the <TT
CLASS="FILENAME"
>source</TT
>
subdirectory.</P
><P
><B
CLASS="COMMAND"
>--format=&lt;run|rpm|deb|tbz2|depot|solaris-pkg&gt;</B
> The format
of the binary installer package. &quot;run&quot; is a portable (Unix)
package based on <SPAN
CLASS="APPLICATION"
>makeself</SPAN
>, 
&quot;deb&quot; is a Debian package, &quot;tbz2&quot; is a binary 
Gentoo Linux package, &quot;rpm&quot; is an RPM package, &quot;depot&quot; is
an HP-UX binary package, and 
&quot;solaris-pkg&quot; for Sun Solaris.</P
><P
><B
CLASS="COMMAND"
>--packed=&lt;password&gt;</B
> Build a packed executable, and
set the client password before packing.  </P
><P
><B
CLASS="COMMAND"
>--user=&lt;username&gt;</B
> Login as &lt;username&gt; on the
build host (defaults to root).</P
><P
><B
CLASS="COMMAND"
>--add-path=&lt;path&gt;</B
> Append &lt;path&gt; to the PATH
variable on the build host.</P
><P
><B
CLASS="COMMAND"
>--tmpdir=&lt;path&gt;</B
> Temporary directory to use on the build host (defaults to <TT
CLASS="FILENAME"
>/tmp</TT
>).</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-INSTALL"
>10.1.10. deploy.sh install</A
></H2
><P
>This command will create a temporary directory on a remote host,
copy the selected version of the installer package, its corresponding
samhain-install.sh script, the runtime
configuration file, and the 
preinstall, postinstall, initscripts scripts there. It will then:</P
><P
>(A) run the <TT
CLASS="FILENAME"
>preinstall</TT
> script on the client, 
which shuts down the running samhain daemon (if there is any).</P
><P
>(B) install the binary installer package on the client.</P
><P
>(C) run the <TT
CLASS="FILENAME"
>postinstall</TT
> script on the client, 
which sets
the client password (unless the binary is packed), and replaces the
default runtime configuration file with the proper one. The latter
step is required, because <B
CLASS="COMMAND"
>deploy.sh build</B
> builds
from the pristine source, so the runtime configuration file in the
installer package is just the default one.</P
><P
>(D) copy the proper client runtime configuration file to the
server data directory (as <TT
CLASS="FILENAME"
>rc.&lt;client_name&gt;</TT
>), fix
the server configuration file, and restart the server (which will
fail non-fatally if the server is not running).</P
><P
>(E) run the <TT
CLASS="FILENAME"
>initscript</TT
> script on the client,
which initializes (or updates) the baseline database.</P
><P
>(F) retrieve the baseline database, copy it to the server data
directory (as <TT
CLASS="FILENAME"
>file.&lt;client_name&gt;</TT
>), and remove
the temporary directory on the client.</P
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>The runtime configuration file</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>If <TT
CLASS="FILENAME"
>hosts/&lt;hostname&gt;/&lt;arch&gt;.samhainrc</TT
> or 
<TT
CLASS="FILENAME"
>hosts/&lt;hostname&gt;/samhainrc</TT
> exists, this will
be used (in this order of preference), 
otherwise <TT
CLASS="FILENAME"
>configs/&lt;arch&gt;.samhainrc</TT
>
will be used. If the latter does not exist, the command will fail.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="NOTE"
><P
></P
><TABLE
CLASS="NOTE"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Transparent handling of particular build options</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The build options '--enable-stealth=..' is handled
by determining the argument from the configure options that were used
for the build, and preparing the runtime configuration file appropriately.
I.e., you should provide a 'normal', plain-text configuration file.</P
><P
>The build option '--with-nocl=..' is handled 
by determining the argument (which is required for database initialization) 
from the configure options that were used
for the build, and passing it to the <TT
CLASS="FILENAME"
>initscript</TT
> script.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-INSTALL-OPT"
>10.1.10.1. Specific options</A
></H3
><P
><B
CLASS="COMMAND"
>--host=&lt;hostname&gt;</B
> The host on which to install.</P
><P
><B
CLASS="COMMAND"
>--group=&lt;foobar&gt;</B
> The group to which you want to assign that client (default: none). This is used by the <SPAN
CLASS="APPLICATION"
>beltane</SPAN
> web console to restrict access to users which are members of that group.</P
><P
><B
CLASS="COMMAND"
>--arch=&lt;arch&gt;</B
> The architecture to install. 
This is used to get the installer package from the directory
<TT
CLASS="FILENAME"
>archpkg/&lt;arch&gt;/</TT
>.</P
><P
><B
CLASS="COMMAND"
>--version=&lt;version&gt;</B
> The version of samhain you 
want to install. An installer package for this version must exist in
the <TT
CLASS="FILENAME"
>archpkg/&lt;arch&gt;/</TT
>
subdirectory.</P
><P
><B
CLASS="COMMAND"
>--format=&lt;run|rpm|deb|tbz2|depot|solaris-pkg&gt;</B
> The format
of the binary installer package. &quot;run&quot; is a portable (Unix)
package based on <SPAN
CLASS="APPLICATION"
>makeself</SPAN
>, 
&quot;deb&quot; is a Debian package, &quot;tbz2&quot; is a binary 
Gentoo Linux package, &quot;rpm&quot; is an RPM package, &quot;depot&quot; is 
an HP-UX binary package, and 
&quot;solaris-pkg&quot; for Sun Solaris.</P
><P
><B
CLASS="COMMAND"
>--yule_exec=&lt;path&gt;</B
> Path to the yule executable.</P
><P
><B
CLASS="COMMAND"
>--yule_conf=&lt;path&gt;</B
> Path to the yule configuration file.</P
><P
><B
CLASS="COMMAND"
>--yule_data=&lt;path&gt;</B
> Path to the yule data directory.</P
><P
><B
CLASS="COMMAND"
>--no-init</B
> Do not initialize the file signature 
(baseline) database (and consequentially, do not replace the
<TT
CLASS="FILENAME"
>file.&lt;host&gt;</TT
> file on server.</P
><P
><B
CLASS="COMMAND"
>--no-rcfile</B
> Do not replace the 
<TT
CLASS="FILENAME"
>rc.&lt;host&gt;</TT
> file on server.</P
><P
><B
CLASS="COMMAND"
>--no-start</B
> Do not start up the client after
installation.</P
><P
><B
CLASS="COMMAND"
>--local=&lt;command&gt;</B
> An optional command executed
locally (i.e. on the server) twice (with the last argument set to 'first'
and 'second', respectively. First is after client config file installation 
(i.e. before baseline database initialisation on the client),
second is just before client startup. The script will be called with the
following five arguments:
<P
></P
><OL
TYPE="1"
><LI
><P
>      <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>hostname</I
></SPAN
>, i.e. the host on which to install,
    </P
></LI
><LI
><P
>      <SPAN
CLASS="emphasis"
><I
CLASS="EMPHASIS"
>arch</I
></SPAN
>, the architecture to install,
    </P
></LI
><LI
><P
>      the directory where the deployment system is installed (default is <TT
CLASS="FILENAME"
>/var/lib/yule/profiles</TT
>, but depends on your configure options),
    </P
></LI
><LI
><P
>      the server data directory where client configuration files and baseline databases are stored (default is <TT
CLASS="FILENAME"
>/var/lib/yule</TT
>, but depends on your configure options),
    </P
></LI
><LI
><P
>      the literal word 'first' if the script is called the first time during client installation, the literal word 'second' otherwise.
    </P
></LI
></OL
></P
><P
><B
CLASS="COMMAND"
>--tmpdir=&lt;path&gt;</B
> Temporary directory to use on the installation host (defaults to <TT
CLASS="FILENAME"
>/tmp</TT
>).</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-UNINSTALL"
>10.1.11. deploy.sh uninstall</A
></H2
><P
>This command will remove a samhain client that was previously installed
by using <B
CLASS="COMMAND"
>deploy.sh install</B
>.</P
><DIV
CLASS="SECT3"
><H3
CLASS="SECT3"
><A
NAME="DEPLOY-UNINSTALL-OPT"
>10.1.11.1. Specific options</A
></H3
><P
><B
CLASS="COMMAND"
>--host=&lt;hostname&gt;</B
> The host on which to uninstall.</P
><P
><B
CLASS="COMMAND"
>--tmpdir=&lt;path&gt;</B
> Temporary directory to use on this host (defaults to <TT
CLASS="FILENAME"
>/tmp</TT
>).</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
NAME="DEPLOY-MISC"
>10.1.12. Usage notes</A
></H2
><DIV
CLASS="WARNING"
><P
></P
><TABLE
CLASS="WARNING"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="./stylesheet-images/warning.gif"
HSPACE="5"
ALT="Warning"></TD
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
>Warning</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>On Solaris, the PATH environment variable on the remote host (where you
build or deploy) may get set according to /etc/default/su, which may 
be different from what you would expect (noted by S. Bailey). </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="packing-the-executable.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="native-packages.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Packing the executable</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
>&nbsp;</TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Method B: The native package manager</TD
></TR
></TABLE
></DIV
><!--#if expr="! ($HTTP_USER_AGENT = /MSIE/)"--><!--#include virtual="/resources/ssi/footer.html"--><!--#endif --></BODY
></HTML
>
samhain 3.1.0-5ubuntu1 / usr / share / doc / samhain / manual.html / deployment.html
