File: Samba3-HOWTO.tex

package info (click to toggle)
samba 2%3A3.2.5-4lenny15
links: PTS
area: main
in suites: lenny
size: 124,704 kB
ctags: 69,181
sloc: ansic: 564,153; xml: 219,271; sh: 11,039; perl: 4,458; makefile: 4,301; python: 1,975; cpp: 1,224; exp: 1,147; yacc: 881; awk: 557; csh: 58; sed: 45
file content (27206 lines) | stat: -rw-r--r-- 1,783,703 bytes
% ------------------------------------------------------------	
% Autogenerated LaTeX file for books	
% ------------------------------------------------------------	
\ifx\pdfoutput\undefined
\documentclass[,letterpaper,11pt,openright,twoside,]{sambadoc}
\else
\documentclass[pdftex,,letterpaper,11pt,openright,twoside,]{sambadoc}
\fi
\label{Samba-HOWTO-Collection}\usepackage{ifthen}
% --------------------------------------------
% Check for PDFLaTeX/LaTeX 
% --------------------------------------------
\newif\ifpdf
\ifx\pdfoutput\undefined
\pdffalse % we are not running PDFLaTeX
\else
\pdfoutput=1 % we are running PDFLaTeX
\pdftrue
\fi
% --------------------------------------------
% Load graphicx package with pdf if needed 
% --------------------------------------------
\ifpdf
\usepackage[pdftex]{graphicx}
\pdfcompresslevel=9
\else
\usepackage{graphicx}
\fi

\makeatletter
% redefine the listoffigures and listoftables so that the name of the chapter
% is printed whenever there are figures or tables from that chapter. encourage
% pagebreak prior to the name of the chapter (discourage orphans).
\let\save@@chapter\@chapter
\let\save@@l@figure\l@figure
\let\the@l@figure@leader\relax
\def\@chapter[#1]#2{\save@@chapter[{#1}]{#2}%
\addtocontents{lof}{\protect\def\the@l@figure@leader{\protect\pagebreak[0]\protect\contentsline{chapter}{\protect\numberline{\thechapter}#1}{}{\thepage}}}%
\addtocontents{lot}{\protect\def\the@l@figure@leader{\protect\pagebreak[0]\protect\contentsline{chapter}{\protect\numberline{\thechapter}#1}{}{\thepage}}}%
}
\renewcommand*\l@figure{\the@l@figure@leader\let\the@l@figure@leader\relax\save@@l@figure}
\let\l@table\l@figure
\makeatother
% ---------------------- 
% Most Common Packages   
% ---------------------- 
\usepackage{latexsym}         
\usepackage{enumerate}         
\usepackage{fancybox}      
\usepackage{float}       
\usepackage{ragged2e}       
\usepackage{fancyvrb}         
\makeatletter\@namedef{FV@fontfamily@default}{\def\FV@FontScanPrep{}\def\FV@FontFamily{}}\makeatother
\fvset{obeytabs=true,tabsize=3}
\usepackage{parskip}         
\usepackage{rotating}         
\usepackage{subfigure}         
\usepackage{tabularx}         
\usepackage{url}         
% --------------------------------------------
% Math support                                
% --------------------------------------------
\usepackage{amsmath,amsthm, amsfonts, amssymb, amsxtra,amsopn}
%\newtheorem{thm}{Theorem}[section]
%\newtheorem{cor}[section]{Corollary}
%\newtheorem{lem}[section]{Lemma}
%\newtheorem{defn}[section]{Definition}
%\newtheorem{prop}[section]{Proposition}
%\newtheorem{ax}{Axiom}
%\newtheorem{theorem}[section]{Theorem}
%\newtheorem{corollary}{Corollary}
%\newtheorem{lemma}{Lemma}
%\newtheorem{proposition}{Proposition}
%\theoremstyle{definition}
%\newtheorem{definition}{Definition}
%\theoremstyle{remark}
%\newtheorem{rem}{Remark}
%\newtheorem*{notation}{Notation}
%\newcommand{\ntt}{\normalfont\ttfamily}
%\newcommand{\thmref}[1]{Theorem~\ref{#1}}
%\newcommand{\secref}[1]{\S\ref{#1}}
%\newcommand{\lemref}[1]{Lemma~\ref{#1}}
 \newcommand{\bysame}{\mbox{\rule{3em}{.4pt}}\,}
 \newcommand{\A}{\mathcal{A}}
 \newcommand{\B}{\mathcal{B}}
 \newcommand{\XcY}{{(X,Y)}}
 \newcommand{\SX}{{S_X}}
 \newcommand{\SY}{{S_Y}}
 \newcommand{\SXY}{{S_{X,Y}}}
 \newcommand{\SXgYy}{{S_{X|Y}(y)}}
 \newcommand{\Cw}[1]{{\hat C_#1(X|Y)}}
 \newcommand{\G}{{G(X|Y)}}
 \newcommand{\PY}{{P_{\mathcal{Y}}}}
 \newcommand{\X}{\mathcal{X}}
 \newcommand{\wt}{\widetilde}
 \newcommand{\wh}{\widehat}
 % --------------------------------------------
 %\DeclareMathOperator{\per}{per}
 \DeclareMathOperator{\cov}{cov}
 \DeclareMathOperator{\non}{non}
 \DeclareMathOperator{\cf}{cf}
 \DeclareMathOperator{\add}{add}
 \DeclareMathOperator{\Cham}{Cham}
 \DeclareMathOperator{\IM}{Im}
 \DeclareMathOperator{\esssup}{ess\,sup}
 \DeclareMathOperator{\meas}{meas}
 \DeclareMathOperator{\seg}{seg}
% --------------------------------------------
% --------------------------------------------
% Load hyperref package with pdf if needed 
% --------------------------------------------
\ifpdf
\usepackage[pdftex,bookmarksnumbered,colorlinks,backref,bookmarks,breaklinks,linktocpage,plainpages=false,hyperfigures,hyperindex,citecolor=black,urlcolor=black,filecolor=black,linkcolor=black,menucolor=red,pagecolor=black]{hyperref}
\else
\usepackage[bookmarksnumbered,colorlinks,backref,bookmarks,breaklinks,linktocpage,plainpages=false,]{hyperref}
\fi
% --------------------------------------------
% ----------------------------------------------
% Define a new LaTeX environment (adminipage)
% ----------------------------------------------
\newenvironment{admminipage}%
{ % this code corresponds to the \begin{adminipage} command
 \begin{Sbox}%
 \begin{minipage}%
} %done
{ % this code corresponds to the \end{adminipage} command
 \end{minipage}
 \end{Sbox}
 \fbox{\TheSbox}
} %done
% ----------------------------------------------
% Define a new LaTeX length (admlength)
% ----------------------------------------------
\newlength{\admlength}
% ----------------------------------------------
% Define a new LaTeX environment (admonition)
% With 2 parameters:
% #1 The file (e.g. note.pdf)
% #2 The caption
% ----------------------------------------------
\newenvironment{admonition}[2] 
{ % this code corresponds to the \begin{admonition} command
 \hspace{0mm}\newline\hspace*\fill\newline
 \noindent
 \setlength{\fboxsep}{5pt}
 \setlength{\admlength}{\linewidth}
 \addtolength{\admlength}{-10\fboxsep}
 \addtolength{\admlength}{-10\fboxrule}
 \admminipage{\admlength}
 {\bfseries \sc\large{#2}} \newline
 \\[1mm]
 \sffamily
 \includegraphics[width=1cm]{#1}
 \addtolength{\admlength}{-1cm}
 \addtolength{\admlength}{-20pt}
 \begin{minipage}[lt]{\admlength}
 \parskip=0.5\baselineskip \advance\parskip by 0pt plus 2pt
} %done
{ % this code corresponds to the \end{admonition} command
 \vspace{5mm} 
 \end{minipage}
 \endadmminipage
 \vspace{.5em}
 \par
}
% --------------------------------------------
% Commands to manage/style/create floats      
% figures, tables, algorithms, examples, eqn  
% --------------------------------------------
 \floatstyle{ruled}
 \restylefloat{figure}
 \floatstyle{ruled}
 \restylefloat{table}
 \floatstyle{ruled}
 \newfloat{program}{ht}{lop}[section]
 \floatstyle{ruled}
 \newfloat{example}{ht}{loe}[section]
 \floatname{example}{Example}
 \floatstyle{ruled}
 \newfloat{dbequation}{ht}{loe}[section]
 \makeatletter\def\toclevel@dbequation{0}\makeatother
 \floatname{dbequation}{Equation}
 \floatstyle{boxed}
 \newfloat{algorithm}{ht}{loa}[section]
 \floatname{algorithm}{Algorithm}
\ifpdf
\DeclareGraphicsExtensions{.pdf,.png,.jpg}
\else
\DeclareGraphicsExtensions{.eps}
\fi
% --------------------------------------------
% $latex.caption.swapskip enabled for $formal.title.placement support
\newlength{\docbooktolatextempskip}
\newcommand{\captionswapskip}{\setlength{\docbooktolatextempskip}{\abovecaptionskip}\setlength{\abovecaptionskip}{\belowcaptionskip}\setlength{\belowcaptionskip}{\docbooktolatextempskip}}
% --------------------------------------------
% Better linebreaks
\newcommand{\docbookhyphenatedot}[1]{{\hyphenchar\font=`\.\relax #1\hyphenchar\font=`\-}}
\newcommand{\docbookhyphenatefilename}[1]{{\hyphenchar\font=`\.\relax #1\hyphenchar\font=`\-}}
\newcommand{\docbookhyphenateurl}[1]{{\hyphenchar\font=`\/\relax #1\hyphenchar\font=`\-}}
\usepackage[english]{babel} 
% Guard against a problem with old package versions.
\makeatletter
\AtBeginDocument{
\DeclareRobustCommand\ref{\@refstar}
\DeclareRobustCommand\pageref{\@pagerefstar}
}
\makeatother
% --------------------------------------------
\makeatletter
\newcommand{\dbz}{\penalty \z@}
\newcommand{\docbooktolatexpipe}{\ensuremath{|}\dbz}
\newskip\docbooktolatexoldparskip
\newcommand{\docbooktolatexnoparskip}{\docbooktolatexoldparskip=\parskip\parskip=0pt plus 1pt}
\newcommand{\docbooktolatexrestoreparskip}{\parskip=\docbooktolatexoldparskip}
\def\cleardoublepage{\clearpage\if@twoside \ifodd\c@page\else\hbox{}\thispagestyle{empty}\newpage\if@twocolumn\hbox{}\newpage\fi\fi\fi}
\usepackage[]{ucs}
\usepackage[utf8]{inputenc}

\ifx\dblatex@chaptersmark\@undefined\def\dblatex@chaptersmark#1{\markboth{\MakeUppercase{#1}}{}}\fi
\let\save@makeschapterhead\@makeschapterhead
\def\dblatex@makeschapterhead#1{\vspace*{-80pt}\save@makeschapterhead{#1}}
\def\@makeschapterhead#1{\dblatex@makeschapterhead{#1}\dblatex@chaptersmark{#1}}

			
\AtBeginDocument{\ifx\refname\@undefined\let\docbooktolatexbibname\bibname\def\docbooktolatexbibnamex{\bibname}\else\let\docbooktolatexbibname\refname\def\docbooktolatexbibnamex{\refname}\fi}
% Facilitate use of \cite with \label
\newcommand{\docbooktolatexbibaux}[2]{%
  \protected@write\@auxout{}{\string\global\string\@namedef{docbooktolatexcite@#1}{#2}}
}
% Provide support for bibliography `subsection' environments with titles
\newenvironment{docbooktolatexbibliography}[3]{
   \begingroup
   \let\save@@chapter\chapter
   \let\save@@section\section
   \let\save@@@mkboth\@mkboth
   \let\save@@bibname\bibname
   \let\save@@refname\refname
   \let\@mkboth\@gobbletwo
   \def\@tempa{#3}
   \def\@tempb{}
   \ifx\@tempa\@tempb
      \let\chapter\@gobbletwo
      \let\section\@gobbletwo
      \let\bibname\relax
   \else
      \let\chapter#2
      \let\section#2
      \let\bibname\@tempa
   \fi
   \let\refname\bibname
   \begin{thebibliography}{#1}
}{
   \end{thebibliography}
   \let\chapter\save@@chapter
   \let\section\save@@section
   \let\@mkboth\save@@@mkboth
   \let\bibname\save@@bibname
   \let\refname\save@@refname
   \endgroup
}

		
			
%\usepackage{cite}
%\renewcommand\citeleft{(}  % parentheses around list
%\renewcommand\citeright{)} % parentheses around list
\newcommand{\docbooktolatexcite}[2]{%
  \@ifundefined{docbooktolatexcite@#1}%
  {\cite{#1}}%
  {\def\@docbooktolatextemp{#2}\ifx\@docbooktolatextemp\@empty%
   \cite{\@nameuse{docbooktolatexcite@#1}}%
   \else\cite[#2]{\@nameuse{docbooktolatexcite@#1}}%
   \fi%
  }%
}
\newcommand{\docbooktolatexbackcite}[1]{%
  \ifx\Hy@backout\@undefined\else%
    \@ifundefined{docbooktolatexcite@#1}{%
      % emit warning?
    }{%
      \ifBR@verbose%
        \PackageInfo{backref}{back cite \string`#1\string' as \string`\@nameuse{docbooktolatexcite@#1}\string'}%
      \fi%
      \Hy@backout{\@nameuse{docbooktolatexcite@#1}}%
    }%
  \fi%
}

		
			
% --------------------------------------------
% A way to honour <footnoteref>s
% Blame j-devenish (at) users.sourceforge.net
% In any other LaTeX context, this would probably go into a style file.
\newcommand{\docbooktolatexusefootnoteref}[1]{\@ifundefined{@fn@label@#1}%
  {\hbox{\@textsuperscript{\normalfont ?}}%
    \@latex@warning{Footnote label `#1' was not defined}}%
  {\@nameuse{@fn@label@#1}}}
\newcommand{\docbooktolatexmakefootnoteref}[1]{%
  \protected@write\@auxout{}%
    {\global\string\@namedef{@fn@label@#1}{\@makefnmark}}%
  \@namedef{@fn@label@#1}{\hbox{\@textsuperscript{\normalfont ?}}}%
  }

		\newcommand{\dbglossary}[1]{\chapter*{#1}%
\markboth{\MakeUppercase{#1}}{\MakeUppercase{#1}}}%
\newcommand{\dbglossdiv}[1]{\section*{#1}}%

			
% index labeling helper
\newif\ifdocbooktolatexprintindex\docbooktolatexprintindextrue
\let\dbtolatex@@theindex\theindex
\let\dbtolatex@@endtheindex\endtheindex
\def\theindex{\relax}
\def\endtheindex{\relax}
\newenvironment{dbtolatexindex}[1]
   {
\if@openright\cleardoublepage\else\clearpage\fi
\let\dbtolatex@@indexname\indexname
\def\dbtolatex@indexlabel{%
 \ifnum \c@secnumdepth >\m@ne \refstepcounter{chapter}\fi%
 \label{#1}\hypertarget{#1}{\dbtolatex@@indexname}%
 \global\docbooktolatexprintindexfalse}
\def\indexname{\ifdocbooktolatexprintindex\dbtolatex@indexlabel\else\dbtolatex@@indexname\fi}
\dbtolatex@@theindex
   }
   {
\dbtolatex@@endtheindex\let\indexname\dbtolatex@@indexname
   }

\newlength\saveparskip \newlength\saveparindent
\newlength\tempparskip \newlength\tempparindent

		
\def\docbooktolatexgobble{\expandafter\@gobble}
% Prevent multiple openings of the same aux file
% (happens when backref is used with multiple bibliography environments)
\ifx\AfterBeginDocument\undefined\let\AfterBeginDocument\AtBeginDocument\fi
\AfterBeginDocument{
   \let\latex@@starttoc\@starttoc
   \def\@starttoc#1{%
      \@ifundefined{docbooktolatex@aux#1}{%
         \global\@namedef{docbooktolatex@aux#1}{}%
         \latex@@starttoc{#1}%
      }{}
   }
}
% --------------------------------------------
% Hacks for honouring row/entry/@align
% (\hspace not effective when in paragraph mode)
% Naming convention for these macros is:
% 'docbooktolatex' 'align' {alignment-type} {position-within-entry}
% where r = right, l = left, c = centre
\newcommand{\docbooktolatex@align}[2]{\protect\ifvmode#1\else\ifx\LT@@tabarray\@undefined#2\else#1\fi\fi}
\newcommand{\docbooktolatexalignll}{\docbooktolatex@align{\raggedright}{}}
\newcommand{\docbooktolatexalignlr}{\docbooktolatex@align{}{\hspace*\fill}}
\newcommand{\docbooktolatexaligncl}{\docbooktolatex@align{\centering}{\hfill}}
\newcommand{\docbooktolatexaligncr}{\docbooktolatex@align{}{\hspace*\fill}}
\newcommand{\docbooktolatexalignrl}{\protect\ifvmode\raggedleft\else\hfill\fi}
\newcommand{\docbooktolatexalignrr}{}
\ifx\captionswapskip\@undefined\newcommand{\captionswapskip}{}\fi
\makeatother
\title{\bfseries The Official Samba 3.2.x HOWTO and Reference Guide}
\author{Jelmer R. Vernooij, John H. Terpstra, and Gerald (Jerry) Carter}
% --------------------------------------------
\makeindex
\makeglossary
% --------------------------------------------

\setcounter{tocdepth}{4}

\setcounter{secnumdepth}{4}
\begin{document}
{\maketitle\pagestyle{plain}
\thispagestyle{empty}}
\setcounter{page}{5} % -------------------------------------------------------------
% Preface 
% -------------------------------------------------------------
\chapter*{About the Cover Artwork}%
\label{id2443444}\hypertarget{id2443444}{}%

The cover artwork of this book continues the freedom theme of the first edition of {``}The Official Samba-3 HOWTO and Reference Guide{''}. We may look back upon the past to question the motives of those who have gone before us. Seldom do we realise that the past owes us no answer, and despite what we may think of the actions of those who have travelled lifes' road before us, we must feel a sense of pride and gratitude for those who, in the past, have protected our liberties.

Developments in information technology continue to move at an alarming pace. Human nature causes us to adopt and embrace new developments that appear to answer the needs of the moment, but that can entrap us at a future date. There are many examples in the short history of information technology. MS-DOS was seen as a tool that liberated users from the tyrany of large computer system operating costs, and that made possible the rapid progres we are beneficiaries of today. Yet today we are inclined to look back with disdain on MS-DOS as an obsolete and constraining technology that belongs are an era that is best forgotten.

The embrace of Windows networking, Windows NT4, and MS Active Directory in more recent times, may seem modern and progressive today, but sooner or later something better will replace them. The current preoccupation with extended identity management solutions and with directories is not unexpected. The day will come that these too will be evaluated, and what may seem refreshing and powerful may be better recogized as the chilly winds of the night. To argue against progress is unthinkable, no matter what may lie ahead.

The development of Samba is moving forwards. The changes since Samba 3.0.0 are amazing, yet many users would like to see more and faster progress. The benefits of recent developments can be realized quickly, but documentation is necessary to unlock the pandoras' box. It is our hope that this book will help the network administrator to rapidly deploy the new features with minimum effort. As you deploy and gain mileage from the new enablement, take the time to think through what may lie ahead. Above all, take stock of the freedom of choice that Samba provides in your world, and enjoy the new potential for seamless interoperability.
\cleardoublepage % -------------------------------------------------------------
% Preface 
% -------------------------------------------------------------
\chapter*{Attribution}%
\label{id2437208}\hypertarget{id2437208}{}%

\hyperlink{install}{Chapter {\ref{install}}, {``}How to Install and Test SAMBA{''}} 
\begin{itemize}
%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Karl Auer{\textless}\url{mailto:kauer@biplane.com.au}{\textgreater}


%--- Item
\item 
Dan Shearer{\textless}\url{mailto:dan@samba.org}{\textgreater}

\end{itemize}


\hyperlink{FastStart}{Chapter {\ref{FastStart}}, {``}Fast Start: Cure for Impatience{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{ServerType}{Chapter {\ref{ServerType}}, {``}Server Types and Security Modes{''}} 
\begin{itemize}
%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}


%--- Item
\item 
David Bannon{\textless}\url{mailto:dbannon@samba.org}{\textgreater}


%--- Item
\item 
Guenther Deschner{\textless}\url{mailto:gd@suse.de}{\textgreater} (LDAP updates)

\end{itemize}


\hyperlink{samba-bdc}{Chapter {\ref{samba-bdc}}, {``}Backup Domain Control{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Volker Lendecke{\textless}\url{mailto:Volker.Lendecke@SerNet.DE}{\textgreater}


%--- Item
\item 
Guenther Deschner{\textless}\url{mailto:gd@suse.de}{\textgreater} (LDAP updates)

\end{itemize}


\hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Jeremy Allison{\textless}\url{mailto:jra@samba.org}{\textgreater}


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}


%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
Guenther Deschner{\textless}\url{mailto:gd@suse.de}{\textgreater} (LDAP updates)

\end{itemize}


\hyperlink{StandAloneServer}{Chapter {\ref{StandAloneServer}}, {``}Standalone Servers{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{ClientConfig}{Chapter {\ref{ClientConfig}}, {``}MS Windows Network Configuration Guide{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{ChangeNotes}{Chapter {\ref{ChangeNotes}}, {``}Important and Critical Change Notes for the Samba 3.x Series{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}

\end{itemize}


\hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
Jonathan Johnson{\textless}\url{mailto:jon@sutinen.com}{\textgreater}

\end{itemize}


\hyperlink{passdb}{Chapter {\ref{passdb}}, {``}Account Information Databases{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}


%--- Item
\item 
Jeremy Allison{\textless}\url{mailto:jra@samba.org}{\textgreater}


%--- Item
\item 
Guenther Deschner{\textless}\url{mailto:gd@suse.de}{\textgreater} (LDAP updates)


%--- Item
\item 
Olivier (lem) Lemaire{\textless}\url{mailto:olem@IDEALX.org}{\textgreater}

\end{itemize}


\hyperlink{groupmapping}{Chapter {\ref{groupmapping}}, {``}Group Mapping: MS Windows and UNIX{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Jean François Micouleau


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}

\end{itemize}


\hyperlink{NetCommand}{Chapter {\ref{NetCommand}}, {``}Remote and Local Management: The Net Command{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Volker Lendecke{\textless}\url{mailto:Volker.Lendecke@SerNet.DE}{\textgreater}


%--- Item
\item 
Guenther Deschner{\textless}\url{mailto:gd@suse.de}{\textgreater}

\end{itemize}


\hyperlink{idmapper}{Chapter {\ref{idmapper}}, {``}Identity Mapping (IDMAP){''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{rights}{Chapter {\ref{rights}}, {``}User Rights and Privileges{''}} 
\begin{itemize}
%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{AccessControls}{Chapter {\ref{AccessControls}}, {``}File, Directory, and Share Access Controls{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Jeremy Allison{\textless}\url{mailto:jra@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater} (drawing)

\end{itemize}


\hyperlink{locking}{Chapter {\ref{locking}}, {``}File and Record Locking{''}} 
\begin{itemize}
%--- Item
\item 
Jeremy Allison{\textless}\url{mailto:jra@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Eric Roseme{\textless}\url{mailto:eric.roseme@hp.com}{\textgreater}

\end{itemize}


\hyperlink{securing-samba}{Chapter {\ref{securing-samba}}, {``}Securing Samba{''}} 
\begin{itemize}
%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{InterdomainTrusts}{Chapter {\ref{InterdomainTrusts}}, {``}Interdomain Trust Relationships{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Rafal Szczesniak{\textless}\url{mailto:mimir@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater} (drawing)


%--- Item
\item 
Stephen Langasek{\textless}\url{mailto:vorlon@netexpress.net}{\textgreater}

\end{itemize}


\hyperlink{msdfs}{Chapter {\ref{msdfs}}, {``}Hosting a Microsoft Distributed File System Tree{''}} 
\begin{itemize}
%--- Item
\item 
Shirish Kalele{\textless}\url{mailto:samba@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{classicalprinting}{Chapter {\ref{classicalprinting}}, {``}Classical Printing Support{''}} 
\begin{itemize}
%--- Item
\item 
Kurt Pfeifle{\textless}\url{mailto:kpfeifle@danka.de}{\textgreater}


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}} 
\begin{itemize}
%--- Item
\item 
Kurt Pfeifle{\textless}\url{mailto:kpfeifle@danka.de}{\textgreater}


%--- Item
\item 
Ciprian Vizitiu{\textless}\url{mailto:CVizitiu@gbif.org}{\textgreater} (drawings)


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater} (drawings)

\end{itemize}


\hyperlink{VFS}{Chapter {\ref{VFS}}, {``}Stackable VFS modules{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Tim Potter{\textless}\url{mailto:tpot@samba.org}{\textgreater}


%--- Item
\item 
Simo Sorce (original vfs\_skel README)


%--- Item
\item 
Alexander Bokovoy (original vfs\_netatalk docs)


%--- Item
\item 
Stefan Metzmacher (Update for multiple modules)


%--- Item
\item 
Ed Riddle (original shadow\_copy docs)

\end{itemize}


\hyperlink{winbind}{Chapter {\ref{winbind}}, {``}Winbind: Use of Domain Accounts{''}} 
\begin{itemize}
%--- Item
\item 
Tim Potter{\textless}\url{mailto:tpot@linuxcare.com.au}{\textgreater}


%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}


%--- Item
\item 
Naag Mummaneni{\textless}\url{mailto:getnag@rediffmail.com}{\textgreater} (Notes for Solaris)


%--- Item
\item 
John Trostel{\textless}\url{mailto:jtrostel@snapserver.com}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{AdvancedNetworkManagement}{Chapter {\ref{AdvancedNetworkManagement}}, {``}Advanced Network Management{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{PolicyMgmt}{Chapter {\ref{PolicyMgmt}}, {``}System and Account Policies{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{ProfileMgmt}{Chapter {\ref{ProfileMgmt}}, {``}Desktop Profile Management{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{pam}{Chapter {\ref{pam}}, {``}PAM-Based Distributed Authentication{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Stephen Langasek{\textless}\url{mailto:vorlon@netexpress.net}{\textgreater}

\end{itemize}


\hyperlink{integrate-ms-networks}{Chapter {\ref{integrate-ms-networks}}, {``}Integrating MS Windows Networks with Samba{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{unicode}{Chapter {\ref{unicode}}, {``}Unicode/Charsets{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
TAKAHASHI Motonobu{\textless}\url{mailto:monyo@home.monyo.com}{\textgreater} (Japanese character support)

\end{itemize}


\hyperlink{Backup}{Chapter {\ref{Backup}}, {``}Backup Techniques{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{SambaHA}{Chapter {\ref{SambaHA}}, {``}High Availability{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Jeremy Allison{\textless}\url{mailto:jra@samba.org}{\textgreater}

\end{itemize}


\hyperlink{largefile}{Chapter {\ref{largefile}}, {``}Handling Large Directories{''}} 
\begin{itemize}
%--- Item
\item 
Jeremy Allison{\textless}\url{mailto:jra@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{cfgsmarts}{Chapter {\ref{cfgsmarts}}, {``}Advanced Configuration Techniques{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{upgrading-to-3.0}{Chapter {\ref{upgrading-to-3.0}}, {``}Updating and Upgrading Samba{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}

\end{itemize}


\hyperlink{NT4Migration}{Chapter {\ref{NT4Migration}}, {``}Migration from NT4 PDC to Samba-3 PDC{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{SWAT}{Chapter {\ref{SWAT}}, {``}SWAT: The Samba Web Administration Tool{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{diagnosis}{Chapter {\ref{diagnosis}}, {``}The Samba Checklist{''}} 
\begin{itemize}
%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
Dan Shearer{\textless}\url{mailto:dan@samba.org}{\textgreater}

\end{itemize}


\hyperlink{problems}{Chapter {\ref{problems}}, {``}Analyzing and Solving Samba Problems{''}} 
\begin{itemize}
%--- Item
\item 
Gerald (Jerry) Carter{\textless}\url{mailto:jerry@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
David Bannon{\textless}\url{mailto:dbannon@samba.org}{\textgreater}


%--- Item
\item 
Dan Shearer{\textless}\url{mailto:dan@samba.org}{\textgreater}

\end{itemize}


\hyperlink{bugreport}{Chapter {\ref{bugreport}}, {``}Reporting Bugs{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}

\end{itemize}


\hyperlink{tdb}{Chapter {\ref{tdb}}, {``}Managing TDB Files{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{compiling}{Chapter {\ref{compiling}}, {``}How to Compile Samba{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Andrew Tridgell{\textless}\url{mailto:tridge@samba.org}{\textgreater}

\end{itemize}


\hyperlink{Portability}{Chapter {\ref{Portability}}, {``}Portability{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{Other-Clients}{Chapter {\ref{Other-Clients}}, {``}Samba and Other CIFS Clients{''}} 
\begin{itemize}
%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}


%--- Item
\item 
Dan Shearer{\textless}\url{mailto:dan@samba.org}{\textgreater}


%--- Item
\item 
Jim McDonough{\textless}\url{mailto:jmcd@us.ibm.com}{\textgreater} (OS/2)

\end{itemize}


\hyperlink{speed}{Chapter {\ref{speed}}, {``}Samba Performance Tuning{''}} 
\begin{itemize}
%--- Item
\item 
Paul Cochrane{\textless}\url{mailto:paulc@dth.scot.nhs.uk}{\textgreater}


%--- Item
\item 
Jelmer R. Vernooij{\textless}\url{mailto:jelmer@samba.org}{\textgreater}


%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}


\hyperlink{ch-ldap-tls}{Chapter {\ref{ch-ldap-tls}}, {``}LDAP and Transport Layer Security{''}} 
\begin{itemize}
%--- Item
\item 
Gavin Henry{\textless}\url{mailto:ghenry@suretecsystems.com}{\textgreater}

\end{itemize}


\hyperlink{DNSDHCP}{Chapter {\ref{DNSDHCP}}, {``}DNS and DHCP Configuration Guide{''}} 
\begin{itemize}
%--- Item
\item 
John H. Terpstra{\textless}\url{mailto:jht@samba.org}{\textgreater}

\end{itemize}

\cleardoublepage 
\docbooktolatexnoparskip

\makeatletter
\def\dbtolatex@contentsid{id2408614}
\let\dbtolatex@@contentsname\contentsname
\newif\ifdocbooktolatexcontentsname\docbooktolatexcontentsnametrue
\def\dbtolatex@contentslabel{%
 \label{\dbtolatex@contentsid}\hypertarget{\dbtolatex@contentsid}{\dbtolatex@@contentsname}%
 \global\docbooktolatexcontentsnamefalse}
\def\contentsname{\ifdocbooktolatexcontentsname\dbtolatex@contentslabel\else\dbtolatex@@contentsname\fi}
\tableofcontents
\let\contentsname\dbtolatex@@contentsname
\Hy@writebookmark{}{\dbtolatex@@contentsname}{\dbtolatex@contentsid}{0}{toc}%
\makeatother
				\docbooktolatexrestoreparskip
\cleardoublepage \listofexamples \cleardoublepage \docbooktolatexnoparskip
\listoffigures
\listoftables
\docbooktolatexrestoreparskip
% -------------------------------------------------------------
% Preface 
% -------------------------------------------------------------
\chapter*{Foreword}%
\label{id2430300}\hypertarget{id2430300}{}%

When John first asked me to write an introductory piece for his latest book, I was somewhat mystified as to why he chose me. A conversation with John provided some of the rationale, and he left it to me to fill in the {\em{rest}} of the story. So, if you are willing to endure a little bit of background, I will provide the part of the story that John wouldn't provide.

I am the Director of Corporate Standards at Sun Microsystems, and manage Sun's standards portfolio. Before that, I was the Director of Standards at Netscape, which was when I met John. Before Sun, there was Digital Equipment Corporation, also standards. I've written several books on standards, and tend to observe (and occasionally help) the technical and business trends that drive standardization as a discipline. I tend to see standardization as a management tool, not as a technical discipline and this is part of the rationale that John provided.

The book that you have before you focuses on a particular standardized way of doing something hence, it is a book about a standard. The most important thing to keep in mind about a standard is the rationale for its creation. Standards are created not for technical reasons, not for business reasons, but for a deeper and much more compelling reason. Standards are created and used to allow people to communicate in a meaningful way. Every standard, if it is a true standard, has as its entire (and only) goal set the increasing of relevant communication between people.

This primary goal cannot be met however, unless the standard is documented. I have been involved in too many standardization efforts when it became apparent that {\em{everybody knows}} was the dominant emotion of those providing documentation. {\em{They}} of the ever present {\em{they say}} and {\em{they know}} are the bane of good standards. If {\em{they know}}, why are you doing a standard?

A {\em{good standard}} survives because people know how to use it. People know how to use a standard when it is so transparent, so obvious, and so easy that it become invisible. And a standard becomes invisible only when the documentation describing how to deploy it is clear, unambiguous, and correct. These three elements must be present for a standard to be useful, allowing communication and interaction between two separate and distinct entities to occur without obvious effort. As you read this book, look for the evidence of these three characteristics and notice how they are seamlessly woven into John's text. Clarity and unambiguity without {\em{correctness}} provide a technical nightmare. Correctness and clarity with ambiguity create {\em{maybe bits,}} and correctness and unambiguity without clarity provide a {\em{muddle through}} scenario.

And this is {\em{the rest of the story}} that John couldn't (or wouldn't) bring himself to state. This book provides a clear, concise, unambiguous, and technically valid presentation of Samba to make it useful to a user to someone who wants to use the standard to increase communication and the capability for communication between two or more entities whether person-machine, machine-machine, or person-person. The intent of this book is not to convince anyone of any agenda political, technical, or social. The intent is to provide documentation for users who need to know about Samba, how to use it, and how to get on with their primary responsibilities. While there is pride on John's part because of the tremendous success of the Samba documentation, he writes for the person who needs a tool to accomplish a particular job, and who has selected Samba to be that tool.

The book is a monument to John's perseverance and dedication to Samba and in my opinion to the goal of standardization. By writing this book, John has provided the users of Samba those that want to deploy it to make things better a clear, easy, and ultimately valuable resource. Additionally, he has increased the understanding and utility of a highly useful standard, and for this, as much as for the documentation, he is owed a debt of gratitude by those of us who rely on standards to make our lives more manageable.


\begin{tabular}{l}

Carl Cargill, Senior Director  \\
Corporate Standardization, The Office of the CTO  \\
Sun Microsystems  \\
\end{tabular}

\cleardoublepage % -------------------------------------------------------------
% Preface 
% -------------------------------------------------------------
\chapter*{Preface}%
\label{TOSHpreface}\hypertarget{TOSHpreface}{}%

The editors wish to thank you for your decision to purchase this book. The Official Samba-3 HOWTO and Reference Guide is the result of many years of accumulation of information, feedback, tips, hints, and happy solutions.

Please note that this book is a living document, the contents of which are constantly being updated. We encourage you to contribute your tips, techniques, helpful hints, and your special insight into the Windows networking world to help make the next generation of this book even more valuable to Samba users.

We have made a concerted effort to document more comprehensively than has been done previously the information that may help you to better deploy Samba and to gain more contented network users.

This book provides example configurations, it documents key aspects of Microsoft Windows networking, provides in-depth insight into the important configuration of Samba-3, and helps to put all of these into a useful framework.

The most recent electronic versions of this document can be found at {\textless}\url{http://www.samba.org/}{\textgreater} on the {``}Documentation{''} page.

Updates, patches and corrections are most welcome. Please email your contributions to any one of the following:


\begin{tabular}{l}

Jelmer Vernooij (jelmer@samba.org)\label{id2470775}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:jelmer@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2470775}  \\
John H. Terpstra (jht@samba.org)\label{id2470771}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:jht@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2470771}  \\
Gerald (Jerry) Carter (jerry@samba.org)\label{id2470763}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:jerry@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2470763}  \\
\end{tabular}


We wish to advise that only original and unencumbered material can be published. Please do not submit content that is not your own work unless proof of consent from the copyright holder accompanies your submission.

% ------------------------   
% Section 
\section*{Conventions Used}
\label{id2503819}\hypertarget{id2503819}{}%

The following notation conventions are used throughout this book:

\begin{itemize}
%--- Item
\item 
TOSHARG2 is used as an abbreviation for the book, {``}The Official Samba-3 HOWTO and Reference Guide, Second Edition{''} Editors: John H. Terpstra and Jelmer R. Vernooij, Publisher: Prentice Hall, ISBN: 0131882228.


%--- Item
\item 
S3bE2 is used as an abbreviation for the book, {``}Samba-3 by Example, Second Edition{''} Editors: John H. Terpstra, Publisher: Prentice Hall, ISBN: 013188221X.


%--- Item
\item 
Directories and filenames appear in mono-font. For example, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}}.


%--- Item
\item 
Executable names are bolded. For example, {\bfseries{smbd}}.


%--- Item
\item 
Menu items and buttons appear in bold. For example, click {\sffamily \bfseries Next}.


%--- Item
\item 
Selecting a menu item is indicated as: {\sffamily \bfseries Start} $\to$ {\sffamily \bfseries Control Panel} $\to$ {\sffamily \bfseries Administrative Tools} $\to$ {\sffamily \bfseries Active Directory Users and Computers}

\end{itemize}
\cleardoublepage % -------------------------------------------------------------
% Preface 
% -------------------------------------------------------------
\chapter*{Introduction}%
\label{IntroSMB}\hypertarget{IntroSMB}{}%

{``}A man's gift makes room for him before great men. Gifts are like hooks that can catch hold of the mind taking it beyond the reach of forces that otherwise might constrain it.{''} --- Anon.

This is a book about Samba. It is a tool, a derived work of the labors of many and of the diligence and goodwill of more than a few. This book contains material that has been contributed in a persistent belief that each of us can add value to our neighbors as well as to those who will follow us.

This book is designed to meet the needs of the Microsoft network administrator. UNIX administrators will benefit from this book also, though they may complain that it is hard to find the information they think they need. So if you are a Microsoft certified specialist, this book should meet your needs rather well. If you are a UNIX or Linux administrator, there is no need to feel badly ---  you should have no difficulty finding answers to your current concerns also.

% ------------------------   
% Section 
\section*{What Is Samba?}
\label{id2481352}\hypertarget{id2481352}{}%

Samba is a big, complex project. The Samba project is ambitious and exciting. The team behind Samba is a group of some thirty individuals who are spread the world over and come from an interesting range of backgrounds. This team includes scientists, engineers, programmers, business people, and students.

Team members were drawn into active participation through the desire to help deliver an exciting level of transparent interoperability between Microsoft Windows and the non-Microsoft information technology world.

The slogan that unites the efforts behind the Samba project says: {\em{Samba, Opening Windows to a Wider World!}} The goal behind the project is one of removing barriers to interoperability.

Samba provides file and print services for Microsoft Windows clients. These services may be hosted off any TCP/IP-enabled platform. The original deployment platforms were UNIX and Linux, though today it is in common use across a broad variety of systems.

The Samba project includes not only an impressive feature set in file and print serving capabilities, but has been extended to include client functionality, utilities to ease migration to Samba, tools to aid interoperability with Microsoft Windows, and administration tools.

The real people behind Samba are users like you. You have inspired the developers (the Samba Team) to do more than any of them imagined could or should be done. User feedback drives Samba development. Samba-3 in particular incorporates a huge amount of work done as a result of user requests, suggestions and direct code contributions.

% ------------------------   
% Section 
\section*{Why This Book?}
\label{id2478460}\hypertarget{id2478460}{}%

There is admittedly a large number of Samba books on the market today and each book has its place. Despite the apparent plethora of books, Samba as a project continues to receive much criticism for failing to provide sufficient documentation. Samba is also criticized for being too complex and too difficult to configure. In many ways this is evidence of the success of Samba as there would be no complaints if it was not successful.

The Samba Team members work predominantly with UNIX and Linux, so it is hardly surprising that existing Samba documentation should reflect that orientation. The original HOWTO text documents were intended to provide some tips, a few golden nuggets, and if they helped anyone then that was just wonderful. But the HOWTO documents lacked structure and context. They were isolated snapshots of information that were written to pass information on to someone else who might benefit. They reflected a need to transmit more information that could be conveniently put into manual pages.

The original HOWTO documents were written by different authors. Most HOWTO documents are the result of feedback and contributions from numerous authors. In this book we took care to preserve as much original content as possible. As you read this book you will note that chapters were written by multiple authors, each of whom has his own style. This demonstrates the nature of the Open Source software development process.

Out of the original HOWTO documents sprang a collection of unofficial HOWTO documents that are spread over the Internet. It is sincerely intended that this work will {\em{not}} replace the valuable unofficial HOWTO work that continues to flourish. If you are involved in unofficial HOWTO production then please continue your work!

Those of you who have dedicated your labors to the production of unofficial HOWTOs, to Web page information regarding Samba, or to answering questions on the mailing lists or elsewhere, may be aware that this is a labor of love. We would like to know about your contribution and willingly receive the precious pearls of wisdom you have collected. Please email your contribution to John H. Terpstra (jht@samba.org)\label{id2491593}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:jht@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2491593}. As a service to other users we will gladly adopt material that is technically accurate.

Existing Samba books are largely addressed to the UNIX administrator. From the perspective of this target group the existing books serve an adequate purpose, with one exception ---  now that Samba-3 is out they need to be updated!

This book, the {\em{Official Samba-3 HOWTO and Reference Guide}}, includes the Samba-HOWTO-Collection.pdf that ships with Samba. These documents have been written with a new design intent and purpose.

Over the past two years many Microsoft network administrators have adopted Samba and have become interested in its deployment. Their information needs are very different from that of the UNIX administrator. This book has been arranged and the information presented from the perspective of someone with previous Microsoft Windows network administrative training and experience.

% ------------------------   
% Section 
\section*{Book Structure and Layout}
\label{id2471600}\hypertarget{id2471600}{}%

This book is presented in six parts:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{General Installation}]\null{}
Designed to help you get Samba-3 running quickly. The Fast Start chapter is a direct response to requests from Microsoft network administrators for some sample configurations that {\em{just work}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Server Configuration Basics}]\null{}
The purpose of this section is to aid the transition from existing Microsoft Windows network knowledge to Samba terminology and norms. The chapters in this part each cover the installation of one type of Samba server.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Advanced Configuration}]\null{}
The mechanics of network browsing have long been the Achilles heel of all Microsoft Windows users. Samba-3 introduces new user and machine account management facilities, a new way to map UNIX groups and Windows groups, Interdomain trusts, new loadable file system drivers (VFS), and more. New with this document is expanded printing documentation, as well as a wealth of information regarding desktop and user policy handling, use of desktop profiles, and techniques for enhanced network integration. This section makes up the core of the book. Read and enjoy.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Migration and Updating}]\null{}
A much requested addition to the book is information on how to migrate from Microsoft Windows NT4 to Samba-3, as well as an overview of what the issues are when moving from Samba-2.x to Samba-3.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Troubleshooting}]\null{}
This short section should help you when all else fails.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Reference Section}]\null{}
Here you will find a collection of things that are either too peripheral for most users, or are a little left of field to be included in the main body of information.
\end{description}

Welcome to Samba-3 and the first published document to help you and your users to enjoy a whole new world of interoperability between Microsoft Windows and the rest of the world.
\cleardoublepage % ------------------------------------------------------------- 
% 
% PART General Installation
% 
% ------------------------------------------------------------- 
\part{General Installation}
\label{introduction}\hypertarget{introduction}{}%
\pagenumbering{arabic} 
% -------------------------------------------------------------
% PartIntro Preparing Samba for Configuration 
% ------------------------------------------------------------- 	
\chapter*{Preparing Samba for Configuration}
\label{id2408663}\hypertarget{id2408663}{}%

This section of the Samba-HOWTO-Collection contains general info on how to install Samba and how to configure the parts of Samba you will most likely need. PLEASE read this.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter How to Install and Test SAMBA 
% ------------------------------------------------------------- 	
\chapter{How to Install and Test SAMBA}
\label{install}\hypertarget{install}{}%

% ------------------------   
% Section 
\section{Obtaining and Installing Samba}
\label{id2488889}\hypertarget{id2488889}{}%

\index{packages} Binary packages of Samba are included in almost any Linux or UNIX distribution. There are also some packages available at the Samba home page\label{id2488907}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2488907}. Refer to the manual of your operating system for details on installing packages for your specific operating system.

\index{compile} If you need to compile Samba from source, check \hyperlink{compiling}{Chapter {\ref{compiling}}, {``}How to Compile Samba{''}}.

% ------------------------   
% Section 
\section{Configuring Samba (smb.conf)}
\label{id2488935}\hypertarget{id2488935}{}%

\index{/etc/samba/smb.conf} \index{SWAT} Samba's configuration is stored in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, which usually resides in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smb.\dbz{}conf}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}lib/\dbz{}smb.\dbz{}conf}}}. You can either edit this file yourself or do it using one of the many graphical tools that are available, such as the Web-based interface SWAT, that is included with Samba.
\subsection{Configuration File Syntax}
\label{id2484494}\hypertarget{id2484494}{}%

\index{section name} The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file uses the same syntax as the various old {\texttt{\docbookhyphenatefilename{.\dbz{}ini}}} files in Windows 3.1: Each file consists of various sections, which are started by putting the section name between brackets ({\texttt{\docbookhyphenatedot{[]}}}) on a new line. Each contains zero or more key/value pairs separated by an equality sign ({\texttt{\docbookhyphenatedot{=}}}). The file is just a plaintext file, so you can open and edit it with your favorite editing tool.

\index{meta-service} \index{print!queue} \index{share} \index{spooler.} \index{print!spooler} \index{spool!directory} Each section in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file represents either a share or a meta-service on the Samba server. The section {\texttt{\docbookhyphenatedot{[global]}}} is special, since it contains settings that apply to the whole Samba server. Samba supports a number of meta-services, each of which serves its own purpose. For example, the {\texttt{\docbookhyphenatedot{[homes]}}} share is a meta-service that causes Samba to provide a personal home share for each user. The {\texttt{\docbookhyphenatedot{[printers]}}} share is a meta-service that establishes print queue support and that specifies the location of the intermediate spool directory into which print jobs are received from Windows clients prior to being dispatched to the UNIX/Linux print spooler.

\index{printers} \index{meta-service} \index{printcap} \index{lpstat} \index{CUPS API} \index{browseable} The {\texttt{\docbookhyphenatedot{printers}}} meta-service will cause every printer that is either specified in a {\texttt{\docbookhyphenatedot{printcap}}} file, via the {\bfseries{lpstat}}, or via the CUPS API, to be published as a shared print queue. The {\texttt{\docbookhyphenatedot{printers}}} stanza in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file can be set as not browseable. If it is set to be browseable, then it will be visible as if it is a share. That makes no sense given that this meta-service is responsible only for making UNIX system printers available as Windows print queues. If a {\texttt{\docbookhyphenatedot{comment}}} parameter is specified, the value of it will be displayed as part of the printer name in Windows Explorer browse lists.

\index{stanza} Each section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file that specifies a share, or a meta-service, is called a stanza. The {\texttt{\docbookhyphenatedot{global}}} stanza specifies settings that affect all the other stanzas in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Configuration parameters are documented in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page. Some parameters can be used only in the {\texttt{\docbookhyphenatedot{global}}} stanza, some only in share or meta-service stanzas, and some can be used globally or just within a share or meta-service stanza.

\index{minimal!configuration} \hyperlink{smbconfminimal}{Example {\ref{smbconfminimal}}} contains a very minimal {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. \index{minimal configuration}

\begin{example}%
\hypertarget{smbconfminimal}{}%
\captionswapskip{}{{\caption{A minimal smb.conf}\label{smbconfminimal}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	workgroup = WKG
 	netbios name = MYNAME
 [share1]
 	path = /tmp
 [share2]
 	path = /my_shared_folder
 	comment = Some random files
\end{lstlisting}
\end{example}

\subsection{TDB Database File Information}
\label{tdbdocs}\hypertarget{tdbdocs}{}%

This section contains brief descriptions of the databases that are used by Samba-3.

\index{tdb file locations} The directory in which Samba stores the tdb files is determined by compile-time directives. Samba-3 stores tdb files in two locations. The best way to determine these locations is to execute the following command: 
\begin{Verbatim}[]

root#  smbd -b | grep PRIVATE_DIR
   PRIVATE_DIR: /etc/samba/private

\end{Verbatim}
 This means that the confidential tdb files are stored in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}private}}} directory. Samba-3 also uses a number of tdb files that contain more mundane data. The location of these files can be found by executing: 
\begin{Verbatim}[]

root#  smbd -b | grep LOCKDIR
   LOCKDIR: /var/lib/samba

\end{Verbatim}
 Therefore the remaining control files will, in the example shown, be stored in the {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}lib/\dbz{}samba}}} directory.

\index{tdb file descriptions} The persistent tdb files are described in \hyperlink{tdbpermfiledesc}{Table {\ref{tdbpermfiledesc}}}. All persistent tdb files should be regularly backed up. Use the {\bfseries{tdbbackup}} utility to backup the tdb files. All persistent tdb files must be preserved during machine migrations, updates and upgrades.

The temporary tdb files do not need to be backed up, nor do they need to be preseved across machine migrations, updates or upgrades. The temporary tdb files are described in \hyperlink{tdbtempfiledesc}{Table {\ref{tdbtempfiledesc}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{tdbpermfiledesc}{}%
\captionswapskip{}{{\caption{Persistent TDB File Descriptions}\label{tdbpermfiledesc}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
\docbooktolatexalignll {{{\bfseries Name}}} & {{{\bfseries Description}}} \tabularnewline
 \hline 
{{account\_policy}} & {{Samba/NT account policy settings, includes password expiration settings.}} \tabularnewline
 \hline 
{{group\_mapping}} & {{Mapping table from Windows groups/SID to UNIX groups.}} \tabularnewline
 \hline 
{{ntdrivers}} & {{Stores per-printer installed driver information.}} \tabularnewline
 \hline 
{{ntforms}} & {{Stores per-printer installed forms information.}} \tabularnewline
 \hline 
{{ntprinters}} & {{Stores the per-printer devmode configuration settings.}} \tabularnewline
 \hline 
{{passdb}} & {{Exists only when the tdbsam passwd backend is used. This file stores the SambaSAMAccount information. Note: This file requires that user POSIX account information is availble from either the /etc/passwd file, or from an alternative system source.}} \tabularnewline
 \hline 
{{registry}} & {{Read-only Samba database of a Windows registry skeleton that provides support for exporting various database tables via the winreg RPCs.}} \tabularnewline
 \hline 
{{secrets}} & {{This file stores the Workgroup/Domain/Machine SID, the LDAP directory update password, and a further collection of critical environmental data that is necessary for Samba to operate correctly. This file contains very sensitive information that must be protected. It is stored in the PRIVATE\_DIR directory.}} \tabularnewline
 \hline 
{{share\_info}} & {{Stores per-share ACL information.}} \tabularnewline
 \hline 
{{winbindd\_idmap}} & {{Winbindd's local IDMAP database.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{tdbtempfiledesc}{}%
\captionswapskip{}{{\caption{Temporary TDB File Descriptions}\label{tdbtempfiledesc}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|l|}
\hline 
\docbooktolatexalignll {{{\bfseries Name}}} & {{{\bfseries Description}}} & \docbooktolatexaligncl {{{\bfseries Backup}}} \tabularnewline
 \hline 
{{brlock}} & {{Byte-range locking information.}} & {{No}} \tabularnewline
 \hline 
{{connections}} & {{A temporary cache for current connection information used to enforce max connections.}} & {{no}} \tabularnewline
 \hline 
{{eventlog/*tdb}} & {{Records of eventlog entries. In most circumstances this is just a cache of system logs.}} & {{no}} \tabularnewline
 \hline 
{{gencache}} & {{Generic caching database for dead WINS servers and trusted domain data.}} & {{no}} \tabularnewline
 \hline 
{{login\_cache}} & {{A temporary cache for login information, in particular bad password attempts.}} & {{no}} \tabularnewline
 \hline 
{{messages}} & {{Temporary storage of messages being processed by smbd.}} & {{no}} \tabularnewline
 \hline 
{{netsamlogon\_cache}} & {{Caches user net\_info\_3 structure data from net\_samlogon requests (as a domain member).}} & {{no}} \tabularnewline
 \hline 
{{perfmon/*.tdb}} & {{Performance counter information.}} & {{no}} \tabularnewline
 \hline 
{{printing/*.tdb}} & {{Cached output from lpq command created on a per-print-service basis.}} & {{no}} \tabularnewline
 \hline 
{{schannel\_store}} & {{A confidential file, stored in the PRIVATE\_DIR, containing crytographic connection information so that clients that have temporarily disconnected can reconnect without needing to renegotiate the connection setup process.}} & {{no}} \tabularnewline
 \hline 
{{sessionid}} & {{Temporary cache for miscellaneous session information and for utmp handling.}} & {{no}} \tabularnewline
 \hline 
{{unexpected}} & {{Stores packets received for which no process is actively listening.}} & {{no}} \tabularnewline
 \hline 
{{winbindd\_cache}} & {{Cache of Identity information received from an NT4 domain or from ADS. Includes user lists, etc.}} & {{yes}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsection{Starting Samba}
\label{id2467474}\hypertarget{id2467474}{}%

\index{daemon} Samba essentially consists of two or three daemons. A daemon is a UNIX application that runs in the background and provides services. An example of a service is the Apache Web server for which the daemon is called {\bfseries{httpd}}. In the case of Samba there are three daemons, two of which are needed as a minimum.

The Samba server is made up of the following daemons:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{nmbd}]\null{}
\index{smbd} \index{starting samba!smbd} This daemon handles all name registration and resolution requests. It is the primary vehicle involved in network browsing. It handles all UDP-based protocols. The {\bfseries{nmbd}} daemon should be the first command started as part of the Samba startup process.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{smbd}]\null{}
\index{nmbd} \index{starting samba!nmbd} This daemon handles all TCP/IP-based connection services for file- and print-based operations. It also manages local authentication. It should be started immediately following the startup of {\bfseries{nmbd}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{winbindd}]\null{}
\index{winbindd} \index{starting samba!winbindd} This daemon should be started when Samba is a member of a Windows NT4 or ADS domain. It is also needed when Samba has trust relationships with another domain. The {\bfseries{winbindd}} daemon will check the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file for the presence of the {\ttfamily\itshape{\docbookhyphenatedot{idmap uid}}} and {\ttfamily\itshape{\docbookhyphenatedot{idmap gid}}} parameters. If they are are found, {\bfseries{winbindd}} will use the values specified for for UID and GID allocation. If these parameters are not specified, {\bfseries{winbindd}} will start but it will not be able to allocate UIDs or GIDs.
\end{description}

\index{startup!process} When Samba has been packaged by an operating system vendor, the startup process is typically a custom feature of its integration into the platform as a whole. Please refer to your operating system platform administration manuals for specific information pertaining to correct management of Samba startup.
\subsection{Example Configuration}
\label{id2505446}\hypertarget{id2505446}{}%

\index{examples} \index{source code} \index{distribution} \index{tarball} \index{package} There are sample configuration files in the examples subdirectory in the source code distribution tarball package. It is suggested you read them carefully so you can see how the options go together in practice. See the man page for all the options. It might be worthwhile to start out with the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf.\dbz{}default}}} configuration file and adapt it to your needs. It contains plenty of comments.

\index{simplest!configuration} The simplest useful configuration file would contain something like that shown in \hyperlink{simple-example}{Example {\ref{simple-example}}}. \index{simple configuration}

\begin{example}%
\hypertarget{simple-example}{}%
\captionswapskip{}{{\caption{Another simple smb.conf File}\label{simple-example}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	workgroup = MIDEARTH
 [homes]
 	guest ok = no
 	read only = no
\end{lstlisting}
\end{example}


\index{connections} \index{account} \index{login name} \index{service name} This will allow connections by anyone with an account on the server, using either their login name or \smbconfsection{homes} as the service name. (Note: The workgroup that Samba should appear in must also be set. The default workgroup name is WORKGROUP.)

\index{smbd} Make sure you put the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file in the correct place. Note, the correct location of this file depends on how the binary files were built. You can discover the correct location by executing from the directory that contains the {\bfseries{smbd}} command file: 
\begin{Verbatim}[]

root#  smbd -b | grep smb.conf

\end{Verbatim}


\index{security!settings} For more information about security settings for the \smbconfsection{[homes]} share, please refer to \hyperlink{securing-samba}{Chapter {\ref{securing-samba}}, {``}Securing Samba{''}}.
\subsubsection{Test Your Config File with testparm}
\label{id2505676}\hypertarget{id2505676}{}%

\index{validate} \index{testparm} \index{misconfigurations} It's important to validate the contents of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file using the testparm program. If testparm runs correctly, it will list the loaded services. If not, it will give an error message. Make sure it runs correctly and that the services look reasonable before proceeding. Enter the command: 
\begin{Verbatim}[]

	root#  testparm /etc/samba/smb.conf
	
\end{Verbatim}
 Testparm will parse your configuration file and report any unknown parameters or incorrect syntax. It also performs a check for common misconfigurations and will issue a warning if one is found.

Always run testparm again whenever the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is changed!

\index{smbd} \index{nmbd} \index{winbindd} \index{configuration!documentation} The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is constantly checked by the Samba daemons {\bfseries{smbd}} and every instance of itself that it spawns, {\bfseries{nmbd}} and {\bfseries{winbindd}}. It is good practice to keep this file as small as possible. Many administrators prefer to document Samba configuration settings and thus the need to keep this file small goes against good documentation wisdom. One solution that may be adopted is to do all documentation and configuration in a file that has another name, such as {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf.\dbz{}master}}}. The {\bfseries{testparm}} utility can be used to generate a fully optimized {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file from this master configuration and documtenation file as shown here: 
\begin{Verbatim}[]

root#  testparm -s smb.conf.master > smb.conf

\end{Verbatim}
 This administrative method makes it possible to maintain detailed configuration change records while at the same time keeping the working {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file size to the minimum necessary.
\subsection{SWAT}
\label{id2505861}\hypertarget{id2505861}{}%

\index{swat} SWAT is a Web-based interface that can be used to facilitate the configuration of Samba. SWAT might not be available in the Samba package that shipped with your platform, but in a separate package. If it is necesaary to built SWAT please read the SWAT man page regarding compilation, installation, and configuration of SWAT from the source code.

To launch SWAT, just run your favorite Web browser and point it to {\textless}\url{http://localhost:901/}{\textgreater}. Replace {\ttfamily\itshape{\docbookhyphenatedot{localhost}}} with the name of the computer on which Samba is running if that is a different computer than your browser.

SWAT can be used from a browser on any IP-connected machine, but be aware that connecting from a remote machine leaves your connection open to password sniffing because passwords will be sent over the wire in the clear.

More information about SWAT can be found in \hyperlink{SWAT}{Chapter {\ref{SWAT}}, {``}SWAT: The Samba Web Administration Tool{''}}.

% ------------------------   
% Section 
\section{List Shares Available on the Server}
\label{id2505922}\hypertarget{id2505922}{}%

To list shares that are available from the configured Samba server, execute the following command:


\begin{Verbatim}[]

$ smbclient -L yourhostname

\end{Verbatim}


You should see a list of shares available on your server. If you do not, then something is incorrectly configured. This method can also be used to see what shares are available on other SMB servers, such as Windows 2000.

If you choose user-level security, you may find that Samba requests a password before it will list the shares. See the {\bfseries{smbclient}} man page for details. You can force it to list the shares without a password by adding the option {\texttt{\docbookhyphenatedot{-N}}} to the command line.

% ------------------------   
% Section 
\section{Connect with a UNIX Client}
\label{id2505980}\hypertarget{id2505980}{}%

Enter the following command: 
\begin{Verbatim}[]

$ smbclient  //yourhostname/aservice

\end{Verbatim}


Typically {\ttfamily\itshape{\docbookhyphenatedot{yourhostname}}} is the name of the host on which smbd has been installed. The {\ttfamily\itshape{\docbookhyphenatedot{aservice}}} is any service that has been defined in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Try your username if you just have a \smbconfsection{[homes]} section in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

Example: If the UNIX host is called {\ttfamily\itshape{\docbookhyphenatedot{bambi}}} and a valid login name is {\ttfamily\itshape{\docbookhyphenatedot{fred}}}, you would type:


\begin{Verbatim}[]

$ smbclient //bambi/fred

\end{Verbatim}


% ------------------------   
% Section 
\section{Connect from a Remote SMB Client}
\label{id2506081}\hypertarget{id2506081}{}%

Now that Samba is working correctly locally, you can try to access it from other clients. Within a few minutes, the Samba host should be listed in the Network Neighborhood on all Windows clients of its subnet. Try browsing the server from another client or "mounting" it.

Mounting disks from a DOS, Windows, or OS/2 client can be done by running a command such as: 
\begin{Verbatim}[]

C:\> net use m: \\servername\service

\end{Verbatim}
 Where the drive letter m: is any available drive letter. It is important to double-check that the service (share) name that you used does actually exist.

Try printing, for example, 
\begin{Verbatim}[]

C:\> net use lpt1:	\\servername\spoolservice

\end{Verbatim}
 The {\texttt{\docbookhyphenatedot{spoolservice}}} is the name of the printer (actually the print queue) on the target server. This will permit all print jobs that are captured by the lpt1: port on the Windows client to be sent to the printer that owns the spoolservice that has been specified.


\begin{Verbatim}[]
C:\> print filename

\end{Verbatim}

\subsection{What If Things Don't Work?}
\label{id2506170}\hypertarget{id2506170}{}%

You might want to read \hyperlink{diagnosis}{Chapter {\ref{diagnosis}}, {``}The Samba Checklist{''}}. If you are still stuck, refer to \hyperlink{problems}{Chapter {\ref{problems}}, {``}Analyzing and Solving Samba Problems{''}}. Samba has been successfully installed at thousands of sites worldwide. It is unlikely that your particular problem is unique, so it might be productive to perform an Internet search to see if someone else has encountered your problem and has found a way to overcome it.

If you are new to Samba, and particularly if you are new to Windows networking, or to UNIX/Linux, the book {``}Samba-3 by Example{''} will help you to create a validated network environment. Simply choose from the first five chapters the network design that most closely matches site needs, then follow the simple step-by-step procedure to deploy it. Later, when you have a working network you may well want to refer back to this book for further insight into opportunities for improvement.
\subsection{Still Stuck?}
\label{id2506214}\hypertarget{id2506214}{}%

The best advice under the stress of abject frustration is to cool down! That may be challenging of itself, but while you are angry or annoyed your ability to seek out a solution is somewhat undermined. A cool head clears the way to finding the answer you are looking for. Just remember, every problem has a solution ---  there is a good chance that someone else has found it even though you can't right now. That will change with time, patience and learning.

Now that you have cooled down a bit, please refer to \hyperlink{diagnosis}{Chapter {\ref{diagnosis}}, {``}The Samba Checklist{''}} for a process that can be followed to identify the cause of your problem.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2506248}\hypertarget{id2506248}{}%

The following questions and issues are raised repeatedly on the Samba mailing list.
\subsection{Large Number of smbd Processes}
\label{id2506260}\hypertarget{id2506260}{}%

Samba consists of three core programs: nmbd, smbd, and winbindd. nmbd is the name server message daemon, smbd is the server message daemon, and winbindd is the daemon that handles communication with domain controllers.

If Samba is {\em{not}} running as a WINS server, then there will be one single instance of nmbd running on your system. If it is running as a WINS server, then there will be two instances ---  one to handle the WINS requests.

smbd handles all connection requests. It spawns a new process for each client connection made. That is why you may see so many of them, one per client connection.

winbindd will run as one or two daemons, depending on whether or not it is being run in {\em{split mode}} (in which case there will be two instances).
\subsection{Error Message: open\_oplock\_ipc}
\label{id2506357}\hypertarget{id2506357}{}%

An error message is observed in the log files when smbd is started: {``}open\_oplock\_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested.{''}

Your loopback device isn't working correctly. Make sure it is configured correctly. The loopback device is an internal (virtual) network device with the IP address {\em{127.0.0.1}}. Read your OS documentation for details on how to configure the loopback on your system.
\subsection{{``}The network name cannot be found{''}}
\label{id2506392}\hypertarget{id2506392}{}%

This error can be caused by one of these misconfigurations:

\begin{itemize}
%--- Item
\item 
You specified a nonexisting path for the share in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}.


%--- Item
\item 
The user you are trying to access the share with does not have sufficient permissions to access the path for the share. Both read (r) and access (x) should be possible.


%--- Item
\item 
The share you are trying to access does not exist.

\end{itemize}
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Fast Start: Cure for Impatience 
% ------------------------------------------------------------- 	
\chapter{Fast Start: Cure for Impatience}
\label{FastStart}\hypertarget{FastStart}{}%

When we first asked for suggestions for inclusion in the Samba HOWTO documentation, someone wrote asking for example configurations ---  and lots of them. That is remarkably difficult to do without losing a lot of value that can be derived from presenting many extracts from working systems. That is what the rest of this document does. It does so with extensive descriptions of the configuration possibilities within the context of the chapter that covers it. We hope that this chapter is the medicine that has been requested.

The information in this chapter is very sparse compared with the book {``}Samba-3 by Example{''} that was written after the original version of this book was nearly complete. {``}Samba-3 by Example{''} was the result of feedback from reviewers during the final copy editing of the first edition. It was interesting to see that reader feedback mirrored that given by the original reviewers. In any case, a month and a half was spent in doing basic research to better understand what new as well as experienced network administrators would best benefit from. The book {``}Samba-3 by Example{''} is the result of that research. What is presented in the few pages of this book is covered far more comprehensively in the second edition of {``}Samba-3 by Example{''}. The second edition of both books will be released at the same time.

So in summary, the book {``}The Official Samba-3 HOWTO \& Reference Guide{''} is intended as the equivalent of an auto mechanic's repair guide. The book {``}Samba-3 by Example{''} is the equivalent of the driver's guide that explains how to drive the car. If you want complete network configuration examples, go to Samba-3 by Example\label{id2467568}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/docs/Samba3-ByExample.pdf}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2467568}.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2467576}\hypertarget{id2467576}{}%

Samba needs very little configuration to create a basic working system. In this chapter we progress from the simple to the complex, for each providing all steps and configuration file changes needed to make each work. Please note that a comprehensively configured system will likely employ additional smart features. These additional features are covered in the remainder of this document.

The examples used here have been obtained from a number of people who made requests for example configurations. All identities have been obscured to protect the guilty, and any resemblance to unreal nonexistent sites is deliberate.

% ------------------------   
% Section 
\section{Description of Example Sites}
\label{id2467601}\hypertarget{id2467601}{}%

In the first set of configuration examples we consider the case of exceptionally simple system requirements. There is a real temptation to make something that should require little effort much too complex.

\hyperlink{anon-ro}{Section {\ref{anon-ro}}} documents the type of server that might be sufficient to serve CD-ROM images, or reference document files for network client use. This configuration is also discussed in \hyperlink{StandAloneServer}{Chapter {\ref{StandAloneServer}}, {``}Standalone Servers{''}}, \hyperlink{RefDocServer}{Section {\ref{RefDocServer}}}. The purpose for this configuration is to provide a shared volume that is read-only that anyone, even guests, can access.

The second example shows a minimal configuration for a print server that anyone can print to as long as they have the correct printer drivers installed on their computer. This is a mirror of the system described in \hyperlink{StandAloneServer}{Chapter {\ref{StandAloneServer}}, {``}Standalone Servers{''}}, \hyperlink{SimplePrintServer}{Section {\ref{SimplePrintServer}}}.

The next example is of a secure office file and print server that will be accessible only to users who have an account on the system. This server is meant to closely resemble a workgroup file and print server, but has to be more secure than an anonymous access machine. This type of system will typically suit the needs of a small office. The server provides no network logon facilities, offers no domain control; instead it is just a network-attached storage (NAS) device and a print server.

The later example consider more complex systems that will either integrate into existing MS Windows networks or replace them entirely. These cover domain member servers as well as Samba domain control (PDC/BDC) and finally describes in detail a large distributed network with branch offices in remote locations.

% ------------------------   
% Section 
\section{Worked Examples}
\label{id2467672}\hypertarget{id2467672}{}%

The configuration examples are designed to cover everything necessary to get Samba running. They do not cover basic operating system platform configuration, which is clearly beyond the scope of this text.

It is also assumed that Samba has been correctly installed, either by way of installation of the packages that are provided by the operating system vendor or through other means.
\subsection{Standalone Server}
\label{id2494081}\hypertarget{id2494081}{}%

\index{Server Type!Stand-alone} A standalone server implies no more than the fact that it is not a domain controller and it does not participate in domain control. It can be a simple, workgroup-like server, or it can be a complex server that is a member of a domain security context.

As the examples are developed, every attempt is made to progress the system toward greater capability, just as one might expect would happen in a real business office as that office grows in size and its needs change.
\subsubsection{Anonymous Read-Only Document Server}
\label{anon-ro}\hypertarget{anon-ro}{}%

\index{read only!server} The purpose of this type of server is to make available to any user any documents or files that are placed on the shared resource. The shared resource could be a CD-ROM drive, a CD-ROM image, or a file storage area.

\begin{itemize}
%--- Item
\item 
The file system share point will be {\texttt{\docbookhyphenatefilename{/\dbz{}export}}}.


%--- Item
\item 
All files will be owned by a user called Jack Baumbach. Jack's login name will be {\em{jackb}}. His password will be {\em{m0r3pa1n}} ---  of course, that's just the example we are using; do not use this in a production environment because all readers of this document will know it.

\end{itemize}
Installation Procedure: Read-Only Server
\begin{example}%
\hypertarget{anon-example}{}%
\captionswapskip{}{{\caption{Anonymous Read-Only Server Configuration}\label{anon-example}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = HOBBIT
 	security = share
 [data]
 	comment = Data
 	path = /export
 	read only = Yes
 	guest ok = Yes
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{Add user to system (with creation of the user's home directory): 
\begin{Verbatim}[]

root# useradd -c "Jack Baumbach" -m -g users -p m0r3pa1n jackb

\end{Verbatim}
}

\item{Create directory, and set permissions and ownership: 
\begin{Verbatim}[]

root# mkdir /export
root# chmod u+rwx,g+rx,o+rx /export
root# chown jackb.users /export

\end{Verbatim}
}

\item{Copy the files that should be shared to the {\texttt{\docbookhyphenatefilename{/\dbz{}export}}} directory.}

\item{Install the Samba configuration file ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smb.\dbz{}conf}}}) as shown in \hyperlink{anon-example}{Example {\ref{anon-example}}}.}

\item{Test the configuration file by executing the following command: 
\begin{Verbatim}[]

root# testparm

\end{Verbatim}
 Alternatively, where you are operating from a master configuration file called {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf.\dbz{}master}}}, the following sequence of commands might prove more appropriate: 
\begin{Verbatim}[]

root#  cd /etc/samba
root#  testparm -s smb.conf.master > smb.conf
root#  testparm

\end{Verbatim}
 Note any error messages that might be produced. Proceed only if error-free output has been obtained. An example of typical output that should be generated from the above configuration file is shown here: 
\begin{Verbatim}[]

Load smb config files from /etc/samba/smb.conf
Processing section "[data]"
Loaded services file OK.
Server role: ROLE_STANDALONE
Press enter to see a dump of your service definitions
[Press enter]

# Global parameters
[global]
	workgroup = MIDEARTH
	netbios name = HOBBIT
	security = share

[data]
	comment = Data
	path = /export
	read only = Yes
	guest only = Yes

\end{Verbatim}
}

\item{Start Samba using the method applicable to your operating system platform. The method that should be used is platform dependent. Refer to \hyperlink{startingSamba}{Section {\ref{startingSamba}}} for further information regarding the starting of Samba.}

\item{Configure your MS Windows client for workgroup {\em{MIDEARTH}}, set the machine name to ROBBINS, reboot, wait a few (2 - 5) minutes, then open Windows Explorer and visit the Network Neighborhood. The machine HOBBIT should be visible. When you click this machine icon, it should open up to reveal the {\em{data}} share. After you click the share, it should open up to reveal the files previously placed in the {\texttt{\docbookhyphenatefilename{/\dbz{}export}}} directory.}
\end{enumerate}

The information above (following \# Global parameters) provides the complete contents of the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smb.\dbz{}conf}}} file.
\subsubsection{Anonymous Read-Write Document Server}
\label{id2496150}\hypertarget{id2496150}{}%

\index{anonymous!read-write server} We should view this configuration as a progression from the previous example. The difference is that shared access is now forced to the user identity of jackb and to the primary group jackb belongs to. One other refinement we can make is to add the user {\em{jackb}} to the {\texttt{\docbookhyphenatefilename{smbpasswd}}} file. To do this, execute: 
\begin{Verbatim}[]

root# smbpasswd -a jackb
New SMB password: m0r3pa1n
Retype new SMB password: m0r3pa1n
Added user jackb.

\end{Verbatim}
 Addition of this user to the {\texttt{\docbookhyphenatefilename{smbpasswd}}} file allows all files to be displayed in the Explorer Properties boxes as belonging to {\em{jackb}} instead of to {\em{User Unknown}}.

The complete, modified {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is as shown in \hyperlink{anon-rw}{Example {\ref{anon-rw}}}.

\begin{example}%
\hypertarget{anon-rw}{}%
\captionswapskip{}{{\caption{Modified Anonymous Read-Write smb.conf}\label{anon-rw}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = HOBBIT
 	security = SHARE
 [data]
 	comment = Data
 	path = /export
 	force user = jackb
 	force group = users
 	read only = No
 	guest ok = Yes
\end{lstlisting}
\end{example}

\subsubsection{Anonymous Print Server}
\label{id2505001}\hypertarget{id2505001}{}%

\index{anonymous!print server} An anonymous print server serves two purposes:

\begin{itemize}
%--- Item
\item 
It allows printing to all printers from a single location.


%--- Item
\item 
It reduces network traffic congestion due to many users trying to access a limited number of printers.

\end{itemize}

In the simplest of anonymous print servers, it is common to require the installation of the correct printer drivers on the Windows workstation. In this case the print server will be designed to just pass print jobs through to the spooler, and the spooler should be configured to do raw pass-through to the printer. In other words, the print spooler should not filter or process the data stream being passed to the printer.

In this configuration, it is undesirable to present the Add Printer Wizard, and we do not want to have automatic driver download, so we disable it in the following configuration. \hyperlink{anon-print}{Example {\ref{anon-print}}} is the resulting {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

\begin{example}%
\hypertarget{anon-print}{}%
\captionswapskip{}{{\caption{Anonymous Print Server smb.conf}\label{anon-print}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = LUTHIEN
 	security = share
 	printcap name = cups
 	disable spoolss = Yes
 	show add printer wizard = No
 	printing = cups
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	guest ok = Yes
 	printable = Yes
 	use client driver = Yes
 	browseable = No
\end{lstlisting}
\end{example}


The above configuration is not ideal. It uses no smart features, and it deliberately presents a less than elegant solution. But it is basic, and it does print. Samba makes use of the direct printing application program interface that is provided by CUPS. When Samba has been compiled and linked with the CUPS libraries, the default printing system will be CUPS. By specifying that the printcap name is CUPS, Samba will use the CUPS library API to communicate directly with CUPS for all printer functions. It is possible to force the use of external printing commands by setting the value of the {\ttfamily\itshape{\docbookhyphenatedot{printing}}} to either SYSV or BSD, and thus the value of the parameter {\ttfamily\itshape{\docbookhyphenatedot{printcap name}}} must be set to something other than CUPS. In such case, it could be set to the name of any file that contains a list of printers that should be made available to Windows clients.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Windows users will need to install a local printer and then change the print to device after installation of the drivers. The print to device can then be set to the network printer on this machine.
\end{admonition}


Make sure that the directory {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}spool/\dbz{}samba}}} is capable of being used as intended. The following steps must be taken to achieve this:

\begin{itemize}
%--- Item
\item 
The directory must be owned by the superuser (root) user and group: 
\begin{Verbatim}[]

root# chown root.root /var/spool/samba

\end{Verbatim}



%--- Item
\item 
Directory permissions should be set for public read-write with the sticky bit set as shown: 
\begin{Verbatim}[]

root# chmod a+twrx /var/spool/samba

\end{Verbatim}
 The purpose of setting the sticky bit is to prevent who does not own the temporary print file from being able to take control of it with the potential for devious misuse.

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{MIME!raw} \index{raw printing} On CUPS-enabled systems there is a facility to pass raw data directly to the printer without intermediate processing via CUPS print filters. Where use of this mode of operation is desired, it is necessary to configure a raw printing device. It is also necessary to enable the raw mime handler in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}mime.\dbz{}conv}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}mime.\dbz{}types}}} files. Refer to \hyperlink{cups-raw}{Section {\ref{cups-raw}}}.
\end{admonition}

\subsubsection{Secure Read-Write File and Print Server}
\label{id2406125}\hypertarget{id2406125}{}%

We progress now from simple systems to a server that is slightly more complex.

Our new server will require a public data storage area in which only authenticated users (i.e., those with a local account) can store files, as well as a home directory. There will be one printer that should be available for everyone to use.

In this hypothetical environment (no espionage was conducted to obtain this data), the site is demanding a simple environment that is {\em{secure enough}} but not too difficult to use.

Site users will be Jack Baumbach, Mary Orville, and Amed Sehkah. Each will have a password (not shown in further examples). Mary will be the printer administrator and will own all files in the public share.

This configuration will be based on {\em{user-level security}} that is the default, and for which the default is to store Microsoft Windows-compatible encrypted passwords in a file called {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smbpasswd}}}. The default {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} entry that makes this happen is \smbconfoption{passdb backend} = smbpasswd, guest. Since this is the default, it is not necessary to enter it into the configuration file. Note that the guest backend is added to the list of active passdb backends no matter whether it specified directly in Samba configuration file or not.
Installing the Secure Office Server
\begin{example}%
\hypertarget{OfficeServer}{}%
\captionswapskip{}{{\caption{Secure Office Server smb.conf}\label{OfficeServer}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = OLORIN
 	printcap name = cups
 	disable spoolss = Yes
 	show add printer wizard = No
 	printing = cups
 [homes]
 	comment = Home Directories
 	valid users = %S
 	read only = No
 	browseable = No
 [public]
 	comment = Data
 	path = /export
 	force user = maryo
 	force group = users
 	read only = No
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	printer admin = root, maryo
 	create mask = 0600
 	guest ok = Yes
 	printable = Yes
 	use client driver = Yes
 	browseable = No
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{\index{office server} Add all users to the operating system: 
\begin{Verbatim}[]

root# useradd -c "Jack Baumbach" -m -g users -p m0r3pa1n jackb
root# useradd -c "Mary Orville" -m -g users -p secret maryo
root# useradd -c "Amed Sehkah" -m -g users -p secret ameds

\end{Verbatim}
}

\item{Configure the Samba {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{OfficeServer}{Example {\ref{OfficeServer}}}.}

\item{Initialize the Microsoft Windows password database with the new users: 
\begin{Verbatim}[]

root# smbpasswd -a root
New SMB password: bigsecret
Reenter smb password: bigsecret
Added user root.

root# smbpasswd -a jackb
New SMB password: m0r3pa1n
Retype new SMB password: m0r3pa1n
Added user jackb.

root# smbpasswd -a maryo
New SMB password: secret
Reenter smb password: secret
Added user maryo.

root# smbpasswd -a ameds
New SMB password: mysecret
Reenter smb password: mysecret
Added user ameds.

\end{Verbatim}
}

\item{Install printer using the CUPS Web interface. Make certain that all printers that will be shared with Microsoft Windows clients are installed as raw printing devices.}

\item{Start Samba using the operating system administrative interface. Alternately, this can be done manually by executing: \index{smbd} \index{nmbd} \index{starting samba!smbd} \index{starting samba!nmbd} 
\begin{Verbatim}[]

root#  nmbd; smbd;

\end{Verbatim}
 Both applications automatically execute as daemons. Those who are paranoid about maintaining control can add the {\texttt{\docbookhyphenatedot{-D}}} flag to coerce them to start up in daemon mode.}

\item{Configure the {\texttt{\docbookhyphenatefilename{/\dbz{}export}}} directory: 
\begin{Verbatim}[]

root# mkdir /export
root# chown maryo.users /export
root# chmod u=rwx,g=rwx,o-rwx /export

\end{Verbatim}
}

\item{Check that Samba is running correctly: 
\begin{Verbatim}[]

root# smbclient -L localhost -U%
Domain=[MIDEARTH] OS=[UNIX] Server=[Samba-3.0.20]

Sharename      Type      Comment
---------      ----      -------
public         Disk      Data
IPC$           IPC       IPC Service (Samba-3.0.20)
ADMIN$         IPC       IPC Service (Samba-3.0.20)
hplj4          Printer   hplj4

Server               Comment
---------            -------
OLORIN               Samba-3.0.20

Workgroup            Master
---------            -------
MIDEARTH             OLORIN

\end{Verbatim}
 The following error message indicates that Samba was not running: 
\begin{Verbatim}[]

root#  smbclient -L olorin -U%
Error connecting to 192.168.1.40 (Connection refused)
Connection to olorin failed

\end{Verbatim}
}

\item{Connect to OLORIN as maryo: 
\begin{Verbatim}[]

root# smbclient //olorin/maryo -Umaryo%secret
OS=[UNIX] Server=[Samba-3.0.20]
smb: \> dir
.                              D        0  Sat Jun 21 10:58:16 2003
..                             D        0  Sat Jun 21 10:54:32 2003
Documents                      D        0  Fri Apr 25 13:23:58 2003
DOCWORK                        D        0  Sat Jun 14 15:40:34 2003
OpenOffice.org                 D        0  Fri Apr 25 13:55:16 2003
.bashrc                        H     1286  Fri Apr 25 13:23:58 2003
.netscape6                    DH        0  Fri Apr 25 13:55:13 2003
.mozilla                      DH        0  Wed Mar  5 11:50:50 2003
.kermrc                        H      164  Fri Apr 25 13:23:58 2003
.acrobat                      DH        0  Fri Apr 25 15:41:02 2003

		55817 blocks of size 524288. 34725 blocks available
smb: \> q

\end{Verbatim}
}
\end{enumerate}

By now you should be getting the hang of configuration basics. Clearly, it is time to explore slightly more complex examples. For the remainder of this chapter we abbreviate instructions, since there are previous examples.
\subsection{Domain Member Server}
\label{id2536160}\hypertarget{id2536160}{}%

\index{Server Type!Domain Member} In this instance we consider the simplest server configuration we can get away with to make an accounting department happy. Let's be warned, the users are accountants and they do have some nasty demands. There is a budget for only one server for this department.

The network is managed by an internal Information Services Group (ISG), to which we belong. Internal politics are typical of a medium-sized organization; Human Resources is of the opinion that they run the ISG because they are always adding and disabling users. Also, departmental managers have to fight tooth and nail to gain basic network resources access for their staff. Accounting is different, though, they get exactly what they want. So this should set the scene.

We use the users from the last example. The accounting department has a general printer that all departmental users may use. There is also a check printer that may be used only by the person who has authority to print checks. The chief financial officer (CFO) wants that printer to be completely restricted and for it to be located in the private storage area in her office. It therefore must be a network printer.

The accounting department uses an accounting application called {\em{SpytFull}} that must be run from a central application server. The software is licensed to run only off one server, there are no workstation components, and it is run off a mapped share. The data store is in a UNIX-based SQL backend. The UNIX gurus look after that, so this is not our problem.

The accounting department manager (maryo) wants a general filing system as well as a separate file storage area for form letters (nastygrams). The form letter area should be read-only to all accounting staff except the manager. The general filing system has to have a structured layout with a general area for all staff to store general documents as well as a separate file area for each member of her team that is private to that person, but she wants full access to all areas. Users must have a private home share for personal work-related files and for materials not related to departmental operations.
\subsubsection{Example Configuration}
\label{id2536233}\hypertarget{id2536233}{}%

The server {\em{valinor}} will be a member server of the company domain. Accounting will have only a local server. User accounts will be on the domain controllers, as will desktop profiles and all network policy files.

\begin{example}%
\hypertarget{fast-member-server}{}%
\captionswapskip{}{{\caption{Member Server smb.conf (Globals)}\label{fast-member-server}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = VALINOR
 	security = DOMAIN
 	printcap name = cups
 	disable spoolss = Yes
 	show add printer wizard = No
 	idmap uid = 15000-20000
 	idmap gid = 15000-20000
 	winbind use default domain = Yes
 	printing = cups
\end{lstlisting}
\end{example}


\begin{example}%
\hypertarget{fast-memberserver-shares}{}%
\captionswapskip{}{{\caption{Member Server smb.conf (Shares and Services)}\label{fast-memberserver-shares}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[homes]
 	comment = Home Directories
 	valid users = %S
 	read only = No
 	browseable = No
 [spytfull]
 	comment = Accounting Application Only
 	path = /export/spytfull
 	valid users = @Accounts
 	admin users = maryo
 	read only = Yes
 [public]
 	comment = Data
 	path = /export/public
 	read only = No
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	printer admin = root, maryo
 	create mask = 0600
 	guest ok = Yes
 	printable = Yes
 	use client driver = Yes
 	browseable = No
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{Do not add users to the UNIX/Linux server; all of this will run off the central domain.}

\item{Configure {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} according to \hyperlink{fast-member-server}{Example {\ref{fast-member-server}}} and \hyperlink{fast-memberserver-shares}{Example {\ref{fast-memberserver-shares}}}.}

\item{\index{net!rpc} Join the domain. Note: Do not start Samba until this step has been completed! 
\begin{Verbatim}[]

root# net rpc join -Uroot%'bigsecret'
Joined domain MIDEARTH.

\end{Verbatim}
}

\item{Make absolutely certain that you disable (shut down) the {\bfseries{nscd}} daemon on any system on which {\bfseries{winbind}} is configured to run.}

\item{Start Samba following the normal method for your operating system platform. If you wish to do this manually, execute as root: \index{smbd} \index{nmbd} \index{winbindd} \index{starting samba!smbd} \index{starting samba!nmbd} \index{starting samba!winbindd} 
\begin{Verbatim}[]

root# nmbd; smbd; winbindd;

\end{Verbatim}
}

\item{Configure the name service switch (NSS) control file on your system to resolve user and group names via winbind. Edit the following lines in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}}: 
\begin{Verbatim}[]

passwd: files winbind
group:  files winbind
hosts:  files dns winbind

\end{Verbatim}
}

\item{Set the password for {\bfseries{wbinfo}} to use: 
\begin{Verbatim}[]

root# wbinfo --set-auth-user=root%'bigsecret'

\end{Verbatim}
}

\item{Validate that domain user and group credentials can be correctly resolved by executing: 
\begin{Verbatim}[]

root# wbinfo -u
MIDEARTH\maryo
MIDEARTH\jackb
MIDEARTH\ameds
...
MIDEARTH\root

root# wbinfo -g
MIDEARTH\Domain Users
MIDEARTH\Domain Admins
MIDEARTH\Domain Guests
...
MIDEARTH\Accounts

\end{Verbatim}
}

\item{Check that {\bfseries{winbind}} is working. The following demonstrates correct username resolution via the {\bfseries{getent}} system utility: 
\begin{Verbatim}[]

root# getent passwd maryo
maryo:x:15000:15003:Mary Orville:/home/MIDEARTH/maryo:/bin/false

\end{Verbatim}
}

\item{A final test that we have this under control might be reassuring: 
\begin{Verbatim}[]

root# touch /export/a_file
root# chown maryo /export/a_file
root# ls -al /export/a_file
...
-rw-r--r--    1 maryo    users       11234 Jun 21 15:32 a_file
...

root# rm /export/a_file

\end{Verbatim}
}

\item{Configuration is now mostly complete, so this is an opportune time to configure the directory structure for this site: 
\begin{Verbatim}[]

root# mkdir -p /export/{spytfull,public}
root# chmod ug=rwxS,o=x /export/{spytfull,public}
root# chown maryo.Accounts /export/{spytfull,public}

\end{Verbatim}
}
\end{enumerate}
\subsection{Domain Controller}
\label{id2536893}\hypertarget{id2536893}{}%

\index{Server Type!Domain Controller} For the remainder of this chapter the focus is on the configuration of domain control. The examples that follow are for two implementation strategies. Remember, our objective is to create a simple but working solution. The remainder of this book should help to highlight opportunity for greater functionality and the complexity that goes with it.

A domain controller configuration can be achieved with a simple configuration using the new tdbsam password backend. This type of configuration is good for small offices, but has limited scalability (cannot be replicated), and performance can be expected to fall as the size and complexity of the domain increases.

The use of tdbsam is best limited to sites that do not need more than a Primary Domain Controller (PDC). As the size of a domain grows the need for additional domain controllers becomes apparent. Do not attempt to under-resource a Microsoft Windows network environment; domain controllers provide essential authentication services. The following are symptoms of an under-resourced domain control environment:

\begin{itemize}
%--- Item
\item 
Domain logons intermittently fail.


%--- Item
\item 
File access on a domain member server intermittently fails, giving a permission denied error message.

\end{itemize}

A more scalable domain control authentication backend option might use Microsoft Active Directory or an LDAP-based backend. Samba-3 provides for both options as a domain member server. As a PDC, Samba-3 is not able to provide an exact alternative to the functionality that is available with Active Directory. Samba-3 can provide a scalable LDAP-based PDC/BDC solution.

The tdbsam authentication backend provides no facility to replicate the contents of the database, except by external means (i.e., there is no self-contained protocol in Samba-3 for Security Account Manager database [SAM] replication).

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

If you need more than one domain controller, do not use a tdbsam authentication backend.
\end{admonition}

\subsubsection{Example: Engineering Office}
\label{id2536977}\hypertarget{id2536977}{}%

The engineering office network server we present here is designed to demonstrate use of the new tdbsam password backend. The tdbsam facility is new to Samba-3. It is designed to provide many user and machine account controls that are possible with Microsoft Windows NT4. It is safe to use this in smaller networks.

\begin{example}%
\hypertarget{fast-engoffice-global}{}%
\captionswapskip{}{{\caption{Engineering Office smb.conf (globals)}\label{fast-engoffice-global}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	workgroup = MIDEARTH
 	netbios name = FRODO
 	passdb backend = tdbsam
 	printcap name = cups
 	add user script = /usr/sbin/useradd -m %u
 	delete user script = /usr/sbin/userdel -r %u
 	add group script = /usr/sbin/groupadd %g
 	delete group script = /usr/sbin/groupdel %g
 	add user to group script = /usr/sbin/groupmod -A %u %g
 	delete user from group script = /usr/sbin/groupmod -R %u %g
 	add machine script = /usr/sbin/useradd -s /bin/false -d /var/lib/nobody %u
 # Note: The following specifies the default logon script.
 # Per user logon scripts can be specified in the user account using pdbedit
 	logon script = scripts\logon.bat
 # This sets the default profile path. Set per user paths with pdbedit
 	logon path = \\%L\Profiles\%U
 	logon drive = H:
 	logon home = \\%L\%U
 	domain logons = Yes
 	os level = 35
 	preferred master = Yes
 	domain master = Yes
 	idmap uid = 15000-20000
 	idmap gid = 15000-20000
 	printing = cups
\end{lstlisting}
\end{example}


\begin{example}%
\hypertarget{fast-engoffice-shares}{}%
\captionswapskip{}{{\caption{Engineering Office smb.conf (shares and services)}\label{fast-engoffice-shares}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[homes]
 	comment = Home Directories
 	valid users = %S
 	read only = No
 	browseable = No
 # Printing auto-share (makes printers available thru CUPS)
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	printer admin = root, maryo
 	create mask = 0600
 	guest ok = Yes
 	printable = Yes
 	browseable = No
 [print$]
 	comment = Printer Drivers Share
 	path = /var/lib/samba/drivers
 	write list = maryo, root
 	printer admin = maryo, root
 # Needed to support domain logons
 [netlogon]
 	comment = Network Logon Service
 	path = /var/lib/samba/netlogon
 	admin users = root, maryo
 	guest ok = Yes
 	browseable = No
 # For profiles to work, create a user directory under the path
 # shown. i.e., mkdir -p /var/lib/samba/profiles/maryo
 [Profiles]
 	comment = Roaming Profile Share
 	path = /var/lib/samba/profiles
 	read only = No
 	profile acls = Yes
 # Other resource (share/printer) definitions would follow below.
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{A working PDC configuration using the tdbsam password backend can be found in \hyperlink{fast-engoffice-global}{Example {\ref{fast-engoffice-global}}} together with \hyperlink{fast-engoffice-shares}{Example {\ref{fast-engoffice-shares}}}: \index{pdbedit}}

\item{Create UNIX group accounts as needed using a suitable operating system tool: 
\begin{Verbatim}[]

root# groupadd ntadmins
root# groupadd designers
root# groupadd engineers
root# groupadd qateam

\end{Verbatim}
}

\item{Create user accounts on the system using the appropriate tool provided with the operating system. Make sure all user home directories are created also. Add users to groups as required for access control on files, directories, printers, and as required for use in the Samba environment.}

\item{\index{net!groupmap} \index{initGroups.sh} Assign each of the UNIX groups to NT groups by executing this shell script (You could name the script {\texttt{\docbookhyphenatefilename{initGroups.\dbz{}sh}}}): 
\begin{Verbatim}[]

#!/bin/bash
#### Keep this as a shell script for future re-use
			
# First assign well known groups
net groupmap add ntgroup="Domain Admins" unixgroup=ntadmins rid=512 type=d
net groupmap add ntgroup="Domain Users"  unixgroup=users rid=513 type=
net groupmap add ntgroup="Domain Guests" unixgroup=nobody rid=514 type=d

# Now for our added Domain Groups
net groupmap add ntgroup="Designers" unixgroup=designers type=d
net groupmap add ntgroup="Engineers" unixgroup=engineers type=d
net groupmap add ntgroup="QA Team"   unixgroup=qateam    type=d

\end{Verbatim}
}

\item{Create the {\texttt{\docbookhyphenatefilename{scripts}}} directory for use in the \smbconfsection{[NETLOGON]} share: 
\begin{Verbatim}[]

root# mkdir -p /var/lib/samba/netlogon/scripts

\end{Verbatim}
 Place the logon scripts that will be used (batch or cmd scripts) in this directory.}
\end{enumerate}

The above configuration provides a functional PDC system to which must be added file shares and printers as required.
\subsubsection{A Big Organization}
\label{id2537553}\hypertarget{id2537553}{}%

In this section we finally get to review in brief a Samba-3 configuration that uses a Lightweight Directory Access (LDAP)-based authentication backend. The main reasons for this choice are to provide the ability to host primary and Backup Domain Control (BDC), as well as to enable a higher degree of scalability to meet the needs of a very distributed environment.
\subparagraph*{The Primary Domain Controller}
\label{id2537569}\hypertarget{id2537569}{}%

This is an example of a minimal configuration to run a Samba-3 PDC using an LDAP authentication backend. It is assumed that the operating system has been correctly configured.

The Idealx scripts (or equivalent) are needed to manage LDAP-based POSIX and/or SambaSamAccounts. The Idealx scripts may be downloaded from the Idealx\label{id2537587}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.idealx.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2537587} Web site. They may also be obtained from the Samba tarball. Linux distributions tend to install the Idealx scripts in the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}doc/\dbz{}packages/\dbz{}sambaXXXXXX/\dbz{}examples/\dbz{}LDAP/\dbz{}smbldap-\dbz{}tools}}} directory. Idealx scripts version {\texttt{\docbookhyphenatedot{smbldap-tools-0.9.1}}} are known to work well.

\begin{example}%
\hypertarget{fast-ldap}{}%
\captionswapskip{}{{\caption{LDAP backend smb.conf for PDC}\label{fast-ldap}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = FRODO
 	passdb backend = ldapsam:ldap://localhost
 	username map = /etc/samba/smbusers
 	printcap name = cups
 	add user script = /usr/local/sbin/smbldap-useradd -m '%u'
 	delete user script = /usr/local/sbin/smbldap-userdel %u
 	add group script = /usr/local/sbin/smbldap-groupadd -p '%g'
 	delete group script = /usr/local/sbin/smbldap-groupdel '%g'
 	add user to group script = /usr/local/sbin/smbldap-groupmod -m '%u' '%g'
 	delete user from group script = /usr/local/sbin/smbldap-groupmod -x '%u' '%g'
 	set primary group script = /usr/local/sbin/smbldap-usermod -g '%g' '%u'
 	add machine script = /usr/local/sbin/smbldap-useradd -w '%u'
 	logon script = scripts\logon.bat
 	logon path = \\%L\Profiles\%U
 	logon drive = H:
 	logon home = \\%L\%U
 	domain logons = Yes
 	os level = 35
 	preferred master = Yes
 	domain master = Yes
 	ldap suffix = dc=quenya,dc=org
 	ldap machine suffix = ou=People
 	ldap user suffix = ou=People
 	ldap group suffix = ou=People
 	ldap idmap suffix = ou=People
 	ldap admin dn = cn=Manager
 	ldap ssl = no
 	ldap passwd sync = Yes
 	idmap uid = 15000-20000
 	idmap gid = 15000-20000
 	printing = cups
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{Obtain from the Samba sources {\texttt{\docbookhyphenatefilename{\textasciitilde{}/\dbz{}examples/\dbz{}LDAP/\dbz{}samba.\dbz{}schema}}} and copy it to the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}openldap/\dbz{}schema/\dbz{}}}} directory.}

\item{Set up the LDAP server. This example is suitable for OpenLDAP 2.1.x. The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}openldap/\dbz{}slapd.\dbz{}conf}}} file. \index{/etc/openldap/slapd.conf} Example slapd.conf File 
\begin{Verbatim}[]

# Note commented out lines have been removed
include         /etc/openldap/schema/core.schema
include         /etc/openldap/schema/cosine.schema
include         /etc/openldap/schema/inetorgperson.schema
include         /etc/openldap/schema/nis.schema
include         /etc/openldap/schema/samba.schema

pidfile         /var/run/slapd/slapd.pid
argsfile        /var/run/slapd/slapd.args

database        bdb
suffix          "dc=quenya,dc=org"
rootdn          "cn=Manager,dc=quenya,dc=org"
rootpw          {SSHA}06qDkonA8hk6W6SSnRzWj0/pBcU3m0/P
# The password for the above is 'nastyon3'

directory     /var/lib/ldap

index   objectClass     eq
index cn                      pres,sub,eq
index sn                      pres,sub,eq
index uid                     pres,sub,eq
index displayName             pres,sub,eq
index uidNumber               eq
index gidNumber               eq
index memberUid               eq
index   sambaSID              eq
index   sambaPrimaryGroupSID  eq
index   sambaDomainName       eq
index   default               sub

\end{Verbatim}
}

\item{Create the following file {\texttt{\docbookhyphenatefilename{initdb.\dbz{}ldif}}}: \index{initdb.ldif} 
\begin{Verbatim}[]

# Organization for SambaXP Demo
dn: dc=quenya,dc=org
objectclass: dcObject
objectclass: organization
dc: quenya
o: SambaXP Demo
description: The SambaXP Demo LDAP Tree

# Organizational Role for Directory Management
dn: cn=Manager,dc=quenya,dc=org
objectclass: organizationalRole
cn: Manager
description: Directory Manager

# Setting up the container for users
dn: ou=People, dc=quenya, dc=org
objectclass: top
objectclass: organizationalUnit
ou: People

# Set up an admin handle for People OU
dn: cn=admin, ou=People, dc=quenya, dc=org
cn: admin
objectclass: top
objectclass: organizationalRole
objectclass: simpleSecurityObject
userPassword: {SSHA}0jBHgQ1vp4EDX2rEMMfIudvRMJoGwjVb
# The password for above is 'mordonL8'

\end{Verbatim}
}

\item{Load the initial data above into the LDAP database: 
\begin{Verbatim}[]

root# slapadd -v -l initdb.ldif

\end{Verbatim}
}

\item{Start the LDAP server using the appropriate tool or method for the operating system platform on which it is installed.}

\item{Install the Idealx script files in the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}sbin}}} directory, then configure the smbldap\_conf.pm file to match your system configuration.}

\item{The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file that drives this backend can be found in example \hyperlink{fast-ldap}{Example {\ref{fast-ldap}}}. Add additional stanzas as required.}

\item{Add the LDAP password to the {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}} file so Samba can update the LDAP database: 
\begin{Verbatim}[]

root# smbpasswd -w mordonL8

\end{Verbatim}
}

\item{Add users and groups as required. Users and groups added using Samba tools will automatically be added to both the LDAP backend and the operating system as required.}
\end{enumerate}
\subparagraph*{Backup Domain Controller}
\label{id2507804}\hypertarget{id2507804}{}%

\hyperlink{fast-bdc}{Example {\ref{fast-bdc}}} shows the example configuration for the BDC. Note that the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file does not specify the smbldap-tools scripts ---  they are not needed on a BDC. Add additional stanzas for shares and printers as required.

\begin{example}%
\hypertarget{fast-bdc}{}%
\captionswapskip{}{{\caption{Remote LDAP BDC smb.conf}\label{fast-bdc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = GANDALF
 	passdb backend = ldapsam:ldap://frodo.quenya.org
 	username map = /etc/samba/smbusers
 	printcap name = cups
 	logon script = scripts\logon.bat
 	logon path = \\%L\Profiles\%U
 	logon drive = H:
 	logon home = \\%L\%U
 	domain logons = Yes
 	os level = 33
 	preferred master = Yes
 	domain master = No
 	ldap suffix = dc=quenya,dc=org
 	ldap machine suffix = ou=People
 	ldap user suffix = ou=People
 	ldap group suffix = ou=People
 	ldap idmap suffix = ou=People
 	ldap admin dn = cn=Manager
 	ldap ssl = no
 	ldap passwd sync = Yes
 	idmap uid = 15000-20000
 	idmap gid = 15000-20000
 	printing = cups
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{Decide if the BDC should have its own LDAP server or not. If the BDC is to be the LDAP server, change the following {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} as indicated. The default configuration in \hyperlink{fast-bdc}{Example {\ref{fast-bdc}}} uses a central LDAP server.}

\item{Configure the NETLOGON and PROFILES directory as for the PDC in \hyperlink{fast-bdc}{Example {\ref{fast-bdc}}}.}
\end{enumerate}
\cleardoublepage % ------------------------------------------------------------- 
% 
% PART Server Configuration Basics
% 
% ------------------------------------------------------------- 
\part{Server Configuration Basics}
\label{type}\hypertarget{type}{}%

% -------------------------------------------------------------
% PartIntro First Steps in Server Configuration 
% ------------------------------------------------------------- 	
\chapter*{First Steps in Server Configuration}
\label{id2408703}\hypertarget{id2408703}{}%

Samba can operate in various modes within SMB networks. This HOWTO section contains information on configuring Samba to function as the type of server your network requires. Please read this section carefully.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Server Types and Security Modes 
% ------------------------------------------------------------- 	
\chapter{Server Types and Security Modes}
\label{ServerType}\hypertarget{ServerType}{}%

\index{migrate} \index{security mode} This chapter provides information regarding the types of server that Samba may be configured to be. A Microsoft network administrator who wishes to migrate to or use Samba will want to know the meaning, within a Samba context, of terms familiar to the MS Windows administrator. This means that it is essential also to define how critical security modes function before we get into the details of how to configure the server itself.

This chapter provides an overview of the security modes of which Samba is capable and how they relate to MS Windows servers and clients.

A question often asked is, {``}Why would I want to use Samba?{''} Most chapters contain a section that highlights features and benefits. We hope that the information provided will help to answer this question. Be warned though, we want to be fair and reasonable, so not all features are positive toward Samba. The benefit may be on the side of our competition.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2486607}\hypertarget{id2486607}{}%

Two men were walking down a dusty road, when one suddenly kicked up a small red stone. It hurt his toe and lodged in his sandal. He took the stone out and cursed it with a passion and fury befitting his anguish. The other looked at the stone and said, {``}This is a garnet. I can turn that into a precious gem and some day it will make a princess very happy!{''}

The moral of this tale: Two men, two very different perspectives regarding the same stone. Like it or not, Samba is like that stone. Treat it the right way and it can bring great pleasure, but if you are forced to use it and have no time for its secrets, then it can be a source of discomfort.

\index{UNIX!server} \index{interoperability} Samba started out as a project that sought to provide interoperability for MS Windows 3.x clients with a UNIX server. It has grown up a lot since its humble beginnings and now provides features and functionality fit for large-scale deployment. It also has some warts. In sections like this one, we tell of both.

So, what are the benefits of the features mentioned in this chapter?

\begin{itemize}
%--- Item
\item 
\index{domain!controller} Samba-3 can replace an MS Windows NT4 domain controller.


%--- Item
\item 
\index{active directory} Samba-3 offers excellent interoperability with MS Windows NT4-style domains as well as natively with Microsoft Active Directory domains.


%--- Item
\item 
\index{interdomain!trustrs} Samba-3 permits full NT4-style interdomain trusts.


%--- Item
\item 
\index{authentication} \index{security!modes} Samba has security modes that permit more flexible authentication than is possible with MS Windows NT4 domain controllers.


%--- Item
\item 
\index{account!database!backends} \index{encrypted} Samba-3 permits use of multiple concurrent account database backends. (Encrypted passwords that are stored in the account database are in formats that are unique to Windows networking).


%--- Item
\item 
\index{replicated} The account database backends can be distributed and replicated using multiple methods. This gives Samba-3 greater flexibility than MS Windows NT4 and in many cases a significantly higher utility than Active Directory domains with MS Windows 200x.

\end{itemize}

% ------------------------   
% Section 
\section{Server Types}
\label{id2486443}\hypertarget{id2486443}{}%

\index{Server Type} Administrators of Microsoft networks often refer to three different types of servers:

\begin{itemize}
%--- Item
\item 
Domain Controller

\begin{itemize}
%--- Item
\item 
Primary Domain Controller (PDC)


%--- Item
\item 
Backup Domain Controller (BDC)


%--- Item
\item 
ADS Domain Controller

\end{itemize}


%--- Item
\item 
Domain Member Server

\begin{itemize}
%--- Item
\item 
Active Directory Domain Server


%--- Item
\item 
NT4 Style Domain Domain Server

\end{itemize}


%--- Item
\item 
Standalone Server

\end{itemize}

\index{domain!control} \index{domain!member} \index{domain control!primary} \index{domain control!backup} The chapters covering domain control (\hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}}), backup domain control (\hyperlink{samba-bdc}{Chapter {\ref{samba-bdc}}, {``}Backup Domain Control{''}}), and domain membership (\hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}}) provide pertinent information regarding Samba configuration for each of these server roles. You are strongly encouraged to become intimately familiar with these chapters because they lay the foundation for deployment of Samba domain security.

\index{standalone} A Standalone server is autonomous in respect of the source of its account backend. Refer to \hyperlink{StandAloneServer}{Chapter {\ref{StandAloneServer}}, {``}Standalone Servers{''}} to gain a wider appreciation of what is meant by a server being configured as a {\em{standalone}} server.

% ------------------------   
% Section 
\section{Samba Security Modes}
\label{id2475801}\hypertarget{id2475801}{}%

\index{Security Mode} \index{security} In this section, the function and purpose of Samba's security modes are described. An accurate understanding of how Samba implements each security mode as well as how to configure MS Windows clients for each mode will significantly reduce user complaints and administrator heartache.

\index{Server Message Block|textit{see} {SMB} } \index{Common Internet Filesystem|textit{see} {CIFS} } Microsoft Windows networking uses a protocol that was originally called the Server Message Block (SMB) protocol. Since some time around 1996 the protocol has been better known as the Common Internet Filesystem (CIFS) protocol.

\index{security levels} \index{security modes} \index{user-level} \index{share-level} In the SMB/CIFS networking world, there are only two types of security: {\em{user-level}} and {\em{share level}}. We refer to these collectively as {\em{security levels}}. In implementing these two security levels, Samba provides flexibilities that are not available with MS Windows NT4/200x servers. In fact, Samba implements {\em{share-level}} security only one way, but has four ways of implementing {\em{user-level}} security. Collectively, we call the Samba implementations of the security levels {\em{security modes}}. They are known as {\em{share}}, {\em{user}}, {\em{domain}}, {\em{ADS}}, and {\em{server}} modes. They are documented in this chapter.

An SMB server informs the client, at the time of a session setup, the security level the server is running. There are two options: share-level and user-level. Which of these two the client receives affects the way the client then tries to authenticate itself. It does not directly affect (to any great extent) the way the Samba server does security. This may sound strange, but it fits in with the client/server approach of SMB. In SMB everything is initiated and controlled by the client, and the server can only tell the client what is available and whether an action is allowed.

The term {\texttt{\docbookhyphenatedot{client}}} refers to all agents whether it is a Windows workstation, a Windows server, another Samba server, or any vanilla SMB or CIFS client application (e.g., {\bfseries{smbclient}}) that make use of services provided by an SMB/CIFS server.
\subsection{User Level Security}
\label{id2494508}\hypertarget{id2494508}{}%

\index{user-level} We describe user-level security first because its simpler. In user-level security, the client sends a session setup request directly following protocol negotiation. This request provides a username and password. The server can either accept or reject that username/password combination. At this stage the server has no idea what share the client will eventually try to connect to, so it can't base the {\em{accept/reject}} on anything other than:

\begin{enumerate}
%--- Item
\item 
the username/password.


%--- Item
\item 
the name of the client machine.

\end{enumerate}

\index{credentials} If the server accepts the username/password credentials, the client expects to be able to mount shares (using a {\em{tree connection}}) without further specifying a password. It expects that all access rights will be as the username/password credentials set that was specified in the initial {\em{session setup}}.

\index{session setup} It is also possible for a client to send multiple {\em{session setup}} requests. When the server responds, it gives the client a {\em{uid}} to use as an authentication tag for that username/password. The client can maintain multiple authentication contexts in this way (WinDD is an example of an application that does this).

\index{LanManager} \index{case-preserving} \index{case-insensitive} \index{upper-case} \index{lower-case} Windows networking user account names are case-insensitive, meaning that upper-case and lower-case characters in the account name are considered equivalent. They are said to be case-preserving, but not case significant. Windows and LanManager systems previous to Windows NT version 3.10 have case-insensitive passwords that were not necessarily case-preserving. All Windows NT family systems treat passwords as case-preserving and case-sensitive.
\subsubsection{Example Configuration}
\label{id2474094}\hypertarget{id2474094}{}%

The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter that sets user-level security is:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	security = user
\end{lstlisting}


This is the default setting since Samba-2.2.x.
\subsection{Share-Level Security}
\label{id2474128}\hypertarget{id2474128}{}%

\index{share-level} \index{mount} In share-level security, the client authenticates itself separately for each share. It sends a password along with each tree connection request (share mount), but it does not explicitly send a username with this operation. The client expects a password to be associated with each share, independent of the user. This means that Samba has to work out what username the client probably wants to use, because the username is not explicitly sent to the SMB server. Some commercial SMB servers such as NT actually associate passwords directly with shares in share-level security, but Samba always uses the UNIX authentication scheme where it is a username/password pair that is authenticated, not a share/password pair.

To understand the MS Windows networking parallels, think in terms of MS Windows 9x/Me where you can create a shared folder that provides read-only or full access, with or without a password.

Many clients send a session setup request even if the server is in share-level security. They normally send a valid username but no password. Samba records this username in a list of possible usernames. When the client then issues a tree connection request, it also adds to this list the name of the share they try to connect to (useful for home directories) and any users listed in the \smbconfoption{user} parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. The password is then checked in turn against these possible usernames. If a match is found, then the client is authenticated as that user.

\index{name service switch|textit{see} {NSS} } \index{/etc/passwd} \index{nsswitch.conf} Where the list of possible user names is not provided, Samba makes a UNIX system call to find the user account that has a password that matches the one provided from the standard account database. On a system that has no name service switch (NSS) facility, such lookups will be from the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} database. On NSS enabled systems, the lookup will go to the libraries that have been specified in the {\texttt{\docbookhyphenatefilename{nsswitch.\dbz{}conf}}} file. The entries in that file in which the libraries are specified are: 
\begin{Verbatim}[]

passwd: files nis ldap
shadow: files nis ldap
group: files nis ldap

\end{Verbatim}
 \index{/etc/passwd} \index{/etc/group} \index{NIS} In the example shown here (not likely to be used in practice) the lookup will check {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}}, if not found it will check NIS, then LDAP.
\subsubsection{Example Configuration}
\label{id2457603}\hypertarget{id2457603}{}%

The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter that sets share-level security is:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	security = share
\end{lstlisting}

\subsection{Domain Security Mode (User-Level Security)}
\label{id2457632}\hypertarget{id2457632}{}%

\index{domain!controllers} \index{security!controllers} \index{PDC} \index{BDC} \index{logon} \index{authentication} Domain security provides a mechanism for storing all user and group accounts in a central, shared, account repository. The centralized account repository is shared between domain (security) controllers. Servers that act as domain controllers provide authentication and validation services to all machines that participate in the security context for the domain. A primary domain controller (PDC) is a server that is responsible for maintaining the integrity of the security account database. Backup domain controllers (BDCs) provide only domain logon and authentication services. Usually, BDCs will answer network logon requests more responsively than will a PDC.

\index{domain member} \index{trust account} \index{trust!account} \index{domain!security} \index{domain!controller} When Samba is operating in \smbconfoption{security} = domain mode, the Samba server has a domain security trust account (a machine account) and causes all authentication requests to be passed through to the domain controllers. In other words, this configuration makes the Samba server a domain member server, even when it is in fact acting as a domain controller. All machines that participate in domain security must have a machine account in the security database.

\index{account!database} \index{machine!account} \index{NetBIOS!name} \index{NetBIOS} Within the domain security environment, the underlying security architecture uses user-level security. Even machines that are domain members must authenticate on startup. The machine account consists of an account entry in the accounts database, the name of which is the NetBIOS name of the machine and of which the password is randomly generated and known to both the domain controllers and the member machine. If the machine account cannot be validated during startup, users will not be able to log on to the domain using this machine because it cannot be trusted. The machine account is referred to as a machine trust account.

There are three possible domain member configurations:

\begin{enumerate}
%--- Item
\item 
Primary domain controller (PDC) - of which there is one per domain.


%--- Item
\item 
Backup domain controller (BDC) - of which there can be any number per domain.


%--- Item
\item 
Domain member server (DMS) - of which there can be any number per domain.

\end{enumerate}

\index{DMS} We will discuss each of these in separate chapters. For now, we are most interested in basic DMS configuration.
\subsubsection{Example Configuration}
\label{id2479897}\hypertarget{id2479897}{}%

{\em{Samba as a Domain Member Server}}

\index{server type!domain member} This method involves addition of the following parameters in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	security = domain
 	workgroup = MIDEARTH
\end{lstlisting}


In order for this method to work, the Samba server needs to join the MS Windows NT security domain. This is done as follows: \index{net!rpc} \index{Domain Member!joining}
\begin{enumerate}

\item{On the MS Windows NT domain controller, using the Server Manager, add a machine account for the Samba server.}

\item{On the UNIX/Linux system execute:  
\begin{Verbatim}[]
root# net rpc join -U administrator%password
\end{Verbatim}
}
\end{enumerate}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{smbpasswd} Samba-2.2.4 and later Samba 2.2.x series releases can autojoin a Windows NT4-style domain just by executing: 
\begin{Verbatim}[]

root# smbpasswd -j DOMAIN_NAME -r PDC_NAME \
	 -U Administrator%password

\end{Verbatim}
 \index{net!rpc!join} Samba-3 can do the same by executing: 
\begin{Verbatim}[]

root# net rpc join -U Administrator%password

\end{Verbatim}
 It is not necessary with Samba-3 to specify the {\ttfamily\itshape{\docbookhyphenatedot{DOMAIN\_NAME}}} or the {\ttfamily\itshape{\docbookhyphenatedot{PDC\_NAME}}}, as it figures this out from the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file settings.
\end{admonition}


\index{invalid shell} \index{/etc/passwd} \index{/bin/false} Use of this mode of authentication requires there to be a standard UNIX account for each user in order to assign a UID once the account has been authenticated by the Windows domain controller. This account can be blocked to prevent logons by clients other than MS Windows through means such as setting an invalid shell in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} entry. The best way to allocate an invalid shell to a user account is to set the shell to the file {\texttt{\docbookhyphenatefilename{/\dbz{}bin/\dbz{}false}}}.

\index{PDC} \index{BDC} Domain controllers can be located anywhere that is convenient. The best advice is to have a BDC on every physical network segment, and if the PDC is on a remote network segment the use of WINS (see \hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}} for more information) is almost essential.

An alternative to assigning UIDs to Windows users on a Samba member server is presented in \hyperlink{winbind}{Chapter {\ref{winbind}}, {``}Winbind: Use of Domain Accounts{''}}, \hyperlink{winbind}{Chapter {\ref{winbind}}, {``}Winbind: Use of Domain Accounts{''}}.

For more information regarding domain membership, \hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}}.
\subsection{ADS Security Mode (User-Level Security)}
\label{id2508066}\hypertarget{id2508066}{}%

\index{ADS} \index{native mode} Both Samba-2.2, and Samba-3 can join an Active Directory domain using NT4 style RPC based security. This is possible if the domain is run in native mode. Active Directory in native mode perfectly allows NT4-style domain members. This is contrary to popular belief.

If you are using Active Directory, starting with Samba-3 you can join as a native AD member. Why would you want to do that? Your security policy might prohibit the use of NT-compatible authentication protocols. All your machines are running Windows 2000 and above and all use Kerberos. In this case, Samba, as an NT4-style domain, would still require NT-compatible authentication data. Samba in AD-member mode can accept Kerberos tickets.

\index{realm} \index{mixed mode} Sites that use Microsoft Windows active directory services (ADS) should be aware of the significance of the terms: {\texttt{\docbookhyphenatedot{native mode}}} and {\texttt{\docbookhyphenatedot{mixed mode}}} ADS operation. The term {\texttt{\docbookhyphenatedot{realm}}} is used to describe a Kerberos-based security architecture (such as is used by Microsoft ADS).
\subsubsection{Example Configuration}
\label{id2508144}\hypertarget{id2508144}{}%


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	realm = your.kerberos.REALM
 	security = ADS
\end{lstlisting}


The following parameter may be required:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	password server = your.kerberos.server
\end{lstlisting}


Please refer to \hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}}, and \hyperlink{ads-member}{Section {\ref{ads-member}}} for more information regarding this configuration option.
\subsection{Server Security (User Level Security)}
\label{id2508201}\hypertarget{id2508201}{}%

Server security mode is left over from the time when Samba was not capable of acting as a domain member server. It is highly recommended not to use this feature. Server security mode has many drawbacks that include:

\begin{itemize}
%--- Item
\item 
Potential account lockout on MS Windows NT4/200x password servers.


%--- Item
\item 
Lack of assurance that the password server is the one specified.


%--- Item
\item 
Does not work with Winbind, which is particularly needed when storing profiles remotely.


%--- Item
\item 
This mode may open connections to the password server and keep them open for extended periods.


%--- Item
\item 
Security on the Samba server breaks badly when the remote password server suddenly shuts down.


%--- Item
\item 
With this mode there is NO security account in the domain that the password server belongs to for the Samba server.

\end{itemize}

\index{session setup} \index{SMB} In server security mode the Samba server reports to the client that it is in user-level security. The client then does a session setup as described earlier. The Samba server takes the username/password that the client sends and attempts to log into the \smbconfoption{password server} by sending exactly the same username/password that it got from the client. If that server is in user-level security and accepts the password, then Samba accepts the client's connection. This parameter allows the Samba server to use another SMB server as the \smbconfoption{password server}.

\index{security level} \index{encryption} You should also note that at the start of all this, when the server tells the client what security level it is in, it also tells the client if it supports encryption. If it does, it supplies the client with a random cryptkey. The client will then send all passwords in encrypted form. Samba supports this type of encryption by default.

The parameter \smbconfoption{security} = server means that Samba reports to clients that it is running in {\em{user mode}} but actually passes off all authentication requests to another user mode server. This requires an additional parameter \smbconfoption{password server} that points to the real authentication server. The real authentication server can be another Samba server, or it can be a Windows NT server, the latter being natively capable of encrypted password support.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{password server} \index{workgroup} When Samba is running in {\em{server security mode}}, it is essential that the parameter {\em{password server}} is set to the precise NetBIOS machine name of the target authentication server. Samba cannot determine this from NetBIOS name lookups because the choice of the target authentication server is arbitrary and cannot be determined from a domain name. In essence, a Samba server that is in {\em{server security mode}} is operating in what used to be known as workgroup mode.
\end{admonition}

\subsubsection{Example Configuration}
\label{id2508374}\hypertarget{id2508374}{}%

{\em{Using MS Windows NT as an Authentication Server}}

This method involves the additions of the following parameters in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	encrypt passwords = Yes
 	security = server
 	password server = "NetBIOS_name_of_a_DC"
\end{lstlisting}


There are two ways of identifying whether or not a username and password pair is valid. One uses the reply information provided as part of the authentication messaging process, the other uses just an error code.

\index{bogus} \index{lockout} The downside of this mode of configuration is that for security reasons Samba will send the password server a bogus username and a bogus password, and if the remote server fails to reject the bogus username and password pair, then an alternative mode of identification or validation is used. Where a site uses password lockout, after a certain number of failed authentication attempts, this will result in user lockouts.

Use of this mode of authentication requires a standard UNIX account for the user. This account can be blocked to prevent logons by non-SMB/CIFS clients.

% ------------------------   
% Section 
\section{Password Checking}
\label{id2508461}\hypertarget{id2508461}{}%

MS Windows clients may use encrypted passwords as part of a challenge/response authentication model (a.k.a. NTLMv1 and NTLMv2) or alone, or clear-text strings for simple password-based authentication. It should be realized that with the SMB protocol, the password is passed over the network either in plaintext or encrypted, but not both in the same authentication request.

\index{encrypted passwords} \index{encrypted} When encrypted passwords are used, a password that has been entered by the user is encrypted in two ways:

\begin{itemize}
%--- Item
\item 
An MD4 hash of the unicode of the password string. This is known as the NT hash.


%--- Item
\item 
The password is converted to uppercase, and then padded or truncated to 14 bytes. This string is then appended with 5 bytes of NULL characters and split to form two 56-bit DES keys to encrypt a "magic" 8-byte value. The resulting 16 bytes form the LanMan hash.

\end{itemize}

\index{plain-text!passwords} MS Windows 95 pre-service pack 1 and MS Windows NT versions 3.x and version 4.0 pre-service pack 3 will use either mode of password authentication. All versions of MS Windows that follow these versions no longer support plain-text passwords by default.

\index{cached!password} MS Windows clients have a habit of dropping network mappings that have been idle for 10 minutes or longer. When the user attempts to use the mapped drive connection that has been dropped, the client re-establishes the connection using a cached copy of the password.

When Microsoft changed the default password mode, support was dropped for caching of the plaintext password. This means that when the registry parameter is changed to re-enable use of plaintext passwords, it appears to work, but when a dropped service connection mapping attempts to revalidate, this will fail if the remote authentication server does not support encrypted passwords. It is definitely not a good idea to re-enable plaintext password support in such clients.

The following parameters can be used to work around the issue of Windows 9x/Me clients uppercasing usernames and passwords before transmitting them to the SMB server when using clear-text authentication:
\newpage 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	password level
 	username level
\end{lstlisting}

By default Samba will convert to lowercase the username before attempting to lookup the user in the database of local system accounts. Because UNIX usernames conventionally only contain lowercase characters, the \smbconfoption{username-level} parameter is rarely needed.

\index{clear-text} However, passwords on UNIX systems often make use of mixed-case characters. This means that in order for a user on a Windows 9x/Me client to connect to a Samba server using clear-text authentication, the \smbconfoption{password level} must be set to the maximum number of uppercase letters that {\em{could}} appear in a password. Note that if the Server OS uses the traditional DES version of crypt(), a \smbconfoption{password level} of 8 will result in case-insensitive passwords as seen from Windows users. This will also result in longer login times because Samba has to compute the permutations of the password string and try them one by one until a match is located (or all combinations fail).

The best option to adopt is to enable support for encrypted passwords wherever Samba is used. Most attempts to apply the registry change to re-enable plaintext passwords will eventually lead to user complaints and unhappiness.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2508646}\hypertarget{id2508646}{}%

We all make mistakes. It is okay to make mistakes, as long as they are made in the right places and at the right time. A mistake that causes lost productivity is seldom tolerated; however, a mistake made in a developmental test lab is expected.

Here we look at common mistakes and misapprehensions that have been the subject of discussions on the Samba mailing lists. Many of these are avoidable by doing your homework before attempting a Samba implementation. Some are the result of a misunderstanding of the English language, which has many phrases that are potentially vague and may be highly confusing to those for whom English is not their native tongue.
\subsection{What Makes Samba a Server?}
\label{id2508671}\hypertarget{id2508671}{}%

To some, the nature of the Samba security mode is obvious, but entirely wrong all the same. It is assumed that \smbconfoption{security} = server means that Samba will act as a server. Not so! This setting means that Samba will {\em{try}} to use another SMB server as its source for user authentication alone.

Samba is a server regardless of which security mode is chosen. When Samba is used outside of a domain security context, it is best to leave the security mode at the default setting. By default Samba-3 uses user-mode security.
\subsection{What Makes Samba a Domain Controller?}
\label{id2508703}\hypertarget{id2508703}{}%

\index{server-mode} The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter \smbconfoption{security} = domain does not really make Samba behave as a domain controller. This setting means we want Samba to be a domain member. See \hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}} for more information.
\subsection{What Makes Samba a Domain Member?}
\label{id2508741}\hypertarget{id2508741}{}%

Guess! So many others do. But whatever you do, do not think that \smbconfoption{security} = user makes Samba act as a domain member. Read the manufacturer's manual before the warranty expires. See \hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}}, for more information.
\subsection{Constantly Losing Connections to Password Server}
\label{id2508768}\hypertarget{id2508768}{}%

{``}Why does server\_validate() simply give up rather than re-establish its connection to the password server? Though I am not fluent in the SMB protocol, perhaps the cluster server process passes along to its client workstation the session key it receives from the password server, which means the password hashes submitted by the client would not work on a subsequent connection whose session key would be different. So server\_validate() must give up.{''}

Indeed. That's why \smbconfoption{security} = server is at best a nasty hack. Please use \smbconfoption{security} = domain; \smbconfoption{security} = server mode is also known as pass-through authentication.
\subsection{Stand-alone Server is converted to Domain Controller --- Now User accounts don't work}
\label{id2508811}\hypertarget{id2508811}{}%

{``}When I try to log in to the DOMAIN, the eventlog shows {\em{tried credentials DOMAIN/username; effective credentials SERVER/username}}{''}

Usually this is due to a user or machine account being created before the Samba server is configured to be a domain controller. Accounts created before the server becomes a domain controller will be {\em{local}} accounts and authenticated as what looks like a member in the SERVER domain, much like local user accounts in Windows 2000 and later. Accounts created after the Samba server becomes a domain controller will be {\em{domain}} accounts and will be authenticated as a member of the DOMAIN domain.

This can be verified by issuing the command {\bfseries{pdbedit -L -v username}}. If this reports DOMAIN then the account is a domain account, if it reports SERVER then the account is a local account.

The easiest way to resolve this is to remove and recreate the account; however this may cause problems with established user profiles. You can also use {\bfseries{pdbedit -u username -I DOMAIN}}. You may also need to change the User SID and Primary Group SID to match the domain.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Domain Control 
% ------------------------------------------------------------- 	
\chapter{Domain Control}
\label{samba-pdc}\hypertarget{samba-pdc}{}%

There are many who approach MS Windows networking with incredible misconceptions. That's okay, because it gives the rest of us plenty of opportunity to be of assistance. Those who really want help are well advised to become familiar with information that is already available.

\index{domain!controller} You are advised not to tackle this section without having first understood and mastered some basics. MS Windows networking is not particularly forgiving of misconfiguration. Users of MS Windows networking are likely to complain of persistent niggles that may be caused by a broken network configuration. To a great many people, however, MS Windows networking starts with a domain controller that in some magical way is expected to solve all network operational ills.

\hyperlink{domain-example}{Figure {\ref{domain-example}}} shows a typical MS Windows domain security network environment. Workstations A, B, and C are representative of many physical MS Windows network clients.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{domain-example}{}%
\includegraphics[scale=0.4]{Samba3-HOWTO/images/domain}
{{\caption[{An Example Domain.}]{{{An Example Domain.}}}\label{domain-example}}}
\end{center}
\end{figure}


From the Samba mailing list we can readily identify many common networking issues. If you are not clear on the following subjects, then it will do much good to read the sections of this HOWTO that deal with it. These are the most common causes of MS Windows networking problems:

\begin{itemize}
%--- Item
\item 
Basic TCP/IP configuration.


%--- Item
\item 
NetBIOS name resolution.


%--- Item
\item 
Authentication configuration.


%--- Item
\item 
User and group configuration.


%--- Item
\item 
Basic file and directory permission control in UNIX/Linux.


%--- Item
\item 
Understanding how MS Windows clients interoperate in a network environment.

\end{itemize}

Do not be put off; on the surface of it MS Windows networking seems so simple that anyone can do it. In fact, it is not a good idea to set up an MS Windows network with inadequate training and preparation. But let's get our first indelible principle out of the way: {\em{It is perfectly okay to make mistakes!}} In the right place and at the right time, mistakes are the essence of learning. It is very much not okay to make mistakes that cause loss of productivity and impose an avoidable financial burden on an organization.

Where is the right place to make mistakes? Only out of harms way. If you are going to make mistakes, then please do it on a test network, away from users, and in such a way as to not inflict pain on others. Do your learning on a test network.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2488095}\hypertarget{id2488095}{}%

\index{domain security} {\em{What is the key benefit of Microsoft Domain Security?}}

\index{single sign-on|textit{see} {SSO} } \index{trust} \index{account} \index{domain!security!protocols} In a word, {\em{single sign-on}}, or SSO for short. To many, this is the Holy Grail of MS Windows NT and beyond networking. SSO allows users in a well-designed network to log onto any workstation that is a member of the domain that contains their user account (or in a domain that has an appropriate trust relationship with the domain they are visiting) and they will be able to log onto the network and access resources (shares, files, and printers) as if they are sitting at their home (personal) workstation. This is a feature of the domain security protocols.

\index{SID} \index{RID} \index{relative identifier|textit{see} {RID} } \index{security identifier|textit{see} {SID} } \index{access control} The benefits of domain security are available to those sites that deploy a Samba PDC. A domain provides a unique network security identifier (SID). Domain user and group security identifiers are comprised of the network SID plus a relative identifier (RID) that is unique to the account. User and group SIDs (the network SID plus the RID) can be used to create access control lists (ACLs) attached to network resources to provide organizational access control. UNIX systems recognize only local security identifiers.

\index{SID} A SID represents a security context. For example, every Windows machine has local accounts within the security context of the local machine which has a unique SID. Every domain (NT4, ADS, Samba) contains accounts that exist within the domain security context which is defined by the domain SID.

\index{SID} \index{RID} A domain member server will have a SID that differs from the domain SID. The domain member server can be configured to regard all domain users as local users. It can also be configured to recognize domain users and groups as non-local. SIDs are persistent. A typical domain of user SID looks like this: 
\begin{Verbatim}[]

S-1-5-21-726309263-4128913605-1168186429

\end{Verbatim}
 Every account (user, group, machine, trust, etc.) is assigned a RID. This is done automatically as an account is created. Samba produces the RID algorithmically. The UNIX operating system uses a separate name space for user and group identifiers (the UID and GID) but Windows allocates the RID from a single name space. A Windows user and a Windows group can not have the same RID. Just as the UNIX user {\texttt{\docbookhyphenatedot{root}}} has the UID=0, the Windows Administrator has the well-known RID=500. The RID is catenated to the Windows domain SID, so Administrator account for a domain that has the above SID will have the user SID 
\begin{Verbatim}[]

S-1-5-21-726309263-4128913605-1168186429-500

\end{Verbatim}
 The result is that every account in the Windows networking world has a globally unique security identifier.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{domain!member} \index{machine account} \index{domain!trust account} Network clients of an MS Windows domain security environment must be domain members to be able to gain access to the advanced features provided. Domain membership involves more than just setting the workgroup name to the domain name. It requires the creation of a domain trust account for the workstation (called a machine account). Refer to \hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}} for more information.
\end{admonition}


The following functionalities are new to the Samba-3 release:

\begin{itemize}
%--- Item
\item 
\index{account!backend} Samba-3 supports the use of a choice of backends that may be used in which user, group and machine accounts may be stored. Multiple passwd backends can be used in combination, either as additive backend data sets, or as fail-over data sets.

\index{LDAP} \index{replicated} \index{distributed} \index{scalability} \index{reliability} An LDAP passdb backend confers the benefit that the account backend can be distributed and replicated, which is of great value because it confers scalability and provides a high degree of reliability.


%--- Item
\item 
\index{interdomain!trust!account} \index{trust account!interdomain} \index{interoperability} Windows NT4 domain trusts. Samba-3 supports workstation and server (machine) trust accounts. It also supports Windows NT4 style interdomain trust accounts, which further assists in network scalability and interoperability.


%--- Item
\item 
\index{NetBIOS} \index{raw SMB} \index{active directory} \index{domain!member server} \index{domain!controller} \index{network!browsing} Operation without NetBIOS over TCP/IP, rather using the raw SMB over TCP/IP. Note, this is feasible only when operating as a Microsoft active directory domain member server. When acting as a Samba domain controller the use of NetBIOS is necessary to provide network browsing support.


%--- Item
\item 
\index{WINS} \index{TCP port} \index{session services} Samba-3 provides NetBIOS name services (WINS), NetBIOS over TCP/IP (TCP port 139) session services, SMB over TCP/IP (TCP port 445) session services, and Microsoft compatible ONC DCE RPC services (TCP port 135) services.


%--- Item
\item 
\index{Nexus.exe} Management of users and groups via the User Manager for Domains. This can be done on any MS Windows client using the {\texttt{\docbookhyphenatefilename{Nexus.\dbz{}exe}}} toolkit for Windows 9x/Me, or using the SRVTOOLS.EXE package for MS Windows NT4/200x/XP platforms. These packages are available from Microsoft's Web site.


%--- Item
\item 
Implements full Unicode support. This simplifies cross-locale internationalization support. It also opens up the use of protocols that Samba-2.2.x had but could not use due to the need to fully support Unicode.

\end{itemize}

The following functionalities are not provided by Samba-3:

\begin{itemize}
%--- Item
\item 
\index{SAM} \index{replication} SAM replication with Windows NT4 domain controllers (i.e., a Samba PDC and a Windows NT BDC, or vice versa). This means Samba cannot operate as a BDC when the PDC is Microsoft-based Windows NT PDC. Samba-3 can not participate in replication of account data to Windows PDCs and BDCs.


%--- Item
\item 
\index{kerberos} \index{active directory} Acting as a Windows 2000 active directory domain controller (i.e., Kerberos and Active Directory). In point of fact, Samba-3 does have some Active Directory domain control ability that is at this time purely experimental. Active directory domain control is one of the features that is being developed in Samba-4, the next generation Samba release. At this time there are no plans to enable active directory domain control support during the Samba-3 series life-cycle.


%--- Item
\item 
\index{MMC} \index{SVRTOOLS.EXE} \index{Microsoft management console|textit{see} {MMC} } The Windows 200x/XP Microsoft Management Console (MMC) cannot be used to manage a Samba-3 server. For this you can use only the MS Windows NT4 Domain Server Manager and the MS Windows NT4 Domain User Manager. Both are part of the SVRTOOLS.EXE package mentioned later.

\end{itemize}

\index{Windows XP Home edition} \index{LanMan} Windows 9x/Me/XP Home clients are not true members of a domain for reasons outlined in this chapter. The protocol for support of Windows 9x/Me-style network (domain) logons is completely different from NT4/Windows 200x-type domain logons and has been officially supported for some time. These clients use the old LanMan network logon facilities that are supported in Samba since approximately the Samba-1.9.15 series.

\index{group!mapping} Samba-3 implements group mapping between Windows NT groups and UNIX groups (this is really quite complicated to explain in a short space). This is discussed more fully in \hyperlink{groupmapping}{Chapter {\ref{groupmapping}}, {``}Group Mapping: MS Windows and UNIX{''}}.

\index{machine trust account} \index{trust account!machine} \index{machine account} Samba-3, like an MS Windows NT4 PDC or a Windows 200x Active Directory, needs to store user and Machine Trust Account information in a suitable backend data-store. Refer to \hyperlink{machine-trust-accounts}{Section {\ref{machine-trust-accounts}}}. With Samba-3 there can be multiple backends for this. A complete discussion of account database backends can be found in \hyperlink{passdb}{Chapter {\ref{passdb}}, {``}Account Information Databases{''}}.

% ------------------------   
% Section 
\section{Single Sign-On and Domain Security}
\label{id2476707}\hypertarget{id2476707}{}%

\index{single sign-on|textit{see} {SSO} } \index{SSO} \index{active directory} \index{authentication} \index{validation} \index{password uniqueness} \index{password history} When network administrators are asked to describe the benefits of Windows NT4 and active directory networking the most often mentioned feature is that of single sign-on (SSO). Many companies have implemented SSO solutions. The mode of implementation of a single sign-on solution is an important factor in the practice of networking in general, and is critical in respect of Windows networking. A company may have a wide variety of information systems, each of which requires a form of user authentication and validation, thus it is not uncommon that users may need to remember more than ten login IDs and passwords. This problem is compounded when the password for each system must be changed at regular intervals, and particularly so where password uniqueness and history limits are applied.

\index{management overheads} There is a broadly held perception that SSO is the answer to the problem of users having to deal with too many information system access credentials (username/password pairs). Many elaborate schemes have been devised to make it possible to deliver a user-friendly SSO solution. The trouble is that if this implementation is not done correctly, the site may end up paying dearly by way of complexity and management overheads. Simply put, many SSO solutions are an administrative nightmare.

\index{identity management} \index{authentication system} \index{SSO} SSO implementations utilize centralization of all user account information. Depending on environmental complexity and the age of the systems over which a SSO solution is implemented, it may not be possible to change the solution architecture so as to accomodate a new identity management and user authentication system. Many SSO solutions involving legacy systems consist of a new super-structure that handles authentication on behalf of the user. The software that gets layered over the old system may simply implement a proxy authentication system. This means that the addition of SSO increases over-all information systems complexity. Ideally, the implementation of SSO should reduce complexity and reduce administative overheads.

\index{centralized identity management} \index{identity management!centralized} \index{centralized!authentication} \index{legacy systems} \index{access control} The initial goal of many network administrators is often to create and use a centralized identity management system. It is often assumed that such a centralized system will use a single authentication infrastructure that can be used by all information systems. The Microsoft Windows NT4 security domain architecture and the Micrsoft active directory service are often put forward as the ideal foundation for such a system. It is conceptually simple to install an external authentication agent on each of the disparate infromation systems that can then use the Microsoft (NT4 domain or ads service) for user authentication and access control. The wonderful dream of a single centralized authentication service is commonly broken when realities are realized. The problem with legacy systems is often the inability to externalize the authentication and access control system it uses because its implementation will be excessively invasive from a re-engineering perspective, or because application software has built-in dependencies on particular elements of the way user authentication and access control were designed and built.

\index{meta-directory} \index{credentials} \index{disparate information systems} \index{management procedures} \index{work-flow protocol} \index{rights} \index{privileges} \index{provisioned} Over the past decade an industry has been developed around the various methods that have been built to get around the key limitations of legacy information technology systems. One approach that is often used involves the use of a meta-directory. The meta-directory stores user credentials for all disparate information systems in the format that is particular to each system. An elaborate set of management procedures is coupled with a rigidly enforced work-flow protocol for managing user rights and privileges within the maze of systems that are provisioned by the new infrastructure makes possible user access to all systems using a single set of user credentials.

\index{Organization for the Advancement of Structured Information Standards|textit{see} {OASIS} } \index{Security Assertion Markup Language|textit{see} {SAML} } \index{Federated Identity Management|textit{see} {FIM} } \index{secure access} The Organization for the Advancement of Structured Information Standards (OASIS) has developed the Security Assertion Markup Language (SAML), a structured method for communication of authentication information. The over-all umbrella name for the technologies and methods that deploy SAML is called Federated Identity Management (FIM). FIM depends on each system in the complex maze of disparate information systems to authenticate their respective users and vouch for secure access to the services each provides.

\index{Simple Object Access Protocol|textit{see} {SOAP} } \index{federated organizations} \index{Liberty Alliance} \index{federated-identity} \index{} \index{} SAML documents can be wrapped in a Simple Object Access Protocol (SOAP) message for the computer-to-computer communications needed for Web services. Or they may be passed between Web servers of federated organizations that share live services. The Liberty Alliance, an industry group formed to promote federated-identity standards, has adopted SAML 1.1 as part of its application framework. Microsoft and IBM have proposed an alternative specification called WS-Security. Some believe that the competing technologies and methods may converge when the SAML 2.0 standard is introduced. A few Web access-management products support SAML today, but implemention of the technology mostly requires customization to integrate applications and develop user interfaces. In a nust-shell, that is why FIM is a big and growing industry.

\index{interoperability} \index{ADS} \index{LDAP} \index{GSSAPI} \index{general security service application programming interface|textit{see} {GSSAPI} } Ignoring the bigger picture, which is beyond the scope of this book, the migration of all user and group management to a centralized system is a step in the right direction. It is essential for interoperability reasons to locate the identity management system data in a directory such as Microsoft Active Directory Service (ADS), or any proprietary or open source system that provides a standard protocol for information access (such as LDAP) and that can be coupled with a flexible array of authentication mechanisms (such as kerberos) that use the protocols that are defined by the various general security service application programming interface (GSSAPI) services.

\index{OpenLDAP} \index{ADS} \index{authentication agents} A growing number of companies provide authentication agents for disparate legacy platforms to permit the use of LDAP systems. Thus the use of OpenLDAP, the dominant open source software implementation of the light weight directory access protocol standard. This fact, means that by providing support in Samba for the use of LDAP and Microsoft ADS make Samba a highly scalable and forward reaching organizational networking technology.

\index{ADS} \index{LDAP} \index{authentication architecture} \index{ntlm\_auth} \index{SQUID} \index{FIM} Microsoft ADS provides purely proprietary services that, with limitation, can be extended to provide a centralized authentication infrastructure. Samba plus LDAP provides a similar opportunity for extension of a centralized authentication architecture, but it is the fact that the Samba Team are pro-active in introducing the extension of authentication services, using LDAP or otherwise, to applications such as SQUID (the open source proxy server) through tools such as the {\bfseries{ntlm\_auth}} utility, that does much to create sustainable choice and competition in the FIM market place.

\index{LDAP} \index{OpenLDAP} \index{identity information} Primary domain control, if it is to be scalable to meet the needs of large sites, must therefore be capable of using LDAP. The rapid adoption of OpenLDAP, and Samba configurations that use it, is ample proof that the era of the directory has started. Samba-3 does not demand the use of LDAP, but the demand for a mechanism by which user and group identity information can be distributed makes it an an unavoidable option.

\index{BDC} \index{LDAP} \index{e-Directory} At this time, the use of Samba based BDCs, necessitates the use of LDAP. The most commonly used LDAP implementation used by Samba sites is OpenLDAP. It is possible to use any standards compliant LDAP server. Those known to work includes those manufactured by: IBM, CA, Novell (e-Directory), and others.

% ------------------------   
% Section 
\section{Basics of Domain Control}
\label{id2512504}\hypertarget{id2512504}{}%

\index{domain control} Over the years, public perceptions of what domain control really is has taken on an almost mystical nature. Before we branch into a brief overview of domain control, there are three basic types of domain controllers.
\subsection{Domain Controller Types}
\label{id2512524}\hypertarget{id2512524}{}%

\begin{itemize}
%--- Item
\item 
NT4 style Primary Domain Controller


%--- Item
\item 
NT4 style Backup Domain Controller


%--- Item
\item 
ADS Domain Controller

\end{itemize}

\index{PDC} \index{powerful} \index{network!performance} \index{domain!member!server} The {\em{Primary Domain Controller}} or PDC plays an important role in MS Windows NT4. In Windows 200x domain control architecture, this role is held by domain controllers. Folklore dictates that because of its role in the MS Windows network, the domain controller should be the most powerful and most capable machine in the network. As strange as it may seem to say this here, good overall network performance dictates that the entire infrastructure needs to be balanced. It is advisable to invest more in standalone (domain member) servers than in the domain controllers.

\index{SAM} \index{BDC} \index{authenticatior} \index{synchronization} \index{Security Account Manager|textit{see} {SAM} } In the case of MS Windows NT4-style domains, it is the PDC that initiates a new domain control database. This forms a part of the Windows registry called the Security Account Manager (SAM). It plays a key part in NT4-type domain user authentication and in synchronization of the domain authentication database with BDCs.

\index{domain!controller!hierarchy} \index{LDAP} \index{account!backend} \index{machine account} With MS Windows 200x Server-based Active Directory domains, one domain controller initiates a potential hierarchy of domain controllers, each with its own area of delegated control. The master domain controller has the ability to override any downstream controller, but a downline controller has control only over its downline. With Samba-3, this functionality can be implemented using an LDAP-based user and machine account backend.

\index{backend database} \index{registry} New to Samba-3 is the ability to use a backend database that holds the same type of data as the NT4-style SAM database (one of the registry files)\label{id2512712}\begingroup\catcode`\#=12\footnote{
See also \hyperlink{passdb}{Chapter {\ref{passdb}}, {``}Account Information Databases{''}}.
.}\endgroup\docbooktolatexmakefootnoteref{id2512712}

\index{BDC} \index{PDC} \index{WINS} \index{authentication} \index{netlogon} \index{name lookup} The {\em{Backup Domain Controller}} or BDC plays a key role in servicing network authentication requests. The BDC is biased to answer logon requests in preference to the PDC. On a network segment that has a BDC and a PDC, the BDC will most likely service network logon requests. The PDC will answer network logon requests when the BDC is too busy (high load). When a user logs onto a Windows domain member client the workstation will query the network to locate the nearest network logon server. Where a WINS server is used, this is done via a query to the WINS server. If a netlogon server can not be found from the WINS query, or in the absence of a WINS server, the workstation will perform a NetBIOS name lookup via a mailslot broadcast over the UDP broadcast protocol. This means that the netlogon server that the windows client will use is influenced by a number of variables, thus there is no simple determinant of whether a PDC or a BDC will serve a particular logon authentication request.

\index{promote} \index{demote} A Windows NT4 BDC can be promoted to a PDC. If the PDC is online at the time that a BDC is promoted to PDC, the previous PDC is automatically demoted to a BDC. With Samba-3, this is not an automatic operation; the PDC and BDC must be manually configured, and other appropriate changes also need to be made.

\index{domain!controller!convert} With MS Windows NT4, a decision is made at installation to determine what type of machine the server will be. It is possible to promote a BDC to a PDC, and vice versa. The only method Microsoft provide to convert a Windows NT4 domain controller to a domain member server or a standalone server is to reinstall it. The install time choices offered are:

\begin{itemize}
%--- Item
\item 
{\em{Primary Domain Controller}} ---  the one that seeds the domain SAM.


%--- Item
\item 
{\em{Backup Domain Controller}} ---  one that obtains a copy of the domain SAM.


%--- Item
\item 
{\em{Domain Member Server}} ---  one that has no copy of the domain SAM; rather it obtains authentication from a domain controller for all access controls.


%--- Item
\item 
{\em{Standalone Server}} ---  one that plays no part in SAM synchronization, has its own authentication database, and plays no role in domain security.

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{promote} Algin Technology LLC provide a commercial tool that makes it possible to promote a Windows NT4 standalone server to a PDC or a BDC, and also permits this process to be reversed. Refer to the Algin\label{id2512896}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://utools.com/UPromote.asp}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2512896} web site for further information.
\end{admonition}


\index{domain!control!role} \index{native member} Samba-3 servers can readily be converted to and from domain controller roles through simple changes to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Samba-3 is capable of acting fully as a native member of a Windows 200x server Active Directory domain.

\index{convert!domain member server} For the sake of providing a complete picture, MS Windows 2000 domain control configuration is done after the server has been installed. Please refer to Microsoft documentation for the procedures that should be followed to convert a domain member server to or from a domain control, and to install or remove active directory service support.

\index{replication!SAM} \index{SAM!replication} New to Samba-3 is the ability to function fully as an MS Windows NT4-style domain controller, excluding the SAM replication components. However, please be aware that Samba-3 also supports the MS Windows 200x domain control protocols.

\index{ADS} At this time any appearance that Samba-3 is capable of acting as a {\em{domain controller}} in native ADS mode is limited and experimental in nature. This functionality should not be used until the Samba Team offers formal support for it. At such a time, the documentation will be revised to duly reflect all configuration and management requirements. Samba can act as a NT4-style domain controller in a Windows 2000/XP environment. However, there are certain compromises:

\begin{itemize}
%--- Item
\item 
No machine policy files.


%--- Item
\item 
No Group Policy Objects.


%--- Item
\item 
No synchronously executed Active Directory logon scripts.


%--- Item
\item 
Can't use Active Directory management tools to manage users and machines.


%--- Item
\item 
Registry changes tattoo the main registry, while with Active Directory they do not leave permanent changes in effect.


%--- Item
\item 
Without Active Directory you cannot perform the function of exporting specific applications to specific users or groups.

\end{itemize}
\subsection{Preparing for Domain Control}
\label{id2513043}\hypertarget{id2513043}{}%

\index{standalone} \index{workgroup} \index{member} \index{security} There are two ways that MS Windows machines may interact with each other, with other servers, and with domain controllers: either as {\em{standalone}} systems, more commonly called {\em{workgroup}} members, or as full participants in a security system, more commonly called {\em{domain}} members.

\index{workgroup} \index{workgroup!membership} \index{machine trust account} It should be noted that workgroup membership involves no special configuration other than the machine being configured so the network configuration has a commonly used name for its workgroup entry. It is not uncommon for the name WORKGROUP to be used for this. With this mode of configuration, there are no Machine Trust Accounts, and any concept of membership as such is limited to the fact that all machines appear in the network neighborhood to be logically grouped together. Again, just to be clear: {\em{workgroup mode does not involve security machine accounts}}.

\index{domain membership} \index{machine trust account!password} \index{trigger} Domain member machines have a machine trust account in the domain accounts database. A special procedure must be followed on each machine to effect domain membership. This procedure, which can be done only by the local machine Administrator account, creates the domain machine account (if it does not exist), and then initializes that account. When the client first logs onto the domain, a machine trust account password change will be automatically triggered.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{domain member} When Samba is configured as a domain controller, secure network operation demands that all MS Windows NT4/200x/XP Professional clients should be configured as domain members. If a machine is not made a member of the domain, then it will operate like a workgroup (standalone) machine. Please refer to \hyperlink{domain-member}{Chapter {\ref{domain-member}}, {``}Domain Membership{''}}, for information regarding domain membership.
\end{admonition}


The following are necessary for configuring Samba-3 as an MS Windows NT4-style PDC for MS Windows NT4/200x/XP clients:

\begin{itemize}
%--- Item
\item 
Configuration of basic TCP/IP and MS Windows networking.


%--- Item
\item 
Correct designation of the server role (\smbconfoption{security} = user).


%--- Item
\item 
Consistent configuration of name resolution.\label{id2513223}\begingroup\catcode`\#=12\footnote{
See \hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}}, and \hyperlink{integrate-ms-networks}{Chapter {\ref{integrate-ms-networks}}, {``}Integrating MS Windows Networks with Samba{''}}.
}\endgroup\docbooktolatexmakefootnoteref{id2513223}


%--- Item
\item 
Domain logons for Windows NT4/200x/XP Professional clients.


%--- Item
\item 
Configuration of roaming profiles or explicit configuration to force local profile usage.


%--- Item
\item 
Configuration of network/system policies.


%--- Item
\item 
Adding and managing domain user accounts.


%--- Item
\item 
Configuring MS Windows NT4/2000 Professional and Windows XP Professional client machines to become domain members.

\end{itemize}

The following provisions are required to serve MS Windows 9x/Me clients:

\begin{itemize}
%--- Item
\item 
Configuration of basic TCP/IP and MS Windows networking.


%--- Item
\item 
Correct designation of the server role (\smbconfoption{security} = user).


%--- Item
\item 
Network logon configuration (since Windows 9x/Me/XP Home are not technically domain members, they do not really participate in the security aspects of Domain logons as such).


%--- Item
\item 
Roaming profile configuration.


%--- Item
\item 
Configuration of system policy handling.


%--- Item
\item 
Installation of the network driver {``}Client for MS Windows Networks{''} and configuration to log onto the domain.


%--- Item
\item 
Placing Windows 9x/Me clients in user-level security ---  if it is desired to allow all client-share access to be controlled according to domain user/group identities.


%--- Item
\item 
Adding and managing domain user accounts.

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{roaming profiles} \index{account policies} Roaming profiles and system/network policies are advanced network administration topics that are covered in \hyperlink{ProfileMgmt}{Chapter {\ref{ProfileMgmt}}, {``}Desktop Profile Management{''}} and \hyperlink{PolicyMgmt}{Chapter {\ref{PolicyMgmt}}, {``}System and Account Policies{''}} of this document. However, these are not necessarily specific to a Samba PDC as much as they are related to Windows NT networking concepts.
\end{admonition}


A domain controller is an SMB/CIFS server that:

\begin{itemize}
%--- Item
\item 
\index{NetBIOS!brooadcast} \index{WINS} \index{UDP} \index{DNS} \index{active directory} Registers and advertises itself as a domain controller (through NetBIOS broadcasts as well as by way of name registrations either by Mailslot Broadcasts over UDP broadcast, to a WINS server over UDP unicast, or via DNS and Active Directory).


%--- Item
\item 
\index{NETLOGON} \index{LanMan logon service} Provides the NETLOGON service. (This is actually a collection of services that runs over multiple protocols. These include the LanMan logon service, the Netlogon service, the Local Security Account service, and variations of them.)


%--- Item
\item 
Provides a share called NETLOGON.

\end{itemize}

\index{domain!master!browser} \index{local!master!browser} \index{DMB} \index{LMB} \index{browse list} It is rather easy to configure Samba to provide these. Each Samba domain controller must provide the NETLOGON service that Samba calls the \smbconfoption{domain logons} functionality (after the name of the parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file). Additionally, one server in a Samba-3 domain must advertise itself as the domain master browser.\label{id2513516}\begingroup\catcode`\#=12\footnote{
See \hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}}.
}\endgroup\docbooktolatexmakefootnoteref{id2513516} This causes the PDC to claim a domain-specific NetBIOS name that identifies it as a DMB for its given domain or workgroup. Local master browsers (LMBs) in the same domain or workgroup on broadcast-isolated subnets then ask for a complete copy of the browse list for the whole wide-area network. Browser clients then contact their LMB, and will receive the domain-wide browse list instead of just the list for their broadcast-isolated subnet.

% ------------------------   
% Section 
\section{Domain Control: Example Configuration}
\label{id2513538}\hypertarget{id2513538}{}%

The first step in creating a working Samba PDC is to understand the parameters necessary in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. An example {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} for acting as a PDC can be found in \hyperlink{pdc-example}{Example {\ref{pdc-example}}}.

\begin{example}%
\hypertarget{pdc-example}{}%
\captionswapskip{}{{\caption{smb.conf for being a PDC}\label{pdc-example}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	netbios name
 	workgroup
 	passdb backend = tdbsam
 	os level = 33
 	preferred master = auto
 	domain master = yes
 	local master = yes
 	security = user
 	domain logons = yes
 	logon path = \\%N\profiles\%U
 	logon drive = H:
 	logon home = \\homeserver\%U\winprofile
 	logon script = logon.cmd
 [netlogon]
 	path = /var/lib/samba/netlogon
 	read only = yes
 	write list
 [profiles]
 	path = /var/lib/samba/profiles
 	read only = no
 	create mask = 0600
 	directory mask = 0700
\end{lstlisting}
\end{example}


The basic options shown in \hyperlink{pdc-example}{Example {\ref{pdc-example}}} are explained as follows:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{passdb backend}]\null{}
\index{group!account} \index{smbpasswd} \index{tdbsam} \index{ldapsam} \index{guest} \index{default accounts} This contains all the user and group account information. Acceptable values for a PDC are: {\em{smbpasswd, tdbsam, and ldapsam}}. The {``}guest{''} entry provides default accounts and is included by default; there is no need to add it explicitly.

\index{passdb backend} \index{distributed} \index{smbpasswd} \index{tdbsam} Where use of BDCs is intended, the only logical choice is to use LDAP so the passdb backend can be distributed. The tdbsam and smbpasswd files cannot effectively be distributed and therefore should not be used.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Domain Control Parameters}]\null{}
\index{os level} \index{preferred master} \index{domain master} \index{network!logon} The parameters {\em{os level, preferred master, domain master, security, encrypt passwords}}, and {\em{domain logons}} play a central role in assuring domain control and network logon support.

\index{DMB} \index{encryped password} The {\em{os level}} must be set at or above a value of 32. A domain controller must be the DMB, must be set in {\em{user}} mode security, must support Microsoft-compatible encrypted passwords, and must provide the network logon service (domain logons). Encrypted passwords must be enabled. For more details on how to do this, refer to \hyperlink{passdb}{Chapter {\ref{passdb}}, {``}Account Information Databases{''}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Environment Parameters}]\null{}
\index{logon path} \index{logon home} \index{logon drive} \index{logon script} The parameters {\em{logon path, logon home, logon drive}}, and {\em{logon script}} are environment support settings that help to facilitate client logon operations and that help to provide automated control facilities to ease network management overheads. Please refer to the man page information for these parameters.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{NETLOGON Share}]\null{}
\index{NETLOGON} \index{logon processing} \index{domain logon} \index{domain membership} \index{group policy} \index{NTConfig.POL} The NETLOGON share plays a central role in domain logon and domain membership support. This share is provided on all Microsoft domain controllers. It is used to provide logon scripts, to store group policy files (NTConfig.POL), as well as to locate other common tools that may be needed for logon processing. This is an essential share on a domain controller.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{PROFILE Share}]\null{}
\index{desktop profile} \index{VFS} \index{fake\_permissions} \index{profile} \index{} This share is used to store user desktop profiles. Each user must have a directory at the root of this share. This directory must be write-enabled for the user and must be globally read-enabled. Samba-3 has a VFS module called {``}fake\_permissions{''} that may be installed on this share. This will allow a Samba administrator to make the directory read-only to everyone. Of course this is useful only after the profile has been properly created.
\end{description}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The above parameters make for a full set of functionality that may define the server's mode of operation. The following {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameters are the essentials alone:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	netbios name = BELERIAND
 	workgroup = MIDEARTH
 	domain logons = Yes
 	domain master = Yes
 	security = User
\end{lstlisting}


The additional parameters shown in the longer listing in this section just make for a more complete explanation.
\end{admonition}


% ------------------------   
% Section 
\section{Samba ADS Domain Control}
\label{id2514151}\hypertarget{id2514151}{}%

\index{active directory} Samba-3 is not, and cannot act as, an Active Directory server. It cannot truly function as an Active Directory PDC. The protocols for some of the functionality of Active Directory domain controllers has been partially implemented on an experimental only basis. Please do not expect Samba-3 to support these protocols. Do not depend on any such functionality either now or in the future. The Samba Team may remove these experimental features or may change their behavior. This is mentioned for the benefit of those who have discovered secret capabilities in Samba-3 and who have asked when this functionality will be completed. The answer is maybe someday or maybe never!

\index{domain controllers} \index{active directory} To be sure, Samba-3 is designed to provide most of the functionality that Microsoft Windows NT4-style domain controllers have. Samba-3 does not have all the capabilities of Windows NT4, but it does have a number of features that Windows NT4 domain controllers do not have. In short, Samba-3 is not NT4 and it is not Windows Server 200x: it is not an Active Directory server. We hope this is plain and simple enough for all to understand.

% ------------------------   
% Section 
\section{Domain and Network Logon Configuration}
\label{id2514205}\hypertarget{id2514205}{}%

\index{domain logon} The subject of network or domain logons is discussed here because it forms an integral part of the essential functionality that is provided by a domain controller.
\subsection{Domain Network Logon Service}
\label{id2514226}\hypertarget{id2514226}{}%

\index{domain logon} All domain controllers must run the netlogon service ({\em{domain logons}} in Samba). One domain controller must be configured with \smbconfoption{domain master} = Yes (the PDC); on all BDCs set the parameter \smbconfoption{domain master} = No.
\subsubsection{Example Configuration}
\label{id2514261}\hypertarget{id2514261}{}%

\begin{example}%
\hypertarget{PDC-config}{}%
\captionswapskip{}{{\caption{smb.conf for being a PDC}\label{PDC-config}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	domain logons = Yes
 	domain master = (Yes on PDC, No on BDCs)
 [netlogon]
 	comment = Network Logon Service
 	path = /var/lib/samba/netlogon
 	guest ok = Yes
 	browseable = No
\end{lstlisting}
\end{example}

\subsubsection{The Special Case of MS Windows XP Home Edition}
\label{id2514327}\hypertarget{id2514327}{}%

\index{Windows XP Home edition} To be completely clear: If you want MS Windows XP Home Edition to integrate with your MS Windows NT4 or Active Directory domain security, understand it cannot be done. The only option is to purchase the upgrade from MS Windows XP Home Edition to MS Windows XP Professional.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

MS Windows XP Home Edition does not have the ability to join any type of domain security facility. Unlike MS Windows 9x/Me, MS Windows XP Home Edition also completely lacks the ability to log onto a network.
\end{admonition}


Now that this has been said, please do not ask the mailing list or email any of the Samba Team members with your questions asking how to make this work. It can't be done. If it can be done, then to do so would violate your software license agreement with Microsoft, and we recommend that you do not do that.
\subsubsection{The Special Case of Windows 9x/Me}
\label{id2514367}\hypertarget{id2514367}{}%

\index{domain} \index{workgroup} \index{authentication} \index{browsing} \index{rights} A domain and a workgroup are exactly the same in terms of network browsing. The difference is that a distributable authentication database is associated with a domain, for secure login access to a network. Also, different access rights can be granted to users if they successfully authenticate against a domain logon server. Samba-3 does this now in the same way as MS Windows NT/200x.

\index{browsing} The SMB client logging on to a domain has an expectation that every other server in the domain should accept the same authentication information. Network browsing functionality of domains and workgroups is identical and is explained in this documentation under the browsing discussions. It should be noted that browsing is totally orthogonal to logon support.

\index{single-logon} \index{domain logons} \index{network logon} Issues related to the single-logon network model are discussed in this section. Samba supports domain logons, network logon scripts, and user profiles for MS Windows for Workgroups and MS Windows 9x/Me clients, which are the focus of this section.

\index{broadcast request} When an SMB client in a domain wishes to log on, it broadcasts requests for a logon server. The first one to reply gets the job and validates its password using whatever mechanism the Samba administrator has installed. It is possible (but ill advised) to create a domain where the user database is not shared between servers; that is, they are effectively workgroup servers advertising themselves as participating in a domain. This demonstrates how authentication is quite different from but closely involved with domains.

Using these features, you can make your clients verify their logon via the Samba server, make clients run a batch file when they log on to the network and download their preferences, desktop, and start menu.

{\em{MS Windows XP Home edition is not able to join a domain and does not permit the use of domain logons.}}

Before launching into the configuration instructions, it is worthwhile to look at how a Windows 9x/Me client performs a logon:

\begin{enumerate}
%--- Item
\item 
\index{DOMAIN\textless{}1C\textgreater{}} \index{logon server} The client broadcasts (to the IP broadcast address of the subnet it is in) a NetLogon request. This is sent to the NetBIOS name DOMAIN\textless{}1C\textgreater{} at the NetBIOS layer. The client chooses the first response it receives, which contains the NetBIOS name of the logon server to use in the format of {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\SERVER}}}. The {\texttt{\docbookhyphenatedot{1C}}} name is the name type that is registered by domain controllers (SMB/CIFS servers that provide the netlogon service).


%--- Item
\item 
\index{IPC\$} \index{SMBsessetupX} \index{SMBtconX} The client connects to that server, logs on (does an SMBsessetupX) and then connects to the IPC\$ share (using an SMBtconX).


%--- Item
\item 
\index{NetWkstaUserLogon} The client does a NetWkstaUserLogon request, which retrieves the name of the user's logon script.


%--- Item
\item 
The client then connects to the NetLogon share and searches for said script. If it is found and can be read, it is retrieved and executed by the client. After this, the client disconnects from the NetLogon share.


%--- Item
\item 
\index{NetUserGetInfo} \index{profile} The client sends a NetUserGetInfo request to the server to retrieve the user's home share, which is used to search for profiles. Since the response to the NetUserGetInfo request does not contain much more than the user's home share, profiles for Windows 9x clients must reside in the user home directory.


%--- Item
\item 
\index{profiles} The client connects to the user's home share and searches for the user's profile. As it turns out, you can specify the user's home share as a share name and path. For example, {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\server\docbooktolatexgobble\string\\fred\docbooktolatexgobble\string\\.\dbz{}winprofile}}}. If the profiles are found, they are implemented.


%--- Item
\item 
\index{CONFIG.POL} The client then disconnects from the user's home share and reconnects to the NetLogon share and looks for {\texttt{\docbookhyphenatefilename{CONFIG.\dbz{}POL}}}, the policies file. If this is found, it is read and implemented.

\end{enumerate}

The main difference between a PDC and a Windows 9x/Me logon server configuration is:

\begin{itemize}
%--- Item
\item 
\index{password!plaintext} \index{plaintext password} Password encryption is not required for a Windows 9x/Me logon server. But note that beginning with MS Windows 98 the default setting is that plaintext password support is disabled. It can be re-enabled with the registry changes that are documented in \hyperlink{PolicyMgmt}{Chapter {\ref{PolicyMgmt}}, {``}System and Account Policies{''}}.


%--- Item
\item 
\index{machine trust account} Windows 9x/Me clients do not require and do not use Machine Trust Accounts.

\end{itemize}

\index{network logon services} A Samba PDC will act as a Windows 9x/Me logon server; after all, it does provide the network logon services that MS Windows 9x/Me expect to find.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{sniffer} Use of plaintext passwords is strongly discouraged. Where used they are easily detected using a sniffer tool to examine network traffic.
\end{admonition}

\subsection{Security Mode and Master Browsers}
\label{id2514767}\hypertarget{id2514767}{}%

\index{security mode} \index{user-mode security} \index{share-mode security} There are a few comments to make in order to tie up some loose ends. There has been much debate over the issue of whether it is okay to configure Samba as a domain controller that operates with security mode other than user-mode. The only security mode that will not work due to technical reasons is share-mode security. Domain and server mode security are really just a variation on SMB user-level security.

\index{DOMAIN\textless{}1C\textgreater{}} \index{DOMAIN\textless{}1B\textgreater{}} \index{DMB} \index{PDC} \index{NetBIOS name} \index{domain controller} \index{election} Actually, this issue is also closely tied to the debate on whether Samba must be the DMB for its workgroup when operating as a domain controller. In a pure Microsoft Windows NT domain, the PDC wins the election to be the DMB, and then registers the DOMAIN\textless{}1B\textgreater{} NetBIOS name. This is not the name used by Windows clients to locate the domain controller, all domain controllers register the DOMAIN\textless{}1C\textgreater{} name and Windows clients locate a network logon server by seraching for the DOMAIN\textless{}1C\textgreater{} name. A DMB is a Domain Master Browser ---  see \hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}}, \hyperlink{DMB}{Section {\ref{DMB}}}; Microsoft PDCs expect to win the election to become the DMB, if it loses that election it will report a continuous and rapid sequence of warning messages to its Windows event logger complaining that it has lost the election to become a DMB. For this reason, in networks where a Samba server is the PDC it is wise to configure the Samba domain controller as the DMB.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{DOMAIN\textless{}1D\textgreater{}} \index{synchronization} \index{domain control} \index{browse list management} \index{network!logon!service} SMB/CIFS servers that register the DOMAIN\textless{}1C\textgreater{} name do so because they provide the network logon service. Server that register the DOMAIN\textless{}1B\textgreater{} name are DMBs ---  meaning that they are responsible for browse list synchronization across all machines that have registered the DOMAIN\textless{}1D\textgreater{} name. The later are LMBs that have the responsibility to listen to all NetBIOS name registrations that occur locally to their own network segment. The network logon service (NETLOGON) is germane to domain control and has nothing to do with network browsing and browse list management. The 1C and 1B/1D name services are orthogonal to each other.
\end{admonition}


Now back to the issue of configuring a Samba domain controller to use a mode other than \smbconfoption{security} = user. If a Samba host is configured to use another SMB server or domain controller in order to validate user connection requests, it is a fact that some other machine on the network (the \smbconfoption{password server}) knows more about the user than the Samba host. About 99 percent of the time, this other host is a domain controller. Now to operate in domain mode security, the \smbconfoption{workgroup} parameter must be set to the name of the Windows NT domain (which already has a domain controller). If the domain does not already have a domain controller, you do not yet have a domain.

Configuring a Samba box as a domain controller for a domain that already by definition has a PDC is asking for trouble. Therefore, you should always configure the Samba domain controller to be the DMB for its domain and set \smbconfoption{security} = user. This is the only officially supported mode of operation.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2514993}\hypertarget{id2514993}{}%
\subsection{{``}\${''} Cannot Be Included in Machine Name}
\label{id2514999}\hypertarget{id2514999}{}%

\index{BSD} \index{FreeBSD} \index{/etc/passwd} A machine account, typically stored in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}, takes the form of the machine name with a {``}\${''} appended. Some BSD systems will not create a user with a {``}\${''} in the name. Recent versions of FreeBSD have removed this limitation, but older releases are still in common use.

\index{vipw} The problem is only in the program used to make the entry. Once made, it works perfectly. Create a user without the {``}\${''}. Then use {\bfseries{vipw}} to edit the entry, adding the {``}\${''}. Or create the whole entry with vipw if you like; make sure you use a unique user login ID.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The machine account must have the exact name that the workstation has.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The UNIX tool {\bfseries{vipw}} is a common tool for directly editing the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} file. The use of vipw will ensure that shadow files (where used) will remain current with the passwd file. This is important for security reasons.
\end{admonition}

\subsection{Joining Domain Fails Because of Existing Machine Account}
\label{id2515105}\hypertarget{id2515105}{}%

\index{join domain} {``}I get told, `You already have a connection to the Domain....' or `Cannot join domain, the credentials supplied conflict with an existing set...' when creating a Machine Trust Account.{''}

This happens if you try to create a Machine Trust Account from the machine itself and already have a connection (e.g., mapped drive) to a share (or IPC\$) on the Samba PDC. The following command will remove all network drive connections: 
\begin{Verbatim}[]

C:\> net use * /d

\end{Verbatim}
 This will break all network connections.

Further, if the machine is already a {``}member of a workgroup{''} that is the same name as the domain you are joining (bad idea), you will get this message. Change the workgroup name to something else ---  it does not matter what ---  reboot, and try again.
\subsection{The System Cannot Log You On (C000019B)}
\label{id2515171}\hypertarget{id2515171}{}%

{``}I joined the domain successfully but after upgrading to a newer version of the Samba code I get the message, `The system cannot log you on (C000019B). Please try again or consult your system administrator when attempting to logon.'{''}

\index{SID} This occurs when the domain SID stored in the secrets.tdb database is changed. The most common cause of a change in domain SID is when the domain name and/or the server name (NetBIOS name) is changed. The only way to correct the problem is to restore the original domain SID or remove the domain client from the domain and rejoin. The domain SID may be reset using either the net or rpcclient utilities.

To reset or change the domain SID you can use the net command as follows: 
\begin{Verbatim}[]

root# net getlocalsid 'OLDNAME'
root# net setlocalsid 'SID'

\end{Verbatim}


Workstation Machine Trust Accounts work only with the domain (or network) SID. If this SID changes, domain members (workstations) will not be able to log onto the domain. The original domain SID can be recovered from the secrets.tdb file. The alternative is to visit each workstation to rejoin it to the domain.
\subsection{The Machine Trust Account Is Not Accessible}
\label{id2515250}\hypertarget{id2515250}{}%

{``}When I try to join the domain I get the message, "The machine account for this computer either does not exist or is not accessible." What's wrong?{''}

This problem is caused by the PDC not having a suitable Machine Trust Account. If you are using the \smbconfoption{add machine script} method to create accounts, then this would indicate that it has not worked. Ensure the domain admin user system is working.

Alternately, if you are creating account entries manually, then they have not been created correctly. Make sure that you have the entry correct for the Machine Trust Account in {\texttt{\docbookhyphenatefilename{smbpasswd}}} file on the Samba PDC. If you added the account using an editor rather than using the smbpasswd utility, make sure that the account name is the machine NetBIOS name with a {``}\${''} appended to it (i.e., computer\_name\$). There must be an entry in both the POSIX UNIX system account backend as well as in the SambaSAMAccount backend. The default backend for Samba-3 (i.e., the parameter {\ttfamily\itshape{\docbookhyphenatedot{passdb backend}}} is not specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, or if specified is set to {\texttt{\docbookhyphenatedot{smbpasswd}}}, are respectively the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smbpasswd}}} (or {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}lib/\dbz{}private/\dbz{}smbpasswd}}} if compiled using Samba Team default settings). The use of the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} can be overridden by alternative settings in the NSS {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file.

Some people have also reported that inconsistent subnet masks between the Samba server and the NT client can cause this problem. Make sure that these are consistent for both client and server.
\subsection{Account Disabled}
\label{id2515362}\hypertarget{id2515362}{}%

{``}When I attempt to log in to a Samba domain from a NT4/W200x workstation, I get a message about my account being disabled.{''}

Enable the user accounts with {\ttfamily\bfseries{\docbookhyphenatedot{smbpasswd -\dbz{}e {\ttfamily\itshape{\docbookhyphenatedot{username}}}}}}. This is normally done as an account is created.
\subsection{Domain Controller Unavailable}
\label{id2515391}\hypertarget{id2515391}{}%

{``}Until a few minutes after Samba has started, clients get the error `Domain Controller Unavailable'{''}

A domain controller has to announce its role on the network. This usually takes a while. Be patient for up to 15 minutes, then try again.
\subsection{Cannot Log onto Domain Member Workstation After Joining Domain}
\label{id2515411}\hypertarget{id2515411}{}%

\index{schannel} \index{signing} After successfully joining the domain, user logons fail with one of two messages: one to the effect that the domain controller cannot be found; the other claims that the account does not exist in the domain or that the password is incorrect. This may be due to incompatible settings between the Windows client and the Samba-3 server for {\em{schannel}} (secure channel) settings or {\em{smb signing}} settings. Check your Samba settings for {\em{client schannel}}, {\em{server schannel}}, {\em{client signing}}, {\em{server signing}} by executing: 
\begin{Verbatim}[]

testparm -v | grep channel and looking for the value of these parameters.

\end{Verbatim}


Also use the MMC ---  Local Security Settings. This tool is available from the Control Panel. The Policy settings are found in the Local Policies/Security Options area and are prefixed by {\em{Secure Channel:..., and Digitally sign...}}.

It is important that these be set consistently with the Samba-3 server settings.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Backup Domain Control 
% ------------------------------------------------------------- 	
\chapter{Backup Domain Control}
\label{samba-bdc}\hypertarget{samba-bdc}{}%

Before you continue reading this section, please make sure that you are comfortable with configuring a Samba domain controller as described in \hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}}.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2511982}\hypertarget{id2511982}{}%

This is one of the most difficult chapters to summarize. It does not matter what we say here, for someone will still draw conclusions and/or approach the Samba Team with expectations that are either not yet capable of being delivered or that can be achieved far more effectively using a totally different approach. In the event that you should have a persistent concern that is not addressed in this book, please email John H. Terpstra\label{id2511997}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:jht@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2511997} clearly setting out your requirements and/or question, and we will do our best to provide a solution.

\index{SAM backend!LDAP} \index{PDC} \index{BDC} \index{LDAP!slave} \index{scalability} Samba-3 can act as a Backup Domain Controller (BDC) to another Samba Primary Domain Controller (PDC). A Samba-3 PDC can operate with an LDAP account backend. The LDAP backend can be either a common master LDAP server or a slave server. The use of a slave LDAP server has the benefit that when the master is down, clients may still be able to log onto the network. This effectively gives Samba a high degree of scalability and is an effective solution for large organizations. If you use an LDAP slave server for a PDC, you will need to ensure the master's continued availability ---  if the slave finds its master down at the wrong time, you will have stability and operational problems.

\index{two-way!propagation} \index{replication!SAM} \index{non-LDAP!backend} \index{propagate} While it is possible to run a Samba-3 BDC with a non-LDAP backend, that backend must allow some form of "two-way" propagation of changes from the BDC to the master. At this time only LDAP delivers the capability to propagate identity database changes from the BDC to the PDC. The BDC can use a slave LDAP server, while it is preferable for the PDC to use as its primary an LDAP master server.

\index{non-LDAP!backend} \index{SAM backend!non-LDAP} \index{domain!member!server} \index{BDC} \index{PDC} \index{trust account password} \index{domain trust} The use of a non-LDAP backend SAM database is particularly problematic because domain member servers and workstations periodically change the Machine Trust Account password. The new password is then stored only locally. This means that in the absence of a centrally stored accounts database (such as that provided with an LDAP-based solution) if Samba-3 is running as a BDC, the BDC instance of the domain member trust account password will not reach the PDC (master) copy of the SAM. If the PDC SAM is then replicated to BDCs, this results in overwriting the SAM that contains the updated (changed) trust account password with resulting breakage of the domain trust.

\index{net!rpc} \index{SAM backend!ldapsam} \index{SAM backend!tdbsam} \index{replication!SAM} Considering the number of comments and questions raised concerning how to configure a BDC, let's consider each possible option and look at the pros and cons for each possible solution. \hyperlink{pdc-bdc-table}{Table {\ref{pdc-bdc-table}}} lists possible design configurations for a PDC/BDC infrastructure.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{pdc-bdc-table}{}%
\captionswapskip{}{{\caption{Domain Backend Account Distribution Options}\label{pdc-bdc-table}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|>{\hsize=0.6\hsize\Centering}X|>{\hsize=0.6\hsize\Centering}X|>{\hsize=1.8\hsize\RaggedRight}X|}
\hline 
{{{\bfseries PDC Backend}}} & {{{\bfseries BDC Backend}}} & {{{\bfseries Notes/Discussion}}} \tabularnewline
 \hline 
{{Master LDAP Server}} & {{Slave LDAP Server}} & {{The optimal solution that provides high integrity. The SAM will be replicated to a common master LDAP server.}} \tabularnewline
 \hline 
{{Single Central LDAP Server}} & {{Single Central LDAP Server}} & {{A workable solution without failover ability. This is a usable solution, but not optimal.}} \tabularnewline
 \hline 
{{tdbsam}} & {{tdbsam + {\bfseries{net rpc vampire}}}} & {{Does not work with Samba-3.0; Samba does not implement the server-side protocols required.}} \tabularnewline
 \hline 
{{tdbsam}} & {{tdbsam + {\bfseries{rsync}}}} & {{Do not use this configuration. Does not work because the TDB files are live and data may not have been flushed to disk. Furthermore, this will cause domain trust breakdown.}} \tabularnewline
 \hline 
{{smbpasswd file}} & {{smbpasswd file}} & {{Do not use this configuration. Not an elegant solution due to the delays in synchronization and also suffers from the issue of domain trust breakdown.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


% ------------------------   
% Section 
\section{Essential Background Information}
\label{id2472240}\hypertarget{id2472240}{}%

\index{domain controller} \index{logon requests} \index{LanMan} \index{Netlogon} A domain controller is a machine that is able to answer logon requests from network workstations. Microsoft LanManager and IBM LanServer were two early products that provided this capability. The technology has become known as the LanMan Netlogon service.

\index{network!logon!service} \index{Windows NT3.10} When MS Windows NT3.10 was first released, it supported a new style of Domain Control and with it a new form of the network logon service that has extended functionality. This service became known as the NT NetLogon Service. The nature of this service has changed with the evolution of MS Windows NT and today provides a complex array of services that are implemented over an intricate spectrum of technologies.
\subsection{MS Windows NT4-style Domain Control}
\label{id2512133}\hypertarget{id2512133}{}%

\index{domain controller} \index{authentication server} \index{username} \index{password} \index{SAM} \index{Security Account Manager|textit{see} {SAM} } \index{domain control database|textit{see} {SAM} } Whenever a user logs into a Windows NT4/200x/XP Professional workstation, the workstation connects to a domain controller (authentication server) to validate that the username and password the user entered are valid. If the information entered does not match account information that has been stored in the domain control database (the SAM, or Security Account Manager database), a set of error codes is returned to the workstation that has made the authentication request.

\index{account information} \index{machine accounts database} \index{profile} \index{network access profile} \index{desktop profile} When the username/password pair has been validated, the domain controller (authentication server) will respond with full enumeration of the account information that has been stored regarding that user in the user and machine accounts database for that domain. This information contains a complete network access profile for the user but excludes any information that is particular to the user's desktop profile, or for that matter it excludes all desktop profiles for groups that the user may belong to. It does include password time limits, password uniqueness controls, network access time limits, account validity information, machine names from which the user may access the network, and much more. All this information was stored in the SAM in all versions of MS Windows NT (3.10, 3.50, 3.51, 4.0).

\index{replication!SAM} \index{\%SystemRoot\%\textbackslash System32\textbackslash config} \index{C:\textbackslash WinNT\textbackslash System32\textbackslash config} \index{BDC} \index{SAM} The account information (user and machine) on domain controllers is stored in two files, one containing the security information and the other the SAM. These are stored in files by the same name in the {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\config}}} directory. This normally translates to the path {\texttt{\docbookhyphenatefilename{C:\docbooktolatexgobble\string\\WinNT\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\config}}}. These are the files that are involved in replication of the SAM database where BDCs are present on the network.

There are two situations in which it is desirable to install BDCs:

\begin{itemize}
%--- Item
\item 
\index{PDC} \index{BDC} On the local network that the PDC is on, if there are many workstations and/or where the PDC is generally very busy. In this case the BDCs will pick up network logon requests and help to add robustness to network services.


%--- Item
\item 
\index{network!wide-area} At each remote site, to reduce wide-area network traffic and to add stability to remote network operations. The design of the network, and the strategic placement of BDCs, together with an implementation that localizes as much of network to client interchange as possible, will help to minimize wide-area network bandwidth needs (and thus costs).

\end{itemize}

\index{PDC} \index{SAM} \index{user account database} \index{BDC} \index{trigger} The interoperation of a PDC and its BDCs in a true Windows NT4 environment is worth mentioning here. The PDC contains the master copy of the SAM. In the event that an administrator makes a change to the user account database while physically present on the local network that has the PDC, the change will likely be made directly to the PDC instance of the master copy of the SAM. In the event that this update may be performed in a branch office, the change will likely be stored in a delta file on the local BDC. The BDC will then send a trigger to the PDC to commence the process of SAM synchronization. The PDC will then request the delta from the BDC and apply it to the master SAM. The PDC will then contact all the BDCs in the domain and trigger them to obtain the update and then apply that to their own copy of the SAM.

\index{SAM!replication} \index{SAM!delta file} \index{PDC} \index{BDC} Samba-3 cannot participate in true SAM replication and is therefore not able to employ precisely the same protocols used by MS Windows NT4. A Samba-3 BDC will not create SAM update delta files. It will not interoperate with a PDC (NT4 or Samba) to synchronize the SAM from delta files that are held by BDCs.

\index{PDC} \index{BDC} Samba-3 cannot function as a BDC to an MS Windows NT4 PDC, and Samba-3 cannot function correctly as a PDC to an MS Windows NT4 BDC. Both Samba-3 and MS Windows NT4 can function as a BDC to its own type of PDC.

\index{SAM} \index{BDC} \index{domain security} The BDC is said to hold a {\em{read-only}} of the SAM from which it is able to process network logon requests and authenticate users. The BDC can continue to provide this service, particularly while, for example, the wide-area network link to the PDC is down. A BDC plays a very important role in both the maintenance of domain security as well as in network integrity.

\index{PDC} \index{promoted} \index{demoted} \index{reconfiguration} In the event that the NT4 PDC should need to be taken out of service, or if it dies, one of the NT4 BDCs can be promoted to a PDC. If this happens while the original NT4 PDC is online, it is automatically demoted to an NT4 BDC. This is an important aspect of domain controller management. The tool that is used to effect a promotion or a demotion is the Server Manager for Domains. It should be noted that Samba-3 BDCs cannot be promoted in this manner because reconfiguration of Samba requires changes to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. It is easy enough to manuall change the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file and then restart relevant Samba network services.
\subsubsection{Example PDC Configuration}
\label{id2476447}\hypertarget{id2476447}{}%

\index{domain logon} \index{PDC} Beginning with Version 2.2, Samba officially supports domain logons for all current Windows clients, including Windows NT4, 2003, and XP Professional. For Samba to be enabled as a PDC, some parameters in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} have to be set. Refer to \hyperlink{minimalPDC}{Example {\ref{minimalPDC}}} for an example of the minimum required settings.

\begin{example}%
\hypertarget{minimalPDC}{}%
\captionswapskip{}{{\caption{Minimal smb.conf for a PDC in Use with a BDC ---  LDAP Server on PDC}\label{minimalPDC}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	workgroup = MIDEARTH
 	passdb backend = ldapsam://localhost:389
 	domain master = yes
 	domain logons = yes
 	ldap suffix = dc=quenya,dc=org
 	ldap user suffix = ou=Users
 	ldap group suffix = ou=Groups
 	ldap machine suffix = ou=Computers
 	ldap idmap suffix = ou=Idmap
 	ldap admin dn = cn=sambadmin,dc=quenya,dc=org
\end{lstlisting}
\end{example}


\index{profile path} \index{home drive} Several other things like a \smbconfsection{[homes]} and a \smbconfsection{[netlogon]} share also need to be set along with settings for the profile path, the user's home drive, and so on. This is not covered in this chapter; for more information please refer to \hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}}. Refer to \hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}} for specific recommendations for PDC configuration. Alternately, fully documented working example network configurations using OpenLDAP and Samba as available in the book\label{id2484930}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/docs/Samba3-ByExample}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2484930} {``}Samba-3 by Example{''} that may be obtained from local and on-line book stores.
\subsection{LDAP Configuration Notes}
\label{id2484945}\hypertarget{id2484945}{}%

\index{LDAP!master} \index{LDAP!slave} \index{BDC} When configuring a master and a slave LDAP server, it is advisable to use the master LDAP server for the PDC and slave LDAP servers for the BDCs. It is not essential to use slave LDAP servers; however, many administrators will want to do so in order to provide redundant services. Of course, one or more BDCs may use any slave LDAP server. Then again, it is entirely possible to use a single LDAP server for the entire network.

\index{LDAP!master} \index{LDAP!server} \index{CN} \index{DN} \index{RFC2830} When configuring a master LDAP server that will have slave LDAP servers, do not forget to configure this in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}openldap/\dbz{}slapd.\dbz{}conf}}} file. It must be noted that the DN of a server certificate must use the CN attribute to name the server, and the CN must carry the servers' fully qualified domain name. Additional alias names and wildcards may be present in the subjectAltName certificate extension. More details on server certificate names are in RFC2830.

\index{LDAP} \index{BDC} \index{OpenLDAP} \index{transport layer security|textit{see} {TLS} } \index{/etc/ssl/certs/slapd.pem} \index{slapd.pem} \index{Red Hat Linux} It does not really fit within the scope of this document, but a working LDAP installation is basic to LDAP-enabled Samba operation. When using an OpenLDAP server with Transport Layer Security (TLS), the machine name in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}ssl/\dbz{}certs/\dbz{}slapd.\dbz{}pem}}} must be the same as in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}openldap/\dbz{}sldap.\dbz{}conf}}}. The Red Hat Linux startup script creates the {\texttt{\docbookhyphenatefilename{slapd.\dbz{}pem}}} file with hostname {``}localhost.localdomain.{''} It is impossible to access this LDAP server from a slave LDAP server (i.e., a Samba BDC) unless the certificate is re-created with a correct hostname.

\index{PDC} \index{OpenLDAP} \index{machine account} \index{credentials} \index{replication} \index{duplicate} Do not install a Samba PDC so that is uses an LDAP slave server. Joining client machines to the domain will fail in this configuration because the change to the machine account in the LDAP tree must take place on the master LDAP server. This is not replicated rapidly enough to the slave server that the PDC queries. It therefore gives an error message on the client machine about not being able to set up account credentials. The machine account is created on the LDAP server, but the password fields will be empty. Unfortunately, some sites are unable to avoid such configurations, and these sites should review the \smbconfoption{ldap replication sleep} parameter, intended to slow down Samba sufficiently for the replication to catch up. This is a kludge, and one that the administrator must manually duplicate in any scripts (such as the \smbconfoption{add machine script}) that they use.

Possible PDC/BDC plus LDAP configurations include:

\begin{itemize}
%--- Item
\item 
PDC+BDC -\textgreater{} One Central LDAP Server.


%--- Item
\item 
PDC -\textgreater{} LDAP master server, BDC -\textgreater{} LDAP slave server.


%--- Item
\item 
PDC -\textgreater{} LDAP master, with secondary slave LDAP server.

BDC -\textgreater{} LDAP master, with secondary slave LDAP server.


%--- Item
\item 
PDC -\textgreater{} LDAP master, with secondary slave LDAP server.

BDC -\textgreater{} LDAP slave server, with secondary master LDAP server.

\end{itemize}

In order to have a fallback configuration (secondary) LDAP server, you would specify the secondary LDAP server in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{mulitldapcfg}{Example {\ref{mulitldapcfg}}}.

\begin{example}%
\hypertarget{mulitldapcfg}{}%
\captionswapskip{}{{\caption{Multiple LDAP Servers in smb.\dbz{}conf}\label{mulitldapcfg}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	passdb backend = ldapsam:"ldap://master.quenya.org ldap://slave.quenya.org"
\end{lstlisting}
\end{example}

\subsection{Active Directory Domain Control}
\label{id2515660}\hypertarget{id2515660}{}%

\index{MS Windows 2000} \index{Active Directory} \index{directory} \index{replicated} \index{BDC} \index{domain controller} As of the release of MS Windows 2000 and Active Directory, this information is now stored in a directory that can be replicated and for which partial or full administrative control can be delegated. Samba-3 is not able to be a domain controller within an Active Directory tree, and it cannot be an Active Directory server. This means that Samba-3 also cannot act as a BDC to an Active Directory domain controller.
\subsection{What Qualifies a Domain Controller on the Network?}
\label{id2515721}\hypertarget{id2515721}{}%

\index{DMB} \index{PDC} \index{WINS} \index{NetBIOS} Every machine that is a domain controller for the domain MIDEARTH has to register the NetBIOS group name MIDEARTH\textless{}1C\textgreater{} with the WINS server and/or by broadcast on the local network. The PDC also registers the unique NetBIOS name MIDEARTH\textless{}1B\textgreater{} with the WINS server. The name type \textless{}1B\textgreater{} name is normally reserved for the Domain Master Browser (DMB), a role that has nothing to do with anything related to authentication, but the Microsoft domain implementation requires the DMB to be on the same machine as the PDC.

\index{broadcast} \index{name registration} \index{SMB/CIFS} Where a WINS server is not used, broadcast name registrations alone must suffice. Refer to \hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}},\hyperlink{netdiscuss}{Section {\ref{netdiscuss}}} for more information regarding TCP/IP network protocols and how SMB/CIFS names are handled.
\subsection{How Does a Workstation find its Domain Controller?}
\label{id2515810}\hypertarget{id2515810}{}%

\index{locate domain controller} \index{NetBIOS} There are two different mechanisms to locate a domain controller: one method is used when NetBIOS over TCP/IP is enabled and the other when it has been disabled in the TCP/IP network configuration.

\index{DNS} \index{broadcast messaging} Where NetBIOS over TCP/IP is disabled, all name resolution involves the use of DNS, broadcast messaging over UDP, as well as Active Directory communication technologies. In this type of environment all machines require appropriate DNS entries. More information may be found in \hyperlink{adsdnstech}{Section {\ref{adsdnstech}}}.
\subsubsection{NetBIOS Over TCP/IP Enabled}
\label{id2515866}\hypertarget{id2515866}{}%

\index{Windows NT4/200x/XP} \index{domain controller} \index{logon requests} \index{credentials validation} An MS Windows NT4/200x/XP Professional workstation in the domain MIDEARTH that wants a local user to be authenticated has to find the domain controller for MIDEARTH. It does this by doing a NetBIOS name query for the group name MIDEARTH\textless{}1C\textgreater{}. It assumes that each of the machines it gets back from the queries is a domain controller and can answer logon requests. To not open security holes, both the workstation and the selected domain controller authenticate each other. After that the workstation sends the user's credentials (name and password) to the local domain controller for validation.
\subsubsection{NetBIOS Over TCP/IP Disabled}
\label{id2515915}\hypertarget{id2515915}{}%

\index{realm} \index{logon authentication} \index{DNS} \index{\_ldap.\_tcp.pdc.\_msdcs.quenya.org} An MS Windows NT4/200x/XP Professional workstation in the realm {\texttt{\docbookhyphenatedot{quenya.org}}} that has a need to affect user logon authentication will locate the domain controller by re-querying DNS servers for the {\texttt{\docbookhyphenatedot{\_ldap.\_tcp.pdc.\_msdcs.quenya.org}}} record. More information regarding this subject may be found in \hyperlink{adsdnstech}{Section {\ref{adsdnstech}}}.

% ------------------------   
% Section 
\section{Backup Domain Controller Configuration}
\label{id2515974}\hypertarget{id2515974}{}%

\index{BDC} The creation of a BDC requires some steps to prepare the Samba server before smbd is executed for the first time. These steps are as follows:

\begin{itemize}
%--- Item
\item 
\index{SID} \index{PDC} \index{BDC} \index{private/secrets.tdb} \index{private/MACHINE.SID} \index{domain SID} The domain SID has to be the same on the PDC and the BDC. In Samba versions pre-2.2.5, the domain SID was stored in the file {\texttt{\docbookhyphenatefilename{private/\dbz{}MACHINE.\dbz{}SID}}}. For all versions of Samba released since 2.2.5 the domain SID is stored in the file {\texttt{\docbookhyphenatefilename{private/\dbz{}secrets.\dbz{}tdb}}}. This file is unique to each server and cannot be copied from a PDC to a BDC; the BDC will generate a new SID at startup. It will overwrite the PDC domain SID with the newly created BDC SID. There is a procedure that will allow the BDC to aquire the domain SID. This is described here.

\index{domain SID} \index{PDC} \index{BDC} \index{secrets.tdb} \index{net!rpc!getsid} To retrieve the domain SID from the PDC or an existing BDC and store it in the {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}}, execute:

\begin{Verbatim}[]

root# net rpc getsid

\end{Verbatim}


%--- Item
\item 
\index{secrets.tdb} \index{smbpasswd} \index{LDAP administration password} Specification of the \smbconfoption{ldap admin dn} is obligatory. This also requires the LDAP administration password to be set in the {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}} using the {\bfseries{smbpasswd -w {\ttfamily\itshape{\docbookhyphenatedot{mysecret}}}}}.


%--- Item
\item 
The \smbconfoption{ldap suffix} parameter and the \smbconfoption{ldap idmap suffix} parameter must be specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.


%--- Item
\item 
\index{replication!SAM} \index{user database} \index{synchronized} \index{NIS} The UNIX user database has to be synchronized from the PDC to the BDC. This means that both the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} have to be replicated from the PDC to the BDC. This can be done manually whenever changes are made. Alternately, the PDC is set up as an NIS master server and the BDC as an NIS slave server. To set up the BDC as a mere NIS client would not be enough, as the BDC would not be able to access its user database in case of a PDC failure. NIS is by no means the only method to synchronize passwords. An LDAP solution would also work.


%--- Item
\item 
\index{password database} \index{replicated} \index{PDC} \index{BDC} \index{smbpasswd} \index{rsync} \index{ssh} \index{LDAP} The Samba password database must be replicated from the PDC to the BDC. Although it is possible to synchronize the {\texttt{\docbookhyphenatefilename{smbpasswd}}} file with {\bfseries{rsync}} and {\bfseries{ssh}}, this method is broken and flawed, and is therefore not recommended. A better solution is to set up slave LDAP servers for each BDC and a master LDAP server for the PDC. The use of rsync is inherently flawed by the fact that the data will be replicated at timed intervals. There is no guarantee that the BDC will be operating at all times with correct and current machine and user account information. This means that this method runs the risk of users being inconvenienced by discontinuity of access to network services due to inconsistent security data. It must be born in mind that Windows workstations update (change) the machine trust account password at regular intervals ---  administrators are not normally aware that this is happening or when it takes place.

\index{POSIX} \index{LDAP} \index{SambaSAMAccount} \index{synchronize} The use of LDAP for both the POSIX (UNIX user and group) accounts and for the SambaSAMAccount data automatically ensures that all account change information will be written to the shared directory. This eliminates the need for any special action to synchronize account information because LDAP will meet that requirement.


%--- Item
\item 
\index{netlogon share} \index{replicate} \index{PDC} \index{BDC} \index{cron} \index{rsync} The netlogon share has to be replicated from the PDC to the BDC. This can be done manually whenever login scripts are changed, or it can be done automatically using a {\bfseries{cron}} job that will replicate the directory structure in this share using a tool like {\bfseries{rsync}}. The use of {\bfseries{rsync}} for replication of the netlogon data is not critical to network security and is one that can be manually managed given that the administrator will make all changes to the netlogon share as part of a conscious move.

\end{itemize}
\subsection{Example Configuration}
\label{id2516473}\hypertarget{id2516473}{}%

Finally, the BDC has to be capable of being found by the workstations. This can be done by configuring the Samba {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file \smbconfsection{[global]} section as shown in \hyperlink{minim-bdc}{Example {\ref{minim-bdc}}}.

\begin{example}%
\hypertarget{minim-bdc}{}%
\captionswapskip{}{{\caption{Minimal Setup for Being a BDC}\label{minim-bdc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	workgroup = MIDEARTH
 	passdb backend = ldapsam:ldap://slave-ldap.quenya.org
 	domain master = no
 	domain logons = yes
 	ldap suffix = dc=abmas,dc=biz
 	ldap user suffix = ou=Users
 	ldap group suffix = ou=Groups
 	ldap machine suffix = ou=Computers
 	ldap idmap suffix = ou=Idmap
 	ldap admin dn = cn=sambadmin,dc=quenya,dc=org
 	idmap backend = ldap:ldap://master-ldap.quenya.org
 	idmap uid = 10000-20000
 	idmap gid = 10000-20000
\end{lstlisting}
\end{example}


Fully documented working example network configurations using OpenLDAP and Samba as available in the book\label{id2516600}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/docs/Samba3-ByExample}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2516600} {``}Samba-3 by Example{''} that may be obtained from local and on-line book stores.

\index{BDC} \index{NetBIOS} \index{group} \index{PDC} This configuration causes the BDC to register only the name MIDEARTH\textless{}1C\textgreater{} with the WINS server. This is not a problem, as the name MIDEARTH\textless{}1C\textgreater{} is a NetBIOS group name that is meant to be registered by more than one machine. The parameter \smbconfoption{domain master} = no forces the BDC not to register MIDEARTH\textless{}1B\textgreater{}, which is a unique NetBIOS name that is reserved for the PDC.

\index{idmap backend} \index{winbindd} \index{redirect} \index{winbindd} \index{LDAP database} \index{UID} \index{GID} \index{SID} \index{nss\_ldap} The {\ttfamily\itshape{\docbookhyphenatedot{idmap backend}}} will redirect the {\bfseries{winbindd}} utility to use the LDAP database to store all mappings for Windows SIDs to UIDs and GIDs for UNIX accounts in a repository that is shared. The BDC will however depend on local resolution of UIDs and GIDs via NSS and the {\bfseries{nss\_ldap}} utility.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Server Type!Domain Member} \index{ID mapping} \index{domain member server} \index{idmap backend} Samba-3 has introduced a new ID mapping facility. One of the features of this facility is that it allows greater flexibility in how user and group IDs are handled in respect to NT domain user and group SIDs. One of the new facilities provides for explicitly ensuring that UNIX/Linux UID and GID values will be consistent on the PDC, all BDCs, and all domain member servers. The parameter that controls this is called {\ttfamily\itshape{\docbookhyphenatedot{idmap backend}}}. Please refer to the man page for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} for more information regarding its behavior.
\end{admonition}


\index{BDC} \index{winbindd} \index{domain member servers} The use of the \smbconfoption{idmap backend} = ldap:ldap://master.quenya.org option on a BDC only makes sense where ldapsam is used on a PDC. The purpose of an LDAP-based idmap backend is also to allow a domain member (without its own passdb backend) to use winbindd to resolve Windows network users and groups to common UID/GIDs. In other words, this option is generally intended for use on BDCs and on domain member servers.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2516841}\hypertarget{id2516841}{}%

\index{domain control} Domain control was a new area for Samba, but there are now many examples that we may refer to. Updated information will be published as they become available and may be found in later Samba releases or from the Samba Web site\label{id2516860}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2516860}; refer in particular to the {\texttt{\docbookhyphenatefilename{WHATSNEW.\dbz{}txt}}} in the Samba release tarball. The book, {``}Samba-3 by Example{''} documents well tested and proven configuration examples. You can obtain a copy of this book\label{id2516879}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/docs/Samba3-ByExample.pdf}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2516879} for the Samba web site.
\subsection{Machine Accounts Keep Expiring}
\label{id2516886}\hypertarget{id2516886}{}%

\index{Machine Trust Accounts} \index{passdb} \index{SAM} \index{Local Machine Trust Account} This problem will occur when the passdb (SAM) files are copied from a central server but the local BDC is acting as a PDC. This results in the application of Local Machine Trust Account password updates to the local SAM. Such updates are not copied back to the central server. The newer machine account password is then overwritten when the SAM is recopied from the PDC. The result is that the domain member machine on startup will find that its passwords do not match the one now in the database, and since the startup security check will now fail, this machine will not allow logon attempts to proceed and the account expiry error will be reported.

The solution is to use a more robust passdb backend, such as the ldapsam backend, setting up a slave LDAP server for each BDC and a master LDAP server for the PDC.
\subsection{Can Samba Be a Backup Domain Controller to an NT4 PDC?}
\label{id2516943}\hypertarget{id2516943}{}%

\index{replication!SAM} \index{SAM} No. The native NT4 SAM replication protocols have not yet been fully implemented.

\index{BDC} \index{PDC} \index{logon requests} Can I get the benefits of a BDC with Samba? Yes, but only to a Samba PDC.The main reason for implementing a BDC is availability. If the PDC is a Samba machine, a second Samba machine can be set up to service logon requests whenever the PDC is down.
\subsection{How Do I Replicate the smbpasswd File?}
\label{id2517002}\hypertarget{id2517002}{}%

\index{replication!SAM} \index{smbpasswd} \index{SAM} Replication of the smbpasswd file is sensitive. It has to be done whenever changes to the SAM are made. Every user's password change is done in the smbpasswd file and has to be replicated to the BDC. So replicating the smbpasswd file very often is necessary.

\index{plaintext password} \index{ssh} \index{rsync} As the smbpasswd file contains plaintext password equivalents, it must not be sent unencrypted over the wire. The best way to set up smbpasswd replication from the PDC to the BDC is to use the utility rsync. rsync can use ssh as a transport. {\bfseries{ssh}} itself can be set up to accept {\em{only}} {\bfseries{rsync}} transfer without requiring the user to type a password.

\index{machine trust accounts} \index{LDAP} As said a few times before, use of this method is broken and flawed. Machine trust accounts will go out of sync, resulting in a broken domain. This method is {\em{not}} recommended. Try using LDAP instead.
\subsection{Can I Do This All with LDAP?}
\label{id2517112}\hypertarget{id2517112}{}%

\index{pdb\_ldap} \index{LDAP} The simple answer is yes. Samba's pdb\_ldap code supports binding to a replica LDAP server and will also follow referrals and rebind to the master if it ever needs to make a modification to the database. (Normally BDCs are read-only, so this will not occur often).
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Domain Membership 
% ------------------------------------------------------------- 	
\chapter{Domain Membership}
\label{domain-member}\hypertarget{domain-member}{}%

\index{domain member} \index{machine trust account} \index{domain security} Domain membership is a subject of vital concern. Samba must be able to participate as a member server in a Microsoft domain security context, and Samba must be capable of providing domain machine member trust accounts; otherwise it would not be able to offer a viable option for many users.

\index{domain membership} \index{misinformation} This chapter covers background information pertaining to domain membership, the Samba configuration for it, and MS Windows client procedures for joining a domain. Why is this necessary? Because both are areas in which there exists within the current MS Windows networking world, and particularly in the UNIX/Linux networking and administration world, a considerable level of misinformation, incorrect understanding, and lack of knowledge. Hopefully this chapter will fill the voids.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2488527}\hypertarget{id2488527}{}%

\index{domain security} \index{single sign-on} \index{SSO} MS Windows workstations and servers that want to participate in domain security need to be made domain members. Participating in domain security is often called {\em{single sign-on}}, or SSO for short. This chapter describes the process that must be followed to make a workstation (or another server ---  be it an MS Windows NT4/200x server) or a Samba server a member of an MS Windows domain security context.

\index{native member} \index{ADS} \index{domain control} \index{Server Type!Domain Member} Samba-3 can join an MS Windows NT4-style domain as a native member server, an MS Windows Active Directory domain as a native member server, or a Samba domain control network. Domain membership has many advantages:

\begin{itemize}
%--- Item
\item 
\index{SAM} MS Windows workstation users get the benefit of SSO.


%--- Item
\item 
\index{access rights} \index{file ownership} \index{access controls} \index{SAM} Domain user access rights and file ownership/access controls can be set from the single Domain Security Account Manager (SAM) database (works with domain member servers as well as with MS Windows workstations that are domain members).


%--- Item
\item 
\index{domain members} \index{network logon} Only MS Windows NT4/200x/XP Professional workstations that are domain members can use network logon facilities.


%--- Item
\item 
\index{domain member} \index{policy files} \index{NTConfig.POL} \index{desktop profiles} Domain member workstations can be better controlled through the use of policy files ({\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}}) and desktop profiles.


%--- Item
\item 
\index{logon script} \index{transparent access} \index{application servers} Through the use of logon scripts, users can be given transparent access to network applications that run off application servers.


%--- Item
\item 
\index{user access management} \index{SAM} \index{LDAP} \index{ADS} Network administrators gain better application and user access management abilities because there is no need to maintain user accounts on any network client or server other than the central domain database (either NT4/Samba SAM-style domain, NT4 domain that is backend-ed with an LDAP directory, or via an Active Directory infrastructure).

\end{itemize}

% ------------------------   
% Section 
\section{MS Windows Workstation/Server Machine Trust Accounts}
\label{machine-trust-accounts}\hypertarget{machine-trust-accounts}{}%

\index{Machine Trust Accounts} \index{authenticate} \index{domain controller} \index{rogue user} A Machine Trust Account is an account that is used to authenticate a client machine (rather than a user) to the domain controller server. In Windows terminology, this is known as a {``}computer account.{''} The purpose of the machine trust account is to prevent a rogue user and domain controller from colluding to gain access to a domain member workstation.

\index{machine trust account!password} \index{shared secret} \index{unauthorized} \index{Windows NT/200x/XP Professional} \index{Windows 9x/Me/XP Home} The password of a Machine Trust Account acts as the shared secret for secure communication with the domain controller. This is a security feature to prevent an unauthorized machine with the same NetBIOS name from joining the domain, participating in domain security operations, and gaining access to domain user/group accounts. Windows NT/200x/XP Professional clients use machine trust accounts, but Windows 9x/Me/XP Home clients do not. Hence, a Windows 9x/Me/XP Home client is never a true member of a domain because it does not possess a Machine Trust Account, and, thus, has no shared secret with the domain controller.

\index{Windows Registry} \index{PDC} \index{ADS} \index{Machine Trust Account} A Windows NT4 PDC stores each Machine Trust Account in the Windows Registry. The introduction of MS Windows 2000 saw the introduction of Active Directory, the new repository for Machine Trust Accounts. A Samba PDC, however, stores each Machine Trust Account in two parts, as follows: 
\begin{itemize}
%--- Item
\item 
\index{domain security account} \index{account information} \index{backend database} A domain security account (stored in the \smbconfoption{passdb backend}) that has been configured in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. The precise nature of the account information that is stored depends on the type of backend database that has been chosen.

\index{smbpasswd} \index{UNIX login ID} \index{UID} \index{LanMan} \index{NT-encrypted password} \index{UNIX user identifier|textit{see} {UID} } The older format of this data is the {\texttt{\docbookhyphenatefilename{smbpasswd}}} database that contains the UNIX login ID, the UNIX user identifier (UID), and the LanMan and NT-encrypted passwords. There is also some other information in this file that we do not need to concern ourselves with here.

\index{database} \index{ldapsam} \index{smbpasswd} \index{account controls} The two newer database types are called ldapsam and tdbsam. Both store considerably more data than the older {\texttt{\docbookhyphenatefilename{smbpasswd}}} file did. The extra information enables new user account controls to be implemented.


%--- Item
\item 
\index{UNIX account} \index{/etc/passwd} A corresponding UNIX account, typically stored in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}. Work is in progress to allow a simplified mode of operation that does not require UNIX user accounts, but this has not been a feature of the early releases of Samba-3, and is not currently planned for release either.

\end{itemize}

\newpage 
\index{Machine Trust Accounts!creating} There are three ways to create Machine Trust Accounts:

\begin{itemize}
%--- Item
\item 
\index{manual UNIX account creation} Manual creation from the UNIX/Linux command line. Here, both the Samba and corresponding UNIX account are created by hand.


%--- Item
\item 
\index{Server Manager} \index{Nexus toolkit} Using the MS Windows NT4 Server Manager, either from an NT4 domain member server or using the Nexus toolkit available from the Microsoft Web site. This tool can be run from any MS Windows machine as long as the user is logged on as the administrator account.


%--- Item
\item 
\index{Machine Trust Account} \index{joined client} {``}On-the-fly{''} creation. The Samba Machine Trust Account is automatically created by Samba at the time the client is joined to the domain. (For security, this is the recommended method.) The corresponding UNIX account may be created automatically or manually.

\end{itemize}

\index{enforcing} \index{machine trust account!creation} Neither MS Windows NT4/200x/XP Professional, nor Samba, provide any method for enforcing the method of machine trust account creation. This is a matter of the administrator's choice.
\subsection{Manual Creation of Machine Trust Accounts}
\label{id2459945}\hypertarget{id2459945}{}%

\index{/etc/passwd} \index{} \index{useradd} \index{vipw} The first step in manually creating a Machine Trust Account is to manually create the corresponding UNIX account in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}. This can be done using {\bfseries{vipw}} or another {``}adduser{''} command that is normally used to create new UNIX accounts. The following is an example for a Linux-based Samba server: 
\begin{Verbatim}[]

root# /usr/sbin/useradd -g machines -d /var/lib/nobody \
   -c "machine nickname" \
   -s /bin/false machine_name$ 

root# passwd -l machine_name$

\end{Verbatim}


\index{primary group} \index{GID} \index{machine accounts} In the example above there is an existing system group {``}machines{''} which is used as the primary group for all machine accounts. In the following examples the {``}machines{''} group numeric GID is 100.

\index{chpass} \index{BSD} On *BSD systems, this can be done using the {\bfseries{chpass}} utility: 
\begin{Verbatim}[]

root# chpass -a \
'machine_name$:*:101:100::0:0:Windows machine_name:/dev/null:/sbin/nologin'

\end{Verbatim}


\index{/etc/passwd} \index{\$} \index{null shell} \index{home directory} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} entry will list the machine name with a {``}\${''} appended, and will not have a password, will have a null shell and no home directory. For example, a machine named {``}doppy{''} would have an {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} entry like this: 
\begin{Verbatim}[]

doppy$:x:505:100:machine_nickname:/dev/null:/bin/false

\end{Verbatim}


\index{machine\_nickname} \index{machine\_name} \index{Machine Trust Account} in which {\ttfamily\itshape{\docbookhyphenatedot{machine\_nickname}}} can be any descriptive name for the client, such as BasementComputer. {\ttfamily\itshape{\docbookhyphenatedot{machine\_name}}} absolutely must be the NetBIOS name of the client to be joined to the domain. The {``}\${''} must be appended to the NetBIOS name of the client or Samba will not recognize this as a Machine Trust Account.

\index{UNIX account} \index{Samba account} \index{Machine Trust Account!password} Now that the corresponding UNIX account has been created, the next step is to create the Samba account for the client containing the well-known initial Machine Trust Account password. This can be done using the {\bfseries{smbpasswd}} command as shown here: 
\begin{Verbatim}[]

root# smbpasswd -a -m machine_name

\end{Verbatim}


\index{machine\_name} \index{NetBIOS name} \index{RID} \index{UID} where {\ttfamily\itshape{\docbookhyphenatedot{machine\_name}}} is the machine's NetBIOS name. The RID of the new machine account is generated from the UID of the corresponding UNIX account.

\begin{admonition}{xslt/figures/warning}{Join the client to the domain immediately}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Machine Trust Account} \index{PDC} \index{Server Manager} \index{changes password} \index{NetBIOS name} Manually creating a Machine Trust Account using this method is the equivalent of creating a Machine Trust Account on a Windows NT PDC using \index{Server Manager} the Server Manager. From the time at which the account is created to the time the client joins the domain and changes the password, your domain is vulnerable to an intruder joining your domain using a machine with the same NetBIOS name. A PDC inherently trusts members of the domain and will serve out a large degree of user information to such clients. You have been warned!
\end{admonition}

\subsection{Managing Domain Machine Accounts using NT4 Server Manager}
\label{id2520526}\hypertarget{id2520526}{}%

\index{machine trust accounts} \index{automatic account creation} \index{Server Manager} A working \smbconfoption{add machine script} is essential for machine trust accounts to be automatically created. This applies no matter whether you use automatic account creation or the NT4 Domain Server Manager.

\index{SRVTOOLS.EXE} \index{SrvMgr.exe} \index{UsrMgr.exe} \index{domain management tools} If the machine from which you are trying to manage the domain is an MS Windows NT4 workstation or MS Windows 200x/XP Professional, the tool of choice is the package called {\bfseries{SRVTOOLS.EXE}}. When executed in the target directory it will unpack {\bfseries{SrvMgr.exe}} and {\bfseries{UsrMgr.exe}} (both are domain management tools for MS Windows NT4 workstation).

\index{Nexus.exe} \index{Microsoft Windows 9x/Me} If your workstation is a Microsoft Windows 9x/Me family product, you should download the {\bfseries{Nexus.exe}} package from the Microsoft Web site. When executed from the target directory, it will unpack the same tools but for use on this platform.

Further information about these tools may be obtained from Knowledge Base articles 173673\label{id2520661}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;en-us;173673}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2520661}, and 172540\label{id2520668}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;en-us;172540}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2520668}

\index{srvmgr.exe} \index{Server Manager for Domains} Launch the {\bfseries{srvmgr.exe}} (Server Manager for Domains) and follow these steps:
Server Manager Account Machine Account Management\begin{enumerate}

\item{From the menu select {\sffamily \bfseries Computer}.}

\item{Click {\sffamily \bfseries Select Domain}.}

\item{Click the name of the domain you wish to administer in the {\sffamily \bfseries Select Domain} panel and then click {\sffamily \bfseries OK}.}

\item{Again from the menu select {\sffamily \bfseries Computer}.}

\item{Select {\sffamily \bfseries Add to Domain}.}

\item{In the dialog box, click the radio button to {\sffamily \bfseries Add NT Workstation of Server}, then enter the machine name in the field provided, and click the {\sffamily \bfseries Add} button.}
\end{enumerate}
\subsection{On-the-Fly Creation of Machine Trust Accounts}
\label{id2520802}\hypertarget{id2520802}{}%

\index{Machine Trust Account!creation} The third (and recommended) way of creating Machine Trust Accounts is simply to allow the Samba server to create them as needed when the client is joined to the domain.

\index{Machine Trust Account!UNIX account} \index{UNIX account} \index{add machine script} Since each Samba Machine Trust Account requires a corresponding UNIX account, a method for automatically creating the UNIX account is usually supplied; this requires configuration of the add machine script option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. This method is not required; however, corresponding UNIX accounts may also be created manually.

\index{useradd} \index{Red Hat Linux} Here is an example for a Red Hat Linux system: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	add machine script = /usr/sbin/useradd -d /var/lib/nobody -g 100 -s /bin/false -M %u
\end{lstlisting}

\subsection{Making an MS Windows Workstation or Server a Domain Member}
\label{id2520898}\hypertarget{id2520898}{}%

The procedure for making an MS Windows workstation or server a member of the domain varies with the version of Windows.
\subsubsection{Windows 200x/XP Professional Client}
\label{id2520910}\hypertarget{id2520910}{}%

\index{domain member} \index{machine trust account!create privilege} \index{privileges} \index{root} When the user elects to make the client a domain member, Windows 200x prompts for an account and password that has privileges to create machine accounts in the domain. A Samba administrator account (i.e., a Samba account that has {\texttt{\docbookhyphenatedot{root}}} privileges on the Samba server) must be entered here; the operation will fail if an ordinary user account is given.

\index{administrator account} \index{/etc/passwd} For security reasons, the password for this administrator account should be set to a password that is other than that used for the root user in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}.

\index{account} \index{create domain member} \index{root} \index{map} The name of the account that is used to create domain member machine trust accounts can be anything the network administrator may choose. If it is other than {\texttt{\docbookhyphenatedot{root}}}, then this is easily mapped to {\texttt{\docbookhyphenatedot{root}}} in the file named in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter \smbconfoption{username map} = /etc/samba/smbusers.

\index{administrator account} \index{encryption key} \index{machine trust account} The session key of the Samba administrator account acts as an encryption key for setting the password of the machine trust account. The Machine Trust Account will be created on-the-fly, or updated if it already exists.
\subsubsection{Windows NT4 Client}
\label{id2521068}\hypertarget{id2521068}{}%

\index{Machine Trust Account} \index{Create a Computer Account} \index{join the machine} If the Machine Trust Account was created manually, on the Identification Changes menu enter the domain name, but do not check the box {\sffamily \bfseries Create a Computer Account in the Domain}. In this case, the existing Machine Trust Account is used to join the machine to the domain.

\index{Machine Trust Account} \index{on the fly} \index{Computer Account} \index{administrator account} If the Machine Trust Account is to be created on the fly, on the Identification Changes menu enter the domain name and check the box {\sffamily \bfseries Create a Computer Account in the Domain}. In this case, joining the domain proceeds as above for Windows 2000 (i.e., you must supply a Samba administrator account when prompted).
\subsubsection{Samba Client}
\label{id2521153}\hypertarget{id2521153}{}%

\index{} Joining a Samba client to a domain is documented in \hyperlink{domain-member-server}{Section {\ref{domain-member-server}}}.

% ------------------------   
% Section 
\section{Domain Member Server}
\label{domain-member-server}\hypertarget{domain-member-server}{}%

\index{domain security} \index{security context} \index{authentication regime} \index{ADS} This mode of server operation involves the Samba machine being made a member of a domain security context. This means by definition that all user authentication will be done from a centrally defined authentication regime. The authentication regime may come from an NT3/4-style (old domain technology) server, or it may be provided from an Active Directory server (ADS) running on MS Windows 2000 or later.

{\em{\index{authentication!backend} \index{distributed directory} \index{LDAP} \index{OpenLDAP} \index{iPlanet} \index{Sun} \index{Novell} \index{e-Directory} Of course it should be clear that the authentication backend itself could be from any distributed directory architecture server that is supported by Samba. This can be LDAP (from OpenLDAP), or Sun's iPlanet, or Novell e-Directory Server, and so on.}}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{LDAP} \index{identity management} \index{machine authentication} When Samba is configured to use an LDAP or other identity management and/or directory service, it is Samba that continues to perform user and machine authentication. It should be noted that the LDAP server does not perform authentication handling in place of what Samba is designed to do.
\end{admonition}


\index{create a domain machine account} \index{domain member server} \index{join the domain} Please refer to \hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}}, for more information regarding how to create a domain machine account for a domain member server as well as for information on how to enable the Samba domain member machine to join the domain and be fully trusted by it.
\subsection{Joining an NT4-type Domain with Samba-3}
\label{id2521361}\hypertarget{id2521361}{}%

\hyperlink{assumptions}{Table {\ref{assumptions}}} lists names that are used in the remainder of this chapter.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{assumptions}{}%
\captionswapskip{}{{\caption{Assumptions}\label{assumptions}}}
\captionswapskip{}\begin{tabular}{|r|l|}
\hline 
{{Samba DMS NetBIOS name:}} & {{SERV1}} \tabularnewline
 \hline 
{{Windows 200x/NT domain name:}} & {{MIDEARTH}} \tabularnewline
 \hline 
{{Domain's PDC NetBIOS name:}} & {{DOMPDC}} \tabularnewline
 \hline 
{{Domain's BDC NetBIOS names:}} & {{DOMBDC1 and DOMBDC2}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


\index{} First, you must edit your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to tell Samba it should now use domain security.

\index{security = user} \index{standalone server} \index{domain member server} \index{domain security} Change (or add) your \smbconfoption{security} line in the [global] section of your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to read: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	security = domain
\end{lstlisting}
 Note that if the parameter {\ttfamily\itshape{\docbookhyphenatedot{security = user}}} is used, this machine would function as a standalone server and not as a domain member server. Domain security mode causes Samba to work within the domain security context.

Next change the \smbconfoption{workgroup} line in the \smbconfsection{[global]} section to read: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	workgroup = MIDEARTH
\end{lstlisting}
 This is the name of the domain we are joining.

\index{authenticate} \index{PDC} You must also have the parameter \smbconfoption{encrypt passwords} set to {\texttt{\docbookhyphenatedot{yes}}} in order for your users to authenticate to the NT PDC. This is the default setting if this parameter is not specified. There is no need to specify this parameter, but if it is specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, it must be set to {\texttt{\docbookhyphenatedot{Yes}}}.

\index{PDC} \index{BDC} \index{authenticate users} \index{domain controllers} Finally, add (or modify) a \smbconfoption{password server} line in the [global] section to read: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	password server = DOMPDC DOMBDC1 DOMBDC2
\end{lstlisting}
 These are the PDC and BDCs Samba will attempt to contact in order to authenticate users. Samba will try to contact each of these servers in order, so you may want to rearrange this list in order to spread out the authentication load among Domain Controllers.

\index{list of domain controllers} \index{mechanism} \index{broadcast-based name resolution} \index{DNS name resolution} Alternatively, if you want smbd to determine automatically the list of domain controllers to use for authentication, you may set this line to be: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	password server = *
\end{lstlisting}
 \index{WINS} This method allows Samba to use exactly the same mechanism that NT does. The method either uses broadcast-based name resolution, performs a WINS database lookup in order to find a domain controller against which to authenticate, or locates the domain controller using DNS name resolution.

To join the domain, run this command: \index{net!rpc!join} 
\begin{Verbatim}[]

root# net rpc join -S DOMPDC -UAdministrator%password

\end{Verbatim}


\index{NetBIOS name} \index{PDC} \index{WINS lookup} \index{NetBIOS broadcast} If the {\texttt{\docbookhyphenatedot{-S DOMPDC}}} argument is not given, the domain name will be obtained from {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} and the NetBIOS name of the PDC will be obtained either using a WINS lookup or via NetBIOS broadcast based name look up.

\index{joining the domain} \index{PDC} \index{Administrator\%password} \index{Joined domain} The machine is joining the domain DOM, and the PDC for that domain (the only machine that has write access to the domain SAM database) is DOMPDC; therefore, use the {\texttt{\docbookhyphenatedot{-S}}} option. The {\ttfamily\itshape{\docbookhyphenatedot{Administrator\%password}}} is the login name and password for an account that has the necessary privilege to add machines to the domain. If this is successful, you will see the following message in your terminal window. Where the older NT4-style domain architecture is used: 
\begin{Verbatim}[]

Joined domain DOM.

\end{Verbatim}


\index{net!ads!join} \index{ADS} \index{join the ADS domain} Where Active Directory is used, the command used to join the ADS domain is: 
\begin{Verbatim}[]

root#  net ads join -UAdministrator%password

\end{Verbatim}
 And the following output is indicative of a successful outcome: 
\begin{Verbatim}[]

Joined SERV1 to realm MYREALM.

\end{Verbatim}


Refer to the {\bfseries{net}} man page and to \hyperlink{NetCommand}{Chapter {\ref{NetCommand}}, {``}Remote and Local Management: The Net Command{''}} for further information.

\index{join the domain} \index{create machine trust account} \index{PDC} This process joins the server to the domain without separately having to create the machine trust account on the PDC beforehand.

\index{machine account password!change protocol} \index{random machine account password} \index{/usr/local/samba/private/secrets.tdb} \index{/etc/samba/secrets.tdb} This command goes through the machine account password change protocol, then writes the new (random) machine account password for this Samba server into a file in the same directory in which a smbpasswd file would be normally stored. The trust account information that is needed by the DMS is written into the file {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}private/\dbz{}secrets.\dbz{}tdb}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}secrets.\dbz{}tdb}}}.

\index{domain-level security} \index{shadow password file} This file is created and owned by root and is not readable by any other user. It is the key to the domain-level security for your system and should be treated as carefully as a shadow password file.

\index{Samba daemons} \index{distribution} \index{/etc/init.d/samba} Finally, restart your Samba daemons and get ready for clients to begin using domain security. The way you can restart your Samba daemons depends on your distribution, but in most cases the following will suffice: 
\begin{Verbatim}[]

root# /etc/init.d/samba restart

\end{Verbatim}

\subsection{Why Is This Better Than security = server?}
\label{id2522052}\hypertarget{id2522052}{}%

\index{domain security} \index{UNIX users} \index{authentication} Currently, domain security in Samba does not free you from having to create local UNIX users to represent the users attaching to your server. This means that if domain user {\texttt{\docbookhyphenatedot{DOM\textbackslash fred}}} attaches to your domain security Samba server, there needs to be a local UNIX user fred to represent that user in the UNIX file system. This is similar to the older Samba security mode \smbconfoption{security} = server, where Samba would pass through the authentication request to a Windows NT server in the same way as a Windows 95 or Windows 98 server would.

\index{winbind} \index{UID} \index{GID} Please refer to \hyperlink{winbind}{Chapter {\ref{winbind}}, {``}Winbind: Use of Domain Accounts{''}}, for information on a system to automatically assign UNIX UIDs and GIDs to Windows NT domain users and groups.

\index{domain-level} \index{authentication} \index{RPC} The advantage of domain-level security is that the authentication in domain-level security is passed down the authenticated RPC channel in exactly the same way that an NT server would do it. This means Samba servers now participate in domain trust relationships in exactly the same way NT servers do (i.e., you can add Samba servers into a resource domain and have the authentication passed on from a resource domain PDC to an account domain PDC).

\index{PDC} \index{BDC} \index{connection resources} In addition, with \smbconfoption{security} = server, every Samba daemon on a server has to keep a connection open to the authenticating server for as long as that daemon lasts. This can drain the connection resources on a Microsoft NT server and cause it to run out of available connections. With \smbconfoption{security} = domain, however, the Samba daemons connect to the PDC or BDC only for as long as is necessary to authenticate the user and then drop the connection, thus conserving PDC connection resources.

\index{PDC} \index{authentication reply} \index{SID} \index{NT groups} Finally, acting in the same manner as an NT server authenticating to a PDC means that as part of the authentication reply, the Samba server gets the user identification information such as the user SID, the list of NT groups the user belongs to, and so on.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Much of the text of this document was first published in the Web magazine {\em{LinuxWorld}}\label{id2522258}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxworld.com}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2522258} as the article {\textless}\url{http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html}{\textgreater} {\em{Doing the NIS/NT Samba}}.
\end{admonition}


% ------------------------   
% Section 
\section{Samba ADS Domain Membership}
\label{ads-member}\hypertarget{ads-member}{}%

\index{Active Directory} \index{ADS|textit{see} {Active Directory} } \index{KDC} \index{Kerberos} This is a rough guide to setting up Samba-3 with Kerberos authentication against a Windows 200x KDC. A familiarity with Kerberos is assumed.
\subsection{Configure smb.\dbz{}conf}
\label{id2522325}\hypertarget{id2522325}{}%

You must use at least the following three options in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	realm = your.kerberos.REALM
 	security = ADS
 # The following parameter need only be specified if present.
 # The default setting if not present is Yes.
 	encrypt passwords = yes
\end{lstlisting}

\index{ADS} \index{realm} \index{DNS} \index{ADS DC} \index{password server} In case samba cannot correctly identify the appropriate ADS server using the realm name, use the \smbconfoption{password server} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	password server = your.kerberos.server
\end{lstlisting}
 The most common reason for which Samba may not be able to locate the ADS domain controller is a consequence of sites maintaining some DNS servers on UNIX systems without regard for the DNS requirements of the ADS infrastructure. There is no harm in specifying a preferred ADS domain controller using the {\ttfamily\itshape{\docbookhyphenatedot{password server}}}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{smbpasswd} \index{authenticated} You do {\em{not}} need an smbpasswd file, and older clients will be authenticated as if \smbconfoption{security} = domain, although it will not do any harm and allows you to have local users not in the domain.
\end{admonition}

\subsection{Configure /\dbz{}etc/\dbz{}krb5.\dbz{}conf}
\label{id2522482}\hypertarget{id2522482}{}%

\index{/etc/krb5.conf} \index{Kerberos!/etc/krb5.conf} \index{MIT} \index{Heimdal} With both MIT and Heimdal Kerberos, it is unnecessary to configure the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}krb5.\dbz{}conf}}}, and it may be detrimental.

\index{ADS} \index{SRV records} \index{DNS zon} \index{KDC} \index{\_kerberos.REALM.NAME} Microsoft ADS automatically create SRV records in the DNS zone {\ttfamily\itshape{\docbookhyphenatedot{\_kerberos.\_tcp.REALM.NAME}}} for each KDC in the realm. This is part of the installation and configuration process used to create an Active Directory domain. A KDC is a Kerberos Key Distribution Center and forms an integral part of the Microsoft active directory infrastructure.

\index{kinit} \index{DES-CBC-MD5} \index{DES-CBC-CRC} \index{encryption types} \index{kerberos} \index{Windows 2000} UNIX systems can use kinit and the DES-CBC-MD5 or DES-CBC-CRC encryption types to authenticate to the Windows 2000 KDC. For further information regarding Windows 2000 ADS kerberos interoperability please refer to the Microsoft Windows 2000 Kerberos Interoperability\label{id2522633}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/windows2000/techinfo/planning/security/kerbsteps.asp}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2522633} guide. Another very useful document that may be referred to for general information regarding Kerberos interoperability is RFC1510\label{id2522643}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.ietf.org/rfc/rfc1510.txt?number=1510}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2522643}. This RFC explains much of the magic behind the operation of Kerberos.

\index{MIT} \index{KRB5} \index{SRV records} \index{krb5.conf} \index{DNS lookup} \index{libraries} MIT's, as well as Heimdal's, recent KRB5 libraries default to checking for SRV records, so they will automatically find the KDCs. In addition, {\texttt{\docbookhyphenatefilename{krb5.\dbz{}conf}}} only allows specifying a single KDC, even there if there may be more than one. Using the DNS lookup allows the KRB5 libraries to use whichever KDCs are available.

\index{krb5.conf} When manually configuring {\texttt{\docbookhyphenatefilename{krb5.\dbz{}conf}}}, the minimal configuration is: 
\begin{Verbatim}[]

[libdefaults]
	default_realm = YOUR.KERBEROS.REALM

[realms]
	YOUR.KERBEROS.REALM = {
	kdc = your.kerberos.server
	}

[domain_realms]
	.kerberos.server = YOUR.KERBEROS.REALM

\end{Verbatim}


\index{Heimdal} When using Heimdal versions before 0.6, use the following configuration settings: 
\begin{Verbatim}[]

[libdefaults]
	default_realm      = YOUR.KERBEROS.REALM
	default_etypes     = des-cbc-crc des-cbc-md5
	default_etypes_des = des-cbc-crc des-cbc-md5

[realms]
        YOUR.KERBEROS.REALM = {
        kdc = your.kerberos.server
	}

[domain_realms]
        .kerberos.server = YOUR.KERBEROS.REALM

\end{Verbatim}


\index{KDC} \index{kinit} Test your config by doing a {\ttfamily\bfseries{\docbookhyphenatedot{kinit {\ttfamily\itshape{\docbookhyphenatedot{USERNAME}}}@{\ttfamily\itshape{\docbookhyphenatedot{REALM}}}}}} and making sure that your password is accepted by the Win2000 KDC.

\index{Heimdal} \index{ADS} \index{KDC} \index{Windows 2003} With Heimdal versions earlier than 0.6.x you can use only newly created accounts in ADS or accounts that have had the password changed once after migration, or in case of {\texttt{\docbookhyphenatedot{Administrator}}} after installation. At the moment, a Windows 2003 KDC can only be used with Heimdal releases later than 0.6 (and no default etypes in krb5.conf). Unfortunately, this whole area is still in a state of flux.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{realm} \index{uppercase} \index{KDC} The realm must be in uppercase or you will get a {``}Cannot find KDC for requested realm while getting initial credentials{''} error (Kerberos is case-sensitive!).
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{synchronize} \index{credentials} \index{time difference} \index{clock skew} Time between the two servers must be synchronized. You will get a {``}kinit(v5): Clock skew too great while getting initial credentials{''} if the time difference (clock skew) is more than five minutes.
\end{admonition}


\index{clock skew} \index{Kerberos} Clock skew limits are configurable in the Kerberos protocols. The default setting is five minutes.

\index{DNS} \index{KDC} \index{hostname} \index{realm} You also must ensure that you can do a reverse DNS lookup on the IP address of your KDC. Also, the name that this reverse lookup maps to must either be the NetBIOS name of the KDC (i.e., the hostname with no domain attached) or it can be the NetBIOS name followed by the realm.

\index{/etc/hosts} \index{KDC} \index{realm} The easiest way to ensure you get this right is to add a {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} entry mapping the IP address of your KDC to its NetBIOS name. If you do not get this correct, then you will get a local error when you try to join the realm.

\index{Kerberos} \index{Create the Computer Account} \index{Testing Server Setup} \index{} If all you want is Kerberos support in smbclient, then you can skip directly to \hyperlink{ads-test-smbclient}{Section {\ref{ads-test-smbclient}}} now. \hyperlink{ads-create-machine-account}{Section {\ref{ads-create-machine-account}}} and \hyperlink{ads-test-server}{Section {\ref{ads-test-server}}} are needed only if you want Kerberos support for smbd and winbindd.
\subsection{Create the Computer Account}
\label{ads-create-machine-account}\hypertarget{ads-create-machine-account}{}%

\index{write permission} \index{Samba private directory} \index{Administrator account} \index{ADS} As a user who has write permission on the Samba private directory (usually root), run: 
\begin{Verbatim}[]

root#  net ads join -U Administrator%password

\end{Verbatim}
 The Administrator account can be any account that has been designated in the ADS domain security settings with permission to add machines to the ADS domain. It is, of course, a good idea to use an account other than Administrator. On the UNIX/Linux system, this command must be executed by an account that has UID=0 (root).

\index{ADS} \index{machine trust account} \index{organizational unit} \index{ADS manager} \index{kinit} \index{net!ads!join} When making a Windows client a member of an ADS domain within a complex organization, you may want to create the machine trust account within a particular organizational unit. Samba-3 permits this to be done using the following syntax: 
\begin{Verbatim}[]

root#  kinit Administrator@your.kerberos.REALM
root#  net ads join createcomputer="organizational_unit"

\end{Verbatim}
 Your ADS manager will be able to advise what should be specified for the "organizational\_unit" parameter.

\index{organizational directory} \index{machine trust account} \index{container} \index{ADS} For example, you may want to create the machine trust account in a container called {``}Servers{''} under the organizational directory {``}Computers/BusinessUnit/Department,{''} like this: 
\begin{Verbatim}[]

root#  net ads join "Computers/BusinessUnit/Department/Servers"

\end{Verbatim}
 This command will place the Samba server machine trust account in the container {\texttt{\docbookhyphenatedot{Computers/\dbz{}BusinessUnit/\dbz{}Department/\dbz{}Servers}}}. The container should exist in the ADS directory before executing this command. Please note that forward slashes must be used, because backslashes are both valid characters in an OU name and used as escapes for other characters. If you need a backslash in an OU name, it may need to be quadrupled to pass through the shell escape and ldap escape.
\subsubsection{Possible Errors}
\label{id2523298}\hypertarget{id2523298}{}%


\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{ADS support not compiled in}]\null{}
\index{config.cache} \index{Kerberos} \index{headers files} Samba must be reconfigured (remove config.cache) and recompiled (make clean all install) after the Kerberos libraries and headers files are installed.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{net ads join prompts for user name}]\null{}
\index{kinit} \index{rights} You need to log in to the domain using {\ttfamily\bfseries{\docbookhyphenatedot{kinit {\ttfamily\itshape{\docbookhyphenatedot{USERNAME}}}@{\ttfamily\itshape{\docbookhyphenatedot{REALM}}}}}}. {\ttfamily\itshape{\docbookhyphenatedot{USERNAME}}} must be a user who has rights to add a machine to the domain.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Unsupported encryption/or checksum types}]\null{}
\index{/etc/krb5.conf} \index{unsupported encryption} \index{Kerberos} Make sure that the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}krb5.\dbz{}conf}}} is correctly configured for the type and version of Kerberos installed on the system.
\end{description}

\subsection{Testing Server Setup}
\label{ads-test-server}\hypertarget{ads-test-server}{}%

\index{successful join} \index{computer account} \index{ADS} If the join was successful, you will see a new computer account with the NetBIOS name of your Samba server in Active Directory (in the {``}Computers{''} folder under Users and Computers.

\index{Windows 2000} \index{net!use} \index{DES-CBC-MD5} On a Windows 2000 client, try {\ttfamily\bfseries{\docbookhyphenatedot{net use * \docbooktolatexgobble\string\\\docbooktolatexgobble\string\\server\docbooktolatexgobble\string\\share}}}. You should be logged in with Kerberos without needing to know a password. If this fails, then run {\ttfamily\bfseries{\docbookhyphenatedot{klist tickets}}}. Did you get a ticket for the server? Does it have an encryption type of DES-CBC-MD5?

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{DES-CBC-MD5} \index{ARCFOUR-HMAC-MD5} \index{encoding} Samba can use both DES-CBC-MD5 encryption as well as ARCFOUR-HMAC-MD5 encoding.
\end{admonition}

\subsection{Testing with smbclient}
\label{ads-test-smbclient}\hypertarget{ads-test-smbclient}{}%

\index{smbclient} \index{Kerberos} \index{Kerberos authentication} On your Samba server try to log in to a Windows 2000 server or your Samba server using smbclient and Kerberos. Use smbclient as usual, but specify the {\texttt{\docbookhyphenatedot{-k}}} option to choose Kerberos authentication.
\subsection{Notes}
\label{id2523598}\hypertarget{id2523598}{}%

\index{administrator password} \index{change password} \index{encryption types} You must change the administrator password at least once after installing a domain controller, to create the right encryption types.

\index{\_kerberos.\_udp} \index{\_ldap.\_tcp} \index{default DNS setup} Windows 200x does not seem to create the {\ttfamily\itshape{\docbookhyphenatedot{\_kerberos.\_udp}}} and {\ttfamily\itshape{\docbookhyphenatedot{\_ldap.\_tcp}}} in the default DNS setup. Perhaps this will be fixed later in service packs.

% ------------------------   
% Section 
\section{Sharing User ID Mappings between Samba Domain Members}
\label{id2523673}\hypertarget{id2523673}{}%

\index{maps UNIX users and groups} \index{UID} \index{GID} \index{SID} Samba maps UNIX users and groups (identified by UIDs and GIDs) to Windows users and groups (identified by SIDs). These mappings are done by the {\ttfamily\itshape{\docbookhyphenatedot{idmap}}} subsystem of Samba.

\index{mappings} \index{CIFS} \index{NFS} In some cases it is useful to share these mappings between Samba domain members, so {\em{name-\textgreater{}id}} mapping is identical on all machines. This may be needed in particular when sharing files over both CIFS and NFS.

\index{LDAP} \index{ldap idmap suffix} To use the {\em{LDAP}} {\ttfamily\itshape{\docbookhyphenatedot{ldap idmap suffix}}}, set:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	ldap idmap suffix = ou=Idmap
\end{lstlisting}

See the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page entry for the \smbconfoption{ldap idmap suffix} parameter for further information.

\index{smbpasswd} \index{LDAP administrative password} \index{secrets.tdb} Do not forget to specify also the \smbconfoption{ldap admin dn} and to make certain to set the LDAP administrative password into the {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}} using: 
\begin{Verbatim}[]

root#  smbpasswd -w ldap-admin-password

\end{Verbatim}
 In place of {\texttt{\docbookhyphenatedot{ldap-\dbz{}admin-\dbz{}password}}}, substitute the LDAP administration password for your system.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2523863}\hypertarget{id2523863}{}%

\index{domain member} \index{machine trust accounts} In the process of adding/deleting/re-adding domain member machine trust accounts, there are many traps for the unwary player and many {``}little{''} things that can go wrong. It is particularly interesting how often subscribers on the Samba mailing list have concluded after repeated failed attempts to add a machine account that it is necessary to {``}reinstall{''} MS Windows on the machine. In truth, it is seldom necessary to reinstall because of this type of problem. The real solution is often quite simple, and with an understanding of how MS Windows networking functions, it is easy to overcome.
\subsection{Cannot Add Machine Back to Domain}
\label{id2523904}\hypertarget{id2523904}{}%

\index{machine trust account} \index{already exists} {``}A Windows workstation was reinstalled. The original domain machine trust account was deleted and added immediately. The workstation will not join the domain if I use the same machine name. Attempts to add the machine fail with a message that the machine already exists on the network ---  I know it does not. Why is this failing?{''}

\index{NetBIOS name cache} \index{nbtstat} The original name is still in the NetBIOS name cache and must expire after machine account deletion before adding that same name as a domain member again. The best advice is to delete the old account and then add the machine with a new name. Alternately, the name cache can be flushed and reloaded with current data using the {\bfseries{nbtstat}} command on the Windows client: 
\begin{Verbatim}[]

C:\>  nbtstat -R

\end{Verbatim}

\subsection{Adding Machine to Domain Fails}
\label{id2523983}\hypertarget{id2523983}{}%

\index{PDC} \index{fails} {``}Adding a Windows 200x or XP Professional machine to the Samba PDC Domain fails with a message that says, "The machine could not be added at this time, there is a network problem. Please try again later." Why?{''}

\index{check logs} You should check that there is an \smbconfoption{add machine script} in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. If there is not, please add one that is appropriate for your OS platform. If a script has been defined, you will need to debug its operation. Increase the \smbconfoption{log level} in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to level 10, then try to rejoin the domain. Check the logs to see which operation is failing.

Possible causes include:

\begin{itemize}
%--- Item
\item 
\index{script} \index{path specified} The script does not actually exist, or could not be located in the path specified.

\index{UNIX system account} \index{Samba SAM account} {\em{Corrective action:}} Fix it. Make sure when run manually that the script will add both the UNIX system account and the Samba SAM account.


%--- Item
\item 
\index{UNIX system account} \index{/etc/passwd} The machine could not be added to the UNIX system accounts file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}.

\index{legal UNIX system account name} \index{uppercase} {\em{Corrective action:}} Check that the machine name is a legal UNIX system account name. If the UNIX utility {\bfseries{useradd}} is called, then make sure that the machine name you are trying to add can be added using this tool. {\bfseries{Useradd}} on some systems will not allow any uppercase characters nor will it allow spaces in the name.

\end{itemize}

\index{backend database} \index{UNIX system account} \index{Samba backend database} The \smbconfoption{add machine script} does not create the machine account in the Samba backend database; it is there only to create a UNIX system account to which the Samba backend database account can be mapped.
\subsection{I Can't Join a Windows 2003 PDC}
\label{id2524205}\hypertarget{id2524205}{}%

\index{SMB signing} \index{SMB} \index{Windows 2003} \index{SMB/CIFS} Windows 2003 requires SMB signing. Client-side SMB signing has been implemented in Samba-3.0. Set \smbconfoption{client use spnego} = yes when communicating with a Windows 2003 server. This will not interfere with other Windows clients that do not support the more advanced security features of Windows 2003 because the client will simply negotiate a protocol that both it and the server suppport. This is a well-known fall-back facility that is built into the SMB/CIFS protocols.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Standalone Servers 
% ------------------------------------------------------------- 	
\chapter{Standalone Servers}
\label{StandAloneServer}\hypertarget{StandAloneServer}{}%

\index{standalone server} \index{not domain members} \index{minimum security control} Standalone servers are independent of domain controllers on the network. They are not domain members and function more like workgroup servers. In many cases a standalone server is configured with a minimum of security control with the intent that all data served will be readily accessible to all users.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2460698}\hypertarget{id2460698}{}%

\index{secure} \index{insecure} Standalone servers can be as secure or as insecure as needs dictate. They can have simple or complex configurations. Above all, despite the hoopla about domain security, they remain a common installation.

\index{read-only files} \index{share-mode} \index{read-only} \index{standalone server} If all that is needed is a server for read-only files, or for printers alone, it may not make sense to effect a complex installation. For example, a drafting office needs to store old drawings and reference standards. Noone can write files to the server because it is legislatively important that all documents remain unaltered. A share-mode read-only standalone server is an ideal solution.

\index{simplicity} \index{printers} \index{share-mode server} Another situation that warrants simplicity is an office that has many printers that are queued off a single central server. Everyone needs to be able to print to the printers, there is no need to effect any access controls, and no files will be served from the print server. Again, a share-mode standalone server makes a great solution.

% ------------------------   
% Section 
\section{Background}
\label{id2504647}\hypertarget{id2504647}{}%

\index{standalone server} \index{local authentication} \index{access control} The term {\em{standalone server}} means that it will provide local authentication and access control for all resources that are available from it. In general this means that there will be a local user database. In more technical terms, it means resources on the machine will be made available in either {\em{share}} mode or in {\em{user}} mode.

\index{create user accounts} \index{no network logon service} \index{independent} No special action is needed other than to create user accounts. Standalone servers do not provide network logon services. This means that machines that use this server do not perform a domain logon to it. Whatever logon facility the workstations are subject to is independent of this machine. It is, however, necessary to accommodate any network user so the logon name he or she uses will be translated (mapped) locally on the standalone server to a locally known user name. There are several ways this can be done.

\index{local authentication database} \index{SMB} \index{not domain member} Samba tends to blur the distinction a little in defining a standalone server. This is because the authentication database may be local or on a remote server, even if from the SMB protocol perspective the Samba server is not a member of a domain security context.

\index{PAM} \index{NSS} \index{UNIX-user database} \index{/etc/passwd} \index{/etc/shadow} \index{local smbpasswd file} \index{LDAP backend} \index{Winbind} Through the use of Pluggable Authentication Modules (PAM) (see \hyperlink{pam}{Chapter {\ref{pam}}, {``}PAM-Based Distributed Authentication{''}}) and the name service switcher (NSS), which maintains the UNIX-user database, the source of authentication may reside on another server. We would be inclined to call this the authentication server. This means that the Samba server may use the local UNIX/Linux system password database ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}shadow}}}), may use a local smbpasswd file, or may use an LDAP backend, or even via PAM and Winbind another CIFS/SMB server for authentication.

% ------------------------   
% Section 
\section{Example Configuration}
\label{id2518688}\hypertarget{id2518688}{}%

\index{inspire simplicity} \index{complexity} \hyperlink{simplynice}{Example {\ref{simplynice}}} and \hyperlink{SimplePrintServer}{Section {\ref{SimplePrintServer}}} are designed to inspire simplicity. It is too easy to attempt a high level of creativity and to introduce too much complexity in server and network design.
\subsection{Reference Documentation Server}
\label{RefDocServer}\hypertarget{RefDocServer}{}%

\index{read-only} \index{reference documents} \index{/export} \index{/etc/passwd} Configuration of a read-only data server that everyone can access is very simple. By default, all shares are read-only, unless set otherwise in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. \hyperlink{simplynice}{Example {\ref{simplynice}}} is the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file that will do this. Assume that all the reference documents are stored in the directory {\texttt{\docbookhyphenatefilename{/\dbz{}export}}}, and the documents are owned by a user other than nobody. No home directories are shared, and there are no users in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} UNIX system database. This is a simple system to administer.

\begin{example}%
\hypertarget{simplynice}{}%
\captionswapskip{}{{\caption{smb.conf for Reference Documentation Server}\label{simplynice}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = GANDALF
 	security = SHARE
 	passdb backend = guest
 	wins server = 192.168.1.1
 [data]
 	comment = Data
 	path = /export
 	guest only = Yes
\end{lstlisting}
\end{example}

\begin{quote}

I would have spoken more briefly, if I'd had more time to prepare.

\hspace*\fill---Mark Twain\end{quote}

\index{password backend} \index{guest} \index{unprivileged account names} \index{WINS} In \hyperlink{simplynice}{Example {\ref{simplynice}}}, the machine name is set to GANDALF, and the workgroup is set to the name of the local workgroup (MIDEARTH) so the machine will appear together with systems with which users are familiar. The only password backend required is the {``}guest{''} backend to allow default unprivileged account names to be used. As there is a WINS server on this network, we of course make use of it.

A US Air Force Colonel was renowned for saying: {``}Better is the enemy of good enough!{''} There are often sound reasons for avoiding complexity as well as for avoiding a technically perfect solution. Unfortunately, many network administrators still need to learn the art of doing just enough to keep out of trouble.
\subsection{Central Print Serving}
\label{SimplePrintServer}\hypertarget{SimplePrintServer}{}%

\index{simple print server} \index{tools} Configuration of a simple print server is easy if you have all the right tools on your system.

{\sc{Assumptions}}

\begin{enumerate}
%--- Item
\item 
The print server must require no administration.


%--- Item
\item 
The print spooling and processing system on our print server will be CUPS. (Please refer to \hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}}, for more information).


%--- Item
\item 
The print server will service only network printers. The network administrator will correctly configure the CUPS environment to support the printers.


%--- Item
\item 
All workstations will use only PostScript drivers. The printer driver of choice is the one shipped with the Windows OS for the Apple Color LaserWriter.

\end{enumerate}

\index{print server} \index{/var/spool/samba} \index{anonymous} In this example our print server will spool all incoming print jobs to {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}spool/\dbz{}samba}}} until the job is ready to be submitted by Samba to the CUPS print processor. Since all incoming connections will be as the anonymous (guest) user, two things will be required to enable anonymous printing.

{\sc{Enabling Anonymous Printing}}

\begin{itemize}
%--- Item
\item 
\index{guest account} \index{nobody} \index{testparm} The UNIX/Linux system must have a {\bfseries{guest}} account. The default for this is usually the account {\bfseries{nobody}}. To find the correct name to use for your version of Samba, do the following: 
\begin{Verbatim}[]

$ testparm -s -v | grep "guest account"

\end{Verbatim}
 \index{/etc/passwd} Make sure that this account exists in your system password database ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}).

\index{set a password} \index{lock password} \index{passwd} It is a good idea either to set a password on this account, or else to lock it from UNIX use. Assuming that the guest account is called {\texttt{\docbookhyphenatedot{pcguest}}}, it can be locked by executing: 
\begin{Verbatim}[]

root#  passwd -l pcguest

\end{Verbatim}
 The exact command may vary depending on your UNIX/Linux distribution.


%--- Item
\item 
\index{directory} \index{guest account} \index{available} \index{mkdir} \index{chown} \index{chmod} The directory into which Samba will spool the file must have write access for the guest account. The following commands will ensure that this directory is available for use: 
\begin{Verbatim}[]

root# mkdir /var/spool/samba
root# chown nobody.nobody /var/spool/samba
root# chmod a+rwt /var/spool/samba

\end{Verbatim}


\end{itemize}

The contents of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is shown in \hyperlink{AnonPtrSvr}{Example {\ref{AnonPtrSvr}}}.

\begin{example}%
\hypertarget{AnonPtrSvr}{}%
\captionswapskip{}{{\caption{smb.\dbz{}conf for Anonymous Printing}\label{AnonPtrSvr}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = GANDALF
 	security = SHARE
 	passdb backend = guest
 	printing = cups
 	printcap name = cups
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	printer admin = root
 	guest ok = Yes
 	printable = Yes
 	use client driver = Yes
 	browseable = No
\end{lstlisting}
\end{example}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{MIME!raw} \index{raw printing} \index{/etc/mime.conv} \index{/etc/mime.types} \index{CUPS print filters} On CUPS-enabled systems there is a facility to pass raw data directly to the printer without intermediate processing via CUPS print filters. Where use of this mode of operation is desired, it is necessary to configure a raw printing device. It is also necessary to enable the raw mime handler in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}mime.\dbz{}conv}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}mime.\dbz{}types}}} files. Refer to \hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}}, \hyperlink{cups-raw}{Section {\ref{cups-raw}}}.
\end{admonition}


\index{CUPS libarary API} \index{no printcap file} \index{PDF filter} \index{printcap name} The example in \hyperlink{AnonPtrSvr}{Example {\ref{AnonPtrSvr}}} uses CUPS for direct printing via the CUPS libarary API. This means that all printers will be exposed to Windows users without need to configure a printcap file. If there is necessity to expose only a sub-set of printers, or to define a special type of printer (for example, a PDF filter) the {\ttfamily\itshape{\docbookhyphenatedot{printcap name = cups}}} can be replaced with the entry {\ttfamily\itshape{\docbookhyphenatedot{printcap name = /etc/samba/myprintcap}}}. In this case the file specified should contain a list of the printer names that should be exposed to Windows network users.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2460918}\hypertarget{id2460918}{}%

\index{greatest mistake} \index{configuration too complex} The greatest mistake so often made is to make a network configuration too complex. It pays to use the simplest solution that will meet the needs of the moment.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter MS Windows Network Configuration Guide 
% ------------------------------------------------------------- 	
\chapter{MS Windows Network Configuration Guide}
\label{ClientConfig}\hypertarget{ClientConfig}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2484251}\hypertarget{id2484251}{}%

\index{network difficulty} \index{network client} \index{client client instructions} Occasionally network administrators report difficulty getting Microsoft Windows clients to interoperate correctly with Samba servers. It seems that some folks just cannot accept the fact that the right way to configure an MS Windows network client is precisely as one would do when using MS Windows NT4 or 200x servers. Yet there is repetitious need to provide detailed Windows client configuration instructions.

\index{graphically illustrated client configuration} \index{critical aspects of configuration} The purpose of this chapter is to graphically illustrate MS Windows client configuration for the most common critical aspects of such configuration. An experienced network administrator will not be interested in the details of this chapter.

% ------------------------   
% Section 
\section{Technical Details}
\label{id2503081}\hypertarget{id2503081}{}%

\index{TCP/IP protocol configuration} \index{network membership} This chapter discusses TCP/IP protocol configuration as well as network membership for the platforms that are in common use today. These are:

\begin{itemize}
%--- Item
\item 
Microsoft Windows XP Professional


%--- Item
\item 
Windows 2000 Professional


%--- Item
\item 
Windows Millennium edition (Me)

\end{itemize}
\subsection{TCP/IP Configuration}
\label{id2503124}\hypertarget{id2503124}{}%

\index{network configuration problems} \index{plague network users} The builder of a house must ensure that all construction takes place on a firm foundation. The same is true for the builder of a TCP/IP-based networking system. Fundamental network configuration problems will plague all network users until they are resolved.

\index{fixed IP addresses} \index{DHCP} MS Windows workstations and servers can be configured either with fixed IP addresses or via DHCP. The examples that follow demonstrate the use of DHCP and make only passing reference to those situations where fixed IP configuration settings can be effected.

\index{shortcuts} \index{abbreviated keystrokes} It is possible to use shortcuts or abbreviated keystrokes to arrive at a particular configuration screen. The decision was made to base all examples in this chapter on use of the {\sffamily \bfseries Start} button.
\subsubsection{MS Windows XP Professional}
\label{id2503200}\hypertarget{id2503200}{}%

\index{Windows XP TCP/IP} There are two paths to the Windows XP TCP/IP configuration panel. Choose the access method that you prefer:

Click {\sffamily \bfseries Start -\textgreater{} Control Panel -\textgreater{} Network Connections}.

{\em{Alternately,}} click {\sffamily \bfseries Start -\textgreater{}}, and right-click {\sffamily \bfseries My Network Places} then select {\sffamily \bfseries Properties}.

\index{Windows XP Professional} The following procedure steps through the Windows XP Professional TCP/IP configuration process:
\begin{enumerate}

\item{\index{Local Area Connection} \index{Network Bridge} \index{interface} On some installations the interface will be called {\sffamily \bfseries Local Area Connection} and on others it will be called {\sffamily \bfseries Network Bridge}. On our system it is called {\sffamily \bfseries Network Bridge}. Right-click on {\sffamily \bfseries Network Bridge -\textgreater{} Properties}. See \hyperlink{WXPP002}{Figure {\ref{WXPP002}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WXPP002}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WXPP002}
{{\caption[{Network Bridge Configuration.}]{{{Network Bridge Configuration.}}}\label{WXPP002}}}
\end{center}
\end{figure}

}

\item{\index{TCP/IP protocol settings} \index{Network Bridge Configuration} The Network Bridge Configuration, or Local Area Connection, panel is used to set TCP/IP protocol settings. In {\sffamily \bfseries This connection uses the following items:} box, click on {\sffamily \bfseries Internet Protocol (TCP/IP)}, then click on {\sffamily \bfseries Properties}.  \index{DHCP-enabled operation} \index{IP address automatically} The default setting is DHCP-enabled operation (i.e., {``}Obtain an IP address automatically{''}). See \hyperlink{WXPP003}{Figure {\ref{WXPP003}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WXPP003}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WXPP003}
{{\caption[{Internet Protocol (TCP/IP) Properties.}]{{{Internet Protocol (TCP/IP) Properties.}}}\label{WXPP003}}}
\end{center}
\end{figure}

  \index{DHCP} \index{TCP/IP} \index{DNS} \index{ISC DHCP server} Many network administrators will want to use DHCP to configure all client TCP/IP protocol stack settings. (For information on how to configure the ISC DHCP server for Windows client support see \hyperlink{DHCP}{Section {\ref{DHCP}}}, \hyperlink{DHCP}{Section {\ref{DHCP}}}.  \index{fixed IP address} \index{subnet mask} \index{gateway address} If it is necessary to provide a fixed IP address, click on {``}Use the following IP address{''} and enter the IP Address, the subnet mask, and the default gateway address in the boxes provided.}

\item{\index{Advanced TCP/IP configuration} \index{TCP/IP configuration} \index{IP aliases} \index{default gateways} Click the {\sffamily \bfseries Advanced} button to proceed with TCP/IP configuration. This opens a panel in which it is possible to create additional IP addresses for this interface. The technical name for the additional addresses is {\em{IP aliases}}, and additionally this panel permits the setting of more default gateways (routers). In most cases where DHCP is used, it will not be necessary to create additional settings. See \hyperlink{WXPP005}{Figure {\ref{WXPP005}}} to see the appearance of this panel. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WXPP005}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WXPP005}
{{\caption[{Advanced Network Settings}]{{{Advanced Network Settings}}}\label{WXPP005}}}
\end{center}
\end{figure}

  \index{DNS} \index{WINS} \index{DHCP} Fixed settings may be required for DNS and WINS if these settings are not provided automatically via DHCP.}

\item{\index{DNS server settings} \index{manually configured DNS settings} Click the {\sffamily \bfseries DNS} tab to add DNS server settings. The example system uses manually configured DNS settings. When finished making changes, click the {\sffamily \bfseries OK} to commit the settings. See \hyperlink{WXPP014}{Figure {\ref{WXPP014}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WXPP014}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WXPP014}
{{\caption[{DNS Configuration.}]{{{DNS Configuration.}}}\label{WXPP014}}}
\end{center}
\end{figure}

}

\item{\index{WINS} \index{manual WINS server entries} Click the {\sffamily \bfseries WINS} tab to add manual WINS server entries. This step demonstrates an example system that uses manually configured WINS settings. When finished making changes, click {\sffamily \bfseries OK} to commit the settings. See \hyperlink{WXPP009}{Figure {\ref{WXPP009}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WXPP009}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WXPP009}
{{\caption[{WINS Configuration}]{{{WINS Configuration}}}\label{WXPP009}}}
\end{center}
\end{figure}

}
\end{enumerate}
\subsubsection{MS Windows 2000}
\label{id2479640}\hypertarget{id2479640}{}%

\index{Windows 2000 Professional TCP/IP} \index{TCP/IP configuration panel} There are two paths to the Windows 2000 Professional TCP/IP configuration panel. Choose the access method that you prefer:

Click {\sffamily \bfseries Start -\textgreater{} Control Panel -\textgreater{} Network and Dial-up Connections}.

{\em{Alternatively,}} click {\sffamily \bfseries Start}, then right-click {\sffamily \bfseries My Network Places}, and select {\sffamily \bfseries Properties}.

\index{Windows XP Professional TCP/IP} The following procedure steps through the Windows XP Professional TCP/IP configuration process:
\begin{enumerate}

\item{Right-click on {\sffamily \bfseries Local Area Connection}, then click {\sffamily \bfseries Properties}. See \hyperlink{w2kp001}{Figure {\ref{w2kp001}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{w2kp001}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/w2kp001}
{{\caption[{Local Area Connection Properties.}]{{{Local Area Connection Properties.}}}\label{w2kp001}}}
\end{center}
\end{figure}

}

\item{\index{Local Area Connection Properties} \index{TCP/IP protocol settings} The Local Area Connection Properties is used to set TCP/IP protocol settings. Click on {\sffamily \bfseries Internet Protocol (TCP/IP)} in the {\sffamily \bfseries Components checked are used by this connection:} box, then click the {\sffamily \bfseries Properties} button.}

\item{\index{DHCP-enabled} \index{IP address automatically} The default setting is DHCP-enabled operation (i.e., {``}Obtain an IP address automatically{''}). See \hyperlink{w2kp002}{Figure {\ref{w2kp002}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{w2kp002}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/w2kp002}
{{\caption[{Internet Protocol (TCP/IP) Properties.}]{{{Internet Protocol (TCP/IP) Properties.}}}\label{w2kp002}}}
\end{center}
\end{figure}

  \index{DHCP} \index{protocol stack settings} Many network administrators will want to use DHCP to configure all client TCP/IP protocol stack settings. (For information on how to configure the ISC DHCP server for Windows client support, see, \hyperlink{DHCP}{Section {\ref{DHCP}}}.  \index{fixed IP address} \index{network clients} If it is necessary to provide a fixed IP address, click on {``}Use the following IP address{''} and enter the IP Address, the subnet mask, and the default gateway address in the boxes provided. For this example we are assuming that all network clients will be configured using DHCP.}

\item{Click the {\sffamily \bfseries Advanced} button to proceed with TCP/IP configuration. Refer to \hyperlink{w2kp003}{Figure {\ref{w2kp003}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{w2kp003}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/w2kp003}
{{\caption[{Advanced Network Settings.}]{{{Advanced Network Settings.}}}\label{w2kp003}}}
\end{center}
\end{figure}

  \index{DNS} \index{WINS} \index{DHCP} Fixed settings may be required for DNS and WINS if these settings are not provided automatically via DHCP.}

\item{\index{DNS server settings} \index{commit the settings} Click the {\sffamily \bfseries DNS} tab to add DNS server settings. The example system uses manually configured DNS settings. When finished making changes, click {\sffamily \bfseries OK} to commit the settings. See \hyperlink{w2kp004}{Figure {\ref{w2kp004}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{w2kp004}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/w2kp004}
{{\caption[{DNS Configuration.}]{{{DNS Configuration.}}}\label{w2kp004}}}
\end{center}
\end{figure}

}

\item{\index{manual WINS server entries} \index{WINS} Click the {\sffamily \bfseries WINS} tab to add manual WINS server entries. This step demonstrates an example system that uses manually configured WINS settings. When finished making changes, click {\sffamily \bfseries OK} to commit the settings. See \hyperlink{w2kp005}{Figure {\ref{w2kp005}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{w2kp005}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/w2kp005}
{{\caption[{WINS Configuration.}]{{{WINS Configuration.}}}\label{w2kp005}}}
\end{center}
\end{figure}

}
\end{enumerate}
\subsubsection{MS Windows Me}
\label{id2461036}\hypertarget{id2461036}{}%

\index{Windows Millennium edition (Me) TCP/IP} \index{Windows Millennium} \index{TCP/IP configuration} There are two paths to the Windows Millennium edition (Me) TCP/IP configuration panel. Choose the access method that you prefer:

Click {\sffamily \bfseries Start -\textgreater{} Control Panel -\textgreater{} Network Connections}.

\index{My Network Places} \index{Properties} {\em{Alternatively,}} click on {\sffamily \bfseries Start -\textgreater{}}, and right click on {\sffamily \bfseries My Network Places} then select {\sffamily \bfseries Properties}.

\index{Windows Me TCP/IP} The following procedure steps through the Windows Me TCP/IP configuration process:
\begin{enumerate}

\item{\index{Internet Protocol TCP/IP} In the box labeled {\sffamily \bfseries The following network components are installed:}, click on {\sffamily \bfseries Internet Protocol TCP/IP}, then click on the {\sffamily \bfseries Properties} button. See \hyperlink{WME001}{Figure {\ref{WME001}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME001}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME001}
{{\caption[{The Windows Me Network Configuration Panel.}]{{{The Windows Me Network Configuration Panel.}}}\label{WME001}}}
\end{center}
\end{figure}

}

\item{\index{DHCP} \index{TCP/IP} \index{ISC DHCP server} Many network administrators will want to use DHCP to configure all client TCP/IP protocol stack settings. (For information on how to configure the ISC DHCP server for Windows client support see \hyperlink{DHCP}{Section {\ref{DHCP}}}, \hyperlink{DHCP}{Section {\ref{DHCP}}}. The default setting on Windows Me workstations is for DHCP-enabled operation (i.e., {\sffamily \bfseries Obtain IP address automatically} is enabled). See \hyperlink{WME002}{Figure {\ref{WME002}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME002}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME002}
{{\caption[{IP Address.}]{{{IP Address.}}}\label{WME002}}}
\end{center}
\end{figure}

  \index{Specify an IP address} \index{subnet mask} \index{DHCP} If it is necessary to provide a fixed IP address, click on {\sffamily \bfseries Specify an IP address} and enter the IP Address and the subnet mask in the boxes provided. For this example we are assuming that all network clients will be configured using DHCP.}

\item{\index{DNS} \index{WINS} Fixed settings may be required for DNS and WINS if these settings are not provided automatically via DHCP.}

\item{\index{WINS server settings} If necessary, click the {\sffamily \bfseries DNS Configuration} tab to add DNS server settings. Click the {\sffamily \bfseries WINS Configuration} tab to add WINS server settings. The {\sffamily \bfseries Gateway} tab allows additional gateways (router addresses) to be added to the network interface settings. In most cases where DHCP is used, it will not be necessary to create these manual settings.}

\item{\index{WINS} \index{manually configured} The following example uses manually configured WINS settings. See \hyperlink{WME005}{Figure {\ref{WME005}}}. When finished making changes, click {\sffamily \bfseries OK} to commit the settings. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME005}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME005}
{{\caption[{DNS Configuration.}]{{{DNS Configuration.}}}\label{WME005}}}
\end{center}
\end{figure}

  \index{single DHCP server} \index{multiple Windows workgroups or domains} This is an example of a system that uses manually configured WINS settings. One situation where this might apply is on a network that has a single DHCP server that provides settings for multiple Windows workgroups or domains. See \hyperlink{WME003}{Figure {\ref{WME003}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME003}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME003}
{{\caption[{WINS Configuration.}]{{{WINS Configuration.}}}\label{WME003}}}
\end{center}
\end{figure}

}
\end{enumerate}
\subsection{Joining a Domain: Windows 2000/XP Professional}
\label{id2524668}\hypertarget{id2524668}{}%

\index{Windows NT/200x/XP Professional} \index{domain security} \index{domain member} \index{domain joining} Microsoft Windows NT/200x/XP Professional platforms can participate in domain security. This section steps through the process for making a Windows 200x/XP Professional machine a member of a domain security environment. It should be noted that this process is identical when joining a domain that is controlled by Windows NT4/200x as well as a Samba PDC.
\begin{enumerate}

\item{Click {\sffamily \bfseries Start}.}

\item{Right-click {\sffamily \bfseries My Computer}, then select {\sffamily \bfseries Properties}.}

\item{\index{Control Panel} The opening panel is the same one that can be reached by clicking {\sffamily \bfseries System} on the Control Panel. See \hyperlink{wxpp001}{Figure {\ref{wxpp001}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{wxpp001}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/wxpp001}
{{\caption[{The General Panel.}]{{{The General Panel.}}}\label{wxpp001}}}
\end{center}
\end{figure}

}

\item{\index{Computer Name} Click the {\sffamily \bfseries Computer Name} tab. This panel shows the {\sffamily \bfseries Computer Description}, the {\sffamily \bfseries Full computer name}, and the {\sffamily \bfseries Workgroup} or {\sffamily \bfseries Domain name}.  \index{Network ID} \index{configuration wizard} Clicking the {\sffamily \bfseries Network ID} button will launch the configuration wizard. Do not use this with Samba-3. If you wish to change the computer name or join or leave the domain, click the {\sffamily \bfseries Change} button. See \hyperlink{wxpp004}{Figure {\ref{wxpp004}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{wxpp004}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/wxpp004}
{{\caption[{The Computer Name Panel.}]{{{The Computer Name Panel.}}}\label{wxpp004}}}
\end{center}
\end{figure}

}

\item{Click on {\sffamily \bfseries Change}. This panel shows that our example machine (TEMPTATION) is in a workgroup called WORKGROUP. We will join the domain called MIDEARTH. See \hyperlink{wxpp006}{Figure {\ref{wxpp006}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{wxpp006}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/wxpp006}
{{\caption[{The Computer Name Changes Panel.}]{{{The Computer Name Changes Panel.}}}\label{wxpp006}}}
\end{center}
\end{figure}

}

\item{\index{domain radio button} Enter the name {\sffamily \bfseries MIDEARTH} in the field below the domain radio button.  This panel shows that our example machine (TEMPTATION) is set to join the domain called MIDEARTH. See \hyperlink{wxpp007}{Figure {\ref{wxpp007}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{wxpp007}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/wxpp007}
{{\caption[{The Computer Name Changes Panel ---  Domain MIDEARTH.}]{{{The Computer Name Changes Panel ---  Domain MIDEARTH.}}}\label{wxpp007}}}
\end{center}
\end{figure}

}

\item{\index{credentials} \index{username and password} Now click the {\sffamily \bfseries OK} button. A dialog box should appear to allow you to provide the credentials (username and password) of a domain administrative account that has the rights to add machines to the domain.  \index{root} Enter the name {``}root{''} and the root password from your Samba-3 server. See \hyperlink{wxpp008}{Figure {\ref{wxpp008}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{wxpp008}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/wxpp008}
{{\caption[{Computer Name Changes ---  Username and Password Panel.}]{{{Computer Name Changes ---  Username and Password Panel.}}}\label{wxpp008}}}
\end{center}
\end{figure}

}

\item{Click on {\sffamily \bfseries OK}.  \index{Welcome} \index{rebooted} The {``}Welcome to the MIDEARTH domain.{''} dialog box should appear. At this point the machine must be rebooted. Joining the domain is now complete.}
\end{enumerate}
\subsection{Domain Logon Configuration: Windows 9x/Me}
\label{id2525067}\hypertarget{id2525067}{}%

\index{Windows 9x/Me} \index{domain logon} \index{LanManager} We follow the convention used by most in saying that Windows 9x/Me machines can participate in domain logons. The truth is that these platforms can use only the LanManager network logon protocols.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Windows XP Home edition} \index{LanManager} \index{network logon} Windows XP Home edition cannot participate in domain or LanManager network logons.
\end{admonition}

\begin{enumerate}

\item{Right-click on the {\sffamily \bfseries Network Neighborhood} icon.}

\item{The Network Configuration Panel allows all common network settings to be changed. See \hyperlink{WME009}{Figure {\ref{WME009}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME009}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME009}
{{\caption[{The Network Panel.}]{{{The Network Panel.}}}\label{WME009}}}
\end{center}
\end{figure}

  \index{Client for Microsoft Networks} \index{Properties} Make sure that the {\sffamily \bfseries Client for Microsoft Networks} driver is installed as shown. Click on the {\sffamily \bfseries Client for Microsoft Networks} entry in {\sffamily \bfseries The following network components are installed:} box. Then click the {\sffamily \bfseries Properties} button.}

\item{\index{Networks Properties} \index{network logon} The Client for Microsoft Networks Properties panel is the correct location to configure network logon settings. See \hyperlink{WME010}{Figure {\ref{WME010}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME010}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME010}
{{\caption[{Client for Microsoft Networks Properties Panel.}]{{{Client for Microsoft Networks Properties Panel.}}}\label{WME010}}}
\end{center}
\end{figure}

  \index{Windows NT domain name} \index{domain name} Enter the Windows NT domain name, check the {\sffamily \bfseries Log on to Windows NT domain} box, and click {\sffamily \bfseries OK}.}

\item{\index{Identification} \index{workgroup} \index{computer name} Click on the {\sffamily \bfseries Identification} button. This is the location at which the workgroup (domain) name and the machine name (computer name) need to be set. See \hyperlink{WME013}{Figure {\ref{WME013}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME013}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME013}
{{\caption[{Identification Panel.}]{{{Identification Panel.}}}\label{WME013}}}
\end{center}
\end{figure}

}

\item{\index{Access Control} \index{group accounts} \index{domain user} \index{User-level access control} Now click the {\sffamily \bfseries Access Control} button. If you want to be able to assign share access permissions using domain user and group accounts, it is necessary to enable {\sffamily \bfseries User-level access control} as shown in this panel. See \hyperlink{WME014}{Figure {\ref{WME014}}}. 
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{WME014}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/WME014}
{{\caption[{Access Control Panel.}]{{{Access Control Panel.}}}\label{WME014}}}
\end{center}
\end{figure}

}
\end{enumerate}

% ------------------------   
% Section 
\section{Common Errors}
\label{id2525408}\hypertarget{id2525408}{}%

\index{networking systems} \index{errors that can afflict} The most common errors that can afflict Windows networking systems include:

\begin{itemize}
%--- Item
\item 
Incorrect IP address.


%--- Item
\item 
Incorrect or inconsistent netmasks.


%--- Item
\item 
Incorrect router address.


%--- Item
\item 
Incorrect DNS server address.


%--- Item
\item 
Incorrect WINS server address.


%--- Item
\item 
Use of a Network Scope setting ---  watch out for this one!

\end{itemize}

\index{Windows NT/200x/XP Professional} \index{cannot join domain} The most common reasons for which a Windows NT/200x/XP Professional client cannot join the Samba controlled domain are:

\begin{itemize}
%--- Item
\item 
{\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} does not have correct \smbconfoption{add machine script} settings.


%--- Item
\item 
{``}root{''} account is not in password backend database.


%--- Item
\item 
Attempt to use a user account instead of the {``}root{''} account to join a machine to the domain.


%--- Item
\item 
Open connections from the workstation to the server.


%--- Item
\item 
Firewall or filter configurations in place on either the client or the Samba server.

\end{itemize}
\cleardoublepage % ------------------------------------------------------------- 
% 
% PART Advanced Configuration
% 
% ------------------------------------------------------------- 
\part{Advanced Configuration}
\label{optional}\hypertarget{optional}{}%

% -------------------------------------------------------------
% PartIntro Valuable Nuts and Bolts Information 
% ------------------------------------------------------------- 	
\chapter*{Valuable Nuts and Bolts Information}
\label{id2408773}\hypertarget{id2408773}{}%

Samba has several features that you might want or might not want to use. The chapters in this part each cover specific Samba features.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Important and Critical Change Notes for the Samba 3.x Series 
% ------------------------------------------------------------- 	
\chapter{Important and Critical Change Notes for the Samba 3.x Series}
\label{ChangeNotes}\hypertarget{ChangeNotes}{}%

Please read this chapter carefully before update or upgrading Samba. You should expect to find only critical or very important information here. Comprehensive change notes and guidance information can be found in the section \hyperlink{upgrading-to-3.0}{Chapter {\ref{upgrading-to-3.0}}, {``}Updating and Upgrading Samba{''}}.

% ------------------------   
% Section 
\section{Important Samba-3.2.x Change Notes}
\label{id2493926}\hypertarget{id2493926}{}%

!!!!!!!!!!!!Add all critical update notes here!!!!!!!!!!!!!

% ------------------------   
% Section 
\section{Important Samba-3.0.x Change Notes}
\label{id2517405}\hypertarget{id2517405}{}%

These following notes pertain in particular to Samba 3.0.23 through Samba 3.0.25c (or more recent 3.0.25 update). Samba is a fluid and ever changing project. Changes throughout the 3.0.x series release are documented in this documention - See \hyperlink{oldupdatenotes}{Section {\ref{oldupdatenotes}}}.

Sometimes it is difficult to figure out which part, or parts, of the HOWTO documentation should be updated to reflect the impact of new or modified features. At other times it becomes clear that the documentation is in need of being restructured.

In recent times a group of Samba users has joined the thrust to create a new Samba Wiki\label{id2490206}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://wiki.samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2490206} that is slated to become the all-singing and all-dancing new face of Samba documentation. Hopefully, the Wiki will benefit from greater community input and thus may be kept more up to date. Until that golden dream materializes and matures it is necessary to continue to maintain the HOWTO. This chapter will document major departures from earlier behavior until such time as the body of this HOWTO is restructured or modified.

This chapter is new to the release of the HOWTO for Samba 3.0.23. It includes much of the notes provided in the {\texttt{\docbookhyphenatefilename{WHATSNEW.\dbz{}txt}}} file that is included with the Samba source code release tarball.
\subsection{User and Group Changes}
\label{id2490232}\hypertarget{id2490232}{}%

The change documented here affects unmapped user and group accounts only.

\index{user} \index{group} \index{Relative Identifiers|textit{see} {RID} } \index{net!groupmap} \index{net!rpc!vampire} The user and group internal management routines have been rewritten to prevent overlaps of assigned Relative Identifiers (RIDs). In the past the has been a potential problem when either manually mapping Unix groups with the {\bfseries{net groupmap}} command or when migrating a Windows domain to a Samba domain by executing: {\bfseries{net rpc vampire}}.

\index{SID} \index{SAM} \index{RID} \index{net!getlocalsid} Unmapped users are now assigned a SID in the {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}22-\dbz{}1}}} domain and unmapped groups are assigned a SID in the {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}22-\dbz{}2}}} domain. Previously they were assigned a RID within the SAM on the Samba server. For a domain controller this would have been under the authority of the domain SID where as on a member server or standalone server, this would have been under the authority of the local SAM (see the man page for {\bfseries{net getlocalsid}}).

\index{unmapped users} \index{unmapped groups} \index{SID} \index{NTFS} \index{GID} The result is that any unmapped users or groups on an upgraded Samba domain controller may be assigned a new SID. Because the SID rather than a name is stored in Windows security descriptors, this can cause a user to no longer have access to a resource for example if a file was copied from a Samba file server to a local Windows client NTFS partition. Any files stored on the Samba server itself will continue to be accessible because UNIX stores the UNIX GID and not the SID for authorization checks.

An example helps to illustrate the change:

\index{group mapping} \index{GID} \index{ACL} \index{SID} Assume that a group named {\em{developers}} exists with a UNIX GID of 782. In this case this user does not exist in Samba's group mapping table. It would be perfectly normal for this group to be appear in an ACL editor. Prior to Samba-3.0.23, the group SID might appear as {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}5-\dbz{}21-\dbz{}647511796-\dbz{}4126122067-\dbz{}3123570092-\dbz{}2565}}}.

\index{SID} \index{NTFS} \index{access} \index{group permissions} With the release of Samba-3.0.23, the group SID would be reported as {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}22-\dbz{}2-\dbz{}782}}}. Any security descriptors associated with files stored on a Windows NTFS disk partition will not allow access based on the group permissions if the user was not a member of the {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}5-\dbz{}21-\dbz{}647511796-\dbz{}4126122067-\dbz{}3123570092-\dbz{}2565}}} group. Because this group SID is {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}22-\dbz{}2-\dbz{}782}}} and not reported in a user's token, Windows would fail the authorization check even though both SIDs in some respect refer to the same UNIX group.

\index{group mapping} \index{SID} The workaround for versions of Samba prior to 3.0.23, is to create a manual domain group mapping entry for the group {\em{developers}} to point at the {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}5-\dbz{}21-\dbz{}647511796-\dbz{}4126122067-\dbz{}3123570092-\dbz{}2565}}} SID. With the release of Samba-3.0.23 this workaround is no longer needed.
\subsection{Essential Group Mappings}
\label{id2503859}\hypertarget{id2503859}{}%

Samba 3.0.x series releases before 3.0.23 automatically created group mappings for the essential Windows domain groups {\texttt{\docbookhyphenatedot{Domain Admins, Domain Users, Domain Guests}}}. Commencing with Samba 3.0.23 these mappings need to be created by the Samba administrator. Failure to do this may result in a failure to correctly authenticate and recoognize valid domain users. When this happens users will not be able to log onto the Windows client.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Group mappings are essentail only if the Samba servers is running as a PDC/BDC. Stand-alone servers do not require these group mappings.
\end{admonition}


The following mappings are required:

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{TOSH-domgroups}{}%
\captionswapskip{}{{\caption{Essential Domain Group Mappings}\label{TOSH-domgroups}}}
\captionswapskip{}\begin{tabular}{|c|c|c|}
\hline 
{{{\bfseries Domain Group}}} & {{{\bfseries RID}}} & {{{\bfseries Example UNIX Group}}} \tabularnewline
 \hline 
{{Domain Admins}} & {{512}} & {{root}} \tabularnewline
 \hline 
{{Domain Users}} & {{513}} & {{users}} \tabularnewline
 \hline 
{{Domain Guests}} & {{514}} & {{nobody}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


When the POSIX (UNIX) groups are stored in LDAP, it may be desirable to call these {\texttt{\docbookhyphenatedot{domadmins, domusers, domguests}}} respectively.

For further information regarding group mappings see \hyperlink{groupmapping}{Chapter {\ref{groupmapping}}, {``}Group Mapping: MS Windows and UNIX{''}}.
\subsection{Passdb Changes}
\label{id2503981}\hypertarget{id2503981}{}%

\index{backends} \index{GID} \index{SQL} \index{XML} The \smbconfoption{passdb backend} parameter no long accepts multiple passdb backends in a chained configuration. Also be aware that the SQL and XML based passdb modules have been removed in the Samba-3.0.23 release. More information regarding external support for a SQL passdb module can be found on the pdbsql\label{id2504027}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://pdbsql.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2504027} web site.
\subsection{Group Mapping Changes in Samba-3.0.23}
\label{id2504035}\hypertarget{id2504035}{}%

\index{default mapping} \index{Domain Admins} \index{smbpasswd} \index{tdbsam} \index{passdb backend} \index{group mappings} \index{GID} \index{SID} \index{IDMAP} \index{winbindd} \index{domain groups} The default mapping entries for groups such as {\texttt{\docbookhyphenatedot{Domain Admins}}} are no longer created when using an {\texttt{\docbookhyphenatedot{smbpasswd}}} file or a {\texttt{\docbookhyphenatedot{tdbsam}}} passdb backend. This means that it is necessary to explicitly execute the {\bfseries{net groupmap add}} to create group mappings, rather than use the {\bfseries{net groupmap modify}} method to create the Windows group SID to UNIX GID mappings. This change has no effect on winbindd's IDMAP functionality for domain groups.
\subsection{LDAP Changes in Samba-3.0.23}
\label{id2504347}\hypertarget{id2504347}{}%

\index{LDAP schema} \index{sambaSID} \index{OpenLDAP} \index{slapindex} \index{slapd.conf} There has been a minor update the Samba LDAP schema file. A substring matching rule has been added to the {\texttt{\docbookhyphenatedot{sambaSID}}} attribute definition. For OpenLDAP servers, this will require the addition of {\texttt{\docbookhyphenatedot{index sambaSID sub}}} to the {\texttt{\docbookhyphenatefilename{slapd.\dbz{}conf}}} configuration file. It will be necessary to execute the {\bfseries{slapindex}} command after making this change. There has been no change to the actual data storage schema.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Network Browsing 
% ------------------------------------------------------------- 	
\chapter{Network Browsing}
\label{NetworkBrowsing}\hypertarget{NetworkBrowsing}{}%

\index{browsing across subnets} \index{resolution of NetBIOS names} \index{browse list handling} \index{WINS} This chapter contains detailed information as well as a fast-track guide to implementing browsing across subnets and/or across workgroups (or domains). WINS is the best tool for resolution of NetBIOS names to IP addresses; however, WINS is not involved in browse list handling except by way of name-to-address resolution.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{WINS} What is WINS?

WINS is a facility that provides resolution of a NetBIOS name to its IP address. WINS is like a Dynamic-DNS service for NetBIOS networking names.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Windows 2000} \index{NetBIOS over TCP/IP} \index{DNS} \index{ADS} MS Windows 2000 and later versions can be configured to operate with no NetBIOS over TCP/IP. Samba-3 and later versions also support this mode of operation. When the use of NetBIOS over TCP/IP has been disabled, the primary means for resolution of MS Windows machine names is via DNS and Active Directory. The following information assumes that your site is running NetBIOS over TCP/IP.
\end{admonition}


% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2503598}\hypertarget{id2503598}{}%

Charles Dickens once referred to the past in these words: {``}{\em{It was the best of times, it was the worst of times.}}{''} The more we look back, the more we long for what was and hope it never returns.

\index{NetBIOS} \index{NetBIOS networking} \index{fickle} For many MS Windows network administrators, that statement sums up their feelings about NetBIOS networking precisely. For those who mastered NetBIOS networking, its fickle nature was just par for the course. For those who never quite managed to tame its lusty features, NetBIOS is like Paterson's Curse.

For those not familiar with botanical problems in Australia, Paterson's Curse, {\em{Echium plantagineum}}, was introduced to Australia from Europe during the mid-19th century. Since then it has spread rapidly. The high seed production, with densities of thousands of seeds per square meter, a seed longevity of more than 7 years, and an ability to germinate at any time of year, given the right conditions, are some of the features that make it such a persistent weed.

\index{Network Basic Input/Output System|textit{see} {NetBIOS} } \index{SMB} \index{NetBIOS} \index{TCP/IP} \index{Windows network clients} In this chapter we explore vital aspects of Server Message Block (SMB) networking with a particular focus on SMB as implemented through running NetBIOS (Network Basic Input/Output System) over TCP/IP. Since Samba does not implement SMB or NetBIOS over any other protocols, we need to know how to configure our network environment and simply remember to use nothing but TCP/IP on all our MS Windows network clients.

\index{WINS} \index{MS WINS} Samba provides the ability to implement a WINS (Windows Internetworking Name Server) and implements extensions to Microsoft's implementation of WINS. These extensions help Samba to effect stable WINS operations beyond the normal scope of MS WINS.

\index{NetBIOS over TCP/IP} \index{NetBIOS disabled} \index{WINS} WINS is exclusively a service that applies only to those systems that run NetBIOS over TCP/IP. MS Windows 200x/XP have the capacity to operate with support for NetBIOS disabled, in which case WINS is of no relevance. Samba supports this also.

\index{NetBIOS disabled} \index{DNS} \index{WINS} For those networks on which NetBIOS has been disabled (i.e., WINS is not required), the use of DNS is necessary for hostname resolution.

% ------------------------   
% Section 
\section{What Is Browsing?}
\label{id2517298}\hypertarget{id2517298}{}%

\index{browsing} \index{Network Neighborhood} \index{shares} \index{printers available} To most people, browsing means they can see the MS Windows and Samba servers in the Network Neighborhood, and when the computer icon for a particular server is clicked, it opens up and shows the shares and printers available on the target server.

What seems so simple is in fact a complex interaction of different technologies. The technologies (or methods) employed in making all of this work include:

\begin{itemize}
%--- Item
\item 
MS Windows machines register their presence to the network.


%--- Item
\item 
Machines announce themselves to other machines on the network.


%--- Item
\item 
One or more machines on the network collate the local announcements.


%--- Item
\item 
The client machine finds the machine that has the collated list of machines.


%--- Item
\item 
The client machine is able to resolve the machine names to IP addresses.


%--- Item
\item 
The client machine is able to connect to a target machine.

\end{itemize}

\index{browse list management} \index{name resolution} \index{nmbd} The Samba application that controls browse list management and name resolution is called {\texttt{\docbookhyphenatefilename{nmbd}}}. The configuration parameters involved in nmbd's operation are:

Browsing options:

\begin{itemize}
%--- Item
\item \smbconfoption{os level}

%--- Item
\item \smbconfoption{lm announce}

%--- Item
\item \smbconfoption{lm interval}

%--- Item
\item \smbconfoption{preferred master}(*)

%--- Item
\item \smbconfoption{local master}(*)

%--- Item
\item \smbconfoption{domain master}(*)

%--- Item
\item \smbconfoption{browse list}

%--- Item
\item \smbconfoption{enhanced browsing}
\end{itemize}

Name Resolution Method:

\begin{itemize}
%--- Item
\item \smbconfoption{name resolve order}(*)
\end{itemize}

WINS options:

\begin{itemize}
%--- Item
\item \smbconfoption{dns proxy}

%--- Item
\item \smbconfoption{wins proxy}

%--- Item
\item \smbconfoption{wins server}(*)

%--- Item
\item \smbconfoption{wins support}(*)

%--- Item
\item \smbconfoption{wins hook}
\end{itemize}

Those marked with an (*) are the only options that commonly may need to be modified. Even if none of these parameters is set, {\texttt{\docbookhyphenatefilename{nmbd}}} will still do its job.

\index{WINS} \index{WINS Server} \index{WINS Support} \index{nmbd} \index{mutually exclusive options} For Samba, the WINS Server and WINS Support are mutually exclusive options. When {\bfseries{nmbd}} is started it will fail to execute if both options are set in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. The {\bfseries{nmbd}} understands that when it spawns an instance of itself to run as a WINS server that it has to use its own WINS server also.

% ------------------------   
% Section 
\section{Discussion}
\label{netdiscuss}\hypertarget{netdiscuss}{}%

\index{SMB-based messaging} \index{NetBIOS} \index{NetBIOS} \index{phasing out NetBIOS} All MS Windows networking uses SMB-based messaging. SMB messaging may be implemented with or without NetBIOS. MS Windows 200x supports NetBIOS over TCP/IP for backwards compatibility. Microsoft appears intent on phasing out NetBIOS support.
\subsection{NetBIOS over TCP/IP}
\label{id2519020}\hypertarget{id2519020}{}%

\index{encapsulating} \index{broadcast} \index{unicast} \index{UDP} Samba implements NetBIOS, as does MS Windows NT/200x/XP, by encapsulating it over TCP/IP. NetBIOS-based networking uses broadcast messaging to effect browse list management. When running NetBIOS over TCP/IP, this uses UDP-based messaging. UDP messages can be broadcast or unicast.

\index{UDP} Normally, only unicast UDP messaging can be forwarded by routers. The \smbconfoption{remote announce} parameter to smb.conf helps to project browse announcements to remote network segments via unicast UDP. Similarly, the \smbconfoption{remote browse sync} parameter of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} implements browse list collation using unicast UDP.

The methods used by MS Windows to perform name lookup requests (name resolution) is determined by a configuration parameter called the NetBIOS node-type. There are four basic NetBIOS node types:
\index{b-node}\index{p-node}\index{m-node}\index{h-node}\index{node-type}\index{WINS}\index{broadcast}\index{unicast}
\begin{itemize}
%--- Item
\item 
{\em{b-node (type 0x01):}} The Windows client will use only NetBIOS broadcast requests using UDP broadcast.


%--- Item
\item 
{\em{p-node (type 0x02):}} The Windows client will use point-to-point (NetBIOS unicast) requests using UDP unicast directed to a WINS server.


%--- Item
\item 
{\em{m-node (type 0x04):}} The Windows client will first use NetBIOS broadcast requests using UDP broadcast, then it will use (NetBIOS unicast) requests using UDP unicast directed to a WINS server.


%--- Item
\item 
{\em{h-node (type 0x08):}} The Windows client will use (NetBIOS unicast) requests using UDP unicast directed to a WINS server, then it will use NetBIOS broadcast requests using UDP broadcast.

\end{itemize}

\index{h-node} \index{hybrid} \index{enables NetBIOS over TCP/IP} \index{WINS} \index{broadcast-based} \index{name resolution} The default Windows network client (or server) network configuration enables NetBIOS over TCP/IP and b-node configuration. The use of WINS makes most sense with h-node (hybrid mode) operation so that in the event of a WINS breakdown or non-availability, the client can use broadcast-based name resolution.

\index{LMB|textit{see} {Local Master Browser} } \index{Local Master Browser} \index{SMB} \index{nmbd} \index{WINS} \index{cross-segment browsing} \index{network segment} In those networks where Samba is the only SMB server technology, wherever possible {\texttt{\docbookhyphenatefilename{nmbd}}} should be configured on one machine as the WINS server. This makes it easy to manage the browsing environment. If each network segment is configured with its own Samba WINS server, then the only way to get cross-segment browsing to work is by using the \smbconfoption{remote announce} and the \smbconfoption{remote browse sync} parameters to your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

\index{WINS} If only one WINS server is used for an entire multisegment network, then the use of the \smbconfoption{remote announce} and the \smbconfoption{remote browse sync} parameters should not be necessary.

\index{replication!WINS} As of Samba-3, WINS replication is being worked on. The bulk of the code has been committed, but it still needs maturation. This is not a supported feature of the Samba-3.0.20 release. Hopefully, this will become a supported feature of one of the Samba-3 release series. The delay is caused by the fact that this feature has not been of sufficient significance to inspire someone to pay a developer to complete it.

\index{WINS} \index{MS-WINS replication} \index{redundancy} \index{DNS} \index{NetBIOSless SMB over TCP/IP} \index{local names} \index{subnets} \index{multiple WINS servers} Right now Samba WINS does not support MS-WINS replication. This means that when setting up Samba as a WINS server, there must only be one {\texttt{\docbookhyphenatefilename{nmbd}}} configured as a WINS server on the network. Some sites have used multiple Samba WINS servers for redundancy (one server per subnet) and then used \smbconfoption{remote browse sync} and \smbconfoption{remote announce} to effect browse list collation across all segments. Note that this means clients will only resolve local names and must be configured to use DNS to resolve names on other subnets in order to resolve the IP addresses of the servers they can see on other subnets. This setup is not recommended but is mentioned as a practical consideration (i.e., an {``}if all else fails{''} scenario). NetBIOS over TCP/IP is an ugly and difficult to manage protocol. Its replacement, NetBIOSless SMB over TCP/IP is not without its own manageability concerns. NetBIOS based networking is a life of compromise and trade-offs. WINS stores information that cannot be stored in DNS; consequently, DNS is a poor substitute for WINS given that when NetBIOS over TCP/IP is used, Windows clients are designed to use WINS.

\index{broadcast messages} \index{repeated intervals} \index{across network segments} Lastly, take note that browse lists are a collection of unreliable broadcast messages that are repeated at intervals of not more than 15 minutes. This means that it will take time to establish a browse list, and it can take up to 45 minutes to stabilize, particularly across network segments.

\index{Windows 200x/XP} When an MS Windows 200x/XP system attempts to resolve a host name to an IP address, it follows a defined path:

\begin{enumerate}
%--- Item
\item 
Checks the {\texttt{\docbookhyphenatefilename{hosts}}} file. It is located in {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\Drivers\docbooktolatexgobble\string\\etc}}}.


%--- Item
\item 
Does a DNS lookup.


%--- Item
\item 
Checks the NetBIOS name cache.


%--- Item
\item 
Queries the WINS server.


%--- Item
\item 
Does a broadcast name lookup over UDP.


%--- Item
\item 
Looks up entries in LMHOSTS, located in {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\Drivers\docbooktolatexgobble\string\\etc}}}.

\end{enumerate}

\index{WINS} \index{NetBIOS over TCP/IP} \index{name lookups} \index{DNS} Given the nature of how the NetBIOS over TCP/IP protocol is implemented, only WINS is capable of resolving with any reliability name lookups for service-oriented names such as TEMPTATION\textless{}1C\textgreater{} ---  a NetBIOS name query that seeks to find network logon servers. DNS has no concept of service-oriented names such as this. In fact, the Microsoft ADS implementation specifically manages a whole range of extended service-oriented DNS entries. This type of facility is not implemented and is not supported for the NetBIOS over TCP/IP protocol namespace.
\subsection{TCP/IP without NetBIOS}
\label{id2532174}\hypertarget{id2532174}{}%

\index{NetBIOS} \index{NetBIOS-less} \index{DNS} All TCP/IP-enabled systems use various forms of hostname resolution. The primary methods for TCP/IP hostname resolution involve either a static file ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}}) or the Domain Name System (DNS). DNS is the technology that makes the Internet usable. DNS-based hostname resolution is supported by nearly all TCP/IP-enabled systems. Only a few embedded TCP/IP systems do not support DNS.

\index{DNS} \index{DDNS} \index{ipconfig} \index{Dynamic DNS|textit{see} {DDNS} } Windows 200x/XP can register its hostname with a Dynamic DNS server (DDNS). It is possible to force register with a dynamic DNS server in Windows 200x/XP using {\bfseries{ipconfig /registerdns}}.

\index{ADS} \index{DNS} \index{severely impaired} With Active Directory, a correctly functioning DNS server is absolutely essential. In the absence of a working DNS server that has been correctly configured, MS Windows clients and servers will be unable to locate each other, so network services consequently will be severely impaired.

\index{raw SMB over TCP/IP} \index{No NetBIOS layer} \index{NetBIOS} \index{domain member server} \index{DNS} \index{ADS} Use of raw SMB over TCP/IP (No NetBIOS layer) can be done only with Active Directory domains. Samba is not an Active Directory domain controller: ergo, it is not possible to run Samba as a domain controller and at the same time {\em{not}} use NetBIOS. Where Samba is used as an Active Directory domain member server (DMS) it is possible to configure Samba to not use NetBIOS over TCP/IP. A Samba DMS can integrate fully into an Active Directory domain, however, if NetBIOS over TCP/IP is disabled, it is necessary to manually create appropriate DNS entries for the Samba DMS because they will not be automatically generated either by Samba, or by the ADS environment.
\subsection{DNS and Active Directory}
\label{adsdnstech}\hypertarget{adsdnstech}{}%

\index{DNS!Active Directory} \index{DDNS} \index{ADS} \index{SRV records} \index{DNS!SRV records} Occasionally we hear from UNIX network administrators who want to use a UNIX-based DDNS server in place of the Microsoft DNS server. While this might be desirable to some, the MS Windows 200x DNS server is autoconfigured to work with Active Directory. It is possible to use BIND version 8 or 9, but it will almost certainly be necessary to create service records (SRV records) so MS Active Directory clients can resolve hostnames to locate essential network services. The following are some of the default service records that Active Directory requires:

\index{DDNS} \index{ADS} \index{BIND9} The use of DDNS is highly recommended with Active Directory, in which case the use of BIND9 is preferred for its ability to adequately support the SRV (service) records that are needed for Active Directory. Of course, when running ADS, it makes sense to use Microsoft's own DDNS server because of the natural affinity between ADS and MS DNS.

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\_ldap.\_tcp.pdc.\_msdcs.{\em{Domain}}}]\null{}
This provides the address of the Windows NT PDC for the domain.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\_ldap.\_tcp.pdc.\_msdcs.{\em{DomainTree}}}]\null{}
Resolves the addresses of global catalog servers in the domain.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\_ldap.\_tcp.{\em{site}}.sites.writable.\_msdcs.{\em{Domain}}}]\null{}
Provides list of domain controllers based on sites.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\_ldap.\_tcp.writable.\_msdcs.{\em{Domain}}}]\null{}
Enumerates list of domain controllers that have the writable copies of the Active Directory data store.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\_ldap.\_tcp.{\em{GUID}}.domains.\_msdcs.{\em{DomainTree}}}]\null{}
Entry used by MS Windows clients to locate machines using the global unique identifier.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\_ldap.\_tcp.{\em{Site}}.gc.\_msdcs.{\em{DomainTree}}}]\null{}
Used by Microsoft Windows clients to locate the site configuration-dependent global catalog server.
\end{description}

Specific entries used by Microsoft clients to locate essential services for an example domain called {\texttt{\docbookhyphenatedot{quenya.org}}} include:

\begin{itemize}
%--- Item
\item 
\_kerberos.\_udp.quenya.org ---  Used to contact the KDC server via UDP. This entry must list port 88 for each KDC.


%--- Item
\item 
\_kpasswd.\_udp.quenya.org ---  Used to locate the {\texttt{\docbookhyphenatedot{kpasswd}}} server when a user password change must be processed. This record must list port 464 on the master KDC.


%--- Item
\item 
\_kerberos.\_tcp.quenya.org ---  Used to locate the KDC server via TCP. This entry must list port 88 for each KDC.


%--- Item
\item 
\_ldap.\_tcp.quenya.org ---  Used to locate the LDAP service on the PDC. This record must list port 389 for the PDC.


%--- Item
\item 
\_kpasswd.\_tcp.quenya.org ---  Used to locate the {\texttt{\docbookhyphenatedot{kpasswd}}} server to permit user password changes to be processed. This must list port 464.


%--- Item
\item 
\_gc.\_tcp.quenya.org ---  Used to locate the global catalog server for the top of the domain. This must list port 3268.

\end{itemize}

The following records are also used by the Windows domain member client to locate vital services on the Windows ADS domain controllers.

\begin{itemize}
%--- Item
\item 
\_ldap.\_tcp.pdc.\_msdcs.quenya.org


%--- Item
\item 
\_ldap.gc.\_msdcs.quenya.org


%--- Item
\item 
\_ldap.default-first-site-name.\_sites.gc.\_msdcs.quenya.org


%--- Item
\item 
\_ldap.\{SecID\}.domains.\_msdcs.quenya.org


%--- Item
\item 
\_ldap.\_tcp.dc.\_msdcs.quenya.org


%--- Item
\item 
\_kerberos.\_tcp.dc.\_msdcs.quenya.org


%--- Item
\item 
\_ldap.default-first-site-name.\_sites.dc.\_msdcs.quenya.org


%--- Item
\item 
\_kerberos.default-first-site-name.\_sites.dc.\_msdcs.queyna.org


%--- Item
\item 
SecID.\_msdcs.quenya.org

\end{itemize}

Presence of the correct DNS entries can be validated by executing: 
\begin{Verbatim}[]

root#  dig @frodo -t any _ldap._tcp.dc._msdcs.quenya.org

; <lt;>> DiG 9.2.2 <lt;>> @frodo -t any _ldap._tcp.dc._msdcs.quenya.org
;; global options:  printcmd
;; Got answer:
;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 3072
;; flags: qr aa rd ra; QUERY: 1, ANSWER: 2, AUTHORITY: 0, ADDITIONAL: 2


;; QUESTION SECTION:
;_ldap._tcp.dc._msdcs.quenya.org. IN        ANY


;; ANSWER SECTION:
_ldap._tcp.dc._msdcs.quenya.org. 600 IN SRV 0 100 389 frodo.quenya.org.
_ldap._tcp.dc._msdcs.quenya.org. 600 IN SRV 0 100 389 noldor.quenya.org.


;; ADDITIONAL SECTION:
frodo.quenya.org.  3600  IN      A       10.1.1.16
noldor.quenya.org. 1200  IN      A       10.1.1.17


;; Query time: 0 msec
;; SERVER: frodo#53(10.1.1.16)
;; WHEN: Wed Oct  7 14:39:31 2004
;; MSG SIZE  rcvd: 171

\end{Verbatim}


% ------------------------   
% Section 
\section{How Browsing Functions}
\label{id2500005}\hypertarget{id2500005}{}%

\index{register NetBIOS names} \index{LMHOSTS} \index{DNS} \index{WINS} \index{WINS server address} MS Windows machines register their NetBIOS names (i.e., the machine name for each service type in operation) on startup. The exact method by which this name registration takes place is determined by whether or not the MS Windows client/server has been given a WINS server address, whether or not LMHOSTS lookup is enabled, whether or not DNS for NetBIOS name resolution is enabled, and so on.

\index{WINS server} \index{name lookups} \index{UDP} In the case where there is no WINS server, all name registrations as well as name lookups are done by UDP broadcast. This isolates name resolution to the local subnet, unless LMHOSTS is used to list all names and IP addresses. In such situations, Samba provides a means by which the Samba server name may be forcibly injected into the browse list of a remote MS Windows network (using the \smbconfoption{remote announce} parameter).

\index{WINS} \index{UDP unicast} \index{name resolution across routed networks} Where a WINS server is used, the MS Windows client will use UDP unicast to register with the WINS server. Such packets can be routed, and thus WINS allows name resolution to function across routed networks.

\index{LMB} \index{local master browser|textit{see} {LMB} } \index{WINS} \index{LMHOSTS} \index{DMB} \index{browse list} \index{election} \index{election criteria} During the startup process, an election takes place to create a local master browser (LMB) if one does not already exist. On each NetBIOS network one machine will be elected to function as the domain master browser (DMB). This domain browsing has nothing to do with MS security Domain Control. Instead, the DMB serves the role of contacting each LMB (found by asking WINS or from LMHOSTS) and exchanging browse list contents. This way every master browser will eventually obtain a complete list of all machines that are on the network. Every 11 to 15 minutes an election is held to determine which machine will be the master browser. By the nature of the election criteria used, the machine with the highest uptime, or the most senior protocol version or other criteria, will win the election as DMB.

\index{WINS server} \index{DMB} \index{NetBIOS name type} \index{n security context} \index{network segment} \index{authoritive} \index{browse list maintainers} \index{LMB} Where a WINS server is used, the DMB registers its IP address with the WINS server using the name of the domain and the NetBIOS name type 1B (e.g., DOMAIN\textless{}1B\textgreater{}). All LMBs register their IP addresses with the WINS server, also with the name of the domain and the NetBIOS name type of 1D. The 1B name is unique to one server within the domain security context, and only one 1D name is registered for each network segment. Machines that have registered the 1D name will be authoritive browse list maintainers for the network segment they are on. The DMB is responsible for synchronizing the browse lists it obtains from the LMBs.

\index{name resolution} Clients wishing to browse the network make use of this list but also depend on the availability of correct name resolution to the respective IP address or addresses.

\index{browsing intrinsics} Any configuration that breaks name resolution and/or browsing intrinsics will annoy users because they will have to put up with protracted inability to use the network services.

\index{forced synchronization} \index{LMB} \index{bridges networks} \index{cross-subnet browsing} \index{DNS} \index{/etc/hosts} Samba supports a feature that allows forced synchronization of browse lists across routed networks using the \smbconfoption{remote browse sync} parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. This causes Samba to contact the LMB on a remote network and to request browse list synchronization. This effectively bridges two networks that are separated by routers. The two remote networks may use either broadcast-based name resolution or WINS-based name resolution, but it should be noted that the \smbconfoption{remote browse sync} parameter provides browse list synchronization ---  and that is distinct from name-to-address resolution. In other words, for cross-subnet browsing to function correctly, it is essential that a name-to-address resolution mechanism be provided. This mechanism could be via DNS, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}}, and so on.
\subsection{Configuring Workgroup Browsing}
\label{DMB}\hypertarget{DMB}{}%

\index{cross-subnet browsing} \index{DMB} \index{PDC} \index{LMB} \index{isolated workgroup} \index{workgroup} To configure cross-subnet browsing on a network containing machines in a workgroup, not an NT domain, you need to set up one Samba server to be the DMB (note that this is not the same as a Primary Domain Controller, although in an NT domain the same machine plays both roles). The role of a DMB is to collate the browse lists from LMB on all the subnets that have a machine participating in the workgroup. Without one machine configured as a DMB, each subnet would be an isolated workgroup unable to see any machines on another subnet. It is the presence of a DMB that makes cross-subnet browsing possible for a workgroup.

\index{DMB} In a workgroup environment the DMB must be a Samba server, and there must only be one DMB per workgroup name. To set up a Samba server as a DMB, set the following option in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	domain master = yes
\end{lstlisting}


\index{DMB} \index{LMB} The DMB should preferably be the LMB for its own subnet. In order to achieve this, set the following options in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{dmbexample}{Example {\ref{dmbexample}}}

\begin{example}%
\hypertarget{dmbexample}{}%
\captionswapskip{}{{\caption{Domain Master Browser smb.conf}\label{dmbexample}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	domain master = yes
 	local master = yes
 	preferred master = yes
 	os level = 65
\end{lstlisting}
\end{example}


\index{DMB} \index{WINS server} The DMB may be the same machine as the WINS server, if necessary.

\index{subnets} \index{LMB} \index{rebooted} Next, you should ensure that each of the subnets contains a machine that can act as an LMB for the workgroup. Any MS Windows NT/200x/XP machine should be able to do this, as will Windows 9x/Me machines (although these tend to get rebooted more often, so it is not such a good idea to use them). To make a Samba server an LMB, set the following options in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{lmbexample}{Example {\ref{lmbexample}}}

\begin{example}%
\hypertarget{lmbexample}{}%
\captionswapskip{}{{\caption{Local master browser smb.conf}\label{lmbexample}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	domain master = no
 	local master = yes
 	preferred master = yes
 	os level = 65
\end{lstlisting}
\end{example}


\index{LMB} Do not do this for more than one Samba server on each subnet, or they will war with each other over which is to be the LMB.

\index{LMB} \index{browser election} The \smbconfoption{local master} parameter allows Samba to act as a LMB. The \smbconfoption{preferred master} causes {\bfseries{nmbd}} to force a browser election on startup and the \smbconfoption{os level} parameter sets Samba high enough so it should win any browser elections.

\index{disable LMB} If you have an NT machine on the subnet that you wish to be the LMB, you can disable Samba from becoming an LMB by setting the following options in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{nombexample}{Example {\ref{nombexample}}}.


\begin{example}%
\hypertarget{nombexample}{}%
\captionswapskip{}{{\caption{smb.conf for Not Being a Master Browser}\label{nombexample}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	domain master = no
 	local master = no
 	preferred master = no
 	os level = 0
\end{lstlisting}
\end{example}


\subsection{Domain Browsing Configuration}
\label{id2533488}\hypertarget{id2533488}{}%

\index{DMB} \index{PDC} \index{registers} \index{WINS} If you are adding Samba servers to a Windows NT domain, then you must not set up a Samba server as a DMB. By default, a Windows NT PDC for a domain is also the DMB for that domain. Network browsing may break if a Samba server other than the PDC registers the DMB NetBIOS name ({\ttfamily\itshape{\docbookhyphenatedot{DOMAIN}}}\textless{}1B\textgreater{}) with WINS.

\index{Local Master Browser} For subnets other than the one containing the Windows NT PDC, you may set up Samba servers as LMBs as described. To make a Samba server a Local Master Browser, set the following options in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{remsmb}{Example {\ref{remsmb}}}

\begin{example}%
\hypertarget{remsmb}{}%
\captionswapskip{}{{\caption{Local Master Browser smb.conf}\label{remsmb}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	domain master = no
 	local master = yes
 	preferred master = yes
 	os level = 65
\end{lstlisting}
\end{example}


\index{election} \index{LMB} If you wish to have a Samba server fight the election with machines on the same subnet, you may set the \smbconfoption{os level} parameter to lower levels. By doing this you can tune the order of machines that will become LMBs if they are running. For more details on this, refer to \hyperlink{browse-force-master}{Section {\ref{browse-force-master}}}.

\index{domain members} \index{browser elections} \index{LMB} If you have Windows NT machines that are members of the domain on all subnets and you are sure they will always be running, you can disable Samba from taking part in browser elections and ever becoming an LMB by setting the following options in the \smbconfsection{[global]} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{xremmb}{Example {\ref{xremmb}}}


\begin{example}%
\hypertarget{xremmb}{}%
\captionswapskip{}{{\caption{smb.\dbz{}conf for Not Being a master browser}\label{xremmb}}}
\captionswapskip{}\smbconfsection{[global]}\smbconfoption{domain master} = no\smbconfoption{local master} = no\smbconfoption{preferred master} = no\smbconfoption{os level} = 0\end{example}


\subsection{Forcing Samba to Be the Master}
\label{browse-force-master}\hypertarget{browse-force-master}{}%

\index{master browser} \index{election process} \index{broadcasts} \index{election packet} \index{bias} \index{election} \index{precedence} Who becomes the master browser is determined by an election process using broadcasts. Each election packet contains a number of parameters that determine what precedence (bias) a host should have in the election. By default Samba uses a low precedence and thus loses elections to just about every Windows network server or client.

If you want Samba to win elections, set the \smbconfoption{os level} global option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to a higher number. It defaults to 20. Using 34 would make it win all elections over every other system (except other Samba systems).

An \smbconfoption{os level} of two would make it beat Windows for Workgroups and Windows 9x/Me, but not MS Windows NT/200x Server. An MS Windows NT/200x Server domain controller uses level 32. The maximum os level is 255.

\index{force an election} \index{potential master browsers} \index{local subnet} \index{LMB} If you want Samba to force an election on startup, set the \smbconfoption{preferred master} global option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to {\texttt{\docbookhyphenatedot{yes}}}. Samba will then have a slight advantage over other potential master browsers that are not preferred master browsers. Use this parameter with care, because if you have two hosts (whether they are Windows 9x/Me or NT/200x/XP or Samba) on the same local subnet both set with \smbconfoption{preferred master} to {\texttt{\docbookhyphenatedot{yes}}}, then periodically and continually they will force an election in order to become the LMB.

\index{DMB} \index{LAN} \index{WAN} \index{LMB} \index{broadcast isolated subnet} If you want Samba to be a {\em{DMB}}, then it is recommended that you also set \smbconfoption{preferred master} to {\texttt{\docbookhyphenatedot{yes}}}, because Samba will not become a DMB for the whole of your LAN or WAN if it is not also a LMB on its own broadcast isolated subnet.

\index{DMB} \index{automatic redundancy} \index{UDP} \index{network bandwidth} \index{browser elections} It is possible to configure two Samba servers to attempt to become the DMB for a domain. The first server that comes up will be the DMB. All other Samba servers will attempt to become the DMB every 5 minutes. They will find that another Samba server is already the DMB and will fail. This provides automatic redundancy should the current DMB fail. The network bandwidth overhead of browser elections is relatively small, requiring approximately four UDP packets per machine per election. The maximum size of a UDP packet is 576 bytes.
\subsection{Making Samba the Domain Master}
\label{id2534004}\hypertarget{id2534004}{}%

\index{DMB} \index{collating} \index{browse lists} \index{browsing} The domain master browser is responsible for collating the browse lists of multiple subnets so browsing can occur between subnets. You can make Samba act as the domain master browser by setting \smbconfoption{domain master} = yes in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. By default it will not be a domain master browser.

\index{workgroup} \index{network browsing problems} Do not set Samba to be the domain master for a workgroup that has the same name as an NT/200x domain. If Samba is configured to be the domain master for a workgroup that is present on the same network as a Windows NT/200x domain that has the same name, network browsing problems will certainly be experienced.

When Samba is the domain master and the master browser, it will listen for master announcements (made roughly every 12 minutes) from LMBs on other subnets and then contact them to synchronize browse lists.

\index{win election} \index{force election} If you want Samba to be the domain master, you should also set the \smbconfoption{os level} high enough to make sure it wins elections, and set \smbconfoption{preferred master} to {\texttt{\docbookhyphenatedot{yes}}}, to get Samba to force an election on startup.

\index{WINS server} \index{resolve NetBIOS names} All servers (including Samba) and clients should be using a WINS server to resolve NetBIOS names. If your clients are only using broadcasting to resolve NetBIOS names, then two things will occur:

\begin{enumerate}
%--- Item
\item 
\index{LMB} \index{DMB} LMBs will be unable to find a DMB because they will be looking only on the local subnet.


%--- Item
\item 
\index{domain-wide browse list} If a client happens to get hold of a domain-wide browse list and a user attempts to access a host in that list, it will be unable to resolve the NetBIOS name of that host.

\end{enumerate}

\index{WINS} If, however, both Samba and your clients are using a WINS server, then:

\begin{enumerate}
%--- Item
\item 
LMBs will contact the WINS server and, as long as Samba has registered that it is a DMB with the WINS server, the LMB will receive Samba's IP address as its DMB.


%--- Item
\item 
When a client receives a domain-wide browse list and a user attempts to access a host in that list, it will contact the WINS server to resolve the NetBIOS name of that host. As long as that host has registered its NetBIOS name with the same WINS server, the user will be able to see that host..

\end{enumerate}
\subsection{Note about Broadcast Addresses}
\label{id2538015}\hypertarget{id2538015}{}%

\index{zero-based broadcast} If your network uses a zero-based broadcast address (for example, if it ends in a 0), then you will strike problems. Windows for Workgroups does not seem to support a zeros broadcast, and you will probably find that browsing and name lookups will not work.
\subsection{Multiple Interfaces}
\label{id2538036}\hypertarget{id2538036}{}%

\index{multiple network interfaces} Samba supports machines with multiple network interfaces. If you have multiple interfaces, you will need to use the \smbconfoption{interfaces} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to configure them. For example, the machine you are working with has 4 network interfaces; {\texttt{\docbookhyphenatedot{eth0}}}, {\texttt{\docbookhyphenatedot{eth1}}}, {\texttt{\docbookhyphenatedot{eth2}}}, {\texttt{\docbookhyphenatedot{eth3}}} and only interfaces {\texttt{\docbookhyphenatedot{eth1}}} and {\texttt{\docbookhyphenatedot{eth4}}} should be used by Samba. In this case, the following {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file entries would permit that intent: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	interfaces = eth1, eth4
 	bind interfaces only = Yes
\end{lstlisting}
 \index{port 135} \index{port 137} \index{port 138} \index{port 139} \index{port 445} \index{UDP} \index{TCP} The \smbconfoption{bind interfaces only} = Yes is necessary to exclude TCP/IP session services (ports 135, 139, and 445) over the interfaces that are not specified. Please be aware that {\bfseries{nmbd}} will listen for incoming UDP port 137 packets on the unlisted interfaces, but it will not answer them. It will, however, send its broadcast packets over the unlisted interfaces. Total isolation of ethernet interface requires the use of a firewall to block ports 137 and 138 (UDP), and ports 135, 139, and 445 (TCP) on all network interfaces that must not be able to access the Samba server.
\subsection{Use of the Remote Announce Parameter}
\label{id2538180}\hypertarget{id2538180}{}%

The \smbconfoption{remote announce} parameter of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} can be used to forcibly ensure that all the NetBIOS names on a network get announced to a remote network. The syntax of the \smbconfoption{remote announce} parameter is: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	remote announce = 192.168.12.23 [172.16.21.255] ...
\end{lstlisting}
 {\em{or}} 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	remote announce = 192.168.12.23/MIDEARTH [172.16.21.255/ELVINDORF] ...
\end{lstlisting}
 where: 
\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{{\ttfamily\itshape{\docbookhyphenatedot{192.168.12.23}}} and {\ttfamily\itshape{\docbookhyphenatedot{172.16.21.255}}}}]\null{}
\index{LMB|textit{see} {Local Master Browser} } \index{Local Master Browser} is either the LMB IP address or the broadcast address of the remote network. That is, the LMB is at 192.168.1.23, or the address could be given as 172.16.21.255 where the netmask is assumed to be 24 bits (255.255.255.0). When the remote announcement is made to the broadcast address of the remote network, every host will receive our announcements. This is noisy and therefore undesirable but may be necessary if we do not know the IP address of the remote LMB.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{{\ttfamily\itshape{\docbookhyphenatedot{WORKGROUP}}}}]\null{}
is optional and can be either our own workgroup or that of the remote network. If you use the workgroup name of the remote network, our NetBIOS machine names will end up looking like they belong to that workgroup. This may cause name resolution problems and should be avoided.
\end{description}

\subsection{Use of the Remote Browse Sync Parameter}
\label{id2538285}\hypertarget{id2538285}{}%

\index{LMB} \index{synchronize} The \smbconfoption{remote browse sync} parameter of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} is used to announce to another LMB that it must synchronize its NetBIOS name list with our Samba LMB. This works only if the Samba server that has this option is simultaneously the LMB on its network segment.

The syntax of the \smbconfoption{remote browse sync} parameter is: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	remote browse sync
\end{lstlisting}
 \index{LMB} \index{remote segment} where {\ttfamily\itshape{\docbookhyphenatedot{192.168.10.40}}} is either the IP address of the remote LMB or the network broadcast address of the remote segment.

% ------------------------   
% Section 
\section{WINS: The Windows Internetworking Name Server}
\label{id2538356}\hypertarget{id2538356}{}%

\index{WINS} \index{name\_type} \index{LanManager-compatible} Use of WINS (either Samba WINS or MS Windows NT Server WINS) is highly recommended. Every NetBIOS machine registers its name together with a name\_type value for each of several types of service it has available. It registers its name directly as a unique (the type 0x03) name. It also registers its name if it is running the LanManager-compatible server service (used to make shares and printers available to other users) by registering the server (the type 0x20) name.

\index{NetBIOS name length} \index{name\_type} All NetBIOS names are up to 15 characters in length. The name\_type variable is added to the end of the name, thus creating a 16 character name. Any name that is shorter than 15 characters is padded with spaces to the 15th character. Thus, all NetBIOS names are 16 characters long (including the name\_type information).

\index{WINS} \index{registered} \index{NetLogon service} \index{lmhosts} WINS can store these 16-character names as they get registered. A client that wants to log onto the network can ask the WINS server for a list of all names that have registered the NetLogon service name\_type. This saves broadcast traffic and greatly expedites logon processing. Since broadcast name resolution cannot be used across network segments, this type of information can only be provided via WINS or via a statically configured {\texttt{\docbookhyphenatefilename{lmhosts}}} file that must reside on all clients in the absence of WINS.

\index{synchronization} \index{LMB} \index{DMB} \index{WINS} \index{browse list} WINS also forces browse list synchronization by all LMBs. LMBs must synchronize their browse list with the DMB, and WINS helps the LMB to identify its DMB. By definition this will work only within a single workgroup. Note that the DMB has nothing to do with what is referred to as an MS Windows NT domain. The latter is a reference to a security environment, while the DMB refers to the master controller for browse list information only.

\index{WINS} \index{TCP/IP protocol stack} \index{WINS servers} \index{name-to-address} WINS will work correctly only if every client TCP/IP protocol stack is configured to use the WINS servers. Any client that is not configured to use the WINS server will continue to use only broadcast-based name registration, so WINS may never get to know about it. In any case, machines that have not registered with a WINS server will fail name-to-address lookup attempts by other clients and will therefore cause workstation access errors.

To configure Samba as a WINS server, just add \smbconfoption{wins support} = yes to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file [global] section.

To configure Samba to register with a WINS server, just add \smbconfoption{wins server} = 10.0.0.18 to your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file \smbconfsection{[global]} section.

\begin{admonition}{xslt/figures/important}{Important}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Never use \smbconfoption{wins support} = yes together with \smbconfoption{wins server} = 10.0.0.18 particularly not using its own IP address. Specifying both will cause nmbd to refuse to start!
\end{admonition}

\subsection{WINS Server Configuration}
\label{id2538588}\hypertarget{id2538588}{}%

\index{WINS} Either a Samba server or a Windows NT server machine may be set up as a WINS server. To configure a Samba server to be a WINS server, you must add to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file on the selected Server the following line to the \smbconfsection{[global]} section:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	wins support = yes
\end{lstlisting}


\index{Samba 1.9.17} Versions of Samba prior to 1.9.17 had this parameter default to yes. If you have any older versions of Samba on your network, it is strongly suggested you upgrade to a recent version, or at the very least set the parameter to {``}no{''} on all these machines.

Machines configured with \smbconfoption{wins support} = yes will keep a list of all NetBIOS names registered with them, acting as a DNS for NetBIOS names.

\index{only one WINS server} It is strongly recommended to set up only one WINS server. Do not set the \smbconfoption{wins support} = yes option on more than one Samba server on a network.

\index{replication!WINS} \index{Windows NT/200x} \index{WINS service} \index{replication protocols} \index{WINS server} To configure Windows NT/200x Server as a WINS server, install and configure the WINS service. See the Windows NT/200x documentation for details. Windows NT/200x WINS servers can replicate to each other, allowing more than one to be set up in a complex subnet environment. Because Microsoft refuses to document the replication protocols, Samba cannot currently participate in these replications. It is possible that a Samba-to-Samba WINS replication protocol may be defined in the future, in which case more than one Samba machine could be set up as a WINS server. Currently only one Samba server should have the \smbconfoption{wins support} = yes parameter set.

\index{WINS server} \index{Primary WINS Server} After the WINS server has been configured, you must ensure that all machines participating on the network are configured with the address of this WINS server. If your WINS server is a Samba machine, fill in the Samba machine IP address in the {\sffamily \bfseries Primary WINS Server} field of the {\sffamily \bfseries Control Panel-\textgreater{}Network-\textgreater{}Protocols-\textgreater{}TCP-\textgreater{}WINS Server} dialogs in Windows 9x/Me or Windows NT/200x. To tell a Samba server the IP address of the WINS server, add the following line to the \smbconfsection{[global]} section of all {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} files: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	wins server = <name or IP address>
\end{lstlisting}
 where \textless{}name or IP address\textgreater{} is either the DNS name of the WINS server machine or its IP address.

This line must not be set in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file of the Samba server acting as the WINS server itself. If you set both the \smbconfoption{wins support} = yes option and the \smbconfoption{wins server} = \textless{}name\textgreater{} option then {\bfseries{nmbd}} will fail to start.

\index{cross-subnet browsing} \index{Windows 9x/Me} \index{Windows NT/200x} \index{not part of domain} There are two possible scenarios for setting up cross-subnet browsing. The first details setting up cross-subnet browsing on a network containing Windows 9x/Me, Samba, and Windows NT/200x machines that are not configured as part of a Windows NT domain. The second details setting up cross-subnet browsing on networks that contain NT domains.
\subsection{WINS Replication}
\label{id2538838}\hypertarget{id2538838}{}%

\index{replication!WINS} \index{WINS replication} Samba-3 does not support native WINS replication. There was an approach to implement it, called {\texttt{\docbookhyphenatefilename{wrepld}}}, but it was never ready for action and the development is now discontinued.

Meanwhile, there is a project named {\texttt{\docbookhyphenatefilename{samba4WINS}}}, which makes it possible to run the Samba-4 WINS server parallel to Samba-3 since version 3.0.21. More information about {\texttt{\docbookhyphenatefilename{samba4WINS}}} are available at http://ftp.sernet.de/pub/samba4WINS.
\subsection{Static WINS Entries}
\label{id2538888}\hypertarget{id2538888}{}%

\index{static WINS entries} \index{wins.dat} \index{/usr/local/samba/var/locks} \index{/var/run/samba} Adding static entries to your Samba WINS server is actually fairly easy. All you have to do is add a line to {\texttt{\docbookhyphenatefilename{wins.\dbz{}dat}}}, typically located in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}var/\dbz{}locks}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}run/\dbz{}samba}}}.

Entries in {\texttt{\docbookhyphenatefilename{wins.\dbz{}dat}}} take the form of: 
\begin{Verbatim}[]

"NAME#TYPE" TTL ADDRESS+ FLAGS

\end{Verbatim}
 \index{TTL} \index{time-to-live|textit{see} {TTL} } where NAME is the NetBIOS name, TYPE is the NetBIOS type, TTL is the time-to-live as an absolute time in seconds, ADDRESS+ is one or more addresses corresponding to the registration, and FLAGS are the NetBIOS flags for the registration.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

A change that has been made to the {\texttt{\docbookhyphenatefilename{wins.\dbz{}dat}}} will not take effect until nmbd has been restarted. It should be noted that since the {\texttt{\docbookhyphenatefilename{wins.\dbz{}dat}}} file changes dynamically, nmbd should be stopped before editting this file. Do not forget to restart nmbd when this file has been editted.
\end{admonition}


A typical dynamic entry looks like this: 
\begin{Verbatim}[]

"MADMAN#03" 1155298378 192.168.1.2 66R

\end{Verbatim}
 To make a NetBIOS name static (permanent), simply set the TTL to 0, like this: 
\begin{Verbatim}[]

"MADMAN#03" 0 192.168.1.2 66R

\end{Verbatim}


\index{NetBIOS flags} \index{Broadcast node} \index{Peer node} \index{Meta node} \index{Hybrid node} \index{Permanent name} \index{nameserv.h} The NetBIOS flags may be interpreted as additive hexadecimal values: 00 - Broadcast node registration, 20 - Peer node registration, 40 - Meta node registration, 60 - Hybrid node registration, 02 - Permanent name, 04 - Active name, 80 - Group name. The 'R' indicates this is a registration record. Thus 66R means: Hybrid node active and permanent NetBIOS name. These values may be found in the {\texttt{\docbookhyphenatefilename{nameserv.\dbz{}h}}} header file from the Samba source code repository. These are the values for the NB flags.

\index{WINS replication} Though this method works with early Samba-3 versions, there is a possibility that it may change in future versions if WINS replication is added.

% ------------------------   
% Section 
\section{Helpful Hints}
\label{id2539101}\hypertarget{id2539101}{}%

The following hints should be carefully considered because they are stumbling points for many new network administrators.
\subsection{Windows Networking Protocols}
\label{id2539112}\hypertarget{id2539112}{}%

\index{browsing problems} \index{more than one protocol} A common cause of browsing problems results from the installation of more than one protocol on an MS Windows machine.

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Do not use more than one protocol on MS Windows clients.
\end{admonition}


\index{LMB} \index{DMB} Every NetBIOS machine takes part in a process of electing the LMB (and DMB) every 15 minutes. A set of election criteria is used to determine the order of precedence for winning this election process. A machine running Samba or Windows NT will be biased, so the most suitable machine will predictably win and thus retain its role.

\index{NetBIOS network interface} \index{TCP/IP} \index{IPX} \index{LMB} \index{Windows 9x/Me} \index{TCP/IP-only} The election process is {\em{fought out, so to speak}} over every NetBIOS network interface. In the case of a Windows 9x/Me machine that has both TCP/IP and IPX installed and has NetBIOS enabled over both protocols, the election will be decided over both protocols. As often happens, if the Windows 9x/Me machine is the only one with both protocols, then the LMB may be won on the NetBIOS interface over the IPX protocol. Samba will then lose the LMB role because Windows 9x/Me will insist it knows who the LMB is. Samba will then cease to function as an LMB, and browse list operation on all TCP/IP-only machines will therefore fail.

\index{Windows 9x/Me} \index{extended protocol} Windows 95, 98, 98se, and Me are referred to generically as Windows 9x/Me. The Windows NT4, 200x, and XP use common protocols. These are roughly referred to as the Windows NT family, but it should be recognized that 2000 and XP/2003 introduce new protocol extensions that cause them to behave differently from MS Windows NT4. Generally, where a server does not support the newer or extended protocol, these will fall back to the NT4 protocols.

The safest rule of all to follow is: Use only one protocol!
\subsection{Name Resolution Order}
\label{id2539245}\hypertarget{id2539245}{}%

\index{NetBIOS names} \index{name\_type} Resolution of NetBIOS names to IP addresses can take place using a number of methods. The only ones that can provide NetBIOS name\_type information are:

\begin{itemize}
%--- Item
\item 
WINS ---  the best tool.


%--- Item
\item 
LMHOSTS ---  static and hard to maintain.


%--- Item
\item 
Broadcast ---  uses UDP and cannot resolve names across remote segments.

\end{itemize}

Alternative means of name resolution include:

\begin{itemize}
%--- Item
\item 
Static {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} ---  hard to maintain and lacks name\_type info.


%--- Item
\item 
DNS ---  is a good choice but lacks essential NetBIOS name\_type information.

\end{itemize}

\index{restrict DNS} \index{name resolve order} Many sites want to restrict DNS lookups and avoid broadcast name resolution traffic. The {\ttfamily\itshape{\docbookhyphenatedot{name resolve order}}} parameter is of great help here. The syntax of the {\ttfamily\itshape{\docbookhyphenatedot{name resolve order}}} parameter is: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	name resolve order = wins lmhosts bcast host
\end{lstlisting}
 {\em{or}} 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	name resolve order = wins lmhosts  	(eliminates bcast and host)
\end{lstlisting}
 The default is: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	name resolve order = host lmhost wins bcast
,\end{lstlisting}
 \index{gethostbyname() function call} where {``}host{''} refers to the native methods used by the UNIX system to implement the gethostbyname() function call. This is normally controlled by {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}host.\dbz{}conf}}}, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}resolv.\dbz{}conf}}}.

% ------------------------   
% Section 
\section{Technical Overview of Browsing}
\label{id2539409}\hypertarget{id2539409}{}%

\index{SMB} SMB networking provides a mechanism by which clients can access a list of machines in a network called \smbconfoption{browse list}. This list contains machines that are ready to offer file and/or print services to other machines within the network. It therefore does not include machines that aren't currently able to do server tasks. The browse list is heavily used by all SMB clients. Configuration of SMB browsing has been problematic for some Samba users, hence this document.

\index{NetBIOS over TCP/IP} \index{DNS/LDAP/ADS} \index{name resolution} MS Windows 2000 and later versions, as with Samba-3 and later versions, can be configured to not use NetBIOS over TCP/IP. When configured this way, it is imperative that name resolution (using DNS/LDAP/ADS) be correctly configured and operative. Browsing will not work if name resolution from SMB machine names to IP addresses does not function correctly.

\index{NetBIOS} \index{WINS} Where NetBIOS over TCP/IP is enabled, use of a WINS server is highly recommended to aid the resolution of NetBIOS (SMB) names to IP addresses. WINS allows remote segment clients to obtain NetBIOS name\_type information that cannot be provided by any other means of name resolution.
\subsection{Browsing Support in Samba}
\label{id2539485}\hypertarget{id2539485}{}%

\index{browsing} \index{LMB} \index{domain logons} \index{scripts} Samba facilitates browsing. The browsing is supported by nmbd and is also controlled by options in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Samba can act as an LMB for a workgroup, and the ability to support domain logons and scripts is now available.

\index{DMB for a workgroup} \index{LMB} \index{WINS} Samba can also act as a DMB for a workgroup. This means that it will collate lists from LMBs into a wide-area network server list. In order for browse clients to resolve the names they may find in this list, it is recommended that both Samba and your clients use a WINS server.

\index{domain master} Do not set Samba to be the domain master for a workgroup that has the same name as an NT Domain. On each wide-area network, you must only ever have one DMB per workgroup, regardless of whether it is NT, Samba, or any other type of domain master that is providing this service.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{nmbd} \index{WINS server} {\bfseries{nmbd}} can be configured as a WINS server, but it is not necessary to specifically use Samba as your WINS server. MS Windows NT4, Server or Advanced Server 200x can be configured as your WINS server. In a mixed NT/200x server and Samba environment on a WAN, it is recommended that you use the Microsoft WINS server capabilities. In a Samba-only environment, it is recommended that you use one and only one Samba server as the WINS server.
\end{admonition}


\index{nmbd} To get browsing to work, you need to run {\bfseries{nmbd}} as usual, but must use the \smbconfoption{workgroup} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to control what workgroup Samba becomes a part of.

\index{browsing another subnet} Samba also has a useful option for a Samba server to offer itself for browsing on another subnet. It is recommended that this option is used only for {``}unusual{''} purposes: announcements over the Internet, for example. See \smbconfoption{remote announce} in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.
\subsection{Problem Resolution}
\label{id2539657}\hypertarget{id2539657}{}%

\index{log.nmbd} \index{browse.dat} If something does not work, the {\texttt{\docbookhyphenatefilename{log.\dbz{}nmbd}}} file will help to track down the problem. Try a \smbconfoption{log level} of 2 or 3 for finding problems. Also note that the current browse list usually gets stored in text form in a file called {\texttt{\docbookhyphenatefilename{browse.\dbz{}dat}}}.

\index{\textbackslash \textbackslash SERVER} \index{filemanager} If it does not work, you should still be able to type the server name as {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\SERVER}}} in {\bfseries{filemanager}}, then press enter, and {\bfseries{filemanager}} should display the list of available shares.

\index{IPC\$} \index{guest account} Some people find browsing fails because they do not have the global \smbconfoption{guest account} set to a valid account. Remember that the IPC\$ connection that lists the shares is done as guest and so you must have a valid guest account.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{IPC\$} \index{Windows Explorer} \index{browse resources} \index{Network Neighborhood} \index{My Network Places} The {\texttt{\docbookhyphenatedot{IPC\$}}} share is used by all SMB/CIFS clients to obtain the list of resources that is available on the server. This is the source of the list of shares and printers when browsing an SMB/CIFS server (also Windows machines) using the Windows Explorer to browse resources through the Windows Network Neighborhood (also called My Network Places) through to a Windows server. At this point, the client has opened a connection to the {\texttt{\docbookhyphenatedot{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\server\docbooktolatexgobble\string\\IPC4}}} resource. Clicking on a share will then open up a connection to the {\texttt{\docbookhyphenatedot{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\server\docbooktolatexgobble\string\\share}}}.
\end{admonition}


\index{guest account} \index{anonymous access} \index{IPC\$} \index{browse server resources} MS Windows 2000 and later (as with Samba) can be configured to disallow anonymous (i.e., guest account) access to the IPC\$ share. In that case, the MS Windows 2000/XP/2003 machine acting as an SMB/CIFS client will use the name of the currently logged-in user to query the IPC\$ share. MS Windows 9x/Me clients are not able to do this and thus will not be able to browse server resources.

\index{broadcast address} The other big problem people have is that their broadcast address, netmask, or IP address is wrong (specified with the \smbconfoption{interfaces} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}})
\subsection{Cross-Subnet Browsing}
\label{id2539870}\hypertarget{id2539870}{}%

\index{replication!browse lists} \index{browse across subnet} Since the release of Samba 1.9.17 (alpha1), Samba has supported the replication of browse lists across subnet boundaries. This section describes how to set this feature up in different settings.

\index{browse lists} \index{broadcast traffic} \index{UDP} \index{WINS} \index{remote announce} \index{remote browse sync} To see browse lists that span TCP/IP subnets (i.e., networks separated by routers that do not pass broadcast traffic), you must set up at least one WINS server. The WINS server acts as a DNS for NetBIOS names. This will allow NetBIOS name-to-IP address translation to be completed by a direct query of the WINS server. This is done via a directed UDP packet on port 137 to the WINS server machine. The WINS server avoids the necessity of default NetBIOS name-to-IP address translation, which is done using UDP broadcasts from the querying machine. This means that machines on one subnet will not be able to resolve the names of machines on another subnet without using a WINS server. The Samba hacks, {\ttfamily\itshape{\docbookhyphenatedot{remote browse sync}}}, and {\ttfamily\itshape{\docbookhyphenatedot{remote announce}}} are designed to get around the natural limitations that prevent UDP broadcast propagation. The hacks are not a universal solution and they should not be used in place of WINS, they are considered last resort methods.

\index{DHCP} \index{browsing across subnets} \index{WINS} \index{Network settings} Remember, for browsing across subnets to work correctly, all machines, be they Windows 95, Windows NT, or Samba servers, must have the IP address of a WINS server given to them by a DHCP server or by manual configuration: for Windows 9x/Me and Windows NT/200x/XP, this is in the TCP/IP Properties, under Network settings; for Samba, this is in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

\index{NetBIOS over TCP/IP} \index{ADS} \index{DNS} It is possible to operate Samba-3 without NetBIOS over TCP/IP. If you do this, be warned that if used outside of MS ADS, this will forgo network browsing support. ADS permits network browsing support through DNS, providing appropriate DNS records are inserted for all Samba servers.
\subsubsection{Behavior of Cross-Subnet Browsing}
\label{id2540030}\hypertarget{id2540030}{}%

\index{cross-subnet browsing} \index{complicated} Cross-subnet browsing is a complicated dance, containing multiple moving parts. It has taken Microsoft several years to get the code that correctly achieves this, and Samba lags behind in some areas. Samba is capable of cross-subnet browsing when configured correctly.

Consider a network set up as in \hyperlink{browsing1}{Figure {\ref{browsing1}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{browsing1}{}%
\includegraphics[scale=0.4]{Samba3-HOWTO/images/browsing1}
{{\caption[{Cross-Subnet Browsing Example.}]{{{Cross-Subnet Browsing Example.}}}\label{browsing1}}}
\end{center}
\end{figure}


\index{broadcasts} \index{DMB} \index{WINS} This consists of three subnets (1, 2, 3) connected by two routers (R1, R2), which do not pass broadcasts. Subnet 1 has five machines on it, subnet 2 has four machines, and subnet 3 has four machines. Assume for the moment that all machines are configured to be in the same workgroup (for simplicity's sake). Machine N1\_C on subnet 1 is configured as the DMB (i.e., it will collate the browse lists for the workgroup). Machine N2\_D is configured as a WINS server, and all the other machines are configured to register their NetBIOS names with it.

\index{master browsers} \index{LMB} \index{DMB} As these machines are booted up, elections for master browsers take place on each of the three subnets. Assume that machine N1\_C wins on subnet 1, N2\_B wins on subnet 2, and N3\_D wins on subnet 3. These machines are known as LMBs for their particular subnet. N1\_C has an advantage in winning as the LMB on subnet 1 because it is set up as DMB.

\index{LMB} \index{browse list} On each of the three networks, machines that are configured to offer sharing services will broadcast that they are offering these services. The LMB on each subnet will receive these broadcasts and keep a record of the fact that the machine is offering a service. This list of records is the basis of the browse list. For this case, assume that all the machines are configured to offer services, so all machines will be on the browse list.

\index{LMB} \index{authoritative} \index{verifiable} \index{trusted} \index{non-authoritative} For each network, the LMB on that network is considered {\em{authoritative}} for all the names it receives via local broadcast. This is because a machine seen by the LMB via a local broadcast must be on the same network as the Local Master Browser and thus is a {\em{trusted}} and {\em{verifiable}} resource. Machines on other networks that the LMBs learn about when collating their browse lists have not been directly seen. These records are called {\em{non-authoritative.}}

\index{network neighborhood} At this point the browse lists appear as shown in \hyperlink{browsubnet}{Table {\ref{browsubnet}}} (these are the machines you would see in your network neighborhood if you looked in it on a particular network right now).


% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{browsubnet}{}%
\captionswapskip{}{{\caption{Browse Subnet Example 1}\label{browsubnet}}}
\captionswapskip{}\begin{tabular}{|l|l|l|}
\hline 
{{{\bfseries Subnet}}} & {{{\bfseries Browse Master}}} & {{{\bfseries List}}} \tabularnewline
 \hline 
{{Subnet1}} & {{N1\_C}} & {{N1\_A, N1\_B, N1\_C, N1\_D, N1\_E}} \tabularnewline
 \hline 
{{Subnet2}} & {{N2\_B}} & {{N2\_A, N2\_B, N2\_C, N2\_D}} \tabularnewline
 \hline 
{{Subnet3}} & {{N3\_D}} & {{N3\_A, N3\_B, N3\_C, N3\_D}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}



At this point all the subnets are separate, and no machine is seen across any of the subnets.

\index{DMB} \index{LMB} \index{synchronize} \index{WINS} Now examine subnet 2 in \hyperlink{brsbex}{Table {\ref{brsbex}}}. As soon as N2\_B has become the LMB, it looks for a DMB with which to synchronize its browse list. It does this by querying the WINS server (N2\_D) for the IP address associated with the NetBIOS name WORKGROUP\textless{}1B\textgreater{}. This name was registered by the DMB (N1\_C) with the WINS server as soon as it was started.

\index{MasterAnnouncement} \index{NetServerEnum2} \index{synchronization} \index{browse lists} Once N2\_B knows the address of the DMB, it tells the DMB that it is the LMB for subnet 2 by sending the DMB a {\em{MasterAnnouncement}} packet to UDP port 138. It then synchronizes with the DMB by doing a {\em{NetServerEnum2}} call. This tells the DMB to send the sender all the server names it knows about. Once the DMB receives the {\em{MasterAnnouncement}} packet, it schedules a synchronization request to the sender of that packet. After both synchronizations are complete, the browse lists look like those in \hyperlink{brsbex}{Table {\ref{brsbex}}}

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{brsbex}{}%
\captionswapskip{}{{\caption{Browse Subnet Example 2}\label{brsbex}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|l|>{\hsize=1\hsize}X|}
\hline 
{{{\bfseries Subnet}}} & {{{\bfseries Browse Master}}} & {{{\bfseries List}}} \tabularnewline
 \hline 
{{Subnet1}} & {{N1\_C}} & {{N1\_A, N1\_B, N1\_C, N1\_D, N1\_E, N2\_A(*), N2\_B(*), N2\_C(*), N2\_D(*)}} \tabularnewline
 \hline 
{{Subnet2}} & {{N2\_B}} & {{N2\_A, N2\_B, N2\_C, N2\_D, N1\_A(*), N1\_B(*), N1\_C(*), N1\_D(*), N1\_E(*)}} \tabularnewline
 \hline 
{{Subnet3}} & {{N3\_D}} & {{N3\_A, N3\_B, N3\_C, N3\_D}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


\index{non-authoritative} Servers with an (*) after them are non-authoritative names.

\index{Network Neighborhood} At this point users looking in their Network Neighborhood on subnets 1 or 2 will see all the servers on both; users on subnet 3 will still see only the servers on their own subnet.

\index{DMB} The same sequence of events that occurred for N2\_B now occurs for the LMB on subnet 3 (N3\_D). When it synchronizes browse lists with the DMB (N1\_A) it gets both the server entries on subnet 1 and those on subnet 2. After N3\_D has synchronized with N1\_C and vica versa, the browse lists will appear as shown in \hyperlink{brsex2}{Table {\ref{brsex2}}}

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{brsex2}{}%
\captionswapskip{}{{\caption{Browse Subnet Example 3}\label{brsex2}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|l|>{\hsize=1\hsize}X|}
\hline 
{{{\bfseries Subnet}}} & {{{\bfseries Browse Master}}} & {{{\bfseries List}}} \tabularnewline
 \hline 
{{Subnet1}} & {{N1\_C}} & {{N1\_A, N1\_B, N1\_C, N1\_D, N1\_E, N2\_A(*), N2\_B(*), N2\_C(*), N2\_D(*), N3\_A(*), N3\_B(*), N3\_C(*), N3\_D(*)}} \tabularnewline
 \hline 
{{Subnet2}} & {{N2\_B}} & {{N2\_A, N2\_B, N2\_C, N2\_D, N1\_A(*), N1\_B(*), N1\_C(*), N1\_D(*), N1\_E(*)}} \tabularnewline
 \hline 
{{Subnet3}} & {{N3\_D}} & {{N3\_A, N3\_B, N3\_C, N3\_D, N1\_A(*), N1\_B(*), N1\_C(*), N1\_D(*), N1\_E(*), N2\_A(*), N2\_B(*), N2\_C(*), N2\_D(*)}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


Servers with an (*) after them are non-authoritative names.

At this point, users looking in their Network Neighborhood on subnets 1 or 3 will see all the servers on all subnets, while users on subnet 2 will still see only the servers on subnets 1 and 2, but not 3.

\index{LMB} \index{DMB} \index{browse lists} Finally, the LMB for subnet 2 (N2\_B) will sync again with the DMB (N1\_C) and will receive the missing server entries. Finally, as when a steady state (if no machines are removed or shut off) has been achieved, the browse lists will appear as shown in \hyperlink{brsex3}{Table {\ref{brsex3}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{brsex3}{}%
\captionswapskip{}{{\caption{Browse Subnet Example 4}\label{brsex3}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|l|>{\hsize=1\hsize}X|}
\hline 
{{{\bfseries Subnet}}} & {{{\bfseries Browse Master}}} & {{{\bfseries List}}} \tabularnewline
 \hline 
{{Subnet1}} & {{N1\_C}} & {{N1\_A, N1\_B, N1\_C, N1\_D, N1\_E, N2\_A(*), N2\_B(*), N2\_C(*), N2\_D(*), N3\_A(*), N3\_B(*), N3\_C(*), N3\_D(*)}} \tabularnewline
 \hline 
{{Subnet2}} & {{N2\_B}} & {{N2\_A, N2\_B, N2\_C, N2\_D, N1\_A(*), N1\_B(*), N1\_C(*), N1\_D(*), N1\_E(*), N3\_A(*), N3\_B(*), N3\_C(*), N3\_D(*)}} \tabularnewline
 \hline 
{{Subnet3}} & {{N3\_D}} & {{N3\_A, N3\_B, N3\_C, N3\_D, N1\_A(*), N1\_B(*), N1\_C(*), N1\_D(*), N1\_E(*), N2\_A(*), N2\_B(*), N2\_C(*), N2\_D(*)}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


Servers with an (*) after them are non-authoritative names.

Synchronizations between the DMB and LMBs will continue to occur, but this should remain a steady-state operation.

If either router R1 or R2 fails, the following will occur:

\begin{enumerate}
%--- Item
\item 
\index{Network Neighborhood} Names of computers on each side of the inaccessible network fragments will be maintained for as long as 36 minutes in the Network Neighborhood lists.


%--- Item
\item 
Attempts to connect to these inaccessible computers will fail, but the names will not be removed from the Network Neighborhood lists.


%--- Item
\item 
\index{WINS} \index{NetBIOS name resolution} \index{DNS server} If one of the fragments is cut off from the WINS server, it will only be able to access servers on its local subnet using subnet-isolated broadcast NetBIOS name resolution. The effect is similar to that of losing access to a DNS server.

\end{enumerate}

% ------------------------   
% Section 
\section{Common Errors}
\label{id2540786}\hypertarget{id2540786}{}%

\index{browsing problems} \index{name resolution} Many questions are asked on the mailing lists regarding browsing. The majority of browsing problems originate from incorrect configuration of NetBIOS name resolution. Some are of particular note.
\subsection{Flushing the Samba NetBIOS Name Cache}
\label{id2540811}\hypertarget{id2540811}{}%

How Can One Flush the Samba NetBIOS Name Cache without Restarting Samba?

\index{flush name cache} \index{nmbd} \index{NetBIOS name cache} \index{rogue machine} Samba's {\bfseries{nmbd}} process controls all browse list handling. Under normal circumstances it is safe to restart {\bfseries{nmbd}}. This will effectively flush the Samba NetBIOS name cache and cause it to be rebuilt. This does not make certain that a rogue machine name will not reappear in the browse list. When {\bfseries{nmbd}} is taken out of service, another machine on the network will become the browse master. This new list may still have the rogue entry in it. If you really want to clear a rogue machine from the list, every machine on the network must be shut down and restarted after all machines are down. Failing a complete restart, the only other thing you can do is wait until the entry times out and is then flushed from the list. This may take a long time on some networks (perhaps months).
\subsection{Server Resources Cannot Be Listed}
\label{id2540880}\hypertarget{id2540880}{}%

{``}My Client Reports "{`}This server is not configured to list shared resources."{'}{''}

Your guest account is probably invalid for some reason. Samba uses the guest account for browsing in {\bfseries{smbd}}. Check that your guest account is valid.

Also see \smbconfoption{guest account} in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.
\subsection{I Get an "Unable to browse the network" Error}
\label{id2540918}\hypertarget{id2540918}{}%

This error can have multiple causes: \index{browsing problems}

\begin{itemize}
%--- Item
\item 
There is no LMB. Configure nmbd or any other machine to serve as LMB.


%--- Item
\item 
You cannot log onto the machine that is the LMB. Can you log on to it as a guest user?


%--- Item
\item 
There is no IP connectivity to the LMB. Can you reach it by broadcast?

\end{itemize}
\subsection{Browsing of Shares and Directories is Very Slow}
\label{id2540963}\hypertarget{id2540963}{}%

{``}\index{slow browsing} There are only two machines on a test network. One is a Samba server, the other a Windows XP machine. Authentication and logons work perfectly, but when I try to explore shares on the Samba server, the Windows XP client becomes unresponsive. Sometimes it does not respond for some minutes. Eventually, Windows Explorer will respond and displays files and directories without problem.{''}

{``}\index{cmd} But, the share is immediately available from a command shell ({\bfseries{cmd}}, followed by exploration with DOS command. Is this a Samba problem, or is it a Windows problem? How can I solve this?{''}

Here are a few possibilities:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Bad Networking Hardware}]\null{}
\index{bad hardware} \index{WebClient} \index{defective hardware} \index{Bad networking hardware} \index{data corruption} Most common defective hardware problems center around low cost or defective hubs, routers, network interface controllers (NICs), and bad wiring. If one piece of hardware is defective, the whole network may suffer. Bad networking hardware can cause data corruption. Most bad networking hardware problems are accompanied by an increase in apparent network traffic, but not all.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{The Windows XP WebClient}]\null{}
\index{network browsing problems} A number of sites have reported similar slow network browsing problems and found that when the WebClient service is turned off, the problem disappears. This is certainly something that should be explored because it is a simple solution ---  if it works.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Inconsistent WINS Configuration}]\null{}
\index{WINS Configuration} \index{WINS server} This type of problem is common when one client is configured to use a WINS server (that is a TCP/IP configuration setting) and there is no WINS server on the network. Alternatively, this will happen if there is a WINS server and Samba is not configured to use it. The use of WINS is highly recommended if the network is using NetBIOS over TCP/IP protocols. If use of NetBIOS over TCP/IP is disabled on all clients, Samba should not be configured as a WINS server, nor should it be configured to use one.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Incorrect DNS Configuration}]\null{}
\index{DNS Configuration} \index{NetBIOS over TCP/IP disabled} If use of NetBIOS over TCP/IP is disabled, Active Directory is in use and the DNS server has been incorrectly configured. For further information refer to \hyperlink{adsdnstech}{Section {\ref{adsdnstech}}}.
\end{description}
\subsection{Invalid Cached Share References Affects Network Browsing}
\label{id2541151}\hypertarget{id2541151}{}%

\index{cached references} \index{stale network links} Cached references on your MS Windows client (workstation or server) to shares or servers that no longer exist can cause MS Windows Explorer to appear unresponsive as it tries to connect to these shares. After a delay (can take a long time) it times out and browsing will appear to be mostly normal again.

To eliminate the problem the stale cached references should be removed. This does not happen automatically and requires manual intervention. This is a design feature of MS Windows and not anything that Samba can change. To remove the stale shortcuts found in {\em{My Network Places}} which refer to what are now invalid shares or servers it is necessary to edit the Windows Registry under {\texttt{\docbookhyphenatedot{HKCU\docbooktolatexgobble\string\\Software\docbooktolatexgobble\string\\Microsoft\docbooktolatexgobble\string\\Windows\docbooktolatexgobble\string\\CurrentVersion\docbooktolatexgobble\string\\Explorer\docbooktolatexgobble\string\\}}}. Edit the entry {\texttt{\docbookhyphenatedot{MountPoints2}}} (on Windows XP and later, or {\texttt{\docbookhyphenatedot{MountPoints}}} on Windows 2000 and earlier). Remove all keys named {\texttt{\docbookhyphenatedot{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\server\docbooktolatexgobble\string\\share}}} (where 'server' and 'share' refer to a non-existent server or share).

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Removal of stale network links needs to be done on a per-user basis. Alternately, you can delete the shortcuts from the MS Windows Explorer in {\texttt{\docbookhyphenatedot{My Network Places}}} just by right-clicking them and selecting {\em{Delete.}}
\end{admonition}


\index{slow network browsing} Samba users have reported that these stale references negatively affect network browsing with Windows, Samba, and Novell servers. It is suspected to be a universal problem not directly related to the Samba server. Samba users may experience this more often due to Samba being somewhat viewed as an experimenter's toolkit. This results from the fact that a user might go through several reconfigurations and incarnations of their Samba server, by different names, with different shares, increasing the chances for having stale (invalid) cached share references. Windows clients do not expire these references thus necessitating manual removal.

It is common for {\em{Open}} dialog boxes (for example; in Word and Excel) to respond very slowly, as they attempt to locate all of the cached references, even if they are not in the current directory being accessed.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Account Information Databases 
% ------------------------------------------------------------- 	
\chapter{Account Information Databases}
\label{passdb}\hypertarget{passdb}{}%

\index{account backends} \index{password backends} \index{scalability} \index{ADS} Early releases of Samba-3 implemented new capability to work concurrently with multiple account backends. This capability was removed beginning with release of Samba 3.0.23. Commencing with Samba 3.0.23 it is possible to work with only one specified passwd backend.

\index{passdb backend} \index{smbpasswd} \index{tdbsam} \index{ldapsam} \index{LDAP} \index{single repository} The three passdb backends that are fully maintained (actively supported) by the Samba Team are: {\texttt{\docbookhyphenatedot{smbpasswd}}} (being obsoleted), {\texttt{\docbookhyphenatedot{tdbsam}}} (a tdb-based binary file format), and {\texttt{\docbookhyphenatedot{ldapsam}}} (LDAP directory). Of these, only the {\texttt{\docbookhyphenatedot{ldapsam}}} backend stores both POSIX (UNIX) and Samba user and group account information in a single repository. The {\texttt{\docbookhyphenatedot{smbpasswd}}} and {\texttt{\docbookhyphenatedot{tdbsam}}} backends store only Samba user accounts.

In a strict sense, there are three supported account storage and access systems. One of these is considered obsolete (smbpasswd). It is recommended to use the {\texttt{\docbookhyphenatedot{tdbsam}}} method for all simple systems. Use {\texttt{\docbookhyphenatedot{ldapsam}}} for larger and more complex networks.

\index{passdb backend} \index{account storage mechanisms} \index{account storage system} \index{user and trust accounts} \index{machine trust accounts} \index{computer accounts} \index{interdomain trust accounts} In a strict and literal sense, the passdb backends are account storage mechanisms (or methods) alone. The choice of terminology can be misleading, however we are stuck with this choice of wording. This chapter documents the nature of the account storage system with a focus on user and trust accounts. Trust accounts have two forms, machine trust accounts (computer accounts) and interdomain trust accounts. These are all treated as user-like entities.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2544712}\hypertarget{id2544712}{}%

Samba-3 provides for complete backward compatibility with Samba-2.2.x functionality as follows: \index{SAM backend!smbpasswd} \index{SAM backend!ldapsam\_compat} \index{encrypted passwords}
\subsection{Backward Compatibility Account Storage Systems}
\label{id2501295}\hypertarget{id2501295}{}%

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Plaintext}]\null{}
\index{plaintext} \index{plaintext authentication} \index{/etc/passwd} \index{/etc/shadow} \index{PAM} This isn't really a backend at all, but is listed here for simplicity. Samba can be configured to pass plaintext authentication requests to the traditional UNIX/Linux {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}shadow}}}-style subsystems. On systems that have Pluggable Authentication Modules (PAM) support, all PAM modules are supported. The behavior is just as it was with Samba-2.2.x, and the protocol limitations imposed by MS Windows clients apply likewise. Please refer to \hyperlink{passdbtech}{Section {\ref{passdbtech}}}, for more information regarding the limitations of plaintext password usage.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{smbpasswd}]\null{}
\index{smbpasswd} \index{LanMan passwords} \index{NT-encrypted passwords} \index{SAM} This option allows continued use of the {\texttt{\docbookhyphenatefilename{smbpasswd}}} file that maintains a plain ASCII (text) layout that includes the MS Windows LanMan and NT-encrypted passwords as well as a field that stores some account information. This form of password backend does not store any of the MS Windows NT/200x SAM (Security Account Manager) information required to provide the extended controls that are needed for more comprehensive interoperation with MS Windows NT4/200x servers.

This backend should be used only for backward compatibility with older versions of Samba. It may be deprecated in future releases.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{ldapsam\_compat (Samba-2.2 LDAP Compatibility)}]\null{}
\index{ldapsam\_compat} \index{Samba-2.2.x LDAP schema} \index{OpenLDAP backend} There is a password backend option that allows continued operation with an existing OpenLDAP backend that uses the Samba-2.2.x LDAP schema extension. This option is provided primarily as a migration tool, although there is no reason to force migration at this time. This tool will eventually be deprecated.
\end{description}
\subsection{New Account Storage Systems}
\label{id2528649}\hypertarget{id2528649}{}%

Samba-3 introduces a number of new password backend capabilities. \index{SAM backend!tdbsam} \index{SAM backend!ldapsam}

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{tdbsam}]\null{}
\index{rich database backend} \index{PDC} \index{BDC} This backend provides a rich database backend for local servers. This backend is not suitable for multiple domain controllers (i.e., PDC + one or more BDC) installations.

\index{extended SAM} \index{TDB} \index{binary format TDB} \index{trivial database} \index{system access controls} \index{MS Windows NT4/200x} The {\em{tdbsam}} password backend stores the old {\em{smbpasswd}} information plus the extended MS Windows NT/200x SAM information into a binary format TDB (trivial database) file. The inclusion of the extended information makes it possible for Samba-3 to implement the same account and system access controls that are possible with MS Windows NT4/200x-based systems.

\index{simple operation} \index{OpenLDAP} \index{ADS} The inclusion of the {\em{tdbsam}} capability is a direct response to user requests to allow simple site operation without the overhead of the complexities of running OpenLDAP. It is recommended to use this only for sites that have fewer than 250 users. For larger sites or implementations, the use of OpenLDAP or of Active Directory integration is strongly recommended.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{ldapsam}]\null{}
\index{rich directory backend} \index{distributed account} This provides a rich directory backend for distributed account installation.

\index{LDAP} \index{OpenLDAP} \index{Samba schema} \index{schema file} \index{examples/LDAP} Samba-3 has a new and extended LDAP implementation that requires configuration of OpenLDAP with a new format Samba schema. The new format schema file is included in the {\texttt{\docbookhyphenatefilename{examples/\dbz{}LDAP}}} directory of the Samba distribution.

\index{expands control abilities} \index{profile} \index{home directories} \index{account access controls} \index{greater scalability} The new LDAP implementation significantly expands the control abilities that were possible with prior versions of Samba. It is now possible to specify {``}per-user{''} profile settings, home directories, account access controls, and much more. Corporate sites will see that the Samba Team has listened to their requests both for capability and greater scalability.
\end{description}

% ------------------------   
% Section 
\section{Technical Information}
\label{passdbtech}\hypertarget{passdbtech}{}%

\index{plaintext passwords} \index{encrypted passwords} Old Windows clients send plaintext passwords over the wire. Samba can check these passwords by encrypting them and comparing them to the hash stored in the UNIX user database.

\index{encrypted passwords} \index{LanMan} \index{plaintext passwords} \index{registry} Newer Windows clients send encrypted passwords (LanMan and NT hashes) instead of plaintext passwords over the wire. The newest clients will send only encrypted passwords and refuse to send plaintext passwords unless their registry is tweaked.

\index{UNIX-style encrypted passwords} \index{converted} Many people ask why Samba cannot simply use the UNIX password database. Windows requires passwords that are encrypted in its own format. The UNIX passwords can't be converted to UNIX-style encrypted passwords. Because of that, you can't use the standard UNIX user database, and you have to store the LanMan and NT hashes somewhere else.

\index{differently encrypted passwords} \index{profile} \index{workstations} \index{tdbsam} In addition to differently encrypted passwords, Windows also stores certain data for each user that is not stored in a UNIX user database: for example, workstations the user may logon from, the location where the user's profile is stored, and so on. Samba retrieves and stores this information using a \smbconfoption{passdb backend}. Commonly available backends are LDAP, tdbsam, and plain text file. For more information, see the man page for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} regarding the \smbconfoption{passdb backend} parameter.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{idmap-sid2uid}{}%
\includegraphics[scale=0.4]{Samba3-HOWTO/images/idmap-sid2uid}
{{\caption[{IDMAP: Resolution of SIDs to UIDs.}]{{{IDMAP: Resolution of SIDs to UIDs.}}}\label{idmap-sid2uid}}}
\end{center}
\end{figure}


\index{SID} \index{UID} \index{SID} The resolution of SIDs to UIDs is fundamental to correct operation of Samba. In both cases shown, if winbindd is not running or cannot be contacted, then only local SID/UID resolution is possible. See \hyperlink{idmap-sid2uid}{Figure {\ref{idmap-sid2uid}}} and \hyperlink{idmap-uid2sid}{Figure {\ref{idmap-uid2sid}}} diagrams.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{idmap-uid2sid}{}%
\includegraphics[scale=0.5]{Samba3-HOWTO/images/idmap-uid2sid}
{{\caption[{IDMAP: Resolution of UIDs to SIDs.}]{{{IDMAP: Resolution of UIDs to SIDs.}}}\label{idmap-uid2sid}}}
\end{center}
\end{figure}

\subsection{Important Notes About Security}
\label{id2531457}\hypertarget{id2531457}{}%

\index{SMB password encryption} \index{clear-text passwords} \index{hashed password equivalent} \index{LDAP} \index{secret} The UNIX and SMB password encryption techniques seem similar on the surface. This similarity is, however, only skin deep. The UNIX scheme typically sends clear-text passwords over the network when logging in. This is bad. The SMB encryption scheme never sends the clear-text password over the network, but it does store the 16-byte hashed values on disk. This is also bad. Why? Because the 16 byte hashed values are a {``}password equivalent.{''} You cannot derive the user's password from them, but they could potentially be used in a modified client to gain access to a server. This would require considerable technical knowledge on behalf of the attacker but is perfectly possible. You should therefore treat the data stored in whatever passdb backend you use (smbpasswd file, LDAP) as though it contained the clear-text passwords of all your users. Its contents must be kept secret, and the file should be protected accordingly.

\index{password scheme} \index{plaintext passwords} \index{compatible} Ideally, we would like a password scheme that involves neither plaintext passwords on the network nor plaintext passwords on disk. Unfortunately, this is not available because Samba is stuck with having to be compatible with other SMB systems (Windows NT, Windows for Workgroups, Windows 9x/Me).

\index{encrypted passwords} \index{plaintext passwords} Windows NT 4.0 Service Pack 3 changed the default setting so plaintext passwords are disabled from being sent over the wire. This mandates either the use of encrypted password support or editing the Windows NT registry to re-enable plaintext passwords.

\index{domain security} \index{domain environment} The following versions of Microsoft Windows do not support full domain security protocols, although they may log onto a domain environment:

\begin{itemize}
%--- Item
\item 
MS DOS Network client 3.0 with the basic network redirector installed.


%--- Item
\item 
Windows 95 with the network redirector update installed.


%--- Item
\item 
Windows 98 [Second Edition].


%--- Item
\item 
Windows Me.

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Windows XP Home} \index{domain member} \index{domain logons} MS Windows XP Home does not have facilities to become a domain member, and it cannot participate in domain logons.
\end{admonition}


The following versions of MS Windows fully support domain security protocols.

\begin{itemize}
%--- Item
\item 
Windows NT 3.5x.


%--- Item
\item 
Windows NT 4.0.


%--- Item
\item 
Windows 2000 Professional.


%--- Item
\item 
Windows 200x Server/Advanced Server.


%--- Item
\item 
Windows XP Professional.

\end{itemize}

\index{SMB/CIFS} \index{authentication} \index{challenge/response mechanis} \index{clear-text} \index{encrypted} \index{negotiate} All current releases of Microsoft SMB/CIFS clients support authentication via the SMB challenge/response mechanism described here. Enabling clear-text authentication does not disable the ability of the client to participate in encrypted authentication. Instead, it allows the client to negotiate either plaintext or encrypted password handling.

\index{cached encrypted password} \index{plaintext passwords} \index{registry change} \index{auto-reconnect} \index{encrypted passwords} MS Windows clients will cache the encrypted password alone. Where plaintext passwords are re-enabled through the appropriate registry change, the plaintext password is never cached. This means that in the event that a network connections should become disconnected (broken), only the cached (encrypted) password will be sent to the resource server to effect an auto-reconnect. If the resource server does not support encrypted passwords, the auto-reconnect will fail. Use of encrypted passwords is strongly advised.
\subsubsection{Advantages of Encrypted Passwords}
\label{id2460013}\hypertarget{id2460013}{}%

\begin{itemize}
%--- Item
\item 
\index{passed across the network} \index{network sniffer} \index{SMB server} Plaintext passwords are not passed across the network. Someone using a network sniffer cannot just record passwords going to the SMB server.


%--- Item
\item 
\index{not stored anywhere} \index{memory} \index{disk} Plaintext passwords are not stored anywhere in memory or on disk.


%--- Item
\item 
\index{encrypted passwords} \index{user-level security} \index{password prompt} \index{SMB encryption} Windows NT does not like talking to a server that does not support encrypted passwords. It will refuse to browse the server if the server is also in user-level security mode. It will insist on prompting the user for the password on each connection, which is very annoying. The only thing you can do to stop this is to use SMB encryption.


%--- Item
\item 
\index{encrypted password} \index{automatic reconnects} Encrypted password support allows automatic share (resource) reconnects.


%--- Item
\item 
\index{PDC} \index{BDC} Encrypted passwords are essential for PDC/BDC operation.

\end{itemize}
\subsubsection{Advantages of Non-Encrypted Passwords}
\label{id2544849}\hypertarget{id2544849}{}%

\begin{itemize}
%--- Item
\item 
\index{cached in memory} Plaintext passwords are not kept on disk and are not cached in memory.


%--- Item
\item 
\index{Login} \index{FTP} Plaintext passwords use the same password file as other UNIX services, such as Login and FTP.


%--- Item
\item 
\index{Telnet} \index{FTP} Use of other services (such as Telnet and FTP) that send plaintext passwords over the network makes sending them for SMB not such a big deal.

\end{itemize}
\subsection{Mapping User Identifiers between MS Windows and UNIX}
\label{id2544910}\hypertarget{id2544910}{}%

\index{UID} \index{SID} \index{mapping} Every operation in UNIX/Linux requires a user identifier (UID), just as in MS Windows NT4/200x this requires a security identifier (SID). Samba provides two means for mapping an MS Windows user to a UNIX/Linux UID.

\index{Samba SAM} \index{SAM} \index{UID} \index{account information database} \index{local user account} First, all Samba SAM database accounts require a UNIX/Linux UID that the account will map to. As users are added to the account information database, Samba will call the \smbconfoption{add user script} interface to add the account to the Samba host OS. In essence all accounts in the local SAM require a local user account.

\index{idmap uid} \index{idmap gid} \index{UID} \index{SAM} \index{foreign domain} \index{non-member Windows client} \index{SID} The second way to map Windows SID to UNIX UID is via the {\em{idmap uid}} and {\em{idmap gid}} parameters in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. Please refer to the man page for information about these parameters. These parameters are essential when mapping users from a remote (non-member Windows client or a member of a foreign domain) SAM server.
\subsection{Mapping Common UIDs/GIDs on Distributed Machines}
\label{idmapbackend}\hypertarget{idmapbackend}{}%

\index{UID} \index{GID} \index{BDC} \index{domain member servers} \index{NFS} \index{rsync} Samba-3 has a special facility that makes it possible to maintain identical UIDs and GIDs on all servers in a distributed network. A distributed network is one where there exists a PDC, one or more BDCs, and/or one or more domain member servers. Why is this important? This is important if files are being shared over more than one protocol (e.g., NFS) and where users are copying files across UNIX/Linux systems using tools such as {\bfseries{rsync}}.

\index{LDAP-based} \index{idmap backend} \index{UID} \index{GID} \index{LDAP} \index{SAM backend} \index{LDAP idmap Backend} \index{idmap backend} The special facility is enabled using a parameter called {\ttfamily\itshape{\docbookhyphenatedot{idmap backend}}}. The default setting for this parameter is an empty string. Technically it is possible to use an LDAP-based idmap backend for UIDs and GIDs, but it makes most sense when this is done for network configurations that also use LDAP for the SAM backend. \hyperlink{idmapbackendexample}{Example {\ref{idmapbackendexample}}} shows that configuration.
\index{SAM backend!ldapsam}
\begin{example}%
\hypertarget{idmapbackendexample}{}%
\captionswapskip{}{{\caption{Example Configuration with the LDAP idmap Backend}\label{idmapbackendexample}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	idmap backend = ldap:ldap://ldap-server.quenya.org:636
 # Alternatively, this could be specified as:
 	idmap backend = ldap:ldaps://ldap-server.quenya.org
\end{lstlisting}
\end{example}


\index{LDAP backends} \index{PADL Software} A network administrator who wants to make significant use of LDAP backends will sooner or later be exposed to the excellent work done by PADL Software. PADL {\textless}\url{http://www.padl.com}{\textgreater} have produced and released to open source an array of tools that might be of interest. These tools include:

\begin{itemize}
%--- Item
\item 
\index{nss\_ldap} \index{NSS} \index{AIX} \index{Linux} \index{LDAP} \index{Solaris} \index{UID} \index{GID} {\em{nss\_ldap:}} An LDAP name service switch (NSS) module to provide native name service support for AIX, Linux, Solaris, and other operating systems. This tool can be used for centralized storage and retrieval of UIDs and GIDs.


%--- Item
\item 
\index{pam\_ldap} \index{PAM} \index{LDAP} \index{access authentication} {\em{pam\_ldap:}} A PAM module that provides LDAP integration for UNIX/Linux system access authentication.


%--- Item
\item 
\index{idmap\_ad} \index{IDMAP backend} \index{RFC 2307} \index{PADL} {\em{idmap\_ad:}} An IDMAP backend that supports the Microsoft Services for UNIX RFC 2307 schema available from the PADL Web site\label{id2545385}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.padl.com/download/xad_oss_plugins.tar.gz}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2545385}.

\end{itemize}
\subsection{Comments Regarding LDAP}
\label{id2545395}\hypertarget{id2545395}{}%

\index{LDAP!directories} \index{architecture} \index{FIM} \index{SSO} There is much excitement and interest in LDAP directories in the information technology world today. The LDAP architecture was designed to be highly scalable. It was also designed for use across a huge number of potential areas of application encompassing a wide range of operating systems and platforms. LDAP technologies are at the heart of the current generations of Federated Identity Management (FIM) solutions that can underlie a corporate Single Sign-On (SSO) environment.

\index{LDAP} \index{eDirectory} \index{ADS} \index{authentication} LDAP implementations have been built across a wide variety of platforms. It lies at the core of Microsoft Windows Active Directory services (ADS), Novell's eDirectory, as well as many others. Implementation of the directory services LDAP involves interaction with legacy as well as new generation applications, all of which depend on some form of authentication services.

\index{LDAP directory} \index{authentication} \index{access controls} \index{intermediate tools} \index{middle-ware} \index{central environment} \index{infrastructure} \index{login shells} \index{mail} \index{messaging systems} \index{quota controls} \index{printing systems} \index{DNS servers} \index{DHCP servers} UNIX services can utilize LDAP directory information for authentication and access controls through intermediate tools and utilities. The total environment that consists of the LDAP directory and the middle-ware tools and utilities makes it possible for all user access to the UNIX platform to be managed from a central environment and yet distributed to wherever the point of need may be physically located. Applications that benefit from this infrastructure include: UNIX login shells, mail and messaging systems, quota controls, printing systems, DNS servers, DHCP servers, and also Samba.

\index{LDAP} \index{passdb backend} \index{scalable} \index{SAM backend} \index{LDAP directory} \index{management costs} Many sites are installing LDAP for the first time in order to provide a scalable passdb backend for Samba. Others are faced with the need to adapt an existing LDAP directory to new uses such as for the Samba SAM backend. Whatever your particular need and attraction to Samba may be, decisions made in respect of the design of the LDAP directory structure and its implementation are of a durable nature for the site. These have far-reaching implications that affect long-term information systems management costs.

\index{LDAP deployment} \index{Directory Information Tree|textit{see} {DIT} } Do not rush into an LDAP deployment. Take the time to understand how the design of the Directory Information Tree (DIT) may impact current and future site needs, as well as the ability to meet them. The way that Samba SAM information should be stored within the DIT varies from site to site and with each implementation new experience is gained. It is well understood by LDAP veterans that first implementations create awakening, second implementations of LDAP create fear, and third-generation deployments bring peace and tranquility.
\subsubsection{Caution Regarding LDAP and Samba}
\label{id2545651}\hypertarget{id2545651}{}%

\index{POSIX identity} \index{networking environment} \index{user accounts} \index{group accounts} \index{machine trust accounts} \index{interdomain trust accounts} \index{intermediate information} Samba requires UNIX POSIX identity information as well as a place to store information that is specific to Samba and the Windows networking environment. The most used information that must be dealt with includes: user accounts, group accounts, machine trust accounts, interdomain trust accounts, and intermediate information specific to Samba internals.

\index{deployment guidelines} \index{HOWTO documents} \index{LDAP} The example deployment guidelines in this book, as well as other books and HOWTO documents available from the internet may not fit with established directory designs and implementations. The existing DIT may not be able to accommodate the simple information layout proposed in common sources. Additionally, you may find that the common scripts and tools that are used to provision the LDAP directory for use with Samba may not suit your needs.

\index{existing LDAP DIT} It is not uncommon, for sites that have existing LDAP DITs to find necessity to generate a set of site-specific scripts and utilities to make it possible to deploy Samba within the scope of site operations. The way that user and group accounts are distributed throughout the DIT may make this a challenging matter. The solution will, of course, be rewarding, but the journey to it may be challenging. Take time to understand site needs and do not rush into deployment.

\index{scripts} \index{tools} Above all, do not blindly use scripts and tools that are not suitable for your site. Check and validate all scripts before you execute them to make sure that the existing infrastructure will not be damaged by inadvertent use of an inappropriate tool.
\subsection{LDAP Directories and Windows Computer Accounts}
\label{id2545779}\hypertarget{id2545779}{}%

\index{turnkey solution} \index{LDAP.} \index{frustrating experience} Samba doesn't provide a turnkey solution to LDAP. It is best to deal with the design and configuration of an LDAP directory prior to integration with Samba. A working knowledge of LDAP makes Samba integration easy, and the lack of a working knowledge of LDAP can make it a frustrating experience.

\index{computer accounts} \index{machine accounts} \index{LDAP} Computer (machine) accounts can be placed wherever you like in an LDAP directory subject to some constraints that are described in this chapter.

\index{POSIX} \index{sambaSamAccount} \index{computer accounts} \index{machine accounts} \index{Windows NT4/200X} \index{user account} \index{trust accounts} The POSIX and sambaSamAccount components of computer (machine) accounts are both used by Samba. Thus, machine accounts are treated inside Samba in the same way that Windows NT4/200X treats them. A user account and a machine account are indistinquishable from each other, except that the machine account ends in a \$ character, as do trust accounts.

\index{user} \index{group} \index{machine} \index{trust} \index{UID} The need for Windows user, group, machine, trust, and other accounts to be tied to a valid UNIX UID is a design decision that was made a long way back in the history of Samba development. It is unlikely that this decision will be reversed or changed during the remaining life of the Samba-3.x series.

\index{UID} \index{SID} \index{NSS} The resolution of a UID from the Windows SID is achieved within Samba through a mechanism that must refer back to the host operating system on which Samba is running. The NSS is the preferred mechanism that shields applications (like Samba) from the need to know everything about every host OS it runs on.

\index{UID} \index{passwd} \index{shadow} \index{group} \index{NSS} \index{winbindd} \index{LDAP} Samba asks the host OS to provide a UID via the {``}passwd{''}, {``}shadow{''}, and {``}group{''} facilities in the NSS control (configuration) file. The best tool for achieving this is left up to the UNIX administrator to determine. It is not imposed by Samba. Samba provides winbindd with its support libraries as one method. It is possible to do this via LDAP, and for that Samba provides the appropriate hooks so that all account entities can be located in an LDAP directory.

\index{PADL} \index{nss\_ldap} \index{UID} \index{LDAP} \index{documentation} For many the weapon of choice is to use the PADL nss\_ldap utility. This utility must be configured so that computer accounts can be resolved to a POSIX/UNIX account UID. That is fundamentally an LDAP design question. The information provided on the Samba list and in the documentation is directed at providing working examples only. The design of an LDAP directory is a complex subject that is beyond the scope of this documentation.

% ------------------------   
% Section 
\section{Account Management Tools}
\label{acctmgmttools}\hypertarget{acctmgmttools}{}%

\index{pdbedit} \index{machine accounts} \index{management tools} Samba provides two tools for management of user and machine accounts: {\bfseries{smbpasswd}} and {\bfseries{pdbedit}}.

\index{pdbedit} \index{password aging} \index{failed logins} The {\bfseries{pdbedit}} can be used to manage account policies in addition to Samba user account information. The policy management capability is used to administer domain default settings for password aging and management controls to handle failed login attempts.

\index{smbpasswd} \index{storage mechanism} \index{SambaSAMAccount} \index{net} Some people are confused when reference is made to {\texttt{\docbookhyphenatedot{smbpasswd}}} because the name refers to a storage mechanism for SambaSAMAccount information, but it is also the name of a utility tool. That tool is destined to eventually be replaced by new functionality that is being added to the {\bfseries{net}} toolset (see \hyperlink{NetCommand}{Chapter {\ref{NetCommand}}, {``}Remote and Local Management: The Net Command{''}}.
\subsection{The smbpasswd Tool}
\label{id2546188}\hypertarget{id2546188}{}%

\index{smbpasswd} \index{passwd} \index{yppasswd} \index{passdb backend} \index{storage methods} The {\bfseries{smbpasswd}} utility is similar to the {\bfseries{passwd}} and {\bfseries{yppasswd}} programs. It maintains the two 32 byte password fields in the passdb backend. This utility operates independently of the actual account and password storage methods used (as specified by the {\ttfamily\itshape{\docbookhyphenatedot{passdb backend}}} in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

\index{smbpasswd} \index{client-server mode} {\bfseries{smbpasswd}} works in a client-server mode where it contacts the local smbd to change the user's password on its behalf. This has enormous benefits.

\index{smbpasswd} \index{change passwords} {\bfseries{smbpasswd}} has the capability to change passwords on Windows NT servers (this only works when the request is sent to the NT PDC if changing an NT domain user's password).

\index{user management} \index{user account!Adding/Deleting} {\bfseries{smbpasswd}} can be used to:

\begin{itemize}
%--- Item
\item 
{\em{add}} user or machine accounts.


%--- Item
\item 
{\em{delete}} user or machine accounts.


%--- Item
\item 
{\em{enable}} user or machine accounts.


%--- Item
\item 
{\em{disable}} user or machine accounts.


%--- Item
\item 
{\em{set to NULL}} user passwords.


%--- Item
\item 
{\em{manage}} interdomain trust accounts.

\end{itemize}

To run smbpasswd as a normal user, just type:


\begin{Verbatim}[]

$ smbpasswd
Old SMB password: secret

\end{Verbatim}
 For {\ttfamily\itshape{\docbookhyphenatedot{secret}}}, type the old value here or press return if there is no old password. 
\begin{Verbatim}[]

New SMB Password: new secret
Repeat New SMB Password: new secret

\end{Verbatim}


If the old value does not match the current value stored for that user, or the two new values do not match each other, then the password will not be changed.

\index{SMB password} When invoked by an ordinary user, the command will allow only the user to change his or her own SMB password.

\index{smbpasswd} \index{SMB password} When run by root, {\bfseries{smbpasswd}} may take an optional argument specifying the username whose SMB password you wish to change. When run as root, {\bfseries{smbpasswd}} does not prompt for or check the old password value, thus allowing root to set passwords for users who have forgotten their passwords.

\index{smbpasswd} \index{passwd} \index{yppasswd} \index{change capabilities} {\bfseries{smbpasswd}} is designed to work in the way familiar to UNIX users who use the {\bfseries{passwd}} or {\bfseries{yppasswd}} commands. While designed for administrative use, this tool provides essential user-level password change capabilities.

\index{smbpasswd} For more details on using {\bfseries{smbpasswd}}, refer to the man page (the definitive reference).
\subsection{The pdbedit Tool}
\label{pdbeditthing}\hypertarget{pdbeditthing}{}%

\index{pdbedit} \index{User Management} \index{account policy} \index{User Accounts!Adding/Deleting} {\bfseries{pdbedit}} is a tool that can be used only by root. It is used to manage the passdb backend, as well as domain-wide account policy settings. {\bfseries{pdbedit}} can be used to:

\begin{itemize}
%--- Item
\item 
add, remove, or modify user accounts.


%--- Item
\item 
list user accounts.


%--- Item
\item 
migrate user accounts.


%--- Item
\item 
migrate group accounts.


%--- Item
\item 
manage account policies.


%--- Item
\item 
manage domain access policy settings.

\end{itemize}

\index{Sarbanes-Oxley} Under the terms of the Sarbanes-Oxley Act of 2002, American businesses and organizations are mandated to implement a series of {\texttt{\docbookhyphenatedot{internal controls}}} and procedures to communicate, store, and protect financial data. The Sarbanes-Oxley Act has far reaching implications in respect of:

\begin{enumerate}
%--- Item
\item 
Who has access to information systems that store financial data.


%--- Item
\item 
How personal and financial information is treated among employees and business partners.


%--- Item
\item 
How security vulnerabilities are managed.


%--- Item
\item 
Security and patch level maintenance for all information systems.


%--- Item
\item 
How information systems changes are documented and tracked.


%--- Item
\item 
How information access controls are implemented and managed.


%--- Item
\item 
Auditability of all information systems in respect of change and security.


%--- Item
\item 
Disciplinary procedures and controls to ensure privacy.

\end{enumerate}

\index{accountability} \index{compliance} In short, the Sarbanes-Oxley Act of 2002 is an instrument that enforces accountability in respect of business related information systems so as to ensure the compliance of all information systems that are used to store personal information and particularly for financial records processing. Similar accountabilities are being demanded around the world.

\index{laws} \index{regulations} \index{pdbedit} \index{access controls} \index{manage accounts} The need to be familiar with the Samba tools and facilities that permit information systems operation in compliance with government laws and regulations is clear to all. The {\bfseries{pdbedit}} is currently the only Samba tool that provides the capacity to manage account and systems access controls and policies. During the remaining life-cycle of the Samba-3 series it is possible the new tools may be implemented to aid in this important area.

Domain global policy controls available in Windows NT4 compared with Samba is shown in \hyperlink{policycontrols}{Table {\ref{policycontrols}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{policycontrols}{}%
\captionswapskip{}{{\caption{NT4 Domain v's Samba Policy Controls}\label{policycontrols}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|>{\hsize=1.428571428571428\hsize\RaggedRight}X|>{\hsize=1.428571428571428\hsize\RaggedRight}X|>{\hsize=0.714285714285714\hsize\Centering}X|>{\hsize=0.714285714285714\hsize\Centering}X|>{\hsize=0.714285714285714\hsize\Centering}X|}
\hline 
{{{\bfseries NT4 policy Name}}} & {{{\bfseries Samba Policy Name}}} & {{{\bfseries NT4 Range}}} & {{{\bfseries Samba Range}}} & {{{\bfseries Samba Default}}} \tabularnewline
 \hline 
{{Maximum Password Age}} & {{maximum password age}} & {{0 - 999 (days)}} & {{0 - 4294967295 (sec)}} & {{4294967295}} \tabularnewline
 \hline 
{{Minimum Password Age}} & {{minimum password age}} & {{0 - 999 (days)}} & {{0 - 4294967295 (sec)}} & {{0}} \tabularnewline
 \hline 
{{Mimimum Password Length}} & {{min password length}} & {{1 - 14 (Chars)}} & {{0 - 4294967295 (Chars)}} & {{5}} \tabularnewline
 \hline 
{{Password Uniqueness}} & {{password history}} & {{0 - 23 (\#)}} & {{0 - 4294967295 (\#)}} & {{0}} \tabularnewline
 \hline 
{{Account Lockout - Reset count after}} & {{reset count minutes}} & {{1 - 99998 (min)}} & {{0 - 4294967295 (min)}} & {{30}} \tabularnewline
 \hline 
{{Lockout after bad logon attempts}} & {{bad lockout attempt}} & {{0 - 998 (\#)}} & {{0 - 4294967295 (\#)}} & {{0}} \tabularnewline
 \hline 
{{*** Not Known ***}} & {{disconnect time}} & {{TBA}} & {{0 - 4294967295}} & {{0}} \tabularnewline
 \hline 
{{Lockout Duration}} & {{lockout duration}} & {{1 - 99998 (min)}} & {{0 - 4294967295 (min)}} & {{30}} \tabularnewline
 \hline 
{{Users must log on in order to change password}} & {{user must logon to change password}} & {{0/1}} & {{0 - 4294967295}} & {{0}} \tabularnewline
 \hline 
{{*** Registry Setting ***}} & {{refuse machine password change}} & {{0/1}} & {{0 - 4294967295}} & {{0}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


\index{pdbedit} \index{policy settings} \index{account security} \index{smbpasswd} The {\bfseries{pdbedit}} tool is the only one that can manage the account security and policy settings. It is capable of all operations that smbpasswd can do as well as a superset of them.

\index{pdbedit} \index{account import/export} \index{passdb backend} One particularly important purpose of the {\bfseries{pdbedit}} is to allow the import/export of account information from one passdb backend to another.
\subsubsection{User Account Management}
\label{id2547179}\hypertarget{id2547179}{}%

\index{pdbedit} \index{smbpasswd} \index{system accounts} \index{user account} \index{domain user manager} \index{add user script} \index{interface scripts} The {\bfseries{pdbedit}} tool, like the {\bfseries{smbpasswd}} tool, requires that a POSIX user account already exists in the UNIX/Linux system accounts database (backend). Neither tool will call out to the operating system to create a user account because this is considered to be the responsibility of the system administrator. When the Windows NT4 domain user manager is used to add an account, Samba will implement the {\texttt{\docbookhyphenatedot{add user script}}} (as well as the other interface scripts) to ensure that user, group and machine accounts are correctly created and changed. The use of the {\bfseries{pdbedit}} tool does not make use of these interface scripts.

\index{pdbedit} \index{POSIX account} Before attempting to use the {\bfseries{pdbedit}} tool to manage user and machine accounts, make certain that a system (POSIX) account has already been created.
\subparagraph*{Listing User and Machine Accounts}
\label{id2547285}\hypertarget{id2547285}{}%

\index{tdbsam} \index{password backend} The following is an example of the user account information that is stored in a tdbsam password backend. This listing was produced by running: 
\begin{Verbatim}[]

$ pdbedit -Lv met
UNIX username:        met
NT username:          met
Account Flags:        [U          ]
User SID:             S-1-5-21-1449123459-1407424037-3116680435-2004
Primary Group SID:    S-1-5-21-1449123459-1407424037-3116680435-1201
Full Name:            Melissa E Terpstra
Home Directory:       \\frodo\met\Win9Profile
HomeDir Drive:        H:
Logon Script:         scripts\logon.bat
Profile Path:         \\frodo\Profiles\met
Domain:               MIDEARTH
Account desc:
Workstations:         melbelle
Munged dial:
Logon time:           0
Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
Kickoff time:         Mon, 18 Jan 2038 20:14:07 GMT
Password last set:    Sat, 14 Dec 2002 14:37:03 GMT
Password can change:  Sat, 14 Dec 2002 14:37:03 GMT
Password must change: Mon, 18 Jan 2038 20:14:07 GMT

\end{Verbatim}


\index{smbpasswd format} Accounts can also be listed in the older {\texttt{\docbookhyphenatedot{smbpasswd}}} format: 
\begin{Verbatim}[]

root# pdbedit -Lw
root:0:84B0D8E14D158FF8417EAF50CFAC29C3:
     AF6DD3FD4E2EA8BDE1695A3F05EFBF52:[U          ]:LCT-42681AB8:
jht:1000:6BBC4159020A52741486235A2333E4D2:
     CC099521AD554A3C3CF2556274DBCFBC:[U          ]:LCT-40D75B5B:
rcg:1002:E95D4331A6F23AF8AAD3B435B51404EE:
     BB0F2C39B04CA6100F0E535DF8314B43:[U          ]:LCT-40D7C5A3:
afw:1003:1AAFA7F9F6DC1DEAAAD3B435B51404EE:
     CE92C2F9471594CDC4E7860CA6BC62DB:[T          ]:LCT-40DA501F:
met:1004:A2848CB7E076B435AAD3B435B51404EE:
     F25F5D3405085C555236B80B7B22C0D2:[U          ]:LCT-4244FAB8:
aurora$:1005:060DE593EA638B8ACC4A19F14D2FF2BB:
     060DE593EA638B8ACC4A19F14D2FF2BB:[W          ]:LCT-4173E5CC:
temptation$:1006:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
     A96703C014E404E33D4049F706C45EE9:[W          ]:LCT-42BF0C57:
vaioboss$:1001:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
     88A30A095160072784C88F811E89F98A:[W          ]:LCT-41C3878D:
frodo$:1008:15891DC6B843ECA41249940C814E316B:
     B68EADCCD18E17503D3DAD3E6B0B9A75:[W          ]:LCT-42B7979F:
marvel$:1011:BF709959C3C94E0B3958B7B84A3BB6F3:
     C610EFE9A385A3E8AA46ADFD576E6881:[W          ]:LCT-40F07A4

\end{Verbatim}
 \index{login id} \index{UID} \index{LanManger password} \index{NT password} \index{Account Flags} \index{LCT|textit{see} {last change time} } The account information that was returned by this command in order from left to right consists of the following colon separated data:

\begin{itemize}
%--- Item
\item 
Login ID.


%--- Item
\item 
UNIX UID.


%--- Item
\item 
Microsoft LanManager password hash (password converted to upper-case then hashed.


%--- Item
\item 
Microsoft NT password hash (hash of the case-preserved password).


%--- Item
\item 
Samba SAM Account Flags.


%--- Item
\item 
The LCT data (password last change time).

\end{itemize}

\index{Account Flags} \index{pdbedit} The Account Flags parameters are documented in the {\bfseries{pdbedit}} man page, and are briefly documented in \hyperlink{TOSHARG-acctflags}{Section {\ref{TOSHARG-acctflags}}}.

\index{last change time} The LCT data consists of 8 hexadecimal characters representing the time since January 1, 1970, of the time when the password was last changed.
\subparagraph*{Adding User Accounts}
\label{id2547505}\hypertarget{id2547505}{}%

\index{pdbedit} \index{add a user account} \index{standalone server} \index{domain} \index{SambaSAMAccount} The {\bfseries{pdbedit}} can be used to add a user account to a standalone server or to a domain. In the example shown here the account for the user {\texttt{\docbookhyphenatedot{vlaan}}} has been created before attempting to add the SambaSAMAccount. 
\begin{Verbatim}[]

root#  pdbedit -a vlaan
new password: secretpw
retype new password: secretpw
Unix username:        vlaan
NT username:          vlaan
Account Flags:        [U          ]
User SID:             S-1-5-21-726309263-4128913605-1168186429-3014
Primary Group SID:    S-1-5-21-726309263-4128913605-1168186429-513
Full Name:            Victor Laan
Home Directory:       \\frodo\vlaan
HomeDir Drive:        H:
Logon Script:         scripts\logon.bat
Profile Path:         \\frodo\profiles\vlaan
Domain:               MIDEARTH
Account desc:         Guest User
Workstations:
Munged dial:
Logon time:           0
Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
Kickoff time:         Mon, 18 Jan 2038 20:14:07 GMT
Password last set:    Wed, 29 Jun 2005 19:35:12 GMT
Password can change:  Wed, 29 Jun 2005 19:35:12 GMT
Password must change: Mon, 18 Jan 2038 20:14:07 GMT
Last bad password   : 0
Bad password count  : 0
Logon hours         : FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF

\end{Verbatim}

\subparagraph*{Deleting Accounts}
\label{id2547587}\hypertarget{id2547587}{}%

\index{account deleted} \index{SambaSAMAccount} \index{pdbedit} \index{passdb backend} An account can be deleted from the SambaSAMAccount database 
\begin{Verbatim}[]

root#  pdbedit -x vlaan

\end{Verbatim}
 The account is removed without further screen output. The account is removed only from the SambaSAMAccount (passdb backend) database, it is not removed from the UNIX account backend.

\index{delete user script} \index{pdbedit} The use of the NT4 domain user manager to delete an account will trigger the {\ttfamily\itshape{\docbookhyphenatedot{delete user script}}}, but not the {\bfseries{pdbedit}} tool.
\subparagraph*{Changing User Accounts}
\label{id2547668}\hypertarget{id2547668}{}%

\index{pdbedit} Refer to the {\bfseries{pdbedit}} man page for a full synopsis of all operations that are available with this tool.

\index{pdbedit} An example of a simple change in the user account information is the change of the full name information shown here: 
\begin{Verbatim}[]

root#  pdbedit -r --fullname="Victor Aluicious Laan" vlaan
...
Primary Group SID:    S-1-5-21-726309263-4128913605-1168186429-513
Full Name:            Victor Aluicious Laan
Home Directory:       \\frodo\vlaan
...

\end{Verbatim}


\index{grace time} \index{password expired} \index{expired password} Let us assume for a moment that a user's password has expired and the user is unable to change the password at this time. It may be necessary to give the user additional grace time so that it is possible to continue to work with the account and the original password. This demonstrates how the password expiration settings may be updated 
\begin{Verbatim}[]

root#  pdbedit -Lv vlaan
...
Password last set:    Sun, 09 Sep 2001 22:21:40 GMT
Password can change:  Thu, 03 Jan 2002 15:08:35 GMT
Password must change: Thu, 03 Jan 2002 15:08:35 GMT
Last bad password   : Thu, 03 Jan 2002 15:08:35 GMT
Bad password count  : 2
...

\end{Verbatim}
 \index{bad logon attempts} \index{lock the account} The user has recorded 2 bad logon attempts and the next will lock the account, but the password is also expired. Here is how this account can be reset: 
\begin{Verbatim}[]

root#  pdbedit -z vlaan
...
Password last set:    Sun, 09 Sep 2001 22:21:40 GMT
Password can change:  Thu, 03 Jan 2002 15:08:35 GMT
Password must change: Thu, 03 Jan 2002 15:08:35 GMT
Last bad password   : 0
Bad password count  : 0
...

\end{Verbatim}
 The {\texttt{\docbookhyphenatedot{Password must change:}}} parameter can be reset like this: 
\begin{Verbatim}[]

root#  pdbedit --pwd-must-change-time=1200000000 vlaan
...
Password last set:    Sun, 09 Sep 2001 22:21:40 GMT
Password can change:  Thu, 03 Jan 2002 15:08:35 GMT
Password must change: Thu, 10 Jan 2008 14:20:00 GMT
...

\end{Verbatim}
 Another way to use this tools is to set the date like this: 
\begin{Verbatim}[]

root#  pdbedit --pwd-must-change-time="2010-01-01" \
              --time-format="%Y-%m-%d" vlaan
...
Password last set:    Sun, 09 Sep 2001 22:21:40 GMT
Password can change:  Thu, 03 Jan 2002 15:08:35 GMT
Password must change: Fri, 01 Jan 2010 00:00:00 GMT
...

\end{Verbatim}
 \index{strptime} \index{time format} Refer to the strptime man page for specific time format information.

\index{pdbedit} \index{SambaSAMAccount} Please refer to the pdbedit man page for further information relating to SambaSAMAccount management.
\subparagraph*{Account Flags Management}
\label{TOSHARG-acctflags}\hypertarget{TOSHARG-acctflags}{}%

\index{Samba SAM account flags} \index{account control block|textit{see} {ACB} } \index{account encode\_bits} \index{account control flags} The Samba SAM account flags are properly called the ACB (account control block) within the Samba source code. In some parts of the Samba source code they are referred to as the account encode\_bits, and also as the account control flags.

\index{pdbedit} \index{user account} \index{machine account} \index{trust account} \index{damaged data} The manual adjustment of user, machine (workstation or server) or an inter-domain trust account account flgas should not be necessary under normal conditions of use of Samba. On the other hand, where this information becomes corrupted for some reason, the ability to correct the damaged data is certainly useful. The tool of choice by which such correction can be affected is the {\bfseries{pdbedit}} utility.

\index{account flags} \index{LDAP directory} There have been a few requests for information regarding the account flags from developers who are creating their own Samba management tools. An example of a need for information regarding the proper management of the account flags is evident when developing scripts that will be used to manage an LDAP directory.

\index{pdbedit} \index{account flag order} The account flag field can contain up to 16 characters. Presently, only 11 are in use. These are listed in \hyperlink{accountflags}{Table {\ref{accountflags}}}. The order in which the flags are specified to the {\bfseries{pdbedit}} command is not important. In fact, they can be set without problem in any order in the SambaAcctFlags record in the LDAP directory.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{accountflags}{}%
\captionswapskip{}{{\caption{Samba SAM Account Control Block Flags}\label{accountflags}}}
\captionswapskip{}\begin{tabular}{|c|c|}
\hline 
\docbooktolatexaligncl {{{\bfseries Flag}}} & {{{\bfseries Description}}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{D}} & \docbooktolatexalignll {{Account is disabled.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{H}} & \docbooktolatexalignll {{A home directory is required.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{I}} & \docbooktolatexalignll {{An inter-domain trust account.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{L}} & \docbooktolatexalignll {{Account has been auto-locked.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{M}} & \docbooktolatexalignll {{An MNS (Microsoft network service) logon account.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{N}} & \docbooktolatexalignll {{Password not required.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{S}} & \docbooktolatexalignll {{A server trust account.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{T}} & \docbooktolatexalignll {{Temporary duplicate account entry.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{U}} & \docbooktolatexalignll {{A normal user account.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{W}} & \docbooktolatexalignll {{A workstation trust account.}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{X}} & \docbooktolatexalignll {{Password does not expire.}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


\index{pdbedit} \index{account control flags} An example of use of the {\bfseries{pdbedit}} utility to set the account control flags is shown here: 
\begin{Verbatim}[]

root#  pdbedit -r -c "[DLX]" jht
Unix username:        jht
NT username:          jht
Account Flags:        [DHULX      ]
User SID:             S-1-5-21-729263-4123605-1186429-3000
Primary Group SID:    S-1-5-21-729263-4123605-1186429-513
Full Name:            John H Terpstra,Utah Office
Home Directory:       \\aurora\jht
HomeDir Drive:        H:
Logon Script:         scripts\logon.bat
Profile Path:         \\aurora\profiles\jht
Domain:               MIDEARTH
Account desc:         BluntObject
Workstations:
Logon time:           0
Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
Kickoff time:         0
Password last set:    Sun, 03 Jul 2005 23:19:18 GMT
Password can change:  Sun, 03 Jul 2005 23:19:18 GMT
Password must change: Mon, 18 Jan 2038 20:14:07 GMT
Last bad password   : 0
Bad password count  : 0
Logon hours         : FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF

\end{Verbatim}
 \index{default settings} The flags can be reset to the default settings by executing: 
\begin{Verbatim}[]

root#  pdbedit -r -c "[]" jht
Unix username:        jht
NT username:          jht
Account Flags:        [U          ]
User SID:             S-1-5-21-729263-4123605-1186429-3000
Primary Group SID:    S-1-5-21-729263-4123605-1186429-513
Full Name:            John H Terpstra,Utah Office
Home Directory:       \\aurora\jht
HomeDir Drive:        H:
Logon Script:         scripts\logon.bat
Profile Path:         \\aurora\profiles\jht
Domain:               MIDEARTH
Account desc:         BluntObject
Workstations:
Logon time:           0
Logoff time:          Mon, 18 Jan 2038 20:14:07 GMT
Kickoff time:         0
Password last set:    Sun, 03 Jul 2005 23:19:18 GMT
Password can change:  Sun, 03 Jul 2005 23:19:18 GMT
Password must change: Mon, 18 Jan 2038 20:14:07 GMT
Last bad password   : 0
Bad password count  : 0
Logon hours         : FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF

\end{Verbatim}

\subparagraph*{Domain Account Policy Managment}
\label{id2548342}\hypertarget{id2548342}{}%

\index{domain account access policies} \index{access policies} To view the domain account access policies that may be configured execute: 
\begin{Verbatim}[]

root#  pdbedit -P ?
No account policy by that name
Account policy names are :
min password length
password history
user must logon to change password
maximum password age
minimum password age
lockout duration
reset count minutes
bad lockout attempt
disconnect time
refuse machine password change

\end{Verbatim}


Commands will be executed to establish controls for our domain as follows:

\begin{enumerate}
%--- Item
\item 
min password length = 8 characters.


%--- Item
\item 
password history = last 4 passwords.


%--- Item
\item 
maximum password age = 90 days.


%--- Item
\item 
minimum password age = 7 days.


%--- Item
\item 
bad lockout attempt = 8 bad logon attempts.


%--- Item
\item 
lockout duration = forever, account must be manually reenabled.

\end{enumerate}

The following command execution will achieve these settings: 
\begin{Verbatim}[]

root#  pdbedit -P "min password length" -C 8
account policy value for min password length was 5
account policy value for min password length is now 8
root#  pdbedit -P "password history" -C 4
account policy value for password history was 0
account policy value for password history is now 4
root#  pdbedit -P "maximum password age" -C 7776000
account policy value for maximum password age was 4294967295
account policy value for maximum password age is now 7776000
root#  pdbedit -P "minimum password age" -C 7
account policy value for minimum password age was 0
account policy value for minimum password age is now 7
root#  pdbedit -P "bad lockout attempt" -C 8
account policy value for bad lockout attempt was 0
account policy value for bad lockout attempt is now 8
root#  pdbedit -P "lockout duration" -C -1
account policy value for lockout duration was 30
account policy value for lockout duration is now 4294967295

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

To set the maximum (infinite) lockout time use the value of -1.
\end{admonition}


\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Account policies must be set individually on each PDC and BDC. At this time (Samba 3.0.11 to Samba 3.0.14a) account policies are not replicated automatically. This may be fixed before Samba 3.0.20 ships or some time there after. Please check the WHATSNEW.txt file in the Samba-3 tarball for specific update notiations regarding this facility.
\end{admonition}

\subsubsection{Account Import/Export}
\label{id2548509}\hypertarget{id2548509}{}%

\index{pdbedit} \index{account import/export} \index{authentication} The {\bfseries{pdbedit}} tool allows import/export of authentication (account) databases from one backend to another. For example, to import/export accounts from an old {\texttt{\docbookhyphenatefilename{smbpasswd}}} database to a {\ttfamily\itshape{\docbookhyphenatedot{tdbsam}}} backend:
\begin{enumerate}

\item{\index{pdbedit} 
\begin{Verbatim}[]

root# pdbedit -i smbpasswd -e tdbsam

\end{Verbatim}
}

\item{\index{smbpasswd} Replace the {\ttfamily\itshape{\docbookhyphenatedot{smbpasswd}}} with {\ttfamily\itshape{\docbookhyphenatedot{tdbsam}}} in the {\ttfamily\itshape{\docbookhyphenatedot{passdb backend}}} configuration in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}.}
\end{enumerate}

% ------------------------   
% Section 
\section{Password Backends}
\label{id2548639}\hypertarget{id2548639}{}%

\index{account database} \index{SMB/CIFS server} Samba offers flexibility in backend account database design. The flexibility is immediately obvious as one begins to explore this capability. Recent changes to Samba (since 3.0.23) have removed the mulitple backend feature in order to simplify problems that broke some installations. This removal has made the internal operation of Samba-3 more consistent and predictable.

\index{multiple backends} \index{tdbsam databases} Beginning with Samba 3.0.23 it is no longer possible to specify use of mulitple passdb backends. Earlier versions of Samba-3 made it possible to specify multiple password backends, and even multiple backends of the same type. The multiple passdb backend capability caused many problems with name to SID and SID to name ID resolution. The Samba team wrestled with the challenges and decided that this feature needed to be removed.
\subsection{Plaintext}
\label{id2548695}\hypertarget{id2548695}{}%

\index{user database} \index{/etc/samba/smbpasswd} \index{/etc/smbpasswd} \index{password encryption} \index{/etc/passwd} \index{PAM} Older versions of Samba retrieved user information from the UNIX user database and eventually some other fields from the file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smbpasswd}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}smbpasswd}}}. When password encryption is disabled, no SMB-specific data is stored at all. Instead, all operations are conducted via the way that the Samba host OS will access its {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} database. On most Linux systems, for example, all user and group resolution is done via PAM.
\subsection{smbpasswd: Encrypted Password Database}
\label{id2548774}\hypertarget{id2548774}{}%

\index{SAM backend!smbpasswd} \index{user account} \index{LM/NT password hashes} \index{smbpasswd} Traditionally, when configuring \smbconfoption{encrypt passwords} = yes in Samba's {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, user account information such as username, LM/NT password hashes, password change times, and account flags have been stored in the {\texttt{\docbookhyphenatefilename{smbpasswd(\dbz{}5)\dbz{}}}} file. There are several disadvantages to this approach for sites with large numbers of users (counted in the thousands).

\begin{itemize}
%--- Item
\item 
\index{lookups} The first problem is that all lookups must be performed sequentially. Given that there are approximately two lookups per domain logon (one during intial logon validation and one for a session connection setup, such as when mapping a network drive or printer), this is a performance bottleneck for large sites. What is needed is an indexed approach such as that used in databases.


%--- Item
\item 
\index{smbpasswd} \index{replicate} \index{rsync} \index{ssh} \index{custom scripts} The second problem is that administrators who desire to replicate an smbpasswd file to more than one Samba server are left to use external tools such as {\bfseries{rsync(1)}} and {\bfseries{ssh(1)}} and write custom, in-house scripts.


%--- Item
\item 
\index{smbpasswd} \index{home directory} \index{password expiration} \index{relative identifier} \index{relative identifier|textit{see} {RID} } Finally, the amount of information that is stored in an smbpasswd entry leaves no room for additional attributes such as a home directory, password expiration time, or even a relative identifier (RID).

\end{itemize}

\index{user attributes} \index{smbd} \index{API} \index{samdb interface} As a result of these deficiencies, a more robust means of storing user attributes used by smbd was developed. The API that defines access to user accounts is commonly referred to as the samdb interface (previously, this was called the passdb API and is still so named in the Samba source code trees).

\index{passdb backends} \index{smbpasswd plaintext database} \index{tdbsam} \index{ldapsam} \index{enterprise} Samba provides an enhanced set of passdb backends that overcome the deficiencies of the smbpasswd plaintext database. These are tdbsam and ldapsam. Of these, ldapsam will be of most interest to large corporate or enterprise sites.
\subsection{tdbsam}
\label{id2549044}\hypertarget{id2549044}{}%

\index{SAM backend!tdbsam} \index{trivial database|textit{see} {TDB} } \index{machine account} Samba can store user and machine account data in a {``}TDB{''} (trivial database). Using this backend does not require any additional configuration. This backend is recommended for new installations that do not require LDAP.

\index{tdbsam} \index{PDC} \index{BDC} \index{scalability} As a general guide, the Samba Team does not recommend using the tdbsam backend for sites that have 250 or more users. Additionally, tdbsam is not capable of scaling for use in sites that require PDB/BDC implementations that require replication of the account database. Clearly, for reason of scalability, the use of ldapsam should be encouraged.

\index{250-user limit} \index{performance-based} \index{tdbsam} The recommendation of a 250-user limit is purely based on the notion that this would generally involve a site that has routed networks, possibly spread across more than one physical location. The Samba Team has not at this time established the performance-based scalability limits of the tdbsam architecture.

\index{4,500 user accounts} \index{passdb backend} \index{tdbsam} \index{SambaSAMAccount} There are sites that have thousands of users and yet require only one server. One site recently reported having 4,500 user accounts on one UNIX system and reported excellent performance with the {\texttt{\docbookhyphenatedot{tdbsam}}} passdb backend. The limitation of where the {\texttt{\docbookhyphenatedot{tdbsam}}} passdb backend can be used is not one pertaining to a limitation in the TDB storage system, it is based only on the need for a reliable distribution mechanism for the SambaSAMAccount backend.
\subsection{ldapsam}
\label{id2549209}\hypertarget{id2549209}{}%

\index{LDAP} \index{ldapsam} \index{SAM backend!ldapsam} There are a few points to stress that the ldapsam does not provide. The LDAP support referred to in this documentation does not include:

\begin{itemize}
%--- Item
\item 
A means of retrieving user account information from a Windows 200x Active Directory server.


%--- Item
\item 
A means of replacing /etc/passwd.

\end{itemize}

\index{LDAP} \index{NSS} \index{PAM} \index{LGPL} The second item can be accomplished by using LDAP NSS and PAM modules. LGPL versions of these libraries can be obtained from PADL Software\label{id2549292}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.padl.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549292}. More information about the configuration of these packages may be found in {\em{LDAP, System Administration}} by Gerald Carter, Chapter 6, Replacing NIS"\label{id2549300}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://safari.oreilly.com/?XmlId=1-56592-491-6}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549300}.

\index{LDAP directory} \index{smbpasswd} \index{directory server} This document describes how to use an LDAP directory for storing Samba user account information traditionally stored in the smbpasswd(5) file. It is assumed that the reader already has a basic understanding of LDAP concepts and has a working directory server already installed. For more information on LDAP architectures and directories, please refer to the following sites:

\begin{itemize}
%--- Item
\item 
OpenLDAP\label{id2549349}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.openldap.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549349}


%--- Item
\item 
Sun One Directory Server\label{id2549357}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.sun.com/software/products/directory_srvr_ee/index.xml}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549357}


%--- Item
\item 
Novell eDirectory\label{id2549367}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.novell.com/products/edirectory/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549367}


%--- Item
\item 
IBM Tivoli Directory Server\label{id2549376}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www-306.ibm.com/software/tivoli/products/directory-server/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549376}


%--- Item
\item 
Red Hat Directory Server\label{id2549385}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.redhat.com/software/rha/directory/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549385}


%--- Item
\item 
Fedora Directory Server\label{id2549394}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxsecurity.com/content/view/119229}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549394}

\end{itemize}

Two additional Samba resources that may prove to be helpful are:

\begin{itemize}
%--- Item
\item 
\index{Samba-PDC-LDAP-HOWTO} The Samba-PDC-LDAP-HOWTO\label{id2549420}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549420} maintained by Ignacio Coupeau.


%--- Item
\item 
\index{IDEALX} \index{NT migration scripts} \index{smbldap-tools} The NT migration scripts from IDEALX\label{id2549455}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://samba.idealx.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549455} that are geared to manage users and groups in such a Samba-LDAP domain controller configuration. Idealx also produced the smbldap-tools and the Interactive Console Management tool.

\end{itemize}
\subsubsection{Supported LDAP Servers}
\label{id2549467}\hypertarget{id2549467}{}%

\index{LDAP} \index{ldapsam} \index{OpenLDAP} \index{Netscape's Directory Server} The LDAP ldapsam code was developed and tested using the OpenLDAP 2.x server and client libraries. The same code should work with Netscape's Directory Server and client SDK. However, there are bound to be compile errors and bugs. These should not be hard to fix. Please submit fixes via the process outlined in \hyperlink{bugreport}{Chapter {\ref{bugreport}}, {``}Reporting Bugs{''}}.

Samba is capable of working with any standards-compliant LDAP server.
\subsubsection{Schema and Relationship to the RFC 2307 posixAccount}
\label{id2549523}\hypertarget{id2549523}{}%

Samba-3.0 includes the necessary schema file for OpenLDAP 2.x in the {\texttt{\docbookhyphenatefilename{examples/\dbz{}LDAP/\dbz{}samba.\dbz{}schema}}} directory of the source code distribution tarball. The schema entry for the sambaSamAccount ObjectClass is shown here: 
\begin{Verbatim}[]

ObjectClass (1.3.6.1.4.1.7165.2.2.6 NAME 'sambaSamAccount' SUP top AUXILIARY
    DESC 'Samba-3.0 Auxiliary SAM Account'
    MUST ( uid $ sambaSID )
    MAY  ( cn $ sambaLMPassword $ sambaNTPassword $ sambaPwdLastSet $
          sambaLogonTime $ sambaLogoffTime $ sambaKickoffTime $
          sambaPwdCanChange $ sambaPwdMustChange $ sambaAcctFlags $
          displayName $ sambaHomePath $ sambaHomeDrive $ sambaLogonScript $
          sambaProfilePath $ description $ sambaUserWorkstations $
          sambaPrimaryGroupSID $ sambaDomainName ))

\end{Verbatim}


\index{samba.schema} \index{OpenLDAP} \index{OID} The {\texttt{\docbookhyphenatefilename{samba.\dbz{}schema}}} file has been formatted for OpenLDAP 2.0/2.1. The Samba Team owns the OID space used by the above schema and recommends its use. If you translate the schema to be used with Netscape DS, please submit the modified schema file as a patch to jerry@samba.org\label{id2549592}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:jerry@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2549592}.

\index{smbpasswd} \index{/etc/passwd} \index{sambaSamAccount} \index{AUXILIARY} \index{ObjectClass} \index{LDAP} \index{RFC 2307.} Just as the smbpasswd file is meant to store information that provides information additional to a user's {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} entry, so is the sambaSamAccount object meant to supplement the UNIX user account information. A sambaSamAccount is an {\texttt{\docbookhyphenatedot{AUXILIARY}}} ObjectClass, so it can be used to augment existing user account information in the LDAP directory, thus providing information needed for Samba account handling. However, there are several fields (e.g., uid) that overlap with the posixAccount ObjectClass outlined in RFC 2307. This is by design.

\index{account information} \index{sambaSamAccount} \index{posixAccount} \index{ObjectClasses} \index{smbd} \index{getpwnam} \index{LDAP} \index{NIS} \index{NSS} In order to store all user account information (UNIX and Samba) in the directory, it is necessary to use the sambaSamAccount and posixAccount ObjectClasses in combination. However, {\bfseries{smbd}} will still obtain the user's UNIX account information via the standard C library calls, such as getpwnam(). This means that the Samba server must also have the LDAP NSS library installed and functioning correctly. This division of information makes it possible to store all Samba account information in LDAP, but still maintain UNIX account information in NIS while the network is transitioning to a full LDAP infrastructure.
\subsubsection{OpenLDAP Configuration}
\label{id2549757}\hypertarget{id2549757}{}%

\index{sambaSamAccount} \index{OpenLDAP} \index{slapd} \index{samba.schema} To include support for the sambaSamAccount object in an OpenLDAP directory server, first copy the samba.schema file to slapd's configuration directory. The samba.schema file can be found in the directory {\texttt{\docbookhyphenatefilename{examples/\dbz{}LDAP}}} in the Samba source distribution. 
\begin{Verbatim}[]

root# cp samba.schema /etc/openldap/schema/

\end{Verbatim}


\index{samba.schema} \index{slapd.conf} \index{sambaSamAccount} \index{cosine.schema} \index{uid} \index{inetorgperson.schema} \index{displayName} \index{attribute} Next, include the {\texttt{\docbookhyphenatefilename{samba.\dbz{}schema}}} file in {\texttt{\docbookhyphenatefilename{slapd.\dbz{}conf}}}. The sambaSamAccount object contains two attributes that depend on other schema files. The {\ttfamily\itshape{\docbookhyphenatedot{uid}}} attribute is defined in {\texttt{\docbookhyphenatefilename{cosine.\dbz{}schema}}} and the {\ttfamily\itshape{\docbookhyphenatedot{displayName}}} attribute is defined in the {\texttt{\docbookhyphenatefilename{inetorgperson.\dbz{}schema}}} file. Both of these must be included before the {\texttt{\docbookhyphenatefilename{samba.\dbz{}schema}}} file. 
\begin{Verbatim}[]

## /etc/openldap/slapd.conf

## schema files (core.schema is required by default)
include	           /etc/openldap/schema/core.schema

## needed for sambaSamAccount
include            /etc/openldap/schema/cosine.schema
include            /etc/openldap/schema/inetorgperson.schema
include            /etc/openldap/schema/nis.schema
include            /etc/openldap/schema/samba.schema
....

\end{Verbatim}


\index{sambaSamAccount} \index{posixAccount} \index{posixGroup} \index{ObjectClasses} It is recommended that you maintain some indices on some of the most useful attributes, as in the following example, to speed up searches made on sambaSamAccount ObjectClasses (and possibly posixAccount and posixGroup as well):


\begin{Verbatim}[]

# Indices to maintain
## required by OpenLDAP
index objectclass             eq

index cn                      pres,sub,eq
index sn                      pres,sub,eq
## required to support pdb_getsampwnam
index uid                     pres,sub,eq
## required to support pdb_getsambapwrid()
index displayName             pres,sub,eq

## uncomment these if you are storing posixAccount and
## posixGroup entries in the directory as well
##index uidNumber               eq
##index gidNumber               eq
##index memberUid               eq

index   sambaSID              eq
index   sambaPrimaryGroupSID  eq
index   sambaDomainName       eq
index   default               sub

\end{Verbatim}


Create the new index by executing: 
\begin{Verbatim}[]

root# ./sbin/slapindex -f slapd.conf

\end{Verbatim}


Remember to restart slapd after making these changes: 
\begin{Verbatim}[]

root# /etc/init.d/slapd restart

\end{Verbatim}

\subsubsection{Initialize the LDAP Database}
\label{id2550040}\hypertarget{id2550040}{}%

\index{LDAP database} \index{account containers} \index{LDIF file} \index{DNS} Before you can add accounts to the LDAP database, you must create the account containers that they will be stored in. The following LDIF file should be modified to match your needs (DNS entries, and so on): 
\begin{Verbatim}[]

# Organization for Samba Base
dn: dc=quenya,dc=org
objectclass: dcObject
objectclass: organization
dc: quenya
o: Quenya Org Network
description: The Samba-3 Network LDAP Example

# Organizational Role for Directory Management
dn: cn=Manager,dc=quenya,dc=org
objectclass: organizationalRole
cn: Manager
description: Directory Manager

# Setting up container for Users OU
dn: ou=People,dc=quenya,dc=org
objectclass: top
objectclass: organizationalUnit
ou: People

# Setting up admin handle for People OU
dn: cn=admin,ou=People,dc=quenya,dc=org
cn: admin
objectclass: top
objectclass: organizationalRole
objectclass: simpleSecurityObject
userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz

# Setting up container for groups
dn: ou=Groups,dc=quenya,dc=org
objectclass: top
objectclass: organizationalUnit
ou: Groups

# Setting up admin handle for Groups OU
dn: cn=admin,ou=Groups,dc=quenya,dc=org
cn: admin
objectclass: top
objectclass: organizationalRole
objectclass: simpleSecurityObject
userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz

# Setting up container for computers
dn: ou=Computers,dc=quenya,dc=org
objectclass: top
objectclass: organizationalUnit
ou: Computers

# Setting up admin handle for Computers OU
dn: cn=admin,ou=Computers,dc=quenya,dc=org
cn: admin
objectclass: top
objectclass: organizationalRole
objectclass: simpleSecurityObject
userPassword: {SSHA}c3ZM9tBaBo9autm1dL3waDS21+JSfQVz

\end{Verbatim}


\index{userPassword} \index{slappasswd} The userPassword shown above should be generated using {\bfseries{slappasswd}}.

\index{LDIF} \index{LDAP} The following command will then load the contents of the LDIF file into the LDAP database. \index{slapadd} 
\begin{Verbatim}[]

$ slapadd -v -l initldap.dif

\end{Verbatim}


Do not forget to secure your LDAP server with an adequate access control list as well as an admin password.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{secrets.tdb} Before Samba can access the LDAP server, you need to store the LDAP admin password in the Samba-3 {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}} database by: \index{smbpasswd} 
\begin{Verbatim}[]

root# smbpasswd -w secret

\end{Verbatim}

\end{admonition}

\subsubsection{Configuring Samba}
\label{id2550232}\hypertarget{id2550232}{}%

\index{LDAP} \index{smbd} The following parameters are available in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} only if your version of Samba was built with LDAP support. Samba automatically builds with LDAP support if the LDAP libraries are found. The best method to verify that Samba was built with LDAP support is: 
\begin{Verbatim}[]

root#  smbd -b | grep LDAP
   HAVE_LDAP_H
   HAVE_LDAP
   HAVE_LDAP_DOMAIN2HOSTLIST
   HAVE_LDAP_INIT
   HAVE_LDAP_INITIALIZE
   HAVE_LDAP_SET_REBIND_PROC
   HAVE_LIBLDAP
   LDAP_SET_REBIND_PROC_ARGS

\end{Verbatim}
 If the build of the {\bfseries{smbd}} command you are using does not produce output that includes {\texttt{\docbookhyphenatedot{HAVE\_\dbz{}LDAP\_\dbz{}H}}} it is necessary to discover why the LDAP headers and libraries were not found during compilation.

LDAP-related smb.conf options include these: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	passdb backend = ldapsam:url
 	ldap admin dn
 	ldap delete dn
 	ldap filter
 	ldap group suffix
 	ldap idmap suffix
 	ldap machine suffix
 	ldap passwd sync
 	ldap ssl
 	ldap suffix
 	ldap user suffix
 	ldap replication sleep
 	ldap timeout
 	ldap page size
\end{lstlisting}


These are described in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page and so are not repeated here. However, an example for use with an LDAP directory is shown in \hyperlink{confldapex}{Example {\ref{confldapex}}}

\begin{example}%
\hypertarget{confldapex}{}%
\captionswapskip{}{{\caption{Configuration with LDAP}\label{confldapex}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	security = user
 	encrypt passwords = yes
 	netbios name = MORIA
 	workgroup = NOLDOR
 # LDAP related parameters:
 # Define the DN used when binding to the LDAP servers.
 # The password for this DN is not stored in smb.conf
 # Set it using 'smbpasswd -w secret' to store the
 # passphrase in the secrets.tdb file.
 # If the "ldap admin dn" value changes, it must be reset.
 	ldap admin dn = "cn=Manager,dc=quenya,dc=org"
 # SSL directory connections can be configured by:
 # ('off', 'start tls', or 'on' (default))
 	ldap ssl = start tls
 # syntax: passdb backend = ldapsam:ldap://server-name[:port]
 	passdb backend = ldapsam:ldap://frodo.quenya.org
 # smbpasswd -x delete the entire dn-entry
 	ldap delete dn = no
 # The machine and user suffix are added to the base suffix
 # wrote WITHOUT quotes. NULL suffixes by default
 	ldap user suffix = ou=People
 	ldap group suffix = ou=Groups
 	ldap machine suffix = ou=Computers
 # Trust UNIX account information in LDAP
 # (see the smb.conf man page for details)
 # Specify the base DN to use when searching the directory
 	ldap suffix = dc=quenya,dc=org
\end{lstlisting}
\end{example}

\subsubsection{Accounts and Groups Management}
\label{id2550552}\hypertarget{id2550552}{}%

\index{User Management} \index{User Accounts!Adding/Deleting} Because user accounts are managed through the sambaSamAccount ObjectClass, you should modify your existing administration tools to deal with sambaSamAccount attributes.

\index{sambaSamAccount} \index{/etc/openldap/sldap.conf} \index{NSS} Machine accounts are managed with the sambaSamAccount ObjectClass, just like user accounts. However, it is up to you to store those accounts in a different tree of your LDAP namespace. You should use {``}ou=Groups,dc=quenya,dc=org{''} to store groups and {``}ou=People,dc=quenya,dc=org{''} to store users. Just configure your NSS and PAM accordingly (usually, in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}openldap/\dbz{}sldap.\dbz{}conf}}} configuration file).

\index{POSIX} \index{posixGroup} \index{Domain Groups} \index{ADS} In Samba-3, the group management system is based on POSIX groups. This means that Samba makes use of the posixGroup ObjectClass. For now, there is no NT-like group system management (global and local groups). Samba-3 knows only about {\texttt{\docbookhyphenatedot{Domain Groups}}} and, unlike MS Windows 2000 and Active Directory, Samba-3 does not support nested groups.
\subsubsection{Security and sambaSamAccount}
\label{id2550670}\hypertarget{id2550670}{}%

\index{sambaSAMAccount} There are two important points to remember when discussing the security of sambaSAMAccount entries in the directory.

\begin{itemize}
%--- Item
\item 
{\em{Never}} retrieve the SambaLMPassword or \index{SambaNTPassword} SambaNTPassword attribute values over an unencrypted LDAP session.


%--- Item
\item 
{\em{Never}} allow non-admin users to view the SambaLMPassword or SambaNTPassword attribute values.

\end{itemize}

\index{clear-text} \index{impersonate} \index{LM/NT password hashes} These password hashes are clear-text equivalents and can be used to impersonate the user without deriving the original clear-text strings. For more information on the details of LM/NT password hashes, refer to \hyperlink{passdb}{Chapter {\ref{passdb}}, {``}Account Information Databases{''}}.

\index{encrypted session} \index{StartTLS} \index{LDAPS} \index{secure communications} To remedy the first security issue, the \smbconfoption{ldap ssl} {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter defaults to require an encrypted session (\smbconfoption{ldap    ssl} = on) using the default port of {\texttt{\docbookhyphenatedot{636}}} when contacting the directory server. When using an OpenLDAP server, it is possible to use the StartTLS LDAP extended operation in the place of LDAPS. In either case, you are strongly encouraged to use secure communications protocols (so do not set \smbconfoption{ldap ssl} = off).

\index{LDAPS} \index{StartTLS} \index{LDAPv3} Note that the LDAPS protocol is deprecated in favor of the LDAPv3 StartTLS extended operation. However, the OpenLDAP library still provides support for the older method of securing communication between clients and servers.

\index{harvesting password hashes} \index{ACL} \index{slapd.conf} The second security precaution is to prevent non-administrative users from harvesting password hashes from the directory. This can be done using the following ACL in {\texttt{\docbookhyphenatefilename{slapd.\dbz{}conf}}}:


\begin{Verbatim}[]

## allow the "ldap admin dn" access, but deny everyone else
access to attrs=SambaLMPassword,SambaNTPassword
     by dn="cn=Samba Admin,ou=People,dc=quenya,dc=org" write
     by * none

\end{Verbatim}

\subsubsection{LDAP Special Attributes for sambaSamAccounts}
\label{id2550894}\hypertarget{id2550894}{}%

The sambaSamAccount ObjectClass is composed of the attributes shown in next tables: \hyperlink{attribobjclPartA}{Table {\ref{attribobjclPartA}}}, and \hyperlink{attribobjclPartB}{Table {\ref{attribobjclPartB}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{attribobjclPartA}{}%
\captionswapskip{}{{\caption{Attributes in the sambaSamAccount ObjectClass (LDAP), Part A}\label{attribobjclPartA}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
{{{\texttt{\docbookhyphenatedot{sambaLMPassword}}}}} & {{The LanMan password 16-byte hash stored as a character representation of a hexadecimal string.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaNTPassword}}}}} & {{The NT password 16-byte hash stored as a character representation of a hexadecimal string.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaPwdLastSet}}}}} & {{The integer time in seconds since 1970 when the {\texttt{\docbookhyphenatedot{sambaLMPassword}}} and {\texttt{\docbookhyphenatedot{sambaNTPassword}}} attributes were last set.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaAcctFlags}}}}} & {{String of 11 characters surrounded by square brackets [ ] representing account flags such as U (user), W (workstation), X (no password expiration), I (domain trust account), H (home dir required), S (server trust account), and D (disabled).}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaLogonTime}}}}} & {{Integer value currently unused.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaLogoffTime}}}}} & {{Integer value currently unused.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaKickoffTime}}}}} & {{Specifies the time (UNIX time format) when the user will be locked down and cannot login any longer. If this attribute is omitted, then the account will never expire. Using this attribute together with shadowExpire of the shadowAccount ObjectClass will enable accounts to expire completely on an exact date.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaPwdCanChange}}}}} & {{Specifies the time (UNIX time format) after which the user is allowed to change his password. If this attribute is not set, the user will be free to change his password whenever he wants.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaPwdMustChange}}}}} & {{Specifies the time (UNIX time format) when the user is forced to change his password. If this value is set to 0, the user will have to change his password at first login. If this attribute is not set, then the password will never expire.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaHomeDrive}}}}} & {{Specifies the drive letter to which to map the UNC path specified by sambaHomePath. The drive letter must be specified in the form {``}X:{''} where X is the letter of the drive to map. Refer to the {``}logon drive{''} parameter in the smb.conf(5) man page for more information.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaLogonScript}}}}} & {{The sambaLogonScript property specifies the path of the user's logon script, .CMD, .EXE, or .BAT file. The string can be null. The path is relative to the netlogon share. Refer to the \smbconfoption{logon script} parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for more information.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaProfilePath}}}}} & {{Specifies a path to the user's profile. This value can be a null string, a local absolute path, or a UNC path. Refer to the \smbconfoption{logon path} parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for more information.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaHomePath}}}}} & {{The sambaHomePath property specifies the path of the home directory for the user. The string can be null. If sambaHomeDrive is set and specifies a drive letter, sambaHomePath should be a UNC path. The path must be a network UNC path of the form {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\server\docbooktolatexgobble\string\\share\docbooktolatexgobble\string\\directory}}}. This value can be a null string. Refer to the {\bfseries{logon home}} parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for more information.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{attribobjclPartB}{}%
\captionswapskip{}{{\caption{Attributes in the sambaSamAccount ObjectClass (LDAP), Part B}\label{attribobjclPartB}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
{{{\texttt{\docbookhyphenatedot{sambaUserWorkstations}}}}} & {{Here you can give a comma-separated list of machines on which the user is allowed to login. You may observe problems when you try to connect to a Samba domain member. Because domain members are not in this list, the domain controllers will reject them. Where this attribute is omitted, the default implies no restrictions.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaSID}}}}} & {{The security identifier(SID) of the user. The Windows equivalent of UNIX UIDs.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaPrimaryGroupSID}}}}} & {{The security identifier (SID) of the primary group of the user.}} \tabularnewline
 \hline 
{{{\texttt{\docbookhyphenatedot{sambaDomainName}}}}} & {{Domain the user is part of.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


\index{PDC} \index{sambaSamAccount} The majority of these parameters are only used when Samba is acting as a PDC of a domain (refer to \hyperlink{samba-pdc}{Chapter {\ref{samba-pdc}}, {``}Domain Control{''}}, for details on how to configure Samba as a PDC). The following four attributes are only stored with the sambaSamAccount entry if the values are non-default values:
\index{sambaHomePath}\index{sambaLogonScript}\index{sambaProfilePath}\index{sambaHomeDrive}
\begin{itemize}
%--- Item
\item 
sambaHomePath


%--- Item
\item 
sambaLogonScript


%--- Item
\item 
sambaProfilePath


%--- Item
\item 
sambaHomeDrive

\end{itemize}

\index{sambaSamAccount} \index{PDC} \index{smbHome} These attributes are only stored with the sambaSamAccount entry if the values are non-default values. For example, assume MORIA has now been configured as a PDC and that \smbconfoption{logon home} = \textbackslash \textbackslash \%L\textbackslash \%u was defined in its {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. When a user named {``}becky{''} logs on to the domain, the \smbconfoption{logon home} string is expanded to \textbackslash \textbackslash MORIA\textbackslash becky. If the smbHome attribute exists in the entry {``}uid=becky,ou=People,dc=samba,dc=org{''}, this value is used. However, if this attribute does not exist, then the value of the \smbconfoption{logon home} parameter is used in its place. Samba will only write the attribute value to the directory entry if the value is something other than the default (e.g., {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\MOBY\docbooktolatexgobble\string\\becky}}}).
\subsubsection{Example LDIF Entries for a sambaSamAccount}
\label{id2551387}\hypertarget{id2551387}{}%

The following is a working LDIF that demonstrates the use of the SambaSamAccount ObjectClass: 
\begin{Verbatim}[]

dn: uid=guest2, ou=People,dc=quenya,dc=org
sambaLMPassword: 878D8014606CDA29677A44EFA1353FC7
sambaPwdMustChange: 2147483647
sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-513
sambaNTPassword: 552902031BEDE9EFAAD3B435B51404EE
sambaPwdLastSet: 1010179124
sambaLogonTime: 0
objectClass: sambaSamAccount
uid: guest2
sambaKickoffTime: 2147483647
sambaAcctFlags: [UX         ]
sambaLogoffTime: 2147483647
sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5006
sambaPwdCanChange: 0

\end{Verbatim}


The following is an LDIF entry for using both the sambaSamAccount and posixAccount ObjectClasses: 
\begin{Verbatim}[]

dn: uid=gcarter, ou=People,dc=quenya,dc=org
sambaLogonTime: 0
displayName: Gerald Carter
sambaLMPassword: 552902031BEDE9EFAAD3B435B51404EE
sambaPrimaryGroupSID: S-1-5-21-2447931902-1787058256-3961074038-1201
objectClass: posixAccount
objectClass: sambaSamAccount
sambaAcctFlags: [UX         ]
userPassword: {crypt}BpM2ej8Rkzogo
uid: gcarter
uidNumber: 9000
cn: Gerald Carter
loginShell: /bin/bash
logoffTime: 2147483647
gidNumber: 100
sambaKickoffTime: 2147483647
sambaPwdLastSet: 1010179230
sambaSID: S-1-5-21-2447931902-1787058256-3961074038-5004
homeDirectory: /home/moria/gcarter
sambaPwdCanChange: 0
sambaPwdMustChange: 2147483647
sambaNTPassword: 878D8014606CDA29677A44EFA1353FC7

\end{Verbatim}

\subsubsection{Password Synchronization}
\label{id2551437}\hypertarget{id2551437}{}%

Samba-3 and later can update the non-Samba (LDAP) password stored with an account. When using pam\_ldap, this allows changing both UNIX and Windows passwords at once.

The \smbconfoption{ldap passwd sync} options can have the values shown in \hyperlink{ldappwsync}{Table {\ref{ldappwsync}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{ldappwsync}{}%
\captionswapskip{}{{\caption{Possible ldap passwd sync Values}\label{ldappwsync}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|>{\hsize=0.4\hsize\RaggedRight}X|>{\hsize=1.6\hsize}X|}
\hline 
\docbooktolatexalignll {{{\bfseries Value}}} & \docbooktolatexaligncl {{{\bfseries Description}}} \tabularnewline
 \hline 
{{yes}} & {{When the user changes his password, update {\texttt{\docbookhyphenatedot{SambaNTPassword}}}, {\texttt{\docbookhyphenatedot{SambaLMPassword}}}, and the {\texttt{\docbookhyphenatedot{password}}} fields.}} \tabularnewline
 \hline 
{{no}} & {{Only update {\texttt{\docbookhyphenatedot{SambaNTPassword}}} and {\texttt{\docbookhyphenatedot{SambaLMPassword}}}.}} \tabularnewline
 \hline 
{{only}} & {{Only update the LDAP password and let the LDAP server worry about the other fields. This option is only available on some LDAP servers and only when the LDAP server supports LDAP\_EXOP\_X\_MODIFY\_PASSWD.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


More information can be found in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.
\subsubsection{Using OpenLDAP Overlay for Password Syncronization}
\label{id2551587}\hypertarget{id2551587}{}%

Howard Chu has written a special overlay called {\bfseries{smbk5pwd}}. This tool modifies the {\texttt{\docbookhyphenatedot{SambaNTPassword}}}, {\texttt{\docbookhyphenatedot{SambaLMPassword}}} and {\texttt{\docbookhyphenatedot{Heimdal}}} hashes in an OpenLDAP entry when an LDAP\_EXOP\_X\_MODIFY\_PASSWD operation is performed.

The overlay is shipped with OpenLDAP-2.3 and can be found in the {\texttt{\docbookhyphenatefilename{contrib/\dbz{}slapd-\dbz{}modules/\dbz{}smbk5pwd}}} subdirectory. This module can also be used with OpenLDAP-2.2.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2551640}\hypertarget{id2551640}{}%
\subsection{Users Cannot Logon}
\label{id2551646}\hypertarget{id2551646}{}%

{``}I've installed Samba, but now I can't log on with my UNIX account!{''}

Make sure your user has been added to the current Samba \smbconfoption{passdb backend}. Read the \hyperlink{acctmgmttools}{Section {\ref{acctmgmttools}}} for details.
\subsection{Configuration of auth methods}
\label{id2551676}\hypertarget{id2551676}{}%

When explicitly setting an \smbconfoption{auth methods} parameter, {\ttfamily\itshape{\docbookhyphenatedot{guest}}} must be specified as the first entry on the line ---  for example, \smbconfoption{auth methods} = guest sam.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Group Mapping: MS Windows and UNIX 
% ------------------------------------------------------------- 	
\chapter{Group Mapping: MS Windows and UNIX}
\label{groupmapping}\hypertarget{groupmapping}{}%

\index{groups!mapping} \index{SID} \index{associations} \index{UNIX groups} \index{groupmap} \index{net} Starting with Samba-3, new group mapping functionality is available to create associations between Windows group SIDs and UNIX group GIDs. The {\bfseries{groupmap}} subcommand included with the net tool can be used to manage these associations.

\index{group mapping} \index{domain groups} The new facility for mapping NT groups to UNIX system groups allows the administrator to decide which NT domain groups are to be exposed to MS Windows clients. Only those NT groups that map to a UNIX group that has a value other than the default ({\texttt{\docbookhyphenatedot{-1}}}) will be exposed in group selection lists in tools that access domain users and groups.

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{domain admin group} \index{Windows group} The {\ttfamily\itshape{\docbookhyphenatedot{domain admin group}}} parameter has been removed in Samba-3 and should no longer be specified in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. In Samba-2.2.x, this parameter was used to give the listed users membership in the {\texttt{\docbookhyphenatedot{Domain Admins}}} Windows group, which gave local admin rights on their workstations (in default configurations).
\end{admonition}


% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2510586}\hypertarget{id2510586}{}%

Samba allows the administrator to create MS Windows NT4/200x group accounts and to arbitrarily associate them with UNIX/Linux group accounts.

\index{UID} \index{GID} \index{idmap uid} \index{MMC} \index{winbindd} \index{ID range} \index{group accounts} Group accounts can be managed using the MS Windows NT4 or MS Windows 200x/XP Professional MMC tools. Appropriate interface scripts should be provided in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} if it is desired that UNIX/Linux system accounts should be automatically created when these tools are used. In the absence of these scripts, and so long as {\bfseries{winbindd}} is running, Samba group accounts that are created using these tools will be allocated UNIX UIDs and GIDs from the ID range specified by the \smbconfoption{idmap uid}/\smbconfoption{idmap gid} parameters in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{idmap-sid2gid}{}%
\includegraphics[scale=0.5]{Samba3-HOWTO/images/idmap-sid2gid}
{{\caption[{IDMAP: Group SID-to-GID Resolution.}]{{{IDMAP: Group SID-to-GID Resolution.}}}\label{idmap-sid2gid}}}
\end{center}
\end{figure}


% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{idmap-gid2sid}{}%
\includegraphics[scale=0.5]{Samba3-HOWTO/images/idmap-gid2sid}
{{\caption[{IDMAP: GID Resolution to Matching SID.}]{{{IDMAP: GID Resolution to Matching SID.}}}\label{idmap-gid2sid}}}
\end{center}
\end{figure}


\index{IDMAP} \index{SID-to-GID} \index{net!groupmap} \index{group mappings} In both cases, when winbindd is not running, only locally resolvable groups can be recognized. Please refer to \hyperlink{idmap-sid2gid}{Figure {\ref{idmap-sid2gid}}} and \hyperlink{idmap-gid2sid}{Figure {\ref{idmap-gid2sid}}}. The {\bfseries{net groupmap}} is used to establish UNIX group to NT SID mappings as shown in \hyperlink{idmap-store-gid2sid}{Figure {\ref{idmap-store-gid2sid}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{idmap-store-gid2sid}{}%
\includegraphics[scale=0.5]{Samba3-HOWTO/images/idmap-store-gid2sid}
{{\caption[{IDMAP Storing Group Mappings.}]{{{IDMAP Storing Group Mappings.}}}\label{idmap-store-gid2sid}}}
\end{center}
\end{figure}


\index{groupadd} \index{groupdel} \index{shadow utilities} \index{groupmod} Administrators should be aware that where {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} group interface scripts make direct calls to the UNIX/Linux system tools (the shadow utilities, {\bfseries{groupadd}}, {\bfseries{groupdel}}, and {\bfseries{groupmod}}), the resulting UNIX/Linux group names will be subject to any limits imposed by these tools. If the tool does not allow uppercase characters or space characters, then the creation of an MS Windows NT4/200x-style group of {\texttt{\docbookhyphenatedot{Engineering Managers}}} will attempt to create an identically named UNIX/Linux group, an attempt that will of course fail.

\index{GID} \index{SID} There are several possible workarounds for the operating system tools limitation. One method is to use a script that generates a name for the UNIX/Linux system group that fits the operating system limits and that then just passes the UNIX/Linux group ID (GID) back to the calling Samba interface. This will provide a dynamic workaround solution.

\index{net!groupmap} Another workaround is to manually create a UNIX/Linux group, then manually create the MS Windows NT4/200x group on the Samba server, and then use the {\bfseries{net groupmap}} tool to connect the two to each other.

% ------------------------   
% Section 
\section{Discussion}
\label{id2529854}\hypertarget{id2529854}{}%

\index{Windows NT4/200x} \index{group privileges} When you install MS Windows NT4/200x on a computer, the installation program creates default users and groups, notably the {\texttt{\docbookhyphenatedot{Administrators}}} group, and gives that group privileges necessary to perform essential system tasks, such as the ability to change the date and time or to kill (or close) any process running on the local machine.

\index{Administrator} The {\texttt{\docbookhyphenatedot{Administrator}}} user is a member of the {\texttt{\docbookhyphenatedot{Administrators}}} group, and thus inherits {\texttt{\docbookhyphenatedot{Administrators}}} group privileges. If a {\texttt{\docbookhyphenatedot{joe}}} user is created to be a member of the {\texttt{\docbookhyphenatedot{Administrators}}} group, {\texttt{\docbookhyphenatedot{joe}}} has exactly the same rights as the user {\texttt{\docbookhyphenatedot{Administrator}}}.

\index{domain member} \index{Domain Admins} \index{inherits rights} \index{PDC} When an MS Windows NT4/200x/XP machine is made a domain member, the {``}Domain Admins{''} group of the PDC is added to the local {\texttt{\docbookhyphenatedot{Administrators}}} group of the workstation. Every member of the {\texttt{\docbookhyphenatedot{Domain Admins}}} group inherits the rights of the local {\texttt{\docbookhyphenatedot{Administrators}}} group when logging on the workstation.

\index{Domain Admins} \index{PDC} The following steps describe how to make Samba PDC users members of the {\texttt{\docbookhyphenatedot{Domain Admins}}} group.

\begin{enumerate}
%--- Item
\item 
Create a UNIX group (usually in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}}); let's call it {\texttt{\docbookhyphenatedot{domadm}}}.


%--- Item
\item 
\index{/etc/group} Add to this group the users that must be {``}Administrators{''}. For example, if you want {\texttt{\docbookhyphenatedot{joe, john}}}, and {\texttt{\docbookhyphenatedot{mary}}} to be administrators, your entry in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} will look like this:


\begin{Verbatim}[]

		domadm:x:502:joe,john,mary
		
\end{Verbatim}



%--- Item
\item 
Map this domadm group to the {``}Domain Admins{''} group by executing the command:


\begin{Verbatim}[]

root# net groupmap add ntgroup="Domain Admins" unixgroup=domadm rid=512 type=d

\end{Verbatim}


\index{Domain Admins group} The quotes around {``}Domain Admins{''} are necessary due to the space in the group name. Also make sure to leave no white space surrounding the equal character (=).

\end{enumerate}

Now {\texttt{\docbookhyphenatedot{joe, john}}}, and {\texttt{\docbookhyphenatedot{mary}}} are domain administrators.

\index{groups!domain} It is possible to map any arbitrary UNIX group to any Windows NT4/200x group as well as to make any UNIX group a Windows domain group. For example, if you wanted to include a UNIX group (e.g., acct) in an ACL on a local file or printer on a Domain Member machine, you would flag that group as a domain group by running the following on the Samba PDC:


\begin{Verbatim}[]

root# net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct type=d

\end{Verbatim}
 The {\texttt{\docbookhyphenatedot{ntgroup}}} value must be in quotes if it contains space characters to prevent the space from being interpreted as a command delimiter.

\index{RID} \index{assigned RID} Be aware that the RID parameter is an unsigned 32-bit integer that should normally start at 1000. However, this RID must not overlap with any RID assigned to a user. Verification for this is done differently depending on the passdb backend you are using. Future versions of the tools may perform the verification automatically, but for now the burden is on you.
\subsection{Warning: User Private Group Problems}
\label{id2528544}\hypertarget{id2528544}{}%

\index{group accounts} \index{Red Hat Linux} \index{private groups} Windows does not permit user and group accounts to have the same name. This has serious implications for all sites that use private group accounts. A private group account is an administrative practice whereby users are each given their own group account. Red Hat Linux, as well as several free distributions of Linux, by default create private groups.

\index{UNIX/Linux group} \index{Windows group} When mapping a UNIX/Linux group to a Windows group account, all conflict can be avoided by assuring that the Windows domain group name does not overlap with any user account name.
\subsection{Nested Groups: Adding Windows Domain Groups to Windows Local Groups}
\label{id2528604}\hypertarget{id2528604}{}%
\index{groups!nested}
\index{nested groups} This functionality is known as {\texttt{\docbookhyphenatedot{nested groups}}} and was first added to Samba-3.0.3.

\index{nested groups} All MS Windows products since the release of Windows NT 3.10 support the use of nested groups. Many Windows network administrators depend on this capability because it greatly simplifies security administration.

\index{nested group} \index{group membership} \index{domain security} \index{domain member server} \index{local groups} \index{domain global groups} \index{domain global users} The nested group architecture was designed with the premise that day-to-day user and group membership management should be performed on the domain security database. The application of group security should be implemented on domain member servers using only local groups. On the domain member server, all file system security controls are then limited to use of the local groups, which will contain domain global groups and domain global users.

\index{individual domain user} \index{domain group settings} \index{Account Unknown} You may ask, What are the benefits of this arrangement? The answer is obvious to those who have plumbed the dark depths of Windows networking architecture. Consider for a moment a server on which are stored 200,000 files, each with individual domain user and domain group settings. The company that owns the file server is bought by another company, resulting in the server being moved to another location, and then it is made a member of a different domain. Who would you think now owns all the files and directories? Answer: Account Unknown.

\index{directory access control} \index{local groups} \index{ACL} \index{Account Unknown} Unraveling the file ownership mess is an unenviable administrative task that can be avoided simply by using local groups to control all file and directory access control. In this case, only the members of the local groups will have been lost. The files and directories in the storage subsystem will still be owned by the local groups. The same goes for all ACLs on them. It is administratively much simpler to delete the {\texttt{\docbookhyphenatedot{Account Unknown}}} membership entries inside local groups with appropriate entries for domain global groups in the new domain that the server has been made a member of.

\index{nested groups} \index{administrative privileges} \index{domain member workstations} \index{domain member servers} \index{member machine} \index{full rights} \index{Domain Admins} \index{local administrative privileges} Another prominent example of the use of nested groups involves implementation of administrative privileges on domain member workstations and servers. Administrative privileges are given to all members of the built-in local group {\texttt{\docbookhyphenatedot{Administrators}}} on each domain member machine. To ensure that all domain administrators have full rights on the member server or workstation, on joining the domain, the {\texttt{\docbookhyphenatedot{Domain Admins}}} group is added to the local Administrators group. Thus everyone who is logged into the domain as a member of the Domain Admins group is also granted local administrative privileges on each domain member.

\index{nested groups} \index{auxiliary members} \index{/etc/group} \index{winbind} UNIX/Linux has no concept of support for nested groups, and thus Samba has for a long time not supported them either. The problem is that you would have to enter UNIX groups as auxiliary members of a group in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}}. This does not work because it was not a design requirement at the time the UNIX file system security model was implemented. Since Samba-2.2, the winbind daemon can provide {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} entries on demand by obtaining user and group information from the domain controller that the Samba server is a member of.

\index{/etc/group} \index{libnss\_winbind} \index{local groups} \index{Domain Users} \index{alias group} In effect, Samba supplements the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} data via the dynamic {\bfseries{libnss\_winbind}} mechanism. Beginning with Samba-3.0.3, this facility is used to provide local groups in the same manner as Windows. It works by expanding the local groups on the fly as they are accessed. For example, the {\texttt{\docbookhyphenatedot{Domain Users}}} group of the domain is made a member of the local group {\texttt{\docbookhyphenatedot{demo}}}. Whenever Samba needs to resolve membership of the {\texttt{\docbookhyphenatedot{demo}}} local (alias) group, winbind asks the domain controller for demo members of the Domain Users group. By definition, it can only contain user objects, which can then be faked to be member of the UNIX/Linux group {\texttt{\docbookhyphenatedot{demo}}}.

\index{nested groups} \index{winbindd} \index{NSS} \index{winbind} \index{local groups} \index{Domain User Manager} \index{net!rpc!group} To enable the use of nested groups, {\bfseries{winbindd}} must be used with NSS winbind. Creation and administration of the local groups is done best via the Windows Domain User Manager or its Samba equivalent, the utility {\bfseries{net rpc group}}. Creating the local group {\texttt{\docbookhyphenatedot{demo}}} is achieved by executing: 
\begin{Verbatim}[]

	root#  net rpc group add demo -L -Uroot%not24get
	
\end{Verbatim}
 \index{addmem} \index{delmem} Here the -L switch means that you want to create a local group. It may be necessary to add -S and -U switches for accessing the correct host with appropriate user or root privileges. Adding and removing group members can be done via the {\texttt{\docbookhyphenatedot{addmem}}} and {\texttt{\docbookhyphenatedot{delmem}}} subcommands of {\bfseries{net rpc group}} command. For example, addition of {``}DOM\textbackslash Domain Users{''} to the local group {\texttt{\docbookhyphenatedot{demo}}} is done by executing: 
\begin{Verbatim}[]

	net rpc group addmem demo "DOM\Domain Users"
	
\end{Verbatim}
 \index{getent group demo} \index{trusted domain} \index{foreign domain} \index{local access permissions} Having completed these two steps, the execution of {\bfseries{getent group demo}} will show demo members of the global {\texttt{\docbookhyphenatedot{Domain Users}}} group as members of the group {\texttt{\docbookhyphenatedot{demo}}}. This also works with any local or domain user. In case the domain DOM trusts another domain, it is also possible to add global users and groups of the trusted domain as members of {\texttt{\docbookhyphenatedot{demo}}}. The users from the foreign domain who are members of the group that has been added to the {\texttt{\docbookhyphenatedot{demo}}} group now have the same local access permissions as local domain users have.
\subsection{Important Administrative Information}
\label{id2526881}\hypertarget{id2526881}{}%

Administrative rights are necessary in two specific forms:

\begin{enumerate}
%--- Item
\item 
For Samba-3 domain controllers and domain member servers/clients.


%--- Item
\item 
To manage domain member Windows workstations.

\end{enumerate}

\index{rights and privileges} \index{domain member client} \index{group account} Versions of Samba up to and including 3.0.10 do not provide a means for assigning rights and privileges that are necessary for system administration tasks from a Windows domain member client machine, so domain administration tasks such as adding, deleting, and changing user and group account information, and managing workstation domain membership accounts, can be handled by any account other than root.

\index{privilege management} \index{delegated} \index{Administrator} Samba-3.0.11 introduced a new privilege management interface (see \hyperlink{rights}{Chapter {\ref{rights}}, {``}User Rights and Privileges{''}}) that permits these tasks to be delegated to non-root (i.e., accounts other than the equivalent of the MS Windows Administrator) accounts.

\index{mapped} \index{Domain Admins} Administrative tasks on a Windows domain member workstation can be done by anyone who is a member of the {\texttt{\docbookhyphenatedot{Domain Admins}}} group. This group can be mapped to any convenient UNIX group.
\subsubsection{Applicable Only to Versions Earlier than 3.0.11}
\label{id2527001}\hypertarget{id2527001}{}%

\index{privilege} Administrative tasks on UNIX/Linux systems, such as adding users or groups, requires {\texttt{\docbookhyphenatedot{root}}}-level privilege. The addition of a Windows client to a Samba domain involves the addition of a user account for the Windows client.

\index{system security} \index{privileges} Many UNIX administrators continue to request that the Samba Team make it possible to add Windows workstations, or the ability to add, delete, or modify user accounts, without requiring {\texttt{\docbookhyphenatedot{root}}} privileges. Such a request violates every understanding of basic UNIX system security.

\index{privileges} \index{/etc/passwd} \index{Domain Server Manager} \index{Domain User Manager} \index{manage share-level ACL} \index{share-level ACLs} There is no safe way to provide access on a UNIX/Linux system without providing {\texttt{\docbookhyphenatedot{root}}}-level privileges. Provision of {\texttt{\docbookhyphenatedot{root}}} privileges can be done either by logging on to the Domain as the user {\texttt{\docbookhyphenatedot{root}}} or by permitting particular users to use a UNIX account that has a UID=0 in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} database. Users of such accounts can use tools like the NT4 Domain User Manager and the NT4 Domain Server Manager to manage user and group accounts as well as domain member server and client accounts. This level of privilege is also needed to manage share-level ACLs.
\subsection{Default Users, Groups, and Relative Identifiers}
\label{id2527126}\hypertarget{id2527126}{}%

\index{Relative Identifier|textit{see} {RID} } \index{RID} \index{Windows NT4/200x/XP} \index{well-known RID} \index{domain groups} \index{tdbsam} \index{LDAP} \index{NT groups} When first installed, Windows NT4/200x/XP are preconfigured with certain user, group, and alias entities. Each has a well-known RID. These must be preserved for continued integrity of operation. Samba must be provisioned with certain essential domain groups that require the appropriate RID value. When Samba-3 is configured to use {\texttt{\docbookhyphenatedot{tdbsam}}}, the essential domain groups are automatically created. It is the LDAP administrator's responsibility to create (provision) the default NT groups.

\index{default users} \index{default groups} \index{default aliases} \index{RID} Each essential domain group must be assigned its respective well-known RID. The default users, groups, aliases, and RIDs are shown in \hyperlink{WKURIDS}{Table {\ref{WKURIDS}}}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{passdb backend} \index{LDAP} \index{ldapsam} \index{domain groups} \index{RID} It is the administrator's responsibility to create the essential domain groups and to assign each its default RID.
\end{admonition}


\index{domain groups} \index{RID} It is permissible to create any domain group that may be necessary; just make certain that the essential domain groups (well known) have been created and assigned their default RIDs. Other groups you create may be assigned any arbitrary RID you care to use.

Be sure to map each domain group to a UNIX system group. That is the only way to ensure that the group will be available for use as an NT domain group.


% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{WKURIDS}{}%
\captionswapskip{}{{\caption{Well-Known User Default RIDs}\label{WKURIDS}}}
\captionswapskip{}\begin{tabular}{|l|l|l|c|}
\hline 
{{{\bfseries Well-Known Entity}}} & {{{\bfseries RID}}} & {{{\bfseries Type}}} & {{{\bfseries Essential}}} \tabularnewline
 \hline 
{{Domain Administrator}} & {{500}} & {{User}} & {{No}} \tabularnewline
 \hline 
{{Domain Guest}} & {{501}} & {{User}} & {{No}} \tabularnewline
 \hline 
{{Domain KRBTGT}} & {{502}} & {{User}} & {{No}} \tabularnewline
 \hline 
{{Domain Admins}} & {{512}} & {{Group}} & {{Yes}} \tabularnewline
 \hline 
{{Domain Users}} & {{513}} & {{Group}} & {{Yes}} \tabularnewline
 \hline 
{{Domain Guests}} & {{514}} & {{Group}} & {{Yes}} \tabularnewline
 \hline 
{{Domain Computers}} & {{515}} & {{Group}} & {{No}} \tabularnewline
 \hline 
{{Domain Controllers}} & {{516}} & {{Group}} & {{No}} \tabularnewline
 \hline 
{{Domain Certificate Admins}} & {{517}} & {{Group}} & {{No}} \tabularnewline
 \hline 
{{Domain Schema Admins}} & {{518}} & {{Group}} & {{No}} \tabularnewline
 \hline 
{{Domain Enterprise Admins}} & {{519}} & {{Group}} & {{No}} \tabularnewline
 \hline 
{{Domain Policy Admins}} & {{520}} & {{Group}} & {{No}} \tabularnewline
 \hline 
{{Builtin Admins}} & {{544}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin users}} & {{545}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin Guests}} & {{546}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin Power Users}} & {{547}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin Account Operators}} & {{548}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin System Operators}} & {{549}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin Print Operators}} & {{550}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin Backup Operators}} & {{551}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin Replicator}} & {{552}} & {{Alias}} & {{No}} \tabularnewline
 \hline 
{{Builtin RAS Servers}} & {{553}} & {{Alias}} & {{No}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


\subsection{Example Configuration}
\label{id2541315}\hypertarget{id2541315}{}%

\index{net!groupmap!list} You can list the various groups in the mapping database by executing {\bfseries{net groupmap list}}. Here is an example:

\index{net!groupmap} 
\begin{Verbatim}[]

root#  net groupmap list
Domain Admins (S-1-5-21-2547222302-1596225915-2414751004-512) -> domadmin
Domain Users (S-1-5-21-2547222302-1596225915-2414751004-513) -> domuser
Domain Guests (S-1-5-21-2547222302-1596225915-2414751004-514) -> domguest

\end{Verbatim}


For complete details on {\bfseries{net groupmap}}, refer to the net(8) man page.

% ------------------------   
% Section 
\section{Configuration Scripts}
\label{id2541391}\hypertarget{id2541391}{}%

Everyone needs tools. Some of us like to create our own, others prefer to use canned tools (i.e., prepared by someone else for general use).
\subsection{Sample smb.\dbz{}conf Add Group Script}
\label{id2541403}\hypertarget{id2541403}{}%

\index{smbgrpadd.sh} \index{groupadd limitations} \index{smbgrpadd.sh} \index{/etc/group} \index{groupadd} A script to create complying group names for use by the Samba group interfaces is provided in \hyperlink{smbgrpadd.sh}{Example {\ref{smbgrpadd.sh}}}. This script adds a temporary entry in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} file and then renames it to the desired name. This is an example of a method to get around operating system maintenance tool limitations such as those present in some version of the {\bfseries{groupadd}} tool. 
\begin{example}%
\hypertarget{smbgrpadd.sh}{}%
\captionswapskip{}{{\caption{smbgrpadd.sh}\label{smbgrpadd.sh}}}
\captionswapskip{}
\begin{Verbatim}[]

#!/bin/bash

# Add the group using normal system groupadd tool.
groupadd smbtmpgrp00

thegid=`cat /etc/group | grep ^smbtmpgrp00 | cut -d ":" -f3`

# Now change the name to what we want for the MS Windows networking end
cp /etc/group /etc/group.bak
cat /etc/group.bak | sed "s/^smbtmpgrp00/$1/g" > /etc/group
rm /etc/group.bak

# Now return the GID as would normally happen.
echo $thegid
exit 0

\end{Verbatim}
\end{example}



The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} entry for the above script shown in \hyperlink{smbgrpadd}{Example {\ref{smbgrpadd}}} demonstrates how it may be used. 
\begin{example}%
\hypertarget{smbgrpadd}{}%
\captionswapskip{}{{\caption{Configuration of smb.\dbz{}conf for the add group Script}\label{smbgrpadd}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	add group script = /path_to_tool/smbgrpadd.sh "%g"
\end{lstlisting}
\end{example}


\subsection{Script to Configure Group Mapping}
\label{id2541555}\hypertarget{id2541555}{}%

\index{initGroups.sh} In our example we have created a UNIX/Linux group called {\texttt{\docbookhyphenatedot{ntadmin}}}. Our script will create the additional groups {\texttt{\docbookhyphenatedot{Orks}}}, {\texttt{\docbookhyphenatedot{Elves}}}, and {\texttt{\docbookhyphenatedot{Gnomes}}}. It is a good idea to save this shell script for later use just in case you ever need to rebuild your mapping database. For the sake of convenience we elect to save this script as a file called {\texttt{\docbookhyphenatefilename{initGroups.\dbz{}sh}}}. This script is given in \hyperlink{set-group-map}{Example {\ref{set-group-map}}}. \index{initGroups.sh} 
\begin{example}%
\hypertarget{set-group-map}{}%
\captionswapskip{}{{\caption{Script to Set Group Mapping}\label{set-group-map}}}
\captionswapskip{}
\begin{Verbatim}[]

#!/bin/bash

net groupmap add ntgroup="Domain Admins" unixgroup=ntadmin rid=512 type=d
net groupmap add ntgroup="Domain Users" unixgroup=users rid=513 type=d
net groupmap add ntgroup="Domain Guests" unixgroup=nobody rid=514 type=d

groupadd Orks
groupadd Elves
groupadd Gnomes

net groupmap add ntgroup="Orks"   unixgroup=Orks   type=d
net groupmap add ntgroup="Elves"  unixgroup=Elves  type=d
net groupmap add ntgroup="Gnomes" unixgroup=Gnomes type=d

\end{Verbatim}
\end{example}



Of course it is expected that the administrator will modify this to suit local needs. For information regarding the use of the {\bfseries{net groupmap}} tool please refer to the man page.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Versions of Samba-3 prior to 3.0.23 automatically create default group mapping for the {\texttt{\docbookhyphenatedot{Domain Admins, Domain Users}}} and {\texttt{\docbookhyphenatedot{Domain Guests}}} Windows groups, but do not map them to UNIX GIDs. This was a cause of administrative confusion and trouble. Commencing with Samba-3.0.23 this annomaly has been fixed - thus all Windows groups must now be manually and explicitly created and mapped to a valid UNIX GID by the Samba administrator.
\end{admonition}


% ------------------------   
% Section 
\section{Common Errors}
\label{id2541682}\hypertarget{id2541682}{}%

At this time there are many little surprises for the unwary administrator. In a real sense it is imperative that every step of automated control scripts be carefully tested manually before putting it into active service.
\subsection{Adding Groups Fails}
\label{id2541696}\hypertarget{id2541696}{}%

\index{groupadd} This is a common problem when the {\bfseries{groupadd}} is called directly by the Samba interface script for the \smbconfoption{add group script} in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

\index{uppercase character} \index{space character} The most common cause of failure is an attempt to add an MS Windows group account that has an uppercase character and/or a space character in it.

\index{groupadd} There are three possible workarounds. First, use only group names that comply with the limitations of the UNIX/Linux {\bfseries{groupadd}} system tool. Second, it involves the use of the script mentioned earlier in this chapter, and third is the option is to manually create a UNIX/Linux group account that can substitute for the MS Windows group name, then use the procedure listed above to map that group to the MS Windows group.
\subsection{Adding Domain Users to the Workstation Power Users Group}
\label{id2541777}\hypertarget{id2541777}{}%

{``}What must I do to add domain users to the Power Users group?{''}

\index{Domain Users group} The Power Users group is a group that is local to each Windows 200x/XP Professional workstation. You cannot add the Domain Users group to the Power Users group automatically, it must be done on each workstation by logging in as the local workstation {\em{administrator}} and then using the following procedure:
\begin{enumerate}

\item{Click {\sffamily \bfseries Start -\textgreater{} Control Panel -\textgreater{} Users and Passwords}.}

\item{Click the {\sffamily \bfseries Advanced} tab.}

\item{Click the {\sffamily \bfseries Advanced} button.}

\item{Click {\texttt{\docbookhyphenatedot{Groups}}}.}

\item{Double-click {\texttt{\docbookhyphenatedot{Power Users}}}. This will launch the panel to add users or groups to the local machine {\texttt{\docbookhyphenatedot{Power Users}}} group.}

\item{Click the {\sffamily \bfseries Add} button.}

\item{Select the domain from which the {\texttt{\docbookhyphenatedot{Domain Users}}} group is to be added.}

\item{Double-click the {\texttt{\docbookhyphenatedot{Domain Users}}} group.}

\item{Click the {\sffamily \bfseries OK} button. If a logon box is presented during this process, please remember to enter the connect as {\texttt{\docbookhyphenatedot{DOMAIN\textbackslash UserName}}}, that is, for the domain {\texttt{\docbookhyphenatedot{MIDEARTH}}} and the user {\texttt{\docbookhyphenatedot{root}}} enter {\texttt{\docbookhyphenatedot{MIDEARTH\textbackslash root}}}.}
\end{enumerate}
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Remote and Local Management: The Net Command 
% ------------------------------------------------------------- 	
\chapter{Remote and Local Management: The Net Command}
\label{NetCommand}\hypertarget{NetCommand}{}%

\index{net} \index{remote management} \index{command-line} \index{scripted control} The {\bfseries{net}} command is one of the new features of Samba-3 and is an attempt to provide a useful tool for the majority of remote management operations necessary for common tasks. The {\bfseries{net}} tool is flexible by design and is intended for command-line use as well as for scripted control application.

\index{net} \index{network administrator's toolbox} \index{smbgroupedit} \index{rpcclient} Originally introduced with the intent to mimic the Microsoft Windows command that has the same name, the {\bfseries{net}} command has morphed into a very powerful instrument that has become an essential part of the Samba network administrator's toolbox. The Samba Team has introduced tools, such as {\bfseries{smbgroupedit}} and {\bfseries{rpcclient}}, from which really useful capabilities have been integrated into the {\bfseries{net}}. The {\bfseries{smbgroupedit}} command was absorbed entirely into the {\bfseries{net}}, while only some features of the {\bfseries{rpcclient}} command have been ported to it. Anyone who finds older references to these utilities and to the functionality they provided should look at the {\bfseries{net}} command before searching elsewhere.

A Samba-3 administrator cannot afford to gloss over this chapter because to do so will almost certainly cause the infliction of self-induced pain, agony, and desperation. Be warned: this is an important chapter.

% ------------------------   
% Section 
\section{Overview}
\label{id2544152}\hypertarget{id2544152}{}%

\index{standalone} \index{domain member} \index{PDC} \index{BDC} \index{DMS} \index{authentication} The tasks that follow the installation of a Samba-3 server, whether standalone or domain member, of a domain controller (PDC or BDC) begins with the need to create administrative rights. Of course, the creation of user and group accounts is essential for both a standalone server and a PDC. In the case of a BDC or a Domain Member server (DMS), domain user and group accounts are obtained from the central domain authentication backend.

\index{server type} \index{local UNIX groups} \index{mapped} \index{domain global group} \index{UID} \index{GID} \index{access rights} \index{net} Regardless of the type of server being installed, local UNIX groups must be mapped to the Windows networking domain global group accounts. Do you ask why? Because Samba always limits its access to the resources of the host server by way of traditional UNIX UID and GID controls. This means that local groups must be mapped to domain global groups so that domain users who are members of the domain global groups can be given access rights based on UIDs and GIDs local to the server that is hosting Samba. Such mappings are implemented using the {\bfseries{net}} command.

\index{PDC} \index{BDC} \index{DMS} \index{security account} \index{domain authentication} \index{trust accounts} \index{net} UNIX systems that are hosting a Samba-3 server that is running as a member (PDC, BDC, or DMS) must have a machine security account in the domain authentication database (or directory). The creation of such security (or trust) accounts is also handled using the {\bfseries{net}} command.

\index{interdomain trusts} \index{net} \index{administrative duties} \index{user management} \index{group management} \index{share management} \index{printer management} \index{printer migration} \index{SID management} The establishment of interdomain trusts is achieved using the {\bfseries{net}} command also, as may a plethora of typical administrative duties such as user management, group management, share and printer management, file and printer migration, security identifier management, and so on.

\index{net} \index{man pages} The overall picture should be clear now: the {\bfseries{net}} command plays a central role on the Samba-3 stage. This role will continue to be developed. The inclusion of this chapter is evidence of its importance, one that has grown in complexity to the point that it is no longer considered prudent to cover its use fully in the online UNIX man pages.

% ------------------------   
% Section 
\section{Administrative Tasks and Methods}
\label{id2463010}\hypertarget{id2463010}{}%

\index{net} \index{ADS} \index{Distributed Computing Environment|textit{see} {DCE} } \index{Remote Procedure Call|textit{see} {RPC} } The basic operations of the {\bfseries{net}} command are documented here. This documentation is not exhaustive, and thus it is incomplete. Since the primary focus is on migration from Windows servers to a Samba server, the emphasis is on the use of the Distributed Computing Environment Remote Procedure Call (DCE RPC) mode of operation. When used against a server that is a member of an Active Directory domain, it is preferable (and often necessary) to use ADS mode operations. The {\bfseries{net}} command supports both, but not for every operation. For most operations, if the mode is not specified, {\bfseries{net}} will automatically fall back via the {\texttt{\docbookhyphenatedot{ads}}}, {\texttt{\docbookhyphenatedot{rpc}}}, and {\texttt{\docbookhyphenatedot{rap}}} modes. Please refer to the man page for a more comprehensive overview of the capabilities of this utility.

% ------------------------   
% Section 
\section{UNIX and Windows Group Management}
\label{id2463093}\hypertarget{id2463093}{}%

\index{Active Directory} \index{net!rpc} \index{net!ads} \index{net!rap} \index{RAP} As stated, the focus in most of this chapter is on use of the {\bfseries{net rpc}} family of operations that are supported by Samba. Most of them are supported by the {\bfseries{net ads}} mode when used in connection with Active Directory. The {\bfseries{net rap}} operating mode is also supported for some of these operations. RAP protocols are used by IBM OS/2 and by several earlier SMB servers.

\index{net} \index{user management} \index{group management} Samba's {\bfseries{net}} tool implements sufficient capability to permit all common administrative tasks to be completed from the command line. In this section each of the essential user and group management facilities are explored.

\index{groups} \index{domain!groups} \index{local!groups} \index{domain user accounts} Samba-3 recognizes two types of groups: {\em{domain groups}} and {\em{local groups}}. Domain groups can contain (have as members) only domain user accounts. Local groups can contain local users, domain users, and domain groups as members.

The purpose of a local group is to permit file permission to be set for a group account that, like the usual UNIX/Linux group, is persistent across redeployment of a Windows file server.
\subsection{Adding, Renaming, or Deletion of Group Accounts}
\label{id2530469}\hypertarget{id2530469}{}%

Samba provides file and print services to Windows clients. The file system resources it makes available to the Windows environment must, of necessity, be provided in a manner that is compatible with the Windows networking environment. UNIX groups are created and deleted as required to serve operational needs in the UNIX operating system and its file systems.

In order to make available to the Windows environment, Samba has a facility by which UNIX groups can be mapped to a logical entity, called a Windows (or domain) group. Samba supports two types of Windows groups, local and global. Global groups can contain as members, global users. This membership is affected in the normal UNIX manner, but adding UNIX users to UNIX groups. Windows user accounts consist of a mapping between a user SambaSAMAccount (logical entity) and a UNIX user account. Therefore, a UNIX user is mapped to a Windows user (i.e., is given a Windows user account and password) and the UNIX groups to which that user belongs, is mapped to a Windows group account. The result is that in the Windows account environment that user is also a member of the Windows group account by virtue of UNIX group memberships.

The following sub-sections that deal with management of Windows groups demonstrates the relationship between the UNIX group account and its members to the respective Windows group accounts. It goes on to show how UNIX group members automatically pass-through to Windows group membership as soon as a logical mapping has been created.
\subsubsection{Adding or Creating a New Group}
\label{id2530513}\hypertarget{id2530513}{}%

Before attempting to add a Windows group account, the currently available groups can be listed as shown here: \index{net!rpc!group} \index{net!rpc!group list} 
\begin{Verbatim}[]

root#  net rpc group list -Uroot%not24get
Password:
Domain Admins
Domain Users
Domain Guests
Print Operators
Backup Operators
Replicator
Domain Computers
Engineers

\end{Verbatim}

\newpage 
A Windows group account called {``}SupportEngrs{''} can be added by executing the following command: \index{net!rpc!group add} 
\begin{Verbatim}[]

root#  net rpc group add "SupportEngrs" -Uroot%not24get

\end{Verbatim}
 The addition will result in immediate availability of the new group account as validated by executing this command: 
\begin{Verbatim}[]

root#  net rpc group list -Uroot%not24get
Password:
Domain Admins
Domain Users
Domain Guests
Print Operators
Backup Operators
Replicator
Domain Computers
Engineers
SupportEngrs

\end{Verbatim}


\index{POSIX} \index{smbldap-groupadd} \index{getent} The following demonstrates that the POSIX (UNIX/Linux system account) group has been created by calling the \smbconfoption{add group script} = /opt/IDEALX/sbin/smbldap-groupadd -p "\%g" interface script: 
\begin{Verbatim}[]

root#  getent group
...
Domain Admins:x:512:root
Domain Users:x:513:jht,lct,ajt,met
Domain Guests:x:514:
Print Operators:x:550:
Backup Operators:x:551:
Replicator:x:552:
Domain Computers:x:553:
Engineers:x:1002:jht
SupportEngrs:x:1003:

\end{Verbatim}
 The following demonstrates that the use of the {\bfseries{net}} command to add a group account results in immediate mapping of the POSIX group that has been created to the Windows group account as shown here: \index{net!groupmap!list} 
\begin{Verbatim}[]

root#  net groupmap list
Domain Admins (S-1-5-21-72630-4128915-11681869-512) -> Domain Admins
Domain Users (S-1-5-21-72630-4128915-11681869-513) -> Domain Users
Domain Guests (S-1-5-21-72630-4128915-11681869-514) -> Domain Guests
Print Operators (S-1-5-21-72630-4128915-11681869-550) -> Print Operators
Backup Operators (S-1-5-21-72630-4128915-11681869-551) -> Backup Operators
Replicator (S-1-5-21-72630-4128915-11681869-552) -> Replicator
Domain Computers (S-1-5-21-72630-4128915-11681869-553) -> Domain Computers
Engineers (S-1-5-21-72630-4128915-11681869-3005) -> Engineers
SupportEngrs (S-1-5-21-72630-4128915-11681869-3007) -> SupportEngrs

\end{Verbatim}

\subsubsection{Mapping Windows Groups to UNIX Groups}
\label{id2500162}\hypertarget{id2500162}{}%

\index{mapped} \index{Windows groups} \index{system groups} \index{access controls} Windows groups must be mapped to UNIX system (POSIX) groups so that file system access controls can be asserted in a manner that is consistent with the methods appropriate to the operating system that is hosting the Samba server.

\index{access controls} \index{UID} \index{GID} \index{locally known UID} All file system (file and directory) access controls, within the file system of a UNIX/Linux server that is hosting a Samba server, are implemented using a UID/GID identity tuple. Samba does not in any way override or replace UNIX file system semantics. Thus it is necessary that all Windows networking operations that access the file system provide a mechanism that maps a Windows user to a particular UNIX/Linux group account. The user account must also map to a locally known UID. Note that the {\bfseries{net}} command does not call any RPC-functions here but directly accesses the passdb.

\index{default mappings} \index{Domain Admins} \index{Domain Users} \index{Domain Guests} \index{Windows group} \index{UNIX group} \index{mapping} Samba depends on default mappings for the {\texttt{\docbookhyphenatedot{Domain Admins, Domain Users}}}, and {\texttt{\docbookhyphenatedot{Domain Guests}}} global groups. Additional groups may be added as shown in the examples just given. There are times when it is necessary to map an existing UNIX group account to a Windows group. This operation, in effect, creates a Windows group account as a consequence of creation of the mapping.

\index{net!groupmap!modify} \index{net!groupmap!add} \index{net!groupmap!delete} The operations that are permitted include: {\texttt{\docbookhyphenatedot{add}}}, {\texttt{\docbookhyphenatedot{modify}}}, and {\texttt{\docbookhyphenatedot{delete}}}. An example of each operation is shown here.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Commencing with Samba-3.0.23 Windows Domain Groups must be explicitly created. By default, all UNIX groups are exposed to Windows networking as Windows local groups.
\end{admonition}


An existing UNIX group may be mapped to an existing Windows group by this example: 
\begin{Verbatim}[]

root#  net groupmap modify ntgroup="Domain Users" unixgroup=users

\end{Verbatim}
 An existing UNIX group may be mapped to a new Windows group as shown here: 
\begin{Verbatim}[]

root#  net groupmap add ntgroup="EliteEngrs" unixgroup=Engineers type=d

\end{Verbatim}
 Supported mapping types are 'd' (domain global) and 'l' (domain local). A Windows group may be deleted, and then a new Windows group can be mapped to the UNIX group by executing these commands: 
\begin{Verbatim}[]

root#  net groupmap delete ntgroup=Engineers
root#  net groupmap add ntgroup=EngineDrivers unixgroup=Engineers type=d

\end{Verbatim}
 The deletion and addition operations affected only the logical entities known as Windows groups, or domain groups. These operations are inert to UNIX system groups, meaning that they neither delete nor create UNIX system groups. The mapping of a UNIX group to a Windows group makes the UNIX group available as Windows groups so that files and folders on domain member clients (workstations and servers) can be given domain-wide access controls for domain users and groups.

Two types of Windows groups can be created: {\texttt{\docbookhyphenatedot{domain (global)}}} and {\texttt{\docbookhyphenatedot{local}}}. In the previous examples the Windows groups created were of type {\texttt{\docbookhyphenatedot{domain}}} or global. The following command will create a Windows group of type {\texttt{\docbookhyphenatedot{local}}}. 
\begin{Verbatim}[]

root#  net groupmap add ntgroup=Pixies unixgroup=pixies type=l

\end{Verbatim}
 Supported mapping types are 'd' (domain global) and 'l' (domain local), a domain local group in Samba is treated as local to the individual Samba server. Local groups can be used with Samba to enable multiple nested group support.
\subsubsection{Deleting a Group Account}
\label{id2553463}\hypertarget{id2553463}{}%

\index{net!rpc!group delete} A group account may be deleted by executing the following command: 
\begin{Verbatim}[]

root#  net rpc group delete SupportEngineers -Uroot%not24get

\end{Verbatim}


Validation of the deletion is advisable. The same commands may be executed as shown above.
\subsubsection{Rename Group Accounts}
\label{id2553501}\hypertarget{id2553501}{}%

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

This command is not documented in the man pages; it is implemented in the source code, but it does not work at this time. The example given documents, from the source code, how it should work. Watch the release notes of a future release to see when this may have been fixed.
\end{admonition}


Sometimes it is necessary to rename a group account. Good administrators know how painful some managers' demands can be if this simple request is ignored. The following command demonstrates how the Windows group {``}SupportEngrs{''} can be renamed to {``}CustomerSupport{''}: \index{net!rpc!group rename} 
\begin{Verbatim}[]

root#  net rpc group rename SupportEngrs \
    CustomerSupport -Uroot%not24get

\end{Verbatim}

\subsection{Manipulating Group Memberships}
\label{grpmemshipchg}\hypertarget{grpmemshipchg}{}%

Three operations can be performed regarding group membership. It is possible to (1) add Windows users to a Windows group, to (2) delete Windows users from Windows groups, and to (3) list the Windows users that are members of a Windows group.

To avoid confusion, it makes sense to check group membership before attempting to make any changes. The {\bfseries{getent group}} will list UNIX/Linux group membership. UNIX/Linux group members are seen also as members of a Windows group that has been mapped using the {\bfseries{net groupmap}} command (see \hyperlink{groupmapping}{Chapter {\ref{groupmapping}}, {``}Group Mapping: MS Windows and UNIX{''}}). The following list of UNIX/Linux group membership shows that the user {\texttt{\docbookhyphenatedot{ajt}}} is a member of the UNIX/Linux group {\texttt{\docbookhyphenatedot{Engineers}}}. 
\begin{Verbatim}[]

root#  getent group
...
Domain Admins:x:512:root
Domain Users:x:513:jht,lct,ajt,met,vlendecke
Domain Guests:x:514:
Print Operators:x:550:
Backup Operators:x:551:
Replicator:x:552:
Domain Computers:x:553:
Engineers:x:1000:jht,ajt

\end{Verbatim}
 The UNIX/Linux groups have been mapped to Windows groups, as is shown here: 
\begin{Verbatim}[]

root#  net groupmap list
Domain Admins (S-1-5-21-72630-412605-116429-512) -> Domain Admins
Domain Users (S-1-5-21-72630-412605-116429-513) -> Domain Users
Domain Guests (S-1-5-21-72630-412605-116429-514) -> Domain Guests
Print Operators (S-1-5-21-72630-412605-116429-550) -> Print Operators
Backup Operators (S-1-5-21-72630-412605-116429-551) -> Backup Operators
Replicator (S-1-5-21-72630-412605-116429-552) -> Replicator
Domain Computers (S-1-5-21-72630-412605-116429-553) -> Domain Computers
Engineers (S-1-5-21-72630-412605-116429-3001) -> Engineers

\end{Verbatim}


Given that the user {\texttt{\docbookhyphenatedot{ajt}}} is already a member of the UNIX/Linux group and, via the group mapping, a member of the Windows group, an attempt to add this account again should fail. This is demonstrated here: \index{net!rpc!group addmem} 
\begin{Verbatim}[]

root#  net rpc group addmem "MIDEARTH\Engineers" ajt -Uroot%not24get
Could not add ajt to MIDEARTH\Engineers: NT_STATUS_MEMBER_IN_GROUP

\end{Verbatim}
 This shows that the group mapping between UNIX/Linux groups and Windows groups is effective and transparent.

To permit the user {\texttt{\docbookhyphenatedot{ajt}}} to be added using the {\bfseries{net rpc group}} utility, this account must first be removed. The removal and confirmation of its effect is shown here: \index{net!rpc!group delmem} 
\begin{Verbatim}[]

root#  net rpc group delmem "MIDEARTH\Engineers" ajt -Uroot%not24get
root#  getent group Engineers
Engineers:x:1000:jht
root#  net rpc group members Engineers -Uroot%not24get
MIDEARTH\jht

\end{Verbatim}
 In this example both at the UNIX/Linux system level, the group no longer has the {\texttt{\docbookhyphenatedot{ajt}}} as a member. The above also shows this to be the case for Windows group membership.

The account is now added again, using the {\bfseries{net rpc group}} utility: 
\begin{Verbatim}[]

root#  net rpc group addmem "MIDEARTH\Engineers" ajt -Uroot%not24get
root#  getent group Engineers
Engineers:x:1000:jht,ajt
root#  net rpc group members Engineers -Uroot%not24get
MIDEARTH\jht
MIDEARTH\ajt

\end{Verbatim}


In this example the members of the Windows {\texttt{\docbookhyphenatedot{Domain Users}}} account are validated using the {\bfseries{net rpc group}} utility. Note the this contents of the UNIX/Linux group was shown four paragraphs earlier. The Windows (domain) group membership is shown here: \index{net!rpc!group members} 
\begin{Verbatim}[]

root#  net rpc group members "Domain Users" -Uroot%not24get
MIDEARTH\jht
MIDEARTH\lct
MIDEARTH\ajt
MIDEARTH\met
MIDEARTH\vlendecke

\end{Verbatim}
 This express example shows that Windows group names are treated by Samba (as with MS Windows) in a case-insensitive manner: 
\begin{Verbatim}[]

root#  net rpc group members "DomAiN USerS" -Uroot%not24get
MIDEARTH\jht
MIDEARTH\lct
MIDEARTH\ajt
MIDEARTH\met
MIDEARTH\vlendecke

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

An attempt to specify the group name as {\texttt{\docbookhyphenatedot{MIDEARTH\textbackslash Domain Users}}} in place of just simply {\texttt{\docbookhyphenatedot{Domain Users}}} will fail. The default behavior of the net rpc group is to direct the command at the local machine. The Windows group is treated as being local to the machine. If it is necessary to query another machine, its name can be specified using the {\texttt{\docbookhyphenatedot{-S servername}}} parameter to the {\bfseries{net}} command.
\end{admonition}

\subsection{Nested Group Support}
\label{nestedgrpmgmgt}\hypertarget{nestedgrpmgmgt}{}%

It is possible in Windows (and now in Samba also) to create a local group that has members (contains), domain users, and domain global groups. Creation of the local group {\texttt{\docbookhyphenatedot{demo}}} is achieved by executing: 
\begin{Verbatim}[]

root#  net rpc group add demo -L -S MORDON -Uroot%not24get

\end{Verbatim}
 The -L switch means create a local group. Use the -S argument to direct the operation to a particular server. The parameters to the -U argument should be for a user who has appropriate administrative right and privileges on the machine.

Addition and removal of group members can be achieved using the {\texttt{\docbookhyphenatedot{addmem}}} and {\texttt{\docbookhyphenatedot{delmem}}} subcommands of {\bfseries{net rpc group}} command. For example, addition of {``}DOM\textbackslash Domain Users{''} to the local group {\texttt{\docbookhyphenatedot{demo}}} would be done by executing: 
\begin{Verbatim}[]

root#  net rpc group addmem demo "DOM\Domain Users" -Uroot%not24get

\end{Verbatim}


The members of a nested group can be listed by executing the following: 
\begin{Verbatim}[]

root#  net rpc group members demo -Uroot%not24get
DOM\Domain Users
DOM\Engineers
DOM\jamesf
DOM\jht

\end{Verbatim}


Nested group members can be removed (deleted) as shown here: 
\begin{Verbatim}[]

root#  net rpc group delmem demo "DOM\jht" -Uroot%not24get

\end{Verbatim}

\subsubsection{Managing Nest Groups on Workstations from the Samba Server}
\label{id2553936}\hypertarget{id2553936}{}%

Windows network administrators often ask on the Samba mailing list how it is possible to grant everyone administrative rights on their own workstation. This is of course a very bad practice, but commonly done to avoid user complaints. Here is how it can be done remotely from a Samba PDC or BDC: \index{net!rpc!group addmem} 
\begin{Verbatim}[]

root#  net rpc group addmem "Administrators" "Domain Users" \
    -S WINPC032 -Uadministrator%secret

\end{Verbatim}


This can be scripted, and can therefore be performed as a user logs onto the domain from a Windows workstation. Here is a simple example that shows how this can be done.
Automating User Addition to the Workstation Power Users Group
\begin{example}%
\hypertarget{autopoweruserscript}{}%
\captionswapskip{}{{\caption{Script to Auto-add Domain Users to Workstation Power Users Group}\label{autopoweruserscript}}}
\captionswapskip{}
\begin{Verbatim}[]

#!/bin/bash

/usr/bin/net rpc group addmem "Power Users" "DOMAIN_NAME\$1" \
                   -UAdministrator%secret -S $2

exit 0

\end{Verbatim}
\end{example}


\begin{example}%
\hypertarget{magicnetlogon}{}%
\captionswapskip{}{{\caption{A Magic Netlogon Share}\label{magicnetlogon}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[netlogon]
 	comment = Netlogon Share
 	path = /var/lib/samba/netlogon
 	root preexec = /etc/samba/scripts/autopoweruser.sh %U %m
 	read only = Yes
 	guest ok = Yes
\end{lstlisting}
\end{example}

\begin{enumerate}

\item{Create the script shown in \hyperlink{autopoweruserscript}{Example {\ref{autopoweruserscript}}} and locate it in the directory {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}scripts}}}, named as {\texttt{\docbookhyphenatefilename{autopoweruser.\dbz{}sh}}}. \index{net!rpc!group addmem} \index{autopoweruser.sh} \index{/etc/samba/scripts}}

\item{Set the permissions on this script to permit it to be executed as part of the logon process: 
\begin{Verbatim}[]

root#  chown root:root /etc/samba/autopoweruser.sh
root#  chmod 755 /etc/samba/autopoweruser.sh

\end{Verbatim}
}

\item{Modify the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file so the {\texttt{\docbookhyphenatedot{NETLOGON}}} stanza contains the parameters shown in \hyperlink{magicnetlogon}{Example {\ref{magicnetlogon}}}.}

\item{Ensure that every Windows workstation Administrator account has the same password that you have used in the script shown in \hyperlink{magicnetlogon}{Example {\ref{magicnetlogon}}}}
\end{enumerate}

This script will be executed every time a user logs on to the network. Therefore every user will have local Windows workstation management rights. This could of course be assigned using a group, in which case there is little justification for the use of this procedure. The key justification for the use of this method is that it will guarantee that all users have appropriate rights on the workstation.

% ------------------------   
% Section 
\section{UNIX and Windows User Management}
\label{id2554169}\hypertarget{id2554169}{}%

\index{user account} \index{UNIX/Linux user account} \index{UID} \index{POSIX account} \index{range} \index{Windows user accounts} \index{winbindd} \index{account information} Every Windows network user account must be translated to a UNIX/Linux user account. In actual fact, the only account information the UNIX/Linux Samba server needs is a UID. The UID is available either from a system (POSIX) account or from a pool (range) of UID numbers that is set aside for the purpose of being allocated for use by Windows user accounts. In the case of the UID pool, the UID for a particular user will be allocated by {\bfseries{winbindd}}.

Although this is not the appropriate place to discuss the \smbconfoption{username map} facility, this interface is an important method of mapping a Windows user account to a UNIX account that has a different name. Refer to the man page for the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file for more information regarding this facility. User name mappings cannot be managed using the {\bfseries{net}} utility.
\subsection{Adding User Accounts}
\label{sbeuseraddn}\hypertarget{sbeuseraddn}{}%

The syntax for adding a user account via the {\bfseries{net}} (according to the man page) is shown here: 
\begin{Verbatim}[]

net [<method>] user ADD <name> [-c container] [-F user flags] \
    [misc. options] [targets]

\end{Verbatim}
 The user account password may be set using this syntax: 
\begin{Verbatim}[]

net rpc password <username> [<password>] -Uadmin_username%admin_pass

\end{Verbatim}


The following demonstrates the addition of an account to the server {\texttt{\docbookhyphenatedot{FRODO}}}: \index{net!rpc!user add} \index{net!rpc!user password} 
\begin{Verbatim}[]

root#  net rpc user add jacko -S FRODO -Uroot%not24get
Added user jacko

\end{Verbatim}
 The account password can be set with the following methods (all show the same operation): 
\begin{Verbatim}[]

root#  net rpc password jacko f4sth0rse -S FRODO -Uroot%not24get
root#  net rpc user password jacko f4sth0rse \
    -S FRODO -Uroot%not24get

\end{Verbatim}

\subsection{Deletion of User Accounts}
\label{id2554358}\hypertarget{id2554358}{}%

Deletion of a user account can be done using the following syntax: 
\begin{Verbatim}[]

net [<method>] user DELETE <name> [misc. options] [targets]

\end{Verbatim}
 The following command will delete the user account {\texttt{\docbookhyphenatedot{jacko}}}: \index{net!rpc!user delete} 
\begin{Verbatim}[]

root#  net rpc user delete jacko -Uroot%not24get
Deleted user account

\end{Verbatim}

\subsection{Managing User Accounts}
\label{id2554402}\hypertarget{id2554402}{}%

Two basic user account operations are routinely used: change of password and querying which groups a user is a member of. The change of password operation is shown in \hyperlink{sbeuseraddn}{Section {\ref{sbeuseraddn}}}.

The ability to query Windows group membership can be essential. Here is how a remote server may be interrogated to find which groups a user is a member of: \index{net!rpc!user info} 
\begin{Verbatim}[]

root#  net rpc user info jacko -S SAURON -Uroot%not24get
net rpc user info jacko -S SAURON -Uroot%not24get
Domain Users
Domain Admins
Engineers
TorridGroup
BOP Shop
Emergency Services

\end{Verbatim}


It is also possible to rename user accounts: \index{net!rpc!user rename}oldusername newusername Note that this operation does not yet work against Samba Servers. It is, however, possible to rename useraccounts on Windows Servers.
\subsection{User Mapping}
\label{id2554466}\hypertarget{id2554466}{}%

\index{logon name} \index{/etc/samba/smbusers} \index{username map} In some situations it is unavoidable that a user's Windows logon name will differ from the login ID that user has on the Samba server. It is possible to create a special file on the Samba server that will permit the Windows user name to be mapped to a different UNIX/Linux user name. The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file must also be amended so that the {\texttt{\docbookhyphenatedot{[global]}}} stanza contains the parameter: 
\begin{Verbatim}[]

username map = /etc/samba/smbusers

\end{Verbatim}
 The content of the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smbusers}}} file is shown here: 
\begin{Verbatim}[]

parsonsw: "William Parsons"
marygee: geeringm

\end{Verbatim}
 In this example the Windows user account {``}William Parsons{''} will be mapped to the UNIX user {\texttt{\docbookhyphenatedot{parsonsw}}}, and the Windows user account {``}geeringm{''} will be mapped to the UNIX user {\texttt{\docbookhyphenatedot{marygee}}}.

% ------------------------   
% Section 
\section{Administering User Rights and Privileges}
\label{id2554543}\hypertarget{id2554543}{}%

\index{credentials} \index{manage printers} \index{manage shares} \index{manage groups} \index{manage users} With all versions of Samba earlier than 3.0.11 the only account on a Samba server that could manage users, groups, shares, printers, and such was the {\texttt{\docbookhyphenatedot{root}}} account. This caused problems for some users and was a frequent source of scorn over the necessity to hand out the credentials for the most security-sensitive account on a UNIX/Linux system.

\index{delegate administrative privileges} \index{normal user} \index{rights and privilege} \index{privilege management} \index{groups of users} New to Samba version 3.0.11 is the ability to delegate administrative privileges as necessary to either a normal user or to groups of users. The significance of the administrative privileges is documented in \hyperlink{rights}{Chapter {\ref{rights}}, {``}User Rights and Privileges{''}}. Examples of use of the {\bfseries{net}} for user rights and privilege management is appropriate to this chapter.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

When user rights and privileges are correctly set, there is no longer a need for a Windows network account for the {\texttt{\docbookhyphenatedot{root}}} user (nor for any synonym of it) with a UNIX UID=0. Initial user rights and privileges can be assigned by any account that is a member of the {\texttt{\docbookhyphenatedot{Domain Admins}}} group. Rights can be assigned to user as well as group accounts.
\end{admonition}


By default, no privileges and rights are assigned. This is demonstrated by executing the command shown here: 
\begin{Verbatim}[]

root#  net rpc rights list accounts -U root%not24get
BUILTIN\Print Operators
No privileges assigned

BUILTIN\Account Operators
No privileges assigned

BUILTIN\Backup Operators
No privileges assigned

BUILTIN\Server Operators
No privileges assigned

BUILTIN\Administrators
No privileges assigned

Everyone
No privileges assigned

\end{Verbatim}


The {\bfseries{net}} command can be used to obtain the currently supported capabilities for rights and privileges using this method: \index{SeMachineAccountPrivilege} \index{SePrintOperatorPrivilege} \index{SeAddUsersPrivilege} \index{SeRemoteShutdownPrivilege} \index{SeDiskOperatorPrivilege} \index{SeBackupPrivilege} \index{SeRestorePrivilege} \index{SeTakeOwnershipPrivilege} \index{net!rpc!rights list} 
\begin{Verbatim}[]

root#  net rpc rights list -U root%not24get
     SeMachineAccountPrivilege  Add machines to domain
      SePrintOperatorPrivilege  Manage printers
           SeAddUsersPrivilege  Add users and groups to the domain
     SeRemoteShutdownPrivilege  Force shutdown from a remote system
       SeDiskOperatorPrivilege  Manage disk shares
             SeBackupPrivilege  Back up files and directories
            SeRestorePrivilege  Restore files and directories
      SeTakeOwnershipPrivilege  Take ownership of files or other objects

\end{Verbatim}
 Machine account privilege is necessary to permit a Windows NT4 or later network client to be added to the domain. The disk operator privilege is necessary to permit the user to manage share ACLs and file and directory ACLs for objects not owned by the user.

In this example, all rights are assigned to the {\texttt{\docbookhyphenatedot{Domain Admins}}} group. This is a good idea since members of this group are generally expected to be all-powerful. This assignment makes that the reality: \index{net!rpc!rights grant} 
\begin{Verbatim}[]

root#  net rpc rights grant "MIDEARTH\Domain Admins" \
    SeMachineAccountPrivilege SePrintOperatorPrivilege \
    SeAddUsersPrivilege SeRemoteShutdownPrivilege \
    SeDiskOperatorPrivilege  -U root%not24get
Successfully granted rights.

\end{Verbatim}
 Next, the domain user {\texttt{\docbookhyphenatedot{jht}}} is given the privileges needed for day-to-day administration: 
\begin{Verbatim}[]

root#  net rpc rights grant "MIDEARTH\jht" \
    SeMachineAccountPrivilege SePrintOperatorPrivilege \
    SeAddUsersPrivilege SeDiskOperatorPrivilege \
    -U root%not24get
Successfully granted rights.

\end{Verbatim}


The following step permits validation of the changes just made: \index{net!rpc!rights list accounts} 
\begin{Verbatim}[]

root#  net rpc rights list accounts -U root%not24get
MIDEARTH\jht
SeMachineAccountPrivilege
SePrintOperatorPrivilege
SeAddUsersPrivilege
SeDiskOperatorPrivilege

BUILTIN\Print Operators
No privileges assigned

BUILTIN\Account Operators
No privileges assigned

BUILTIN\Backup Operators
No privileges assigned

BUILTIN\Server Operators
No privileges assigned

BUILTIN\Administrators
No privileges assigned

Everyone
No privileges assigned

MIDEARTH\Domain Admins
SeMachineAccountPrivilege
SePrintOperatorPrivilege
SeAddUsersPrivilege
SeRemoteShutdownPrivilege
SeDiskOperatorPrivilege

\end{Verbatim}


% ------------------------   
% Section 
\section{Managing Trust Relationships}
\label{id2554865}\hypertarget{id2554865}{}%

There are essentially two types of trust relationships: the first is between domain controllers and domain member machines (network clients), the second is between domains (called interdomain trusts). All Samba servers that participate in domain security require a domain membership trust account, as do like Windows NT/200x/XP workstations.
\subsection{Machine Trust Accounts}
\label{id2554880}\hypertarget{id2554880}{}%

The net command looks in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to obtain its own configuration settings. Thus, the following command 'knows' which domain to join from the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

A Samba server domain trust account can be validated as shown in this example: \index{net!rpc!testjoin} 
\begin{Verbatim}[]

root#  net rpc testjoin
Join to 'MIDEARTH' is OK

\end{Verbatim}
 Where there is no domain membership account, or when the account credentials are not valid, the following results will be observed: 
\begin{Verbatim}[]

net rpc testjoin -S DOLPHIN
Join to domain 'WORLDOCEAN' is not valid

\end{Verbatim}


The equivalent command for joining a Samba server to a Windows ADS domain is shown here: \index{net!ads!testjoin} 
\begin{Verbatim}[]

root#  net ads testjoin
Using short domain name -- TAKEAWAY
Joined 'LEMONADE' to realm 'TAKEAWAY.BIZ'

\end{Verbatim}
 In the event that the ADS trust was not established, or is broken for one reason or another, the following error message may be obtained: 
\begin{Verbatim}[]

root#  net ads testjoin -UAdministrator%secret
Join to domain is not valid

\end{Verbatim}


The following demonstrates the process of creating a machine trust account in the target domain for the Samba server from which the command is executed: \index{net!rpc!join} 
\begin{Verbatim}[]

root#  net rpc join -S FRODO -Uroot%not24get
Joined domain MIDEARTH.

\end{Verbatim}
 The joining of a Samba server to a Samba domain results in the creation of a machine account. An example of this is shown here: 
\begin{Verbatim}[]

root#  pdbedit -Lw merlin\$
merlin$:1009:9B4489D6B90461FD6A3EC3AB96147E16:\
176D8C554E99914BDF3407DEA2231D80:[S          ]:LCT-42891919:

\end{Verbatim}
 The S in the square brackets means this is a server (PDC/BDC) account. The domain join can be cast to join purely as a workstation, in which case the S is replaced with a W (indicating a workstation account). The following command can be used to affect this: \index{net!rpc!join member} 
\begin{Verbatim}[]

root#  net rpc join member -S FRODO -Uroot%not24get
Joined domain MIDEARTH.

\end{Verbatim}
 Note that the command-line parameter {\texttt{\docbookhyphenatedot{member}}} makes this join specific. By default the type is deduced from the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file configuration. To specifically join as a PDC or BDC, the command-line parameter will be {\texttt{\docbookhyphenatedot{[PDC \docbooktolatexpipe{} BDC]}}}. For example: \index{net!rpc!join bdc} 
\begin{Verbatim}[]

root#  net rpc join bdc -S FRODO -Uroot%not24get
Joined domain MIDEARTH.

\end{Verbatim}
 It is best to let Samba figure out the domain join type from the settings in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

The command to join a Samba server to a Windows ADS domain is shown here: \index{net!ads!join} 
\begin{Verbatim}[]

root#  net ads join -UAdministrator%not24get
Using short domain name -- GDANSK
Joined 'FRANDIMITZ' to realm 'GDANSK.ABMAS.BIZ'

\end{Verbatim}


There is no specific option to remove a machine account from an NT4 domain. When a domain member that is a Windows machine is withdrawn from the domain, the domain membership account is not automatically removed either. Inactive domain member accounts can be removed using any convenient tool. If necessary, the machine account can be removed using the following {\bfseries{net}} command: \index{net!rpc!user delete} 
\begin{Verbatim}[]

root#  net rpc user delete HERRING\$ -Uroot%not24get
Deleted user account.

\end{Verbatim}
 The removal is made possible because machine accounts are just like user accounts with a trailing \$ character. The account management operations treat user and machine accounts in like manner.

A Samba-3 server that is a Windows ADS domain member can execute the following command to detach from the domain: \index{net!ads!leave} 
\begin{Verbatim}[]

root#  net ads leave

\end{Verbatim}


Detailed information regarding an ADS domain can be obtained by a Samba DMS machine by executing the following: \index{net!ads!status} 
\begin{Verbatim}[]

root#  net ads status

\end{Verbatim}
 The volume of information is extensive. Please refer to the book {``}Samba-3 by Example{''}, Chapter 7 for more information regarding its use. This book may be obtained either in print or online from the Samba-3 by Example\label{id2555218}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/docs/Samba3-ByExample.pdf}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2555218}.
\subsection{Interdomain Trusts}
\label{id2555227}\hypertarget{id2555227}{}%

Interdomain trust relationships form the primary mechanism by which users from one domain can be granted access rights and privileges in another domain.

To discover what trust relationships are in effect, execute this command: \index{net!rpc!trustdom list} 
\begin{Verbatim}[]

root#  net rpc trustdom list -Uroot%not24get
Trusted domains list:

none

Trusting domains list:

none

\end{Verbatim}
 There are no interdomain trusts at this time; the following steps will create them.

It is necessary to create a trust account in the local domain. A domain controller in a second domain can create a trusted connection with this account. That means that the foreign domain is being trusted to access resources in the local domain. This command creates the local trust account: \index{net!rpc!trustdom add} 
\begin{Verbatim}[]

root#  net rpc trustdom add DAMNATION f00db4r -Uroot%not24get

\end{Verbatim}
 The account can be revealed by using the {\bfseries{pdbedit}} as shown here: 
\begin{Verbatim}[]

root#  pdbedit -Lw DAMNATION\$
DAMNATION$:1016:9AC1F121DF897688AAD3B435B51404EE: \
7F845808B91BB9F7FEF44B247D9DC9A6:[I         ]:LCT-428934B1:

\end{Verbatim}
 A trust account will always have an I in the field within the square brackets.

If the trusting domain is not capable of being reached, the following command will fail: \index{net!rpc!trustdom list} 
\begin{Verbatim}[]

root#  net rpc trustdom list -Uroot%not24get
Trusted domains list:

none

Trusting domains list:

DAMNATION           S-1-5-21-1385457007-882775198-1210191635

\end{Verbatim}
 The above command executed successfully; a failure is indicated when the following response is obtained: 
\begin{Verbatim}[]

net rpc trustdom list -Uroot%not24get
Trusted domains list:

DAMNATION           S-1-5-21-1385457007-882775198-1210191635

Trusting domains list:

DAMNATION           domain controller is not responding

\end{Verbatim}


Where a trust account has been created on a foreign domain, Samba is able to establish the trust (connect with) the foreign account. In the process it creates a one-way trust to the resources on the remote domain. This command achieves the objective of joining the trust relationship: \index{net!rpc!trustdom establish} 
\begin{Verbatim}[]

root#  net rpc trustdom establish DAMNATION
Password: xxxxxxx	== f00db4r
Could not connect to server TRANSGRESSION
Trust to domain DAMNATION established

\end{Verbatim}
 Validation of the two-way trust now established is possible as shown here: 
\begin{Verbatim}[]

root#  net rpc trustdom list -Uroot%not24get
Trusted domains list:

DAMNATION           S-1-5-21-1385457007-882775198-1210191635

Trusting domains list:

DAMNATION           S-1-5-21-1385457007-882775198-1210191635

\end{Verbatim}


Sometimes it is necessary to remove the ability for local users to access a foreign domain. The trusting connection can be revoked as shown here: \index{net!rpc!trustdom revoke} 
\begin{Verbatim}[]

root#  net rpc trustdom revoke DAMNATION -Uroot%not24get

\end{Verbatim}
 At other times it becomes necessary to remove the ability for users from a foreign domain to be able to access resources in the local domain. The command shown here will do that: 
\begin{Verbatim}[]

root#  net rpc trustdom del DAMNATION -Uroot%not24get

\end{Verbatim}


% ------------------------   
% Section 
\section{Managing Security Identifiers (SIDS)}
\label{id2555448}\hypertarget{id2555448}{}%

\index{security identifier} \index{SID} \index{desktop profiles} \index{user encoded} \index{group SID} The basic security identifier that is used by all Windows networking operations is the Windows security identifier (SID). All Windows network machines (servers and workstations), users, and groups are identified by their respective SID. All desktop profiles are also encoded with user and group SIDs that are specific to the SID of the domain to which the user belongs.

\index{machine SID} \index{domain SID} \index{SID} \index{rejoin} It is truly prudent to store the machine and/or domain SID in a file for safekeeping. Why? Because a change in hostname or in the domain (workgroup) name may result in a change in the SID. When you have the SID on hand, it is a simple matter to restore it. The alternative is to suffer the pain of having to recover user desktop profiles and perhaps rejoin all member machines to the domain.

First, do not forget to store the local SID in a file. It is a good idea to put this in the directory in which the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is also stored. Here is a simple action to achieve this: \index{net!getlocalsid} 
\begin{Verbatim}[]

root#  net getlocalsid > /etc/samba/my-sid

\end{Verbatim}
 Good, there is now a safe copy of the local machine SID. On a PDC/BDC this is the domain SID also.

The following command reveals what the former one should have placed into the file called {\texttt{\docbookhyphenatefilename{my-\dbz{}sid}}}: 
\begin{Verbatim}[]

root#  net getlocalsid
SID for domain MERLIN is: S-1-5-21-726309263-4128913605-1168186429

\end{Verbatim}


If ever it becomes necessary to restore the SID that has been stored in the {\texttt{\docbookhyphenatefilename{my-\dbz{}sid}}} file, simply copy the SID (the string of characters that begins with {\texttt{\docbookhyphenatedot{S-1-5-21}}}) to the command line shown here: \index{net!setlocalsid} 
\begin{Verbatim}[]

root#  net setlocalsid S-1-5-21-1385457007-882775198-1210191635

\end{Verbatim}
 Restoration of a machine SID is a simple operation, but the absence of a backup copy can be very problematic.

The following operation is useful only for machines that are being configured as a PDC or a BDC. DMS and workstation clients should have their own machine SID to avoid any potential namespace collision. Here is the way that the BDC SID can be synchronized to that of the PDC (this is the default NT4 domain practice also): \index{net!rpc!getsid} 
\begin{Verbatim}[]

root#  net rpc getsid -S FRODO -Uroot%not24get
Storing SID S-1-5-21-726309263-4128913605-1168186429 \
    for Domain MIDEARTH in secrets.tdb

\end{Verbatim}
 Usually it is not necessary to specify the target server (-S FRODO) or the administrator account credentials (-Uroot\%not24get).

% ------------------------   
% Section 
\section{Share Management}
\label{id2555658}\hypertarget{id2555658}{}%

Share management is central to all file serving operations. Typical share operations include:

\begin{itemize}
%--- Item
\item 
Creation/change/deletion of shares


%--- Item
\item 
Setting/changing ACLs on shares


%--- Item
\item 
Moving shares from one server to another


%--- Item
\item 
Change of permissions of share contents

\end{itemize}

Each of these are dealt with here insofar as they involve the use of the {\bfseries{net}} command. Operations outside of this command are covered elsewhere in this document.
\subsection{Creating, Editing, and Removing Shares}
\label{id2555703}\hypertarget{id2555703}{}%

A share can be added using the {\bfseries{net rpc share}} command capabilities. The target machine may be local or remote and is specified by the -S option. It must be noted that the addition and deletion of shares using this tool depends on the availability of a suitable interface script. The interface scripts Sambas {\bfseries{smbd}} uses are called \smbconfoption{add share command}, \smbconfoption{delete share command} and \smbconfoption{change share command} A set of example scripts are provided in the Samba source code tarball in the directory {\texttt{\docbookhyphenatefilename{\textasciitilde{}samba/\dbz{}examples/\dbz{}scripts}}}.

The following steps demonstrate the use of the share management capabilities of the {\bfseries{net}} utility. In the first step a share called {\texttt{\docbookhyphenatedot{Bulge}}} is added. The sharepoint within the file system is the directory {\texttt{\docbookhyphenatefilename{/\dbz{}data}}}. The command that can be executed to perform the addition of this share is shown here: \index{net!rpc!share add} 
\begin{Verbatim}[]

root#  net rpc share add Bulge=/data -S MERLIN -Uroot%not24get

\end{Verbatim}
 Validation is an important process, and by executing the command {\bfseries{net rpc share}} with no other operators it is possible to obtain a listing of available shares, as shown here: 
\begin{Verbatim}[]

root#  net rpc share -S MERLIN -Uroot%not24get
profdata
archive
Bulge   <--- This one was added
print$
netlogon
profiles
IPC$
kyocera
ADMIN$

\end{Verbatim}


Often it is desirable also to permit a share to be removed using a command-line tool. The following step permits the share that was previously added to be removed: \index{net!rpc!share delete} 
\begin{Verbatim}[]

root#  net rpc share delete Bulge -S MERLIN -Uroot%not24get

\end{Verbatim}
 A simple validation shown here demonstrates that the share has been removed: 
\begin{Verbatim}[]

root#  net rpc share -S MERLIN -Uroot%not24get
profdata
archive
print$
netlogon
profiles
IPC$
ADMIN$
kyocera

\end{Verbatim}

\subsection{Creating and Changing Share ACLs}
\label{id2555855}\hypertarget{id2555855}{}%

At this time the {\bfseries{net}} tool cannot be used to manage ACLs on Samba shares. In MS Windows language this is called Share Permissions.

It is possible to set ACLs on Samba shares using either the SRVTOOLS NT4 Domain Server Manager or using the Computer Management MMC snap-in. Neither is covered here, but see \hyperlink{AccessControls}{Chapter {\ref{AccessControls}}, {``}File, Directory, and Share Access Controls{''}}.
\subsection{Share, Directory, and File Migration}
\label{id2555883}\hypertarget{id2555883}{}%

\index{net!rpc!vampire} Shares and files can be migrated in the same manner as user, machine, and group accounts. It is possible to preserve access control settings (ACLs) as well as security settings throughout the migration process. The {\bfseries{net rpc vampire}} facility is used to migrate accounts from a Windows NT4 (or later) domain to a Samba server. This process preserves passwords and account security settings and is a precursor to the migration of shares and files.

The {\bfseries{net rpc share}} command may be used to migrate shares, directories, files, and all relevant data from a Windows server to a Samba server.

A set of command-line switches permit the creation of almost direct clones of Windows file servers. For example, when migrating a fileserver, file ACLs and DOS file attributes from the Windows server can be included in the migration process and will reappear, almost identically, on the Samba server when the migration has been completed.

The migration process can be completed only with the Samba server already being fully operational. The user and group accounts must be migrated before attempting to migrate data share, files, and printers. The migration of files and printer configurations involves the use of both SMB and MS DCE RPC services. The benefit of the manner in which the migration process has been implemented is that the possibility now exists to use a Samba server as a man-in-middle migration service that affects a transfer of data from one server to another. For example, if the Samba server is called MESSER, the source Windows NT4 server is called PEPPY, and the target Samba server is called GONZALES, the machine MESSER can be used to effect the migration of all data (files and shares) from PEPPY to GONZALES. If the target machine is not specified, the local server is assumed by default - as net's general rule of thumb .

The success of server migration requires a firm understanding of the structure of the source server (or domain) as well as the processes on which the migration is critically dependant.

There are two known limitations to the migration process:

\begin{enumerate}
%--- Item
\item 
The {\bfseries{net}} command requires that the user credentials provided exist on both the migration source and the migration target.


%--- Item
\item 
Printer settings may not be fully or may be incorrectly migrated. This might in particular happen when migrating a Windows 2003 print server to Samba.

\end{enumerate}
\subsubsection{Share Migration}
\label{id2555991}\hypertarget{id2555991}{}%

The {\bfseries{net rpc share migrate}} command operation permits the migration of plain share stanzas. A stanza contains the parameters within which a file or print share are defined. The use of this migration method will create share stanzas that have as parameters the file system directory path, an optional description, and simple security settings that permit write access to files. One of the first steps necessary following migration is to review the share stanzas to ensure that the settings are suitable for use.

The shares are created on the fly as part of the migration process. The {\bfseries{smbd}} application does this by calling on the operating system to execute the script specified by the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter {\ttfamily\itshape{\docbookhyphenatedot{add share command}}}.

There is a suitable example script for the {\ttfamily\itshape{\docbookhyphenatedot{add share command}}} in the {\texttt{\docbookhyphenatefilename{\$SAMBA\_\dbz{}SOURCES/\dbz{}examples/\dbz{}scripts}}} directory. It should be noted that the account that is used to drive the migration must, of necessity, have appropriate file system access privileges and have the right to create shares and to set ACLs on them. Such rights are conferred by these rights: {\ttfamily\itshape{\docbookhyphenatedot{SeAddUsersPrivilege}}} and {\ttfamily\itshape{\docbookhyphenatedot{SeDiskOperatorPrivilege}}}. For more information regarding rights and privileges please refer to \hyperlink{rights}{Chapter {\ref{rights}}, {``}User Rights and Privileges{''}}.

The syntax of the share migration command is shown here: 
\begin{Verbatim}[]

net rpc share MIGRATE SHARES <share-name> -S <source>
        [--destination=localhost] [--exclude=share1,share2] [-v]

\end{Verbatim}
 When the parameter \textless{}share-name\textgreater{} is omitted, all shares will be migrated. The potentially large list of available shares on the system that is being migrated can be limited using the {\ttfamily\itshape{\docbookhyphenatedot{--exclude}}} switch. For example: \index{net!rpc!share migrate} 
\begin{Verbatim}[]

root#  net rpc share migrate shares myshare\
         -S win2k -U administrator%secret"

\end{Verbatim}
 This will migrate the share {\texttt{\docbookhyphenatedot{myshare}}} from the server {\texttt{\docbookhyphenatedot{win2k}}} to the Samba Server using the permissions that are tied to the account {\texttt{\docbookhyphenatedot{administrator}}} with the password {\texttt{\docbookhyphenatedot{secret}}}. The account that is used must be the same on both the migration source server and the target Samba server. The use of the {\bfseries{net rpc vampire}}, prior to attempting the migration of shares, will ensure that accounts will be identical on both systems. One precaution worth taking before commencement of migration of shares is to validate that the migrated accounts (on the Samba server) have the needed rights and privileges. This can be done as shown here: \index{net!rpc!right list accounts} 
\begin{Verbatim}[]

root#  net rpc right list accounts -Uroot%not24get

\end{Verbatim}
 The steps taken so far perform only the migration of shares. Directories and directory contents are not migrated by the steps covered up to this point.
\subsubsection{File and Directory Migration}
\label{id2556166}\hypertarget{id2556166}{}%

Everything covered to this point has been done in preparation for the migration of file and directory data. For many people preparation is potentially boring and the real excitement only begins when file data can be used. The next steps demonstrate the techniques that can be used to transfer (migrate) data files using the {\bfseries{net}} command.

Transfer of files from one server to another has always been a challenge for MS Windows administrators because Windows NT and 200X servers do not always include the tools needed. The {\bfseries{xcopy}} from Windows NT is not capable of preserving file and directory ACLs, it does so only with Windows 200x. Microsoft does provide a utility that can copy ACLs (security settings) called {\bfseries{scopy}}, but it is provided only as part of the Windows NT or 200X Server Resource Kit.

There are several tools, both commercial and freeware, that can be used from a Windows server to copy files and directories with full preservation of security settings. One of the best known of the free tools is called {\bfseries{robocopy}}.

The {\bfseries{net}} utility can be used to copy files and directories with full preservation of ACLs as well as DOS file attributes. Note that including ACLs makes sense only where the destination system will operate within the same security context as the source system. This applies both to a DMS and to domain controllers that result from a vampired domain. Before file and directory migration, all shares must already exist.

The syntax for the migration commands is shown here: 
\begin{Verbatim}[]

net rpc share MIGRATE FILES <share-name> -S <source>
    [--destination=localhost] [--exclude=share1,share2]
    [--acls] [--attrs] [--timestamps] [-v]

\end{Verbatim}
 If the \textless{}share-name\textgreater{} parameter is omitted, all shares will be migrated. The potentially large list of shares on the source system can be restricted using the {\ttfamily\itshape{\docbookhyphenatedot{--exclude}}} command switch.

Where it is necessary to preserve all file ACLs, the {\ttfamily\itshape{\docbookhyphenatedot{--acls}}} switch should be added to the above command line. Original file timestamps can be preserved by specifying the {\ttfamily\itshape{\docbookhyphenatedot{--timestamps}}} switch, and the DOS file attributes (i.e., hidden, archive, etc.) can be preserved by specifying the {\ttfamily\itshape{\docbookhyphenatedot{--attrs}}} switch.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The ability to preserve ACLs depends on appropriate support for ACLs as well as the general file system semantics of the host operating system on the target server. A migration from one Windows file server to another will perfectly preserve all file attributes. Because of the difficulty of mapping Windows ACLs onto a POSIX ACLs-supporting system, there can be no perfect migration of Windows ACLs to a Samba server.
\end{admonition}


The ACLs that result on a Samba server will most probably not match the originating ACLs. Windows supports the possibility of files that are owned only by a group. Group-alone file ownership is not possible under UNIX/Linux. Errors in migrating group-owned files can be avoided by using the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file \smbconfoption{force unknown acl user} = yes parameter. This facility will automatically convert group-owned files into correctly user-owned files on the Samba server.

An example for migration of files from a machine called {\texttt{\docbookhyphenatedot{nt4box}}} to the Samba server from which the process will be handled is shown here: \index{net!rpc!share migrate files} 
\begin{Verbatim}[]

root#  net rpc share migrate files -S nt4box --acls \
    --attrs -U administrator%secret

\end{Verbatim}


This command will migrate all files and directories from all file shares on the Windows server called {\texttt{\docbookhyphenatedot{nt4box}}} to the Samba server from which migration is initiated. Files that are group-owned will be owned by the user account {\texttt{\docbookhyphenatedot{administrator}}}.
\subsubsection{Share-ACL Migration}
\label{id2556358}\hypertarget{id2556358}{}%

It is possible to have share-ACLs (security descriptors) that won't allow you, even as Administrator, to copy any files or directories into it. Therefor the migration of the share-ACLs has been put into a separate function: \index{net!rpc!share migrate security} 
\begin{Verbatim}[]

root#  net rpc share migrate security -S nt4box -U administrator%secret

\end{Verbatim}


This command will only copy the share-ACL of each share on nt4box to your local samba-system.
\subsubsection{Simultaneous Share and File Migration}
\label{id2556399}\hypertarget{id2556399}{}%

The operating mode shown here is just a combination of the previous three. It first migrates share definitions and then all shared files and directories and finally migrates the share-ACLs: 
\begin{Verbatim}[]

net rpc share MIGRATE ALL <share-name> -S <source>
    [--exclude=share1, share2] [--acls] [--attrs] [--timestamps] [-v]

\end{Verbatim}


An example of simultaneous migration is shown here: \index{net!rpc!share migrate all} 
\begin{Verbatim}[]

root#  net rpc share migrate all -S w2k3server -U administrator%secret

\end{Verbatim}
 This will generate a complete server clone of the {\ttfamily\itshape{\docbookhyphenatedot{w2k3server}}} server.
\subsection{Printer Migration}
\label{id2556453}\hypertarget{id2556453}{}%

The installation of a new server, as with the migration to a new network environment, often is similar to building a house; progress is very rapid from the laying of foundations up to the stage at which the house can be locked up, but the finishing off appears to take longer and longer as building approaches completion.

Printing needs vary greatly depending on the network environment and may be very simple or complex. If the need is very simple, the best solution to the implementation of printing support may well be to re-install everything from a clean slate instead of migrating older configurations. On the other hand, a complex network that is integrated with many international offices and a multiplexity of local branch offices, each of which form an inter-twined maze of printing possibilities, the ability to migrate all printer configurations is decidedly beneficial. To manually re-establish a complex printing network will take much time and frustration. Often it will not be possible to find driver files that are currently in use, necessitating the installation of newer drivers. Newer drivers often implement printing features that will necessitate a change in the printer usage. Additionally, with very complex printer configurations it becomes almost impossible to re-create the same environment ---  no matter how extensively it has been documented.

The migration of an existing printing architecture involves the following:

\begin{itemize}
%--- Item
\item 
Establishment of print queues.


%--- Item
\item 
Installation of printer drivers (both for the print server and for Windows clients.


%--- Item
\item 
Configuration of printing forms.


%--- Item
\item 
Implementation of security settings.


%--- Item
\item 
Configuration of printer settings.

\end{itemize}

The Samba {\bfseries{net}} utility permits printer migration from one Windows print server to another. When this tool is used to migrate printers to a Samba server {\bfseries{smbd}}, the application that receives the network requests to create the necessary services must call out to the operating system in order to create the underlying printers. The call-out is implemented by way of an interface script that can be specified by the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file parameter \smbconfoption{}. This script is essential to the migration process. A suitable example script may be obtained from the {\texttt{\docbookhyphenatefilename{\$SAMBA\_\dbz{}SOURCES/\dbz{}examples/\dbz{}scripts}}} directory. Take note that this script must be customized to suit the operating system environment and may use its tools to create a print queue.

Each of the components listed above can be completed separately, or they can be completed as part of an automated operation. Many network administrators prefer to deal with migration issues in a manner that gives them the most control, particularly when things go wrong. The syntax for each operation is now briefly described.

Printer migration from a Windows print server (NT4 or 200x) is shown. This instruction causes the printer share to be created together with the underlying print queue: \index{net!rpc!printer migrate printers} 
\begin{Verbatim}[]

net rpc printer MIGRATE PRINTERS [printer] [misc. options] [targets]

\end{Verbatim}
 Printer drivers can be migrated from the Windows print server to the Samba server using this command-line instruction: \index{net!rpc!printer migrate drivers} 
\begin{Verbatim}[]

net rpc printer MIGRATE DRIVERS [printer] [misc. options] [targets]

\end{Verbatim}
 Printer forms can be migrated with the following operation: \index{net!rpc!printer migrate forms} 
\begin{Verbatim}[]

net rpc printer MIGRATE FORMS [printer] [misc. options] [targets]

\end{Verbatim}
 Printer security settings (ACLs) can be migrated from the Windows server to the Samba server using this command: \index{net!rpc!printer migrate security} 
\begin{Verbatim}[]

net rpc printer MIGRATE SECURITY [printer] [misc. options] [targets]

\end{Verbatim}
 Printer configuration settings include factors such as paper size and default paper orientation. These can be migrated from the Windows print server to the Samba server with this command: \index{net!rpc!printer migrate settings} 
\begin{Verbatim}[]

net rpc printer MIGRATE SETTINGS [printer] [misc. options] [targets]

\end{Verbatim}


Migration of printers including the above-mentioned sets of information may be completed with a single command using this syntax: 
\begin{Verbatim}[]

net rpc printer MIGRATE ALL [printer] [misc. options] [targets]

\end{Verbatim}


% ------------------------   
% Section 
\section{Controlling Open Files}
\label{id2556688}\hypertarget{id2556688}{}%

The man page documents the {\bfseries{net file}} function suite, which provides the tools to close open files using either RAP or RPC function calls. Please refer to the man page for specific usage information.

% ------------------------   
% Section 
\section{Session and Connection Management}
\label{id2556706}\hypertarget{id2556706}{}%

The session management interface of the {\bfseries{net session}} command uses the old RAP method to obtain the list of connections to the Samba server, as shown here: \index{net!rap!session} 
\begin{Verbatim}[]

root#  net rap session -S MERLIN -Uroot%not24get
Computer             User name            Client Type        Opens Idle time
------------------------------------------------------------------------------
\\merlin             root                 Unknown Client         0 00:00:00
\\marvel             jht                  Unknown Client         0 00:00:00
\\maggot             jht                  Unknown Client         0 00:00:00
\\marvel             jht                  Unknown Client         0 00:00:00

\end{Verbatim}


A session can be closed by executing a command as shown here: 
\begin{Verbatim}[]

root#  net rap session close marvel -Uroot%not24get

\end{Verbatim}


% ------------------------   
% Section 
\section{Printers and ADS}
\label{id2556769}\hypertarget{id2556769}{}%

When Samba-3 is used within an MS Windows ADS environment, printers shared via Samba will not be browseable until they have been published to the ADS domain. Information regarding published printers may be obtained from the ADS server by executing the {\bfseries{net ads print info}} command following this syntax: \index{net!ads!printer info} 
\begin{Verbatim}[]

net ads printer info <printer_name> <server_name> -Uadministrator%secret

\end{Verbatim}
 If the asterisk (*) is used in place of the printer\_name argument, a list of all printers will be returned.

To publish (make available) a printer to ADS, execute the following command: \index{net!ads!printer publish} 
\begin{Verbatim}[]

net ads printer publish <printer_name> -Uadministrator%secret

\end{Verbatim}
 This publishes a printer from the local Samba server to ADS.

Removal of a Samba printer from ADS is achieved by executing this command: \index{net!ads!printer remove} 
\begin{Verbatim}[]

net ads printer remove <printer_name> -Uadministrator%secret

\end{Verbatim}


A generic search (query) can also be made to locate a printer across the entire ADS domain by executing: \index{net!ads!printer search} 
\begin{Verbatim}[]

net ads printer search <printer_name> -Uadministrator%secret

\end{Verbatim}


% ------------------------   
% Section 
\section{Manipulating the Samba Cache}
\label{id2556875}\hypertarget{id2556875}{}%

Please refer to the {\bfseries{net}} command man page for information regarding cache management.

% ------------------------   
% Section 
\section{Managing IDMAP UID/SID Mappings}
\label{id2556891}\hypertarget{id2556891}{}%

The IDMAP UID to SID, and SID to UID, mappings that are created by {\bfseries{winbindd}} can be backed up to a text file. The text file can be manually edited, although it is highly recommended that you attempt this only if you know precisely what you are doing.

An IDMAP text dump file can be restored (or reloaded). There are two situations that may necessitate this action: a) The existing IDMAP file is corrupt, b) It is necessary to install an editted version of the mapping information.

Winbind must be shut down to dump the IDMAP file. Before restoring a dump file, shut down {\bfseries{winbindd}} and delete the old {\texttt{\docbookhyphenatefilename{winbindd\_\dbz{}idmap.\dbz{}tdb}}} file.
\subsection{Creating an IDMAP Database Dump File}
\label{id2556933}\hypertarget{id2556933}{}%

The IDMAP database can be dumped to a text file as shown here: 
\begin{Verbatim}[]

net idmap dump <full_path_and_tdb_filename> > dumpfile.txt

\end{Verbatim}
 Where a particular build of Samba the run-time tdb files are stored in the {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}lib/\dbz{}samba}}} directory the following commands to create the dump file will suffice: 
\begin{Verbatim}[]

net idmap dump /var/lib/samba/winbindd_idmap.tdb > idmap_dump.txt

\end{Verbatim}

\subsection{Restoring the IDMAP Database Dump File}
\label{id2556965}\hypertarget{id2556965}{}%

The IDMAP dump file can be restored using the following command: 
\begin{Verbatim}[]

net idmap restore <full_path_and_tdb_filename> < dumpfile.txt

\end{Verbatim}
 Where the Samba run-time tdb files are stored in the {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}lib/\dbz{}samba}}} directory the following command can be used to restore the data to the tdb file: 
\begin{Verbatim}[]

net idmap restore /var/lib/samba/winbindd_idmap.tdb < idmap_dump.txt

\end{Verbatim}


% ------------------------   
% Section 
\section{Other Miscellaneous Operations}
\label{netmisc1}\hypertarget{netmisc1}{}%

The following command is useful for obtaining basic statistics regarding a Samba domain. This command does not work with current Windows XP Professional clients. \index{net!rpc!info} 
\begin{Verbatim}[]

root#  net rpc info
Domain Name: RAPIDFLY
Domain SID: S-1-5-21-399034208-633907489-3292421255
Sequence number: 1116312355
Num users: 720
Num domain groups: 27
Num local groups: 6

\end{Verbatim}


Another useful tool is the {\bfseries{net time}} tool set. This tool may be used to query the current time on the target server as shown here: \index{net!time} 
\begin{Verbatim}[]

root#  net time -S SAURON
Tue May 17 00:50:43 2005

\end{Verbatim}
 In the event that it is the intent to pass the time information obtained to the UNIX {\bfseries{/bin/time}}, it is a good idea to obtain the time from the target server in a format that is ready to be passed through. This may be done by executing: \index{net!time!system} 
\begin{Verbatim}[]

root#  net time system -S FRODO
051700532005.16

\end{Verbatim}
 The time can be set on a target server by executing: \index{net!time!set} 
\begin{Verbatim}[]

root#  net time set -S MAGGOT -U Administrator%not24get
Tue May 17 00:55:30 MDT 2005

\end{Verbatim}
 It is possible to obtain the time zone of a server by executing the following command against it: \index{net!time!zone} 
\begin{Verbatim}[]

root#  net time zone -S SAURON
-0600

\end{Verbatim}

\cleardoublepage 
% -------------------------------------------------------------
% Chapter Identity Mapping (IDMAP) 
% ------------------------------------------------------------- 	
\chapter{Identity Mapping (IDMAP)}
\label{idmapper}\hypertarget{idmapper}{}%

\index{Windows} \index{interoperability} \index{IDMAP} \index{Windows Security Identifiers|textit{see} {SID} } \index{SID} \index{UID} \index{GID} The Microsoft Windows operating system has a number of features that impose specific challenges to interoperability with the operating systems on which Samba is implemented. This chapter deals explicitly with the mechanisms Samba-3 (version 3.0.8 and later) uses to overcome one of the key challenges in the integration of Samba servers into an MS Windows networking environment. This chapter deals with identity mapping (IDMAP) of Windows security identifiers (SIDs) to UNIX UIDs and GIDs.

To ensure sufficient coverage, each possible Samba deployment type is discussed. This is followed by an overview of how the IDMAP facility may be implemented.

\index{network client} \index{IDMAP} \index{IDMAP infrastructure} \index{default behavior} The IDMAP facility is of concern where more than one Samba server (or Samba network client) is installed in a domain. Where there is a single Samba server, do not be too concerned regarding the IDMAP infrastructure ---  the default behavior of Samba is nearly always sufficient. Where mulitple Samba servers are used it is often necessary to move data off one server and onto another, and that is where the fun begins!

\index{UID} \index{GID} \index{LDAP} \index{NSS} \index{nss\_ldap} \index{NT4 domain members} \index{ADS domain members} \index{security name-space} Where user and group account information is stored in an LDAP directory every server can have the same consistent UID and GID for users and groups. This is achieved using NSS and the nss\_ldap tool. Samba can be configured to use only local accounts, in which case the scope of the IDMAP problem is somewhat reduced. This works reasonably well if the servers belong to a single domain, and interdomain trusts are not needed. On the other hand, if the Samba servers are NT4 domain members, or ADS domain members, or if there is a need to keep the security name-space separate (i.e., the user {\texttt{\docbookhyphenatedot{DOMINICUS\docbooktolatexgobble\string\\FJones}}} must not be given access to the account resources of the user {\texttt{\docbookhyphenatedot{FRANCISCUS\docbooktolatexgobble\string\\FJones}}}\label{id2472517}\begingroup\catcode`\#=12\footnote{Samba local account mode results in both {\texttt{\docbookhyphenatedot{DOMINICUS\docbooktolatexgobble\string\\FJones}}} and {\texttt{\docbookhyphenatedot{FRANCISCUS\docbooktolatexgobble\string\\FJones}}} mapping to the UNIX user {\texttt{\docbookhyphenatedot{FJones}}}.}\endgroup\docbooktolatexmakefootnoteref{id2472517} free from inadvertent cross-over, close attention should be given to the way that the IDMAP facility is configured.

\index{IDMAP} \index{domain access} \index{SID} \index{UID} \index{GID} \index{one domain} The use of IDMAP is important where the Samba server will be accessed by workstations or servers from more than one domain, in which case it is important to run winbind so it can handle the resolution (ID mapping) of foreign SIDs to local UNIX UIDs and GIDs.

\index{winbindd} The use of the IDMAP facility requires the execution of the {\bfseries{winbindd}} upon Samba startup.

% ------------------------   
% Section 
\section{Samba Server Deployment Types and IDMAP}
\label{id2529296}\hypertarget{id2529296}{}%

\index{Server Types} There are four basic server deployment types, as documented in \hyperlink{ServerType}{Chapter {\ref{ServerType}}, {``}Server Types and Security Modes{''}}.
\subsection{Standalone Samba Server}
\label{id2529320}\hypertarget{id2529320}{}%

\index{stand-alone server} \index{Active Directory} \index{NT4 Domain} A standalone Samba server is an implementation that is not a member of a Windows NT4 domain, a Windows 200X Active Directory domain, or a Samba domain.

\index{IDMAP} \index{identity} \index{local user} By definition, this means that users and groups will be created and controlled locally, and the identity of a network user must match a local UNIX/Linux user login. The IDMAP facility is therefore of little to no interest, winbind will not be necessary, and the IDMAP facility will not be relevant or of interest.
\subsection{Domain Member Server or Domain Member Client}
\label{id2529385}\hypertarget{id2529385}{}%

\index{PDC} \index{BDC} \index{NT4} \index{SID} \index{Active Directory} Samba-3 can act as a Windows NT4 PDC or BDC, thereby providing domain control protocols that are compatible with Windows NT4. Samba-3 file and print sharing protocols are compatible with all versions of MS Windows products. Windows NT4, as with MS Active Directory, extensively makes use of Windows SIDs.

\index{MS Windows SID} \index{UID} \index{GID} Samba-3 domain member servers and clients must interact correctly with MS Windows SIDs. Incoming Windows SIDs must be translated to local UNIX UIDs and GIDs. Outgoing information from the Samba server must provide to MS Windows clients and servers appropriate SIDs.

\index{ADS} \index{winbind} A Samba member of a Windows networking domain (NT4-style or ADS) can be configured to handle identity mapping in a variety of ways. The mechanism it uses depends on whether or not the {\bfseries{winbindd}} daemon is used and how the winbind functionality is configured. The configuration options are briefly described here:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind is not used; users and groups are local:}]\null{}
\index{winbindd} \index{smbd} \index{network traffic} \index{LoginID} \index{account name} \index{getpwnam} \index{NSS} \index{local users} \index{local groups} \index{/etc/passwd} \index{/etc/group} Where {\bfseries{winbindd}} is not used Samba ({\bfseries{smbd}}) uses the underlying UNIX/Linux mechanisms to resolve the identity of incoming network traffic. This is done using the LoginID (account name) in the session setup request and passing it to the getpwnam() system function call. This call is implemented using the name service switch (NSS) mechanism on modern UNIX/Linux systems. By saying "users and groups are local," we are implying that they are stored only on the local system, in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} respectively.

\index{SessionSetupAndX} \index{/etc/passwd} For example, when the user {\texttt{\docbookhyphenatedot{BERYLIUM\docbooktolatexgobble\string\\WambatW}}} tries to open a connection to a Samba server the incoming SessionSetupAndX request will make a system call to look up the user {\texttt{\docbookhyphenatedot{WambatW}}} in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} file.

\index{standalone} \index{domain member server} \index{NT4} \index{ADS} \index{PDC} \index{smbpasswd} \index{tdbsam} \index{passdb backend} This configuration may be used with standalone Samba servers, domain member servers (NT4 or ADS), and for a PDC that uses either an smbpasswd or a tdbsam-based Samba passdb backend.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind is not used; users and groups resolved via NSS:}]\null{}
\index{user accounts} \index{group accounts} \index{local accounts} \index{repository} \index{NIS} \index{LDAP} In this situation user and group accounts are treated as if they are local accounts. The only way in which this differs from having local accounts is that the accounts are stored in a repository that can be shared. In practice this means that they will reside in either an NIS-type database or else in LDAP.

\index{standalone} \index{domain member server} \index{NT4} \index{ADS} \index{PDC} \index{smbpasswd} \index{tdbsam} This configuration may be used with standalone Samba servers, domain member servers (NT4 or ADS), and for a PDC that uses either an smbpasswd or a tdbsam-based Samba passdb backend.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind/NSS with the default local IDMAP table:}]\null{}
\index{NT4 domain} \index{ADS domain} \index{winbind} \index{domain control} There are many sites that require only a simple Samba server or a single Samba server that is a member of a Windows NT4 domain or an ADS domain. A typical example is an appliance like file server on which no local accounts are configured and winbind is used to obtain account credentials from the domain controllers for the domain. The domain control can be provided by Samba-3, MS Windows NT4, or MS Windows Active Directory.

\index{UID numbers} \index{GID numbers} \index{/etc/nsswitch.conf} \index{winbind} \index{SID} Winbind is a great convenience in this situation. All that is needed is a range of UID numbers and GID numbers that can be defined in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file is configured to use {\bfseries{winbind}}, which does all the difficult work of mapping incoming SIDs to appropriate UIDs and GIDs. The SIDs are allocated a UID/GID in the order in which winbind receives them.

\index{UID} \index{GID} \index{IDMAP} \index{corrupted file} This configuration is not convenient or practical in sites that have more than one Samba server and that require the same UID or GID for the same user or group across all servers. One of the hazards of this method is that in the event that the winbind IDMAP file becomes corrupted or lost, the repaired or rebuilt IDMAP file may allocate UIDs and GIDs to different users and groups from what was there previously with the result that MS Windows files that are stored on the Samba server may now not belong to the rightful owners.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind/NSS uses RID based IDMAP:}]\null{}
\index{RID} \index{idmap\_rid} \index{ADS} \index{LDAP} The IDMAP\_RID facility is new to Samba version 3.0.8. It was added to make life easier for a number of sites that are committed to use of MS ADS, that do not apply an ADS schema extension, and that do not have an installed an LDAP directory server just for the purpose of maintaining an IDMAP table. If you have a single ADS domain (not a forest of domains, and not multiple domain trees) and you want a simple cookie-cutter solution to the IDMAP table problem, then IDMAP\_RID is an obvious choice.

\index{idmap\_rid} \index{idmap uid} \index{idmap gid} \index{RID} \index{SID} \index{UID} \index{idmap backend} \index{automatic mapping} This facility requires the allocation of the {\ttfamily\itshape{\docbookhyphenatedot{idmap uid}}} and the {\ttfamily\itshape{\docbookhyphenatedot{idmap gid}}} ranges, and within the {\ttfamily\itshape{\docbookhyphenatedot{idmap uid}}} it is possible to allocate a subset of this range for automatic mapping of the relative identifier (RID) portion of the SID directly to the base of the UID plus the RID value. For example, if the {\ttfamily\itshape{\docbookhyphenatedot{idmap uid}}} range is {\texttt{\docbookhyphenatedot{1000-100000000}}} and the {\ttfamily\itshape{\docbookhyphenatedot{idmap backend = idmap\_rid:DOMAIN\_NAME=1000-50000000}}}, and a SID is encountered that has the value {\texttt{\docbookhyphenatedot{S-1-5-21-34567898-12529001-32973135-1234}}}, the resulting UID will be {\texttt{\docbookhyphenatedot{1000 + 1234 = 2234}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind with an NSS/LDAP backend-based IDMAP facility:}]\null{}
\index{Domain Member} \index{winbind} \index{SID} \index{UID} \index{GID} \index{idmap gid} \index{idmap uid} \index{LDAP} In this configuration {\bfseries{winbind}} resolved SIDs to UIDs and GIDs from the {\ttfamily\itshape{\docbookhyphenatedot{idmap uid}}} and {\ttfamily\itshape{\docbookhyphenatedot{idmap gid}}} ranges specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, but instead of using a local winbind IDMAP table, it is stored in an LDAP directory so that all domain member machines (clients and servers) can share a common IDMAP table.

\index{idmap backend} \index{LDAP server} \index{LDAP redirects} It is important that all LDAP IDMAP clients use only the master LDAP server because the {\ttfamily\itshape{\docbookhyphenatedot{idmap backend}}} facility in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file does not correctly handle LDAP redirects.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind with NSS to resolve UNIX/Linux user and group IDs:}]\null{}
The use of LDAP as the passdb backend is a smart solution for PDC, BDC, and domain member servers. It is a neat method for assuring that UIDs, GIDs, and the matching SIDs are consistent across all servers.

\index{LDAP} \index{PADL} The use of the LDAP-based passdb backend requires use of the PADL nss\_ldap utility or an equivalent. In this situation winbind is used to handle foreign SIDs, that is, SIDs from standalone Windows clients (i.e., not a member of our domain) as well as SIDs from another domain. The foreign UID/GID is mapped from allocated ranges (idmap uid and idmap gid) in precisely the same manner as when using winbind with a local IDMAP table.

\index{nss\_ldap} \index{AD4UNIX} \index{MMC} The nss\_ldap tool set can be used to access UIDs and GIDs via LDAP as well as via Active Directory. In order to use Active Directory, it is necessary to modify the ADS schema by installing either the AD4UNIX schema extension or using the Microsoft Services for UNIX version 3.5 or later to extend the ADS schema so it maintains UNIX account credentials. Where the ADS schema is extended, a Microsoft Management Console (MMC) snap-in is also installed to permit the UNIX credentials to be set and managed from the ADS User and Computer Management tool. Each account must be separately UNIX-enabled before the UID and GID data can be used by Samba.
\end{description}
\subsection{Primary Domain Controller}
\label{id2557391}\hypertarget{id2557391}{}%

\index{domain security} \index{SID} \index{RID} \index{algorithmic mapping} Microsoft Windows domain security systems generate the user and group SID as part of the process of creation of an account. Windows does not have a concept of the UNIX UID or a GID; rather, it has its own type of security descriptor. When Samba is used as a domain controller, it provides a method of producing a unique SID for each user and group. Samba generates a machine and a domain SID to which it adds an RID that is calculated algorithmically from a base value that can be specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, plus twice (2x) the UID or GID. This method is called {``}algorithmic mapping{''}.

\index{RID base} For example, if a user has a UID of 4321, and the algorithmic RID base has a value of 1000, the RID will be {\texttt{\docbookhyphenatedot{1000 +\dbz{} (\dbz{}2 x 4321)\dbz{} = 9642}}}. Thus, if the domain SID is {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}5-\dbz{}21-\dbz{}89238497-\dbz{}92787123-\dbz{}12341112}}}, the resulting SID is {\texttt{\docbookhyphenatedot{S-\dbz{}1-\dbz{}5-\dbz{}21-\dbz{}89238497-\dbz{}92787123-\dbz{}12341112-\dbz{}9642}}}.

\index{on-the-fly} \index{SID} \index{passdb backend} \index{ldapsam} The foregoing type of SID is produced by Samba as an automatic function and is either produced on the fly (as is the case when using a {\ttfamily\itshape{\docbookhyphenatedot{passdb backend = [tdbsam \docbooktolatexpipe{} smbpasswd]}}}), or may be stored as a permanent part of an account in an LDAP-based ldapsam.

\index{SFU 3.5} \index{ADS} \index{directory schema} \index{account attributes} \index{UID} \index{GID} \index{ADS schema} \index{account management} \index{MMC} ADS uses a directory schema that can be extended to accommodate additional account attributes such as UIDs and GIDs. The installation of Microsoft Service for UNIX 3.5 will expand the normal ADS schema to include UNIX account attributes. These must of course be managed separately through a snap-in module to the normal ADS account management MMC interface.

\index{PDC} \index{passdb backend} \index{BDC} \index{LDAP backend} Security identifiers used within a domain must be managed to avoid conflict and to preserve itegrity. In an NT4 domain context, the PDC manages the distribution of all security credentials to the backup domain controllers (BDCs). At this time the only passdb backend for a Samba domain controller that is suitable for such information is an LDAP backend.
\subsection{Backup Domain Controller}
\label{id2557608}\hypertarget{id2557608}{}%

\index{BDC} \index{read-only access} \index{security credentials} \index{LDAP} \index{group account} \index{write changes} \index{directory} BDCs have read-only access to security credentials that are stored in LDAP. Changes in user or group account information are passed by the BDC to the PDC. Only the PDC can write changes to the directory.

IDMAP information can be written directly to the LDAP server so long as all domain controllers have access to the master (writable) LDAP server. Samba-3 at this time does not handle LDAP redirects in the IDMAP backend. This means that it is is unsafe to use a slave (replicate) LDAP server with the IDMAP facility.

% ------------------------   
% Section 
\section{Examples of IDMAP Backend Usage}
\label{id2557675}\hypertarget{id2557675}{}%

\index{Domain Member Server|textit{see} {DMS} } \index{Domain Member Client|textit{see} {DMC} } \index{DMS} \index{DMC} \index{winbind} Anyone who wishes to use {\bfseries{winbind}} will find the following example configurations helpful. Remember that in the majority of cases {\bfseries{winbind}} is of primary interest for use with domain member servers (DMSs) and domain member clients (DMCs).
\subsection{Default Winbind TDB}
\label{id2557733}\hypertarget{id2557733}{}%

Two common configurations are used:

\begin{itemize}
%--- Item
\item 
Networks that have an NT4 PDC (with or without BDCs) or a Samba PDC (with or without BDCs).


%--- Item
\item 
Networks that use MS Windows 200x ADS.

\end{itemize}
\subsubsection{NT4-Style Domains (Includes Samba Domains)}
\label{id2557757}\hypertarget{id2557757}{}%

\hyperlink{idmapnt4dms}{Example {\ref{idmapnt4dms}}} is a simple example of an NT4 DMS {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file that shows only the global section.

\begin{example}%
\hypertarget{idmapnt4dms}{}%
\captionswapskip{}{{\caption{NT4 Domain Member Server smb.conf}\label{idmapnt4dms}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MEGANET2
 	security = DOMAIN
 	idmap uid = 10000-20000
 	idmap gid = 10000-20000
 	template primary group = "Domain Users"
 	template shell = /bin/bash
\end{lstlisting}
\end{example}


\index{winbind} \index{/etc/nsswitch.conf} The use of {\bfseries{winbind}} requires configuration of NSS. Edit the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} so it includes the following entries: 
\begin{Verbatim}[]

...
passwd: files winbind
shadow: files winbind
group:  files winbind
...
hosts:  files [dns] wins
...

\end{Verbatim}
 The use of DNS in the hosts entry should be made only if DNS is used on site.

The creation of the DMS requires the following steps:
\begin{enumerate}

\item{Create or install an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file with the above configuration.}

\item{Execute: 
\begin{Verbatim}[]

root#  net rpc join -UAdministrator%password
Joined domain MEGANET2.

\end{Verbatim}
 \index{join} The success of the join can be confirmed with the following command: 
\begin{Verbatim}[]

root#  net rpc testjoin
Join to 'MIDEARTH' is OK

\end{Verbatim}
 A failed join would report an error message like the following: \index{failed join} 
\begin{Verbatim}[]

root#  net rpc testjoin
[2004/11/05 16:34:12, 0] utils/net_rpc_join.c:net_rpc_join_ok(66)
Join to domain 'MEGANET2' is not valid

\end{Verbatim}
}

\item{\index{nmbd} \index{winbind} \index{smbd} Start the {\bfseries{nmbd, winbind,}} and {\bfseries{smbd}} daemons in the order shown.}
\end{enumerate}
\subsubsection{ADS Domains}
\label{id2557978}\hypertarget{id2557978}{}%

\index{domain join} \index{ADS domain} The procedure for joining an ADS domain is similar to the NT4 domain join, except the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file will have the contents shown in \hyperlink{idmapadsdms}{Example {\ref{idmapadsdms}}}

\begin{example}%
\hypertarget{idmapadsdms}{}%
\captionswapskip{}{{\caption{ADS Domain Member Server smb.conf}\label{idmapadsdms}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = BUTTERNET
 	netbios name = GARGOYLE
 	realm = BUTTERNET.BIZ
 	security = ADS
 	template shell = /bin/bash
 	idmap uid = 500-10000000
 	idmap gid = 500-10000000
 	winbind use default domain = Yes
 	winbind nested groups = Yes
 	printer admin = "BUTTERNET\Domain Admins"
\end{lstlisting}
\end{example}


\index{KRB} \index{kerberos} \index{/etc/krb5.conf} \index{MIT} \index{MIT kerberos} \index{Heimdal} \index{Heimdal kerberos} ADS DMS operation requires use of kerberos (KRB). For this to work, the {\texttt{\docbookhyphenatefilename{krb5.\dbz{}conf}}} must be configured. The exact requirements depends on which version of MIT or Heimdal Kerberos is being used. It is sound advice to use only the latest version, which at this time are MIT Kerberos version 1.3.5 and Heimdal 0.61.

The creation of the DMS requires the following steps:
\begin{enumerate}

\item{Create or install an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file with the above configuration.}

\item{Edit the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file as shown above.}

\item{Execute: \index{net!ads!join} 
\begin{Verbatim}[]

root#  net ads join -UAdministrator%password
Joined domain BUTTERNET.

\end{Verbatim}
 The success or failure of the join can be confirmed with the following command: 
\begin{Verbatim}[]

root#  net ads testjoin
Using short domain name -- BUTTERNET
Joined 'GARGOYLE' to realm 'BUTTERNET.BIZ'

\end{Verbatim}
  An invalid or failed join can be detected by executing: 
\begin{Verbatim}[]

root#  net ads testjoin
GARGOYLE$@'s password:
[2004/11/05 16:53:03, 0] utils/net_ads.c:ads_startup(186)
  ads_connect: No results returned
Join to domain is not valid

\end{Verbatim}
 \index{error message} \index{failure} \index{log level} \index{identify} The specific error message may differ from the above because it depends on the type of failure that may have occurred. Increase the {\ttfamily\itshape{\docbookhyphenatedot{log level}}} to 10, repeat the test, and then examine the log files produced to identify the nature of the failure.}

\item{Start the {\bfseries{nmbd}}, {\bfseries{winbind}}, and {\bfseries{smbd}} daemons in the order shown.}
\end{enumerate}
\subsection{IDMAP\_RID with Winbind}
\label{id2558290}\hypertarget{id2558290}{}%

\index{idmap\_rid} \index{SID} \index{RID} \index{IDMAP} The {\bfseries{idmap\_rid}} facility is a new tool that, unlike native winbind, creates a predictable mapping of MS Windows SIDs to UNIX UIDs and GIDs. The key benefit of this method of implementing the Samba IDMAP facility is that it eliminates the need to store the IDMAP data in a central place. The downside is that it can be used only within a single ADS domain and is not compatible with trusted domain implementations.

\index{SID} \index{allow trusted domains} \index{idmap uid} \index{idmap gid} This alternate method of SID to UID/GID mapping can be achieved using the idmap\_rid plug-in. This plug-in uses the RID of the user SID to derive the UID and GID by adding the RID to a base value specified. This utility requires that the parameter {``}allow trusted domains = No{''} be specified, as it is not compatible with multiple domain environments. The {\ttfamily\itshape{\docbookhyphenatedot{idmap uid}}} and {\ttfamily\itshape{\docbookhyphenatedot{idmap gid}}} ranges must be specified.

\index{idmap\_rid} \index{realm} The idmap\_rid facility can be used both for NT4/Samba-style domains and Active Directory. To use this with an NT4 domain, do not include the {\ttfamily\itshape{\docbookhyphenatedot{realm}}} parameter; additionally, the method used to join the domain uses the {\texttt{\docbookhyphenatedot{net rpc join}}} process.

An example {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file for and ADS domain environment is shown in \hyperlink{idmapadsridDMS}{Example {\ref{idmapadsridDMS}}}.

\begin{example}%
\hypertarget{idmapadsridDMS}{}%
\captionswapskip{}{{\caption{ADS Domain Member smb.conf using idmap\_rid}\label{idmapadsridDMS}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = KPAK
 	netbios name = BIGJOE
 	realm = CORP.KPAK.COM
 	server string = Office Server
 	security = ADS
 	allow trusted domains = No
 	idmap backend = idmap_rid:KPAK=500-100000000
 	idmap uid = 500-100000000
 	idmap gid = 500-100000000
 	template shell = /bin/bash
 	winbind use default domain = Yes
 	winbind enum users = No
 	winbind enum groups = No
 	winbind nested groups = Yes
 	printer admin = "Domain Admins"
\end{lstlisting}
\end{example}


\index{large domain} \index{Active Directory} \index{response} \index{getent} In a large domain with many users it is imperative to disable enumeration of users and groups. For example, at a site that has 22,000 users in Active Directory the winbind-based user and group resolution is unavailable for nearly 12 minutes following first startup of {\bfseries{winbind}}. Disabling enumeration resulted in instantaneous response. The disabling of user and group enumeration means that it will not be possible to list users or groups using the {\bfseries{getent passwd}} and {\bfseries{getent group}} commands. It will be possible to perform the lookup for individual users, as shown in the following procedure.

\index{NSS} \index{/etc/nsswitch.conf} The use of this tool requires configuration of NSS as per the native use of winbind. Edit the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} so it has the following parameters: 
\begin{Verbatim}[]

...
passwd: files winbind
shadow: files winbind
group:  files winbind
...
hosts:  files wins
...

\end{Verbatim}


The following procedure can use the idmap\_rid facility:
\begin{enumerate}

\item{Create or install an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file with the above configuration.}

\item{Edit the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file as shown above.}

\item{Execute: 
\begin{Verbatim}[]

root#  net ads join -UAdministrator%password
Using short domain name -- KPAK
Joined 'BIGJOE' to realm 'CORP.KPAK.COM'

\end{Verbatim}
  \index{failed join} An invalid or failed join can be detected by executing: 
\begin{Verbatim}[]

root#  net ads testjoin
BIGJOE$@'s password:
[2004/11/05 16:53:03, 0] utils/net_ads.c:ads_startup(186)
  ads_connect: No results returned
Join to domain is not valid

\end{Verbatim}
 The specific error message may differ from the above because it depends on the type of failure that may have occurred. Increase the {\ttfamily\itshape{\docbookhyphenatedot{log level}}} to 10, repeat the test, and then examine the log files produced to identify the nature of the failure.}

\item{Start the {\bfseries{nmbd}}, {\bfseries{winbind}}, and {\bfseries{smbd}} daemons in the order shown.}

\item{Validate the operation of this configuration by executing: \index{} 
\begin{Verbatim}[]

root#  getent passwd administrator
administrator:x:1000:1013:Administrator:/home/BE/administrator:/bin/bash

\end{Verbatim}
}
\end{enumerate}
\subsection{IDMAP Storage in LDAP Using Winbind}
\label{id2558740}\hypertarget{id2558740}{}%

\index{ADAM} \index{ADS} The storage of IDMAP information in LDAP can be used with both NT4/Samba-3-style domains and ADS domains. OpenLDAP is a commonly used LDAP server for this purpose, although any standards-complying LDAP server can be used. It is therefore possible to deploy this IDMAP configuration using the Sun iPlanet LDAP server, Novell eDirectory, Microsoft ADS plus ADAM, and so on.

An example is for an ADS domain is shown in \hyperlink{idmapldapDMS}{Example {\ref{idmapldapDMS}}}.

\begin{example}%
\hypertarget{idmapldapDMS}{}%
\captionswapskip{}{{\caption{ADS Domain Member Server using LDAP}\label{idmapldapDMS}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = SNOWSHOW
 	netbios name = GOODELF
 	realm = SNOWSHOW.COM
 	server string = Samba Server
 	security = ADS
 	log level = 1 ads:10 auth:10 sam:10 rpc:10
 	ldap admin dn = cn=Manager,dc=SNOWSHOW,dc=COM
 	ldap idmap suffix = ou=Idmap
 	ldap suffix = dc=SNOWSHOW,dc=COM
 	idmap backend = ldap:ldap://ldap.snowshow.com
 	idmap uid = 150000-550000
 	idmap gid = 150000-550000
 	template shell = /bin/bash
 	winbind use default domain = Yes
\end{lstlisting}
\end{example}


\index{realm} In the case of an NT4 or Samba-3-style domain the {\ttfamily\itshape{\docbookhyphenatedot{realm}}} is not used, and the command used to join the domain is {\bfseries{net rpc join}}. The above example also demonstrates advanced error-reporting techniques that are documented in \hyperlink{dbglvl}{Section {\ref{dbglvl}}}.

\index{MIT kerberos} \index{Heimdal kerberos} \index{/etc/krb5.conf} Where MIT kerberos is installed (version 1.3.4 or later), edit the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}krb5.\dbz{}conf}}} file so it has the following contents: 
\begin{Verbatim}[]

[logging]
 default = FILE:/var/log/krb5libs.log
 kdc = FILE:/var/log/krb5kdc.log
 admin_server = FILE:/var/log/kadmind.log

[libdefaults]
 default_realm = SNOWSHOW.COM
 dns_lookup_realm = false
 dns_lookup_kdc = true

[appdefaults]
 pam = {
   debug = false
   ticket_lifetime = 36000
   renew_lifetime = 36000
   forwardable = true
   krb4_convert = false
 }

\end{Verbatim}


Where Heimdal kerberos is installed, edit the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}krb5.\dbz{}conf}}} file so it is either empty (i.e., no contents) or it has the following contents: 
\begin{Verbatim}[]

[libdefaults]
        default_realm = SNOWSHOW.COM
        clockskew = 300

[realms]
        SNOWSHOW.COM = {
                kdc = ADSDC.SHOWSHOW.COM
        }
        
[domain_realm]
        .snowshow.com = SNOWSHOW.COM

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Samba cannot use the Heimdal libraries if there is no {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}krb5.\dbz{}conf}}} file. So long as there is an empty file, the Heimdal kerberos libraries will be usable. There is no need to specify any settings because Samba, using the Heimdal libraries, can figure this out automatically.
\end{admonition}


Edit the NSS control file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} so it has the following entries: 
\begin{Verbatim}[]

...
passwd: files ldap
shadow: files ldap
group:  files ldap
...
hosts:  files wins
...

\end{Verbatim}


\index{PADL} \index{/etc/ldap.conf} You will need the PADL\label{id2559007}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.padl.com}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2559007} {\bfseries{nss\_ldap}} tool set for this solution. Configure the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}ldap.\dbz{}conf}}} file so it has the information needed. The following is an example of a working file: 
\begin{Verbatim}[]

host    192.168.2.1
base    dc=snowshow,dc=com
binddn  cn=Manager,dc=snowshow,dc=com
bindpw  not24get

pam_password exop

nss_base_passwd ou=People,dc=snowshow,dc=com?one
nss_base_shadow ou=People,dc=snowshow,dc=com?one
nss_base_group  ou=Groups,dc=snowshow,dc=com?one
ssl     no

\end{Verbatim}


The following procedure may be followed to effect a working configuration:
\begin{enumerate}

\item{Configure the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown above.}

\item{Create the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}krb5.\dbz{}conf}}} file as shown above.}

\item{Configure the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file as shown above.}

\item{Download, build, and install the PADL nss\_ldap tool set. Configure the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}ldap.\dbz{}conf}}} file as shown above.}

\item{Configure an LDAP server and initialize the directory with the top-level entries needed by IDMAP, shown in the following LDIF file: 
\begin{Verbatim}[]

dn: dc=snowshow,dc=com
objectClass: dcObject
objectClass: organization
dc: snowshow
o: The Greatest Snow Show in Singapore.
description: Posix and Samba LDAP Identity Database

dn: cn=Manager,dc=snowshow,dc=com
objectClass: organizationalRole
cn: Manager
description: Directory Manager

dn: ou=Idmap,dc=snowshow,dc=com
objectClass: organizationalUnit
ou: idmap

\end{Verbatim}
}

\item{Execute the command to join the Samba DMS to the ADS domain as shown here: 
\begin{Verbatim}[]

root#  net ads testjoin
Using short domain name -- SNOWSHOW
Joined 'GOODELF' to realm 'SNOWSHOW.COM'

\end{Verbatim}
}

\item{Store the LDAP server access password in the Samba {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}} file as follows: 
\begin{Verbatim}[]

root#  smbpasswd -w not24get

\end{Verbatim}
}

\item{Start the {\bfseries{nmbd}}, {\bfseries{winbind}}, and {\bfseries{smbd}} daemons in the order shown.}
\end{enumerate}

\index{diagnostic} Follow the diagnositic procedures shown earlier in this chapter to identify success or failure of the join. In many cases a failure is indicated by a silent return to the command prompt with no indication of the reason for failure.
\subsection{IDMAP and NSS Using LDAP from ADS with RFC2307bis Schema Extension}
\label{id2559192}\hypertarget{id2559192}{}%

\index{rfc2307bis} \index{schema} The use of this method is messy. The information provided in the following is for guidance only and is very definitely not complete. This method does work; it is used in a number of large sites and has an acceptable level of performance.

An example {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is shown in \hyperlink{idmaprfc2307}{Example {\ref{idmaprfc2307}}}.

\begin{example}%
\hypertarget{idmaprfc2307}{}%
\captionswapskip{}{{\caption{ADS Domain Member Server using RFC2307bis Schema Extension Date via NSS}\label{idmaprfc2307}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = BOBBY
 	realm = BOBBY.COM
 	security = ADS
 	idmap uid = 150000-550000
 	idmap gid = 150000-550000
 	template shell = /bin/bash
 	winbind cache time = 5
 	winbind use default domain = Yes
 	winbind trusted domains only = Yes
 	winbind nested groups = Yes
\end{lstlisting}
\end{example}


\index{nss\_ldap} The DMS must be joined to the domain using the usual procedure. Additionally, it is necessary to build and install the PADL nss\_ldap tool set. Be sure to build this tool set with the following: 
\begin{Verbatim}[]

./configure --enable-rfc2307bis --enable-schema-mapping
make install

\end{Verbatim}


\index{/etc/nsswitch.conf} The following {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file contents are required: 
\begin{Verbatim}[]

...
passwd: files ldap
shadow: files ldap
group:  files ldap
...
hosts:  files wins
...

\end{Verbatim}


\index{/etc/ldap.conf} \index{nss\_ldap} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}ldap.\dbz{}conf}}} file must be configured also. Refer to the PADL documentation and source code for nss\_ldap to specific instructions.

The next step involves preparation of the ADS schema. This is briefly discussed in the remaining part of this chapter.
\subsubsection{IDMAP, Active Directory, and MS Services for UNIX 3.5}
\label{id2559376}\hypertarget{id2559376}{}%

\index{SFU} The Microsoft Windows Service for UNIX (SFU) version 3.5 is available for free download\label{id2559392}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/windows/sfu/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2559392} from the Microsoft Web site. You will need to download this tool and install it following Microsoft instructions.
\subsubsection{IDMAP, Active Directory and AD4UNIX}
\label{id2559403}\hypertarget{id2559403}{}%

Instructions for obtaining and installing the AD4UNIX tool set can be found from the Geekcomix\label{id2559412}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.geekcomix.com/cgi-bin/classnotes/wiki.pl?LDAP01/An_Alternative_Approach}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2559412} Web site.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter User Rights and Privileges 
% ------------------------------------------------------------- 	
\chapter{User Rights and Privileges}
\label{rights}\hypertarget{rights}{}%

\index{Windows user} \index{Windows group} \index{machine accounts} \index{ADS} The administration of Windows user, group, and machine accounts in the Samba domain-controlled network necessitates interfacing between the MS Windows networking environment and the UNIX operating system environment. The right (permission) to add machines to the Windows security domain can be assigned (set) to non-administrative users both in Windows NT4 domains and Active Directory domains.

\index{Windows NT4/2kX/XPPro} \index{machine account} \index{trusted} \index{user logons} The addition of Windows NT4/2kX/XPPro machines to the domain necessitates the creation of a machine account for each machine added. The machine account is a necessity that is used to validate that the machine can be trusted to permit user logons.

\index{user accounts} \index{special account} \index{account name} \index{/bin/false} \index{/dev/null} \index{man-in-the-middle} Machine accounts are analogous to user accounts, and thus in implementing them on a UNIX machine that is hosting Samba (i.e., on which Samba is running), it is necessary to create a special type of user account. Machine accounts differ from normal user accounts in that the account name (login ID) is terminated with a {\texttt{\docbookhyphenatedot{\$}}} sign. An additional difference is that this type of account should not ever be able to log into the UNIX environment as a system user and therefore is set to have a shell of {\bfseries{/bin/false}} and a home directory of {\bfseries{/dev/null.}} The machine account is used only to authenticate domain member machines during start-up. This security measure is designed to block man-in-the-middle attempts to violate network integrity.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{computer accounts} \index{domain member servers} \index{domain controller} \index{credentials} \index{secure authentication} Machine (computer) accounts are used in the Windows NT OS family to store security credentials for domain member servers and workstations. When the domain member starts up, it goes through a validation process that includes an exchange of credentials with a domain controller. If the domain member fails to authenticate using the credentials known for it by domain controllers, the machine will be refused all access by domain users. The computer account is essential to the way that MS Windows secures authentication.
\end{admonition}


\index{UNIX system accounts} \index{system administrator} \index{root} \index{UID} The creation of UNIX system accounts has traditionally been the sole right of the system administrator, better known as the {\texttt{\docbookhyphenatedot{root}}} account. It is possible in the UNIX environment to create multiple users who have the same UID. Any UNIX user who has a UID=0 is inherently the same as the {\texttt{\docbookhyphenatedot{root}}} account user.

\index{system interface scripts} \index{CIFS function calls} \index{root account} \index{UNIX host system} All versions of Samba call system interface scripts that permit CIFS function calls that are used to manage users, groups, and machine accounts in the UNIX environment. All versions of Samba up to and including version 3.0.10 required the use of a Windows administrator account that unambiguously maps to the UNIX {\texttt{\docbookhyphenatedot{root}}} account to permit the execution of these interface scripts. The requirement to do this has understandably met with some disdain and consternation among Samba administrators, particularly where it became necessary to permit people who should not possess {\texttt{\docbookhyphenatedot{root}}}-level access to the UNIX host system.

% ------------------------   
% Section 
\section{Rights Management Capabilities}
\label{id2553271}\hypertarget{id2553271}{}%

\index{Windows privilege model} \index{privilege model} \index{rights assigned} \index{SID} Samba 3.0.11 introduced support for the Windows privilege model. This model allows certain rights to be assigned to a user or group SID. In order to enable this feature, \smbconfoption{enable privileges} = yes must be defined in the \smbconfsection{global} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

\index{rights} \index{privileges} \index{manage privileges} Currently, the rights supported in Samba-3 are listed in \hyperlink{rp-privs}{Table {\ref{rp-privs}}}. The remainder of this chapter explains how to manage and use these privileges on Samba servers.
\index{SeMachineAccountPrivilege}\index{SePrintOperatorPrivilege}\index{SeAddUsersPrivilege}\index{SeRemoteShutdownPrivilege}\index{SeDiskOperatorPrivilege}\index{SeTakeOwnershipPrivilege}
% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{rp-privs}{}%
\captionswapskip{}{{\caption{Current Privilege Capabilities}\label{rp-privs}}}
\captionswapskip{}\begin{tabular}{|r|l|}
\hline 
\docbooktolatexalignll {{{\bfseries Privilege}}} & \docbooktolatexalignll {{{\bfseries Description}}} \tabularnewline
 \hline 
{{SeMachineAccountPrivilege}} & {{Add machines to domain}} \tabularnewline
 \hline 
{{SePrintOperatorPrivilege}} & {{Manage printers}} \tabularnewline
 \hline 
{{SeAddUsersPrivilege}} & {{Add users and groups to the domain}} \tabularnewline
 \hline 
{{SeRemoteShutdownPrivilege}} & {{Force shutdown from a remote system}} \tabularnewline
 \hline 
{{SeDiskOperatorPrivilege}} & {{Manage disk share}} \tabularnewline
 \hline 
{{SeTakeOwnershipPrivilege}} & {{Take ownership of files or other objects}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}

\subsection{Using the {``}net rpc rights{''} Utility}
\label{id2543509}\hypertarget{id2543509}{}%

\index{managing rights} \index{rights assigned} \index{NT4 User Manager for Domains} \index{command-line utility} \index{administrative actions} There are two primary means of managing the rights assigned to users and groups on a Samba server. The {\bfseries{NT4 User Manager for Domains}} may be used from any Windows NT4, 2000, or XP Professional domain member client to connect to a Samba domain controller and view/modify the rights assignments. This application, however, appears to have bugs when run on a client running Windows 2000 or later; therefore, Samba provides a command-line utility for performing the necessary administrative actions.

The {\bfseries{net rpc rights}} utility in Samba 3.0.11 has three new subcommands:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{list [name\docbooktolatexpipe{}accounts]}]\null{}
\index{net!rpc!list} \index{available rights} \index{privileges assigned} \index{privileged accounts} When called with no arguments, {\bfseries{net rpc list}} simply lists the available rights on the server. When passed a specific user or group name, the tool lists the privileges currently assigned to the specified account. When invoked using the special string {\texttt{\docbookhyphenatedot{accounts}}}, {\bfseries{net rpc rights list}} returns a list of all privileged accounts on the server and the assigned rights.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{grant \textless{}user\textgreater{} \textless{}right [right ...]\textgreater{}}]\null{}
\index{assign rights} \index{grant rights} \index{add client machines} \index{user or group} When called with no arguments, this function is used to assign a list of rights to a specified user or group. For example, to grant the members of the Domain Admins group on a Samba domain controller, the capability to add client machines to the domain, one would run: \null{}
\begin{Verbatim}[]

root#  net -S server -U domadmin rpc rights grant \
	 'DOMAIN\Domain Admins' SeMachineAccountPrivilege

\end{Verbatim}
 The following syntax has the same result: \index{net!rpc!rights grant} \null{}
\begin{Verbatim}[]

root#  net rpc rights grant 'DOMAIN\Domain Admins' \
     SeMachineAccountPrivilege -S server -U domadmin

\end{Verbatim}
 More than one privilege can be assigned by specifying a list of rights separated by spaces. The parameter 'Domain\textbackslash Domain Admins' must be quoted with single ticks or using double-quotes to prevent the backslash and the space from being interpreted by the system shell.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{revoke \textless{}user\textgreater{} \textless{}right [right ...]\textgreater{}}]\null{}
This command is similar in format to {\bfseries{net rpc rights grant}}. Its effect is to remove an assigned right (or list of rights) from a user or group.
\end{description}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{member} \index{Domain Admins} \index{revoke privileges} You must be connected as a member of the Domain Admins group to be able to grant or revoke privileges assigned to an account. This capability is inherent to the Domain Admins group and is not configurable. There are no default rights and privileges, except the ability for a member of the Domain Admins group to assign them. This means that all administrative rights and privileges (other than the ability to assign them) must be explicitly assigned, even for the Domain Admins group.
\end{admonition}


\index{performed as root} \index{necessary rights} \index{add machine script} \index{} By default, no privileges are initially assigned to any account because certain actions will be performed as root once smbd determines that a user has the necessary rights. For example, when joining a client to a Windows domain, {\ttfamily\itshape{\docbookhyphenatedot{add machine script}}} must be executed with superuser rights in most cases. For this reason, you should be very careful about handing out privileges to accounts.

\index{Access} \index{root user} \index{bypasses privilege} Access as the root user (UID=0) bypasses all privilege checks.
\subsection{Description of Privileges}
\label{id2543074}\hypertarget{id2543074}{}%

\index{privileges} \index{additional privileges} \index{house-keeping} The privileges that have been implemented in Samba-3.0.11 are shown below. It is possible, and likely, that additional privileges may be implemented in later releases of Samba. It is also likely that any privileges currently implemented but not used may be removed from future releases as a housekeeping matter, so it is important that the successful as well as unsuccessful use of these facilities should be reported on the Samba mailing lists.

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SeAddUsersPrivilege}]\null{}
\index{SeAddUsersPrivilege} \index{smbd} \index{net rpc user add} This right determines whether or not smbd will allow the user to create new user or group accounts via such tools as {\bfseries{net rpc user add}} or {\bfseries{NT4 User Manager for Domains.}}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SeDiskOperatorPrivilege}]\null{}
\index{SeDiskOperatorPrivilege} \index{add/delete/change share} \index{ACL} Accounts that possess this right will be able to execute scripts defined by the {\bfseries{add/delete/change}} share command in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as root. Such users will also be able to modify the ACL associated with file shares on the Samba server.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SeMachineAccountPrivilege}]\null{}
\index{SeMachineAccountPrivilege} \index{right to join domain} \index{join client} This right controls whether or not the user can join client machines to a Samba-controlled domain.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SePrintOperatorPrivilege}]\null{}
\index{SePrintOperatorPrivilege} \index{privilege} \index{global right} \index{administrative rights} \index{printers admin} This privilege operates identically to the \smbconfoption{printer admin} option in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file (see section 5 man page for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}) except that it is a global right (not on a per-printer basis). Eventually the smb.conf option will be deprecated and administrative rights to printers will be controlled exclusively by this right and the security descriptor associated with the printer object in the {\texttt{\docbookhyphenatefilename{ntprinters.\dbz{}tdb}}} file.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SeRemoteShutdownPrivilege}]\null{}
\index{SeRemoteShutdownPrivilege} \index{rebooting server} \index{aborting shutdown} Samba provides two hooks for shutting down or rebooting the server and for aborting a previously issued shutdown command. Since this is an operation normally limited by the operating system to the root user, an account must possess this right to be able to execute either of these hooks.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SeTakeOwnershipPrivilege}]\null{}
\index{SeTakeOwnershipPrivilege} \index{take ownership} This right permits users to take ownership of files and directories.
\end{description}
\subsection{Privileges Suppored by Windows 2000 Domain Controllers}
\label{id2551900}\hypertarget{id2551900}{}%

For reference purposes, a Windows NT4 Primary Domain Controller reports support for the following privileges: \index{SeCreateTokenPrivilege} \index{SeAssignPrimaryTokenPrivilege} \index{SeLockMemoryPrivilege} \index{SeIncreaseQuotaPrivilege} \index{SeMachineAccountPrivilege} \index{SeTcbPrivilege} \index{SeSecurityPrivilege} \index{SeTakeOwnershipPrivilege} \index{SeLoadDriverPrivilege} \index{SeSystemProfilePrivilege} \index{SeSystemtimePrivilege} \index{SeProfileSingleProcessPrivilege} \index{SeIncreaseBasePriorityPrivilege} \index{SeCreatePagefilePrivilege} \index{SeCreatePermanentPrivilege} \index{SeBackupPrivilege} \index{SeRestorePrivilege} \index{SeShutdownPrivilege} \index{SeDebugPrivilege} \index{SeAuditPrivilege} \index{SeSystemEnvironmentPrivilege} \index{SeChangeNotifyPrivilege} \index{SeRemoteShutdownPrivilege} 
\begin{Verbatim}[]

         SeCreateTokenPrivilege  Create a token object
  SeAssignPrimaryTokenPrivilege  Replace a process level token
          SeLockMemoryPrivilege  Lock pages in memory
       SeIncreaseQuotaPrivilege  Increase quotas
      SeMachineAccountPrivilege  Add workstations to domain
                 SeTcbPrivilege  Act as part of the operating system
            SeSecurityPrivilege  Manage auditing and security log
       SeTakeOwnershipPrivilege  Take ownership of files or other objects
          SeLoadDriverPrivilege  Load and unload device drivers
       SeSystemProfilePrivilege  Profile system performance
          SeSystemtimePrivilege  Change the system time
SeProfileSingleProcessPrivilege  Profile single process
SeIncreaseBasePriorityPrivilege  Increase scheduling priority
      SeCreatePagefilePrivilege  Create a pagefile
     SeCreatePermanentPrivilege  Create permanent shared objects
              SeBackupPrivilege  Back up files and directories
             SeRestorePrivilege  Restore files and directories
            SeShutdownPrivilege  Shut down the system
               SeDebugPrivilege  Debug programs
               SeAuditPrivilege  Generate security audits
   SeSystemEnvironmentPrivilege  Modify firmware environment values
        SeChangeNotifyPrivilege  Bypass traverse checking
      SeRemoteShutdownPrivilege  Force shutdown from a remote system

\end{Verbatim}
 And Windows 200x/XP Domain Controllers and workstations reports to support the following privileges: \index{SeCreateTokenPrivilege} \index{SeAssignPrimaryTokenPrivilege} \index{SeLockMemoryPrivilege} \index{SeIncreaseQuotaPrivilege} \index{SeMachineAccountPrivilege} \index{SeTcbPrivilege} \index{SeSecurityPrivilege} \index{SeTakeOwnershipPrivilege} \index{SeLoadDriverPrivilege} \index{SeSystemProfilePrivilege} \index{SeSystemtimePrivilege} \index{SeProfileSingleProcessPrivilege} \index{SeIncreaseBasePriorityPrivilege} \index{SeCreatePagefilePrivilege} \index{SeCreatePermanentPrivilege} \index{SeBackupPrivilege} \index{SeRestorePrivilege} \index{SeShutdownPrivilege} \index{SeDebugPrivilege} \index{SeAuditPrivilege} \index{SeSystemEnvironmentPrivilege} \index{SeChangeNotifyPrivilege} \index{SeRemoteShutdownPrivilege} \index{SeUndockPrivilege} \index{SeSyncAgentPrivilege} \index{SeEnableDelegationPrivilege} \index{SeManageVolumePrivilege} \index{SeImpersonatePrivilege} \index{SeCreateGlobalPrivilege} 
\begin{Verbatim}[]

         SeCreateTokenPrivilege  Create a token object
  SeAssignPrimaryTokenPrivilege  Replace a process level token
          SeLockMemoryPrivilege  Lock pages in memory
       SeIncreaseQuotaPrivilege  Increase quotas
      SeMachineAccountPrivilege  Add workstations to domain
                 SeTcbPrivilege  Act as part of the operating system
            SeSecurityPrivilege  Manage auditing and security log
       SeTakeOwnershipPrivilege  Take ownership of files or other objects
          SeLoadDriverPrivilege  Load and unload device drivers
       SeSystemProfilePrivilege  Profile system performance
          SeSystemtimePrivilege  Change the system time
SeProfileSingleProcessPrivilege  Profile single process
SeIncreaseBasePriorityPrivilege  Increase scheduling priority
      SeCreatePagefilePrivilege  Create a pagefile
     SeCreatePermanentPrivilege  Create permanent shared objects
              SeBackupPrivilege  Back up files and directories
             SeRestorePrivilege  Restore files and directories
            SeShutdownPrivilege  Shut down the system
               SeDebugPrivilege  Debug programs
               SeAuditPrivilege  Generate security audits
   SeSystemEnvironmentPrivilege  Modify firmware environment values
        SeChangeNotifyPrivilege  Bypass traverse checking
      SeRemoteShutdownPrivilege  Force shutdown from a remote system
              SeUndockPrivilege  Remove computer from docking station
           SeSyncAgentPrivilege  Synchronize directory service data
    SeEnableDelegationPrivilege  Enable computer and user accounts to
                                 be trusted for delegation
        SeManageVolumePrivilege  Perform volume maintenance tasks
         SeImpersonatePrivilege  Impersonate a client after authentication
        SeCreateGlobalPrivilege  Create global objects

\end{Verbatim}
 \index{equivalence} The Samba Team is implementing only those privileges that are logical and useful in the UNIX/Linux environment. Many of the Windows 200X/XP privileges have no direct equivalence in UNIX.

% ------------------------   
% Section 
\section{The Administrator Domain SID}
\label{id2552358}\hypertarget{id2552358}{}%

\index{domain Administrator} \index{User Rights and Privileges} \index{passdb backend} \index{SID} \index{net getlocalsid} Please note that every Windows NT4 and later server requires a domain Administrator account. Samba versions commencing with 3.0.11 permit Administrative duties to be performed via assigned rights and privileges (see \hyperlink{rights}{Chapter {\ref{rights}}, {``}User Rights and Privileges{''}}). An account in the server's passdb backend can be set to the well-known RID of the default administrator account. To obtain the domain SID on a Samba domain controller, run the following command: 
\begin{Verbatim}[]

root#  net getlocalsid
SID for domain FOO is: S-1-5-21-4294955119-3368514841-2087710299

\end{Verbatim}
 \index{RID} You may assign the domain administrator RID to an account using the {\bfseries{pdbedit}} command as shown here: \index{pdbedit} 
\begin{Verbatim}[]

root#  pdbedit -U S-1-5-21-4294955119-3368514841-2087710299-500 -u root -r

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{RID 500} \index{well known RID} \index{rights and privileges} \index{root account} The RID 500 is the well known standard value of the default Administrator account. It is the RID that confers the rights and privileges that the Administrator account has on a Windows machine or domain. Under UNIX/Linux the equivalent is UID=0 (the root account).
\end{admonition}


\index{without Administrator account} \index{equivalent rights and privileges} \index{Windows group account} \index{3.0.11} Releases of Samba version 3.0.11 and later make it possible to operate without an Administrator account provided equivalent rights and privileges have been established for a Windows user or a Windows group account.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2560262}\hypertarget{id2560262}{}%
\subsection{What Rights and Privileges Will Permit Windows Client Administration?}
\label{id2560268}\hypertarget{id2560268}{}%

\index{domain global} \index{local group} \index{administrative rights} \index{Windows client} When a Windows NT4 (or later) client joins a domain, the domain global {\texttt{\docbookhyphenatedot{Domain Admins}}} group is added to the membership of the local {\texttt{\docbookhyphenatedot{Administrators}}} group on the client. Any user who is a member of the domain global {\texttt{\docbookhyphenatedot{Domain Admins}}} group will have administrative rights on the Windows client.

\index{desirable solution} \index{administrative rights and privileges} \index{Power Users} \index{domain global user} \index{domain global group} This is often not the most desirable solution because it means that the user will have administrative rights and privileges on domain servers also. The {\texttt{\docbookhyphenatedot{Power Users}}} group on Windows client workstations permits local administration of the workstation alone. Any domain global user or domain global group can be added to the membership of the local workstation group {\texttt{\docbookhyphenatedot{Power Users}}}.

\index{Nested Group Support} \index{add domain users and groups to a local group} \index{net} \index{Windows workstation.} See \hyperlink{nestedgrpmgmgt}{Section {\ref{nestedgrpmgmgt}}} for an example of how to add domain users and groups to a local group that is on a Windows workstation. The use of the {\bfseries{net}} command permits this to be done from the Samba server.

\index{cmd} \index{cmd shell} \index{net!localgroup} Another way this can be done is to log onto the Windows workstation as the user {\texttt{\docbookhyphenatedot{Administrator}}}, then open a {\bfseries{cmd}} shell, then execute: 
\begin{Verbatim}[]

C:\>  net localgroup administrators /add domain_name\entity

\end{Verbatim}
 where {\texttt{\docbookhyphenatedot{entity}}} is either a domain user or a domain group account name.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter File, Directory, and Share Access Controls 
% ------------------------------------------------------------- 	
\chapter{File, Directory, and Share Access Controls}
\label{AccessControls}\hypertarget{AccessControls}{}%

\index{ACLs} \index{share} \index{network access controls} \index{unauthorized access} Advanced MS Windows users are frequently perplexed when file, directory, and share manipulation of resources shared via Samba do not behave in the manner they might expect. MS Windows network administrators are often confused regarding network access controls and how to provide users with the access they need while protecting resources from unauthorized access.

\index{file access permissions} \index{directory access permissions} Many UNIX administrators are unfamiliar with the MS Windows environment and in particular have difficulty in visualizing what the MS Windows user wishes to achieve in attempts to set file and directory access permissions.

\index{bridge} \index{directory controls} \index{directory permissions} \index{} The problem lies in the differences in how file and directory permissions and controls work between the two environments. This difference is one that Samba cannot completely hide, even though it does try to bridge the chasm to a degree.

\index{Extended Attributes} \index{ACLs!POSIX} \index{Access Control List} \index{commercial Linux products} POSIX Access Control List technology has been available (along with extended attributes) for UNIX for many years, yet there is little evidence today of any significant use. This explains to some extent the slow adoption of ACLs into commercial Linux products. MS Windows administrators are astounded at this, given that ACLs were a foundational capability of the now decade-old MS Windows NT operating system.

\index{network administrator} The purpose of this chapter is to present each of the points of control that are possible with Samba-3 in the hope that this will help the network administrator to find the optimum method for delivering the best environment for MS Windows desktop users.

\index{interoperability} \index{data interchange} This is an opportune point to mention that Samba was created to provide a means of interoperability and interchange of data between differing operating environments. Samba has no intent to change UNIX/Linux into a platform like MS Windows. Instead the purpose was and is to provide a sufficient level of exchange of data between the two environments. What is available today extends well beyond early plans and expectations, yet the gap continues to shrink.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2526487}\hypertarget{id2526487}{}%

Samba offers much flexibility in file system access management. These are the key access control facilities present in Samba today:

{\sc{Samba Access Control Facilities}}

\begin{itemize}
%--- Item
\item 
\index{permissions!UNIX file and directory} {\em{UNIX File and Directory Permissions}}

\index{UNIX file system access controls} \index{access controls} \index{permissions and controls} Samba honors and implements UNIX file system access controls. Users who access a Samba server will do so as a particular MS Windows user. This information is passed to the Samba server as part of the logon or connection setup process. Samba uses this user identity to validate whether or not the user should be given access to file system resources (files and directories). This chapter provides an overview for those to whom the UNIX permissions and controls are a little strange or unknown.


%--- Item
\item 
{\em{Samba Share Definitions}}

\index{share settings} In configuring share settings and controls in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, the network administrator can exercise overrides to native file system permissions and behaviors. This can be handy and convenient to effect behavior that is more like what MS Windows NT users expect, but it is seldom the {\em{best}} way to achieve this. The basic options and techniques are described herein.


%--- Item
\item 
{\em{Samba Share ACLs}} \index{ACLs!share}

\index{ACLs on shares} Just as it is possible in MS Windows NT to set ACLs on shares themselves, so it is possible to do in Samba. Few people make use of this facility, yet it remains one of the easiest ways to affect access controls (restrictions) and can often do so with minimum invasiveness compared with other methods.


%--- Item
\item 
\index{ACLs!POSIX} \index{ACLs!Windows} {\em{MS Windows ACLs through UNIX POSIX ACLs}}

\index{native ACLs} The use of POSIX ACLs on UNIX/Linux is possible only if the underlying operating system supports them. If not, then this option will not be available to you. Current UNIX technology platforms have native support for POSIX ACLs. There are patches for the Linux kernel that also provide this support. Sadly, few Linux platforms ship today with native ACLs and extended attributes enabled. This chapter has pertinent information for users of platforms that support them.

\end{itemize}

% ------------------------   
% Section 
\section{File System Access Controls}
\label{id2561320}\hypertarget{id2561320}{}%

Perhaps the most important recognition to be made is the simple fact that MS Windows NT4/200x/XP implement a totally divergent file system technology from what is provided in the UNIX operating system environment. First we consider what the most significant differences are, then we look at how Samba helps to bridge the differences.
\subsection{MS Windows NTFS Comparison with UNIX File Systems}
\label{id2561335}\hypertarget{id2561335}{}%

\index{NTFS} \index{File System} \index{File System!UNIX} \index{File System!Windows} Samba operates on top of the UNIX file system. This means it is subject to UNIX file system conventions and permissions. It also means that if the MS Windows networking environment requires file system behavior, that differs from UNIX file system behavior then somehow Samba is responsible for emulating that in a transparent and consistent manner.

It is good news that Samba does this to a large extent, and on top of that, provides a high degree of optional configuration to override the default behavior. We look at some of these overrides, but for the greater part we stay within the bounds of default behavior. Those wishing to explore the depths of control ability should review the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.

The following compares file system features for UNIX with those of MS Windows NT/200x: \index{File System!feature comparison}

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Name Space}]\null{}
MS Windows NT4/200x/XP file names may be up to 254 characters long, and UNIX file names may be 1023 characters long. In MS Windows, file extensions indicate particular file types; in UNIX this is not so rigorously observed because all names are considered arbitrary.

What MS Windows calls a folder, UNIX calls a directory.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Case Sensitivity}]\null{}
\index{8.3 file names} \index{File System!case sensitivity} MS Windows file names are generally uppercase if made up of 8.3 (8-character file name and 3 character extension. File names that are longer than 8.3 are case preserving and case insensitive.

UNIX file and directory names are case sensitive and case preserving. Samba implements the MS Windows file name behavior, but it does so as a user application. The UNIX file system provides no mechanism to perform case-insensitive file name lookups. MS Windows does this by default. This means that Samba has to carry the processing overhead to provide features that are not native to the UNIX operating system environment.

Consider the following. All are unique UNIX names but one single MS Windows file name: \null{}
\begin{Verbatim}[]

				MYFILE.TXT
				MyFile.txt
				myfile.txt
		
\end{Verbatim}


So clearly, in an MS Windows file namespace these three files cannot co-exist, but in UNIX they can.

So what should Samba do if all three are present? That which is lexically first will be accessible to MS Windows users; the others are invisible and unaccessible ---  any other solution would be suicidal. The Windows client will ask for a case-insensitive file lookup, and that is the reason for which Samba must offer a consistent selection in the event that the UNIX directory contains multiple files that would match a case insensitive file listing.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Directory Separators}]\null{}
\index{Directory Separators} MS Windows and DOS use the backslash {\texttt{\docbookhyphenatedot{\textbackslash}}} as a directory delimiter, and UNIX uses the forward-slash {\texttt{\docbookhyphenatedot{/}}} as its directory delimiter. This is handled transparently by Samba.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Drive Identification}]\null{}
\index{Drive Identification} MS Windows products support a notion of drive letters, like {\bfseries{C:}}, to represent disk partitions. UNIX has no concept of separate identifiers for file partitions; each such file system is mounted to become part of the overall directory tree. The UNIX directory tree begins at {\texttt{\docbookhyphenatedot{/}}} just as the root of a DOS drive is specified as {\texttt{\docbookhyphenatedot{C:\textbackslash}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{File Naming Conventions}]\null{}
\index{File Naming Conventions} MS Windows generally never experiences file names that begin with a dot ({\texttt{\docbookhyphenatedot{.}}}), while in UNIX these are commonly found in a user's home directory. Files that begin with a dot ({\texttt{\docbookhyphenatedot{.}}}) are typically startup files for various UNIX applications, or they may be files that contain startup configuration data.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Links and Short-Cuts}]\null{}
\index{Links!hard} \index{Links!soft} \index{Shortcuts} MS Windows make use of {\em{links and shortcuts}} that are actually special types of files that will redirect an attempt to execute the file to the real location of the file. UNIX knows of file and directory links, but they are entirely different from what MS Windows users are used to.

Symbolic links are files in UNIX that contain the actual location of the data (file or directory). An operation (like read or write) will operate directly on the file referenced. Symbolic links are also referred to as {``}soft links.{''} A hard link is something that MS Windows is not familiar with. It allows one physical file to be known simultaneously by more than one file name.
\end{description}

There are many other subtle differences that may cause the MS Windows administrator some temporary discomfort in the process of becoming familiar with UNIX/Linux. These are best left for a text that is dedicated to the purpose of UNIX/Linux training and education.
\subsection{Managing Directories}
\label{id2462567}\hypertarget{id2462567}{}%

\index{create} \index{delete} \index{rename} There are three basic operations for managing directories: {\bfseries{create}}, {\bfseries{delete}}, {\bfseries{rename}}. \hyperlink{TOSH-Accesstbl}{Table {\ref{TOSH-Accesstbl}}} compares the commands in Windows and UNIX that implement these operations.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{TOSH-Accesstbl}{}%
\captionswapskip{}{{\caption{Managing Directories with UNIX and Windows}\label{TOSH-Accesstbl}}}
\captionswapskip{}\begin{tabular}{|c|c|c|}
\hline 
{{{\bfseries Action}}} & {{{\bfseries MS Windows Command}}} & {{{\bfseries UNIX Command}}} \tabularnewline
 \hline 
{{create}} & {{md folder}} & {{mkdir folder}} \tabularnewline
 \hline 
{{delete}} & {{rd folder}} & {{rmdir folder}} \tabularnewline
 \hline 
{{rename}} & {{rename oldname newname}} & {{mv oldname newname}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}

\subsection{File and Directory Access Control}
\label{id2462693}\hypertarget{id2462693}{}%

\index{ACLs!File System} \index{POSIX ACLs} \index{EAs} The network administrator is strongly advised to read basic UNIX training manuals and reference materials regarding file and directory permissions maintenance. Much can be achieved with the basic UNIX permissions without having to resort to more complex facilities like POSIX ACLs or extended attributes (EAs).

UNIX/Linux file and directory access permissions involves setting three primary sets of data and one control set. A UNIX file listing looks as follows: 
\begin{Verbatim}[]

$ ls -la
total 632
drwxr-xr-x   13 maryo   gnomes      816 2003-05-12 22:56 .
drwxrwxr-x   37 maryo   gnomes     3800 2003-05-12 22:29 ..
dr-xr-xr-x    2 maryo   gnomes       48 2003-05-12 22:29 muchado02
drwxrwxrwx    2 maryo   gnomes       48 2003-05-12 22:29 muchado03
drw-rw-rw-    2 maryo   gnomes       48 2003-05-12 22:29 muchado04
d-w--w--w-    2 maryo   gnomes       48 2003-05-12 22:29 muchado05
dr--r--r--    2 maryo   gnomes       48 2003-05-12 22:29 muchado06
drwsrwsrwx    2 maryo   gnomes       48 2003-05-12 22:29 muchado08
----------    1 maryo   gnomes     1242 2003-05-12 22:31 mydata00.lst
--w--w--w-    1 maryo   gnomes     7754 2003-05-12 22:33 mydata02.lst
-r--r--r--    1 maryo   gnomes    21017 2003-05-12 22:32 mydata04.lst
-rw-rw-rw-    1 maryo   gnomes    41105 2003-05-12 22:32 mydata06.lst
$ 

\end{Verbatim}


The columns represent (from left to right) permissions, number of hard links to file, owner, group, size (bytes), access date, time of last modification, and file name.

An overview of the permissions field is shown in \hyperlink{access1}{Figure {\ref{access1}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{access1}{}%
\includegraphics[scale=0.4]{Samba3-HOWTO/images/access1}
{{\caption[{Overview of UNIX permissions field.}]{{{Overview of UNIX permissions field.}}}\label{access1}}}
\end{center}
\end{figure}


Any bit flag may be unset. An unset bit flag is the equivalent of "cannot" and is represented as a {``}-{''} character (see \hyperlink{access2}{Example {\ref{access2}}}) \index{read} \index{write} \index{execute} \index{user} \index{group} \index{other}

\begin{example}%
\hypertarget{access2}{}%
\captionswapskip{}{{\caption{Example File}\label{access2}}}
\captionswapskip{}
\begin{Verbatim}[]

-rwxr-x---   Means: 
 ^^^                The owner (user) can read, write, execute
    ^^^             the group can read and execute
       ^^^          everyone else cannot do anything with it.

\end{Verbatim}
\end{example}


\index{character device} \index{block device} \index{pipe device} \index{UNIX Domain Socket} Additional possibilities in the [type] field are c = character device, b = block device, p = pipe device, s = UNIX Domain Socket.

\index{read} \index{write} \index{execute} \index{SGID} \index{SUID} The letters {\texttt{\docbookhyphenatedot{rwxXst}}} set permissions for the user, group, and others as read (r), write (w), execute (or access for directories) (x), execute only if the file is a directory or already has execute permission for some user (X), set user (SUID) or group ID (SGID) on execution (s), sticky (t).

\index{sticky bit} \index{unlinked} \index{/tmp} \index{world-writable} When the sticky bit is set on a directory, files in that directory may be unlinked (deleted) or renamed only by root or their owner. Without the sticky bit, anyone able to write to the directory can delete or rename files. The sticky bit is commonly found on directories, such as {\texttt{\docbookhyphenatefilename{/\dbz{}tmp}}}, that are world-writable.

\index{write} \index{read} \index{setting up directories} \index{set user id|textit{see} {SUID} } \index{set group id|textit{see} {SGID} } When the set user or group ID bit (s) is set on a directory, then all files created within it will be owned by the user and/or group whose `set user or group' bit is set. This can be helpful in setting up directories for which it is desired that all users who are in a group should be able to write to and read from a file, particularly when it is undesirable for that file to be exclusively owned by a user whose primary group is not the group that all such users belong to.

When a directory is set {\texttt{\docbookhyphenatedot{d-wx--x---}}}, the owner can read and create (write) files in it, but because the (r) read flags are not set, files cannot be listed (seen) in the directory by anyone. The group can read files in the directory but cannot create new files. If files in the directory are set to be readable and writable for the group, then group members will be able to write to (or delete) them.
\subsubsection{Protecting Directories and Files from Deletion}
\label{id2564284}\hypertarget{id2564284}{}%

\index{protect files} \index{protect directories} \index{access controls} \index{capability to delete} People have asked on the Samba mailing list how is it possible to protect files or directories from deletion by users. For example, Windows NT/2K/XP provides the capacity to set access controls on a directory into which people can write files but not delete them. It is possible to set an ACL on a Windows file that permits the file to be written to but not deleted. Such concepts are foreign to the UNIX operating system file space. Within the UNIX file system anyone who has the ability to create a file can write to it. Anyone who has write permission on the directory that contains a file and has write permission for it has the capability to delete it.

\index{directory permissions} \index{delete a file} \index{write access} For the record, in the UNIX environment the ability to delete a file is controlled by the permissions on the directory that the file is in. In other words, a user can delete a file in a directory to which that user has write access, even if that user does not own the file.

\index{file system capabilities} \index{inheritance} \index{POSIX ACLs} \index{extended attributes} Of necessity, Samba is subject to the file system semantics of the host operating system. Samba is therefore limited in the file system capabilities that can be made available through Windows ACLs, and therefore performs a "best fit" translation to POSIX ACLs. Some UNIX file systems do, however support, a feature known as extended attributes. Only the Windows concept of {\em{inheritance}} is implemented by Samba through the appropriate extended attribute.

\index{extended attributes} \index{immutible} \index{chattr} \index{CAP\_LINUX\_IMMUTABLE} The specific semantics of the extended attributes are not consistent across UNIX and UNIX-like systems such as Linux. For example, it is possible on some implementations of the extended attributes to set a flag that prevents the directory or file from being deleted. The extended attribute that may achieve this is called the {\texttt{\docbookhyphenatedot{immutible}}} bit. Unfortunately, the implementation of the immutible flag is NOT consistent with published documentation. For example, the man page for the {\bfseries{chattr}} on SUSE Linux 9.2 says: 
\begin{Verbatim}[]

A file with the i attribute cannot be modified: it cannot be deleted
or renamed, no link can be created to this file and no data can be
written to the file. Only the superuser or a process possessing the
CAP_LINUX_IMMUTABLE capability can set or clear this attribute.

\end{Verbatim}
 A simple test can be done to check if the immutible flag is supported on files in the file system of the Samba host server.
Test for File Immutibility Support\begin{enumerate}

\item{Create a file called {\texttt{\docbookhyphenatefilename{filename}}}.}

\item{Login as the {\texttt{\docbookhyphenatedot{root}}} user, then set the immutibile flag on a test file as follows: 
\begin{Verbatim}[]

root#  chattr +i `filename'

\end{Verbatim}
}

\item{Login as the user who owns the file (not root) and attempt to remove the file as follows: 
\begin{Verbatim}[]

mystic:/home/hannibal > rm filename

\end{Verbatim}
 It will not be possible to delete the file if the immutible flag is correctly honored.}
\end{enumerate}

On operating systems and file system types that support the immutible bit, it is possible to create directories that cannot be deleted. Check the man page on your particular host system to determine whether or not immutable directories are writable. If they are not, then the entire directory and its contents will effectively be protected from writing (file creation also) and deletion.

% ------------------------   
% Section 
\section{Share Definition Access Controls}
\label{id2564520}\hypertarget{id2564520}{}%

\index{permissions!share} The following parameters in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file sections define a share control or affect access controls. Before using any of the following options, please refer to the man page for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}.
\subsection{User- and Group-Based Controls}
\label{id2564550}\hypertarget{id2564550}{}%

User- and group-based controls can prove quite useful. In some situations it is distinctly desirable to force all file system operations as if a single user were doing so. The use of the \smbconfoption{force user} and \smbconfoption{force group} behavior will achieve this. In other situations it may be necessary to use a paranoia level of control to ensure that only particular authorized persons will be able to access a share or its contents. Here the use of the \smbconfoption{valid users} or the \smbconfoption{invalid users} parameter may be useful.

As always, it is highly advisable to use the easiest to maintain and the least ambiguous method for controlling access. Remember, when you leave the scene, someone else will need to provide assistance, and if he or she finds too great a mess or does not understand what you have done, there is risk of Samba being removed and an alternative solution being adopted.

\hyperlink{ugbc}{Table {\ref{ugbc}}} enumerates these controls.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{ugbc}{}%
\captionswapskip{}{{\caption{User- and Group-Based Controls}\label{ugbc}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
\docbooktolatexaligncl {{{\bfseries Control Parameter}}} & \docbooktolatexaligncl {{{\bfseries Description, Action, Notes}}} \tabularnewline
 \hline 
{{\smbconfoption{admin users}}} & {{List of users who will be granted administrative privileges on the share. They will do all file operations as the superuser (root). Users in this list will be able to do anything they like on the share, irrespective of file permissions.}} \tabularnewline
 \hline 
{{\smbconfoption{force group}}} & {{Specifies a UNIX group name that will be assigned as the default primary group for all users connecting to this service.}} \tabularnewline
 \hline 
{{\smbconfoption{force user}}} & {{Specifies a UNIX username that will be assigned as the default user for all users connecting to this service. This is useful for sharing files. Incorrect use can cause security problems.}} \tabularnewline
 \hline 
{{\smbconfoption{guest ok}}} & {{If this parameter is set for a service, then no password is required to connect to the service. Privileges will be those of the guest account.}} \tabularnewline
 \hline 
{{\smbconfoption{invalid users}}} & {{List of users that should not be allowed to login to this service.}} \tabularnewline
 \hline 
{{\smbconfoption{only user}}} & {{Controls whether connections with usernames not in the user list will be allowed.}} \tabularnewline
 \hline 
{{\smbconfoption{read list}}} & {{List of users that are given read-only access to a service. Users in this list will not be given write access, no matter what the read-only option is set to.}} \tabularnewline
 \hline 
{{\smbconfoption{username}}} & {{Refer to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for more information; this is a complex and potentially misused parameter.}} \tabularnewline
 \hline 
{{\smbconfoption{valid users}}} & {{List of users that should be allowed to login to this service.}} \tabularnewline
 \hline 
{{\smbconfoption{write list}}} & {{List of users that are given read-write access to a service.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsection{File and Directory Permissions-Based Controls}
\label{id2564803}\hypertarget{id2564803}{}%

Directory permission-based controls, if misused, can result in considerable difficulty in diagnosing the causes of misconfiguration. Use them sparingly and carefully. By gradually introducing each, one at a time, undesirable side effects may be detected. In the event of a problem, always comment all of them out and then gradually reintroduce them in a controlled way.

Refer to \hyperlink{fdpbc}{Table {\ref{fdpbc}}} for information regarding the parameters that may be used to set file and directory permission-based access controls.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{fdpbc}{}%
\captionswapskip{}{{\caption{File and Directory Permission-Based Controls}\label{fdpbc}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
\docbooktolatexaligncl {{{\bfseries Control Parameter}}} & \docbooktolatexaligncl {{{\bfseries Description, Action, Notes}}} \tabularnewline
 \hline 
{{\smbconfoption{create mask}}} & {{Refer to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.}} \tabularnewline
 \hline 
{{\smbconfoption{directory mask}}} & {{The octal modes used when converting DOS modes to UNIX modes when creating UNIX directories. See also directory security mask.}} \tabularnewline
 \hline 
{{\smbconfoption{dos filemode}}} & {{Enabling this parameter allows a user who has write access to the file to modify the permissions on it.}} \tabularnewline
 \hline 
{{\smbconfoption{force create mode}}} & {{This parameter specifies a set of UNIX-mode bit permissions that will always be set on a file created by Samba.}} \tabularnewline
 \hline 
{{\smbconfoption{force directory mode}}} & {{This parameter specifies a set of UNIX-mode bit permissions that will always be set on a directory created by Samba.}} \tabularnewline
 \hline 
{{\smbconfoption{force directory security mode}}} & {{Controls UNIX permission bits modified when a Windows NT client is manipulating UNIX permissions on a directory.}} \tabularnewline
 \hline 
{{\smbconfoption{force security mode}}} & {{Controls UNIX permission bits modified when a Windows NT client manipulates UNIX permissions.}} \tabularnewline
 \hline 
{{\smbconfoption{hide unreadable}}} & {{Prevents clients from seeing the existence of files that cannot be read.}} \tabularnewline
 \hline 
{{\smbconfoption{hide unwriteable files}}} & {{Prevents clients from seeing the existence of files that cannot be written to. Unwritable directories are shown as usual.}} \tabularnewline
 \hline 
{{\smbconfoption{nt acl support}}} & {{This parameter controls whether smbd will attempt to map UNIX permissions into Windows NT ACLs.}} \tabularnewline
 \hline 
{{\smbconfoption{security mask}}} & {{Controls UNIX permission bits modified when a Windows NT client is manipulating the UNIX permissions on a file.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsection{Miscellaneous Controls}
\label{id2565042}\hypertarget{id2565042}{}%

The parameters documented in \hyperlink{mcoc}{Table {\ref{mcoc}}} are often used by administrators in ways that create inadvertent barriers to file access. Such are the consequences of not understanding the full implications of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file settings.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{mcoc}{}%
\captionswapskip{}{{\caption{Other Controls}\label{mcoc}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|>{\hsize=1\hsize}X|>{\hsize=1\hsize}X|}
\hline 
\docbooktolatexaligncl {{{\bfseries Control Parameter}}} & \docbooktolatexaligncl {{{\bfseries Description, Action, Notes}}} \tabularnewline
 \hline 
{{\smbconfoption{case sensitive}, \smbconfoption{default case}, \smbconfoption{short preserve case}}} & {{This means that all file name lookup will be done in a case-sensitive manner. Files will be created with the precise file name Samba received from the MS Windows client.}} \tabularnewline
 \hline 
{{\smbconfoption{csc policy}}} & {{Client-side caching policy parallels MS Windows client-side file caching capabilities.}} \tabularnewline
 \hline 
{{\smbconfoption{dont descend}}} & {{Allows specifying a comma-delimited list of directories that the server should always show as empty.}} \tabularnewline
 \hline 
{{\smbconfoption{dos filetime resolution}}} & {{This option is mainly used as a compatibility option for Visual C++ when used against Samba shares.}} \tabularnewline
 \hline 
{{\smbconfoption{dos filetimes}}} & {{DOS and Windows allow users to change file timestamps if they can write to the file. POSIX semantics prevent this. This option allows DOS and Windows behavior.}} \tabularnewline
 \hline 
{{\smbconfoption{fake oplocks}}} & {{Oplocks are the way that SMB clients get permission from a server to locally cache file operations. If a server grants an oplock, the client is free to assume that it is the only one accessing the file, and it will aggressively cache file data.}} \tabularnewline
 \hline 
{{\smbconfoption{hide dot files}, \smbconfoption{hide files}, \smbconfoption{veto files}}} & {{Note: MS Windows Explorer allows override of files marked as hidden so they will still be visible.}} \tabularnewline
 \hline 
{{\smbconfoption{read only}}} & {{If this parameter is yes, then users of a service may not create or modify files in the service's directory.}} \tabularnewline
 \hline 
{{\smbconfoption{veto files}}} & {{List of files and directories that are neither visible nor accessible.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


% ------------------------   
% Section 
\section{Access Controls on Shares}
\label{id2565270}\hypertarget{id2565270}{}%

\index{per-share access control} \index{Everyone - Full Control} \index{specific restrictions} \index{share access} \index{permissions!share ACLs} This section deals with how to configure Samba per-share access control restrictions. By default, Samba sets no restrictions on the share itself. Restrictions on the share itself can be set on MS Windows NT4/200x/XP shares. This can be an effective way to limit who can connect to a share. In the absence of specific restrictions, the default setting is to allow the global user {\texttt{\docbookhyphenatedot{Everyone - Full Control}}} (full control, change and read).

\index{access control} \index{MMC} \index{Computer Management} At this time Samba does not provide a tool for configuring access control settings on the share itself the only way to create those settings is to use either the NT4 Server Manager or the Windows 200x Microsoft Management Console (MMC) for Computer Management. There are currently no plans to provide this capability in the Samba command-line tool set.

\index{share\_info.tdb} \index{/usr/local/samba/var} \index{tdbdump} \index{tdb files} Samba stores the per-share access control settings in a file called {\texttt{\docbookhyphenatefilename{share\_\dbz{}info.\dbz{}tdb}}}. The location of this file on your system will depend on how Samba was compiled. The default location for Samba's tdb files is under {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}var}}}. If the {\texttt{\docbookhyphenatefilename{tdbdump}}} utility has been compiled and installed on your system, then you can examine the contents of this file by executing {\bfseries{tdbdump share\_info.tdb}} in the directory containing the tdb files.
\subsection{Share Permissions Management}
\label{id2565406}\hypertarget{id2565406}{}%

The best tool for share permissions management is platform-dependent. Choose the best tool for your environment.
\subsubsection{Windows NT4 Workstation/Server}
\label{id2565418}\hypertarget{id2565418}{}%

\index{manage share permissions} \index{share permissions} \index{NT Server Manager} \index{Windows NT4} The tool you need to manage share permissions on a Samba server from a Windows NT4 Workstation or Server is the NT Server Manager. Server Manager is shipped with Windows NT4 Server products but not with Windows NT4 Workstation. You can obtain the NT Server Manager for MS Windows NT4 Workstation from the Microsoft web site support\label{id2565457}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;en-us;173673}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2565457} section.
Instructions\begin{enumerate}

\item{Launch the NT4 Server Manager and click on the Samba server you want to administer. From the menu select {\sffamily \bfseries Computer}, then click on {\sffamily \bfseries Shared Directories}.}

\item{Click on the share that you wish to manage and click the {\sffamily \bfseries Properties} tab, then click the {\sffamily \bfseries Permissions} tab. Now you can add or change access control settings as you wish.}
\end{enumerate}
\subsubsection{Windows 200x/XP}
\label{id2565514}\hypertarget{id2565514}{}%

\index{Windows NT4/200x/XP} \index{ACLs on share} \index{Sharing} \index{Permissions} On MS Windows NT4/200x/XP systems, ACLs on the share itself are set using tools like the MS Explorer. For example, in Windows 200x, right-click on the shared folder, then select {\sffamily \bfseries Sharing}, then click on {\sffamily \bfseries Permissions}. The default Windows NT4/200x permissions allow the group "Everyone" full control on the share.

\index{Computer Management} \index{MMC} \index{tool} MS Windows 200x and later versions come with a tool called the Computer Management snap-in for the MMC. This tool can be accessed via {\sffamily \bfseries Control Panel -\textgreater{} Administrative Tools -\textgreater{} Computer Management}.
Instructions\begin{enumerate}

\item{After launching the MMC with the Computer Management snap-in, click the menu item {\sffamily \bfseries Action} and select {\sffamily \bfseries Connect to another computer}. If you are not logged onto a domain you will be prompted to enter a domain login user identifier and a password. This will authenticate you to the domain. If you are already logged in with administrative privilege, this step is not offered.}

\item{If the Samba server is not shown in the {\sffamily \bfseries Select Computer} box, type in the name of the target Samba server in the field {\sffamily \bfseries Name:}. Now click the on {\sffamily \bfseries [+]} next to {\sffamily \bfseries System Tools}, then on the {\sffamily \bfseries [+]} next to {\sffamily \bfseries Shared Folders} in the left panel.}

\item{\index{Share Permissions} In the right panel, double-click on the share on which you wish to set access control permissions. Then click the tab {\sffamily \bfseries Share Permissions}. It is now possible to add access control entities to the shared folder. Remember to set what type of access (full control, change, read) you wish to assign for each entry.}
\end{enumerate}

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Be careful. If you take away all permissions from the {\texttt{\docbookhyphenatedot{Everyone}}} user without removing this user, effectively no user will be able to access the share. This is a result of what is known as ACL precedence. Everyone with {\em{no access}} means that {\texttt{\docbookhyphenatedot{MaryK}}} who is part of the group {\texttt{\docbookhyphenatedot{Everyone}}} will have no access even if she is given explicit full control access.
\end{admonition}


% ------------------------   
% Section 
\section{MS Windows Access Control Lists and UNIX Interoperability}
\label{id2565724}\hypertarget{id2565724}{}%
\subsection{Managing UNIX Permissions Using NT Security Dialogs}
\label{id2565730}\hypertarget{id2565730}{}%

\index{permissions!file/directory ACLs} Windows NT clients can use their native security settings dialog box to view and modify the underlying UNIX permissions.

This ability is careful not to compromise the security of the UNIX host on which Samba is running and still obeys all the file permission rules that a Samba administrator can set.

Samba does not attempt to go beyond POSIX ACLs, so the various finer-grained access control options provided in Windows are actually ignored.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

All access to UNIX/Linux system files via Samba is controlled by the operating system file access controls. When trying to figure out file access problems, it is vitally important to find the identity of the Windows user as it is presented by Samba at the point of file access. This can best be determined from the Samba log files.
\end{admonition}

\subsection{Viewing File Security on a Samba Share}
\label{id2565776}\hypertarget{id2565776}{}%

From an NT4/2000/XP client, right-click on any file or directory in a Samba-mounted drive letter or UNC path. When the menu pops up, click on the {\sffamily \bfseries Properties} entry at the bottom of the menu. This brings up the file {\texttt{\docbookhyphenatedot{Properties}}} dialog box. Click on the {\sffamily \bfseries Security} tab and you will see three buttons: {\sffamily \bfseries Permissions}, {\sffamily \bfseries Auditing}, and {\sffamily \bfseries Ownership}. The {\sffamily \bfseries Auditing} button will cause either an error message "A requested privilege is not held by the client" to appear if the user is not the NT administrator, or a dialog intended to allow an administrator to add auditing requirements to a file if the user is logged on as the NT administrator. This dialog is nonfunctional with a Samba share at this time, because the only useful button, the {\sffamily \bfseries Add} button, will not currently allow a list of users to be seen.
\subsection{Viewing File Ownership}
\label{id2565843}\hypertarget{id2565843}{}%

Clicking on the {\sffamily \bfseries Ownership} button brings up a dialog box telling you who owns the given file. The owner name will be displayed like this: 
\begin{Verbatim}[]

		SERVER\user (Long name)
		
\end{Verbatim}
 {\ttfamily\itshape{\docbookhyphenatedot{SERVER}}} is the NetBIOS name of the Samba server, {\ttfamily\itshape{\docbookhyphenatedot{user}}} is the username of the UNIX user who owns the file, and {\ttfamily\itshape{\docbookhyphenatedot{(Long name)}}} is the descriptive string identifying the user (normally found in the GECOS field of the UNIX password database). Click on the {\sffamily \bfseries Close} button to remove this dialog.

If the parameter \smbconfoption{nt acl support} is set to {\texttt{\docbookhyphenatedot{false}}}, the file owner will be shown as the NT user {\em{Everyone}}.

\index{Take Ownership} The {\sffamily \bfseries Take Ownership} button will not allow you to change the ownership of this file to yourself (clicking it will display a dialog box complaining that the user as whom you are currently logged onto the NT client cannot be found). The reason for this is that changing the ownership of a file is a privileged operation in UNIX, available only to the {\em{root}} user. Because clicking on this button causes NT to attempt to change the ownership of a file to the current user logged into the NT client, this will not work with Samba at this time.

\index{chown} \index{ownership} \index{Seclib} There is an NT {\bfseries{chown}} command that will work with Samba and allow a user with administrator privilege connected to a Samba server as root to change the ownership of files on both a local NTFS file system or remote mounted NTFS or Samba drive. This is available as part of the Seclib NT security library written by Jeremy Allison of the Samba Team and is downloadable from the main Samba FTP site.
\subsection{Viewing File or Directory Permissions}
\label{id2565969}\hypertarget{id2565969}{}%

The third button is the {\sffamily \bfseries Permissions} button. Clicking on it brings up a dialog box that shows both the permissions and the UNIX owner of the file or directory. The owner is displayed like this:

{\bfseries{{\ttfamily\itshape{\docbookhyphenatedot{SERVER}}}\textbackslash {\ttfamily\itshape{\docbookhyphenatedot{user}}} {\ttfamily\itshape{\docbookhyphenatedot{(Long name)}}}}}

{\ttfamily\itshape{\docbookhyphenatedot{SERVER}}} is the NetBIOS name of the Samba server, {\ttfamily\itshape{\docbookhyphenatedot{user}}} is the username of the UNIX user who owns the file, and {\ttfamily\itshape{\docbookhyphenatedot{(Long name)}}} is the descriptive string identifying the user (normally found in the GECOS field of the UNIX password database).

If the parameter \smbconfoption{nt acl support} is set to {\texttt{\docbookhyphenatedot{false}}}, the file owner will be shown as the NT user {\texttt{\docbookhyphenatedot{Everyone}}}, and the permissions will be shown as NT {\em{Full Control}}.

The permissions field is displayed differently for files and directories. Both are discussed next.
\subsubsection{File Permissions}
\label{id2566039}\hypertarget{id2566039}{}%

The standard UNIX user/group/world triplet and the corresponding {\texttt{\docbookhyphenatedot{read, write, execute}}} permissions triplets are mapped by Samba into a three-element NT ACL with the {``}r{''}, {``}w{''}, and {``}x{''} bits mapped into the corresponding NT permissions. The UNIX world permissions are mapped into the global NT group {\texttt{\docbookhyphenatedot{Everyone}}}, followed by the list of permissions allowed for the UNIX world. The UNIX owner and group permissions are displayed as an NT {\sffamily \bfseries user} icon and an NT {\sffamily \bfseries local group} icon, respectively, followed by the list of permissions allowed for the UNIX user and group.

Because many UNIX permission sets do not map into common NT names such as {\texttt{\docbookhyphenatedot{read}}}, {\texttt{\docbookhyphenatedot{change}}}, or {\texttt{\docbookhyphenatedot{full control}}}, usually the permissions will be prefixed by the words {\texttt{\docbookhyphenatedot{Special Access}}} in the NT display list.

But what happens if the file has no permissions allowed for a particular UNIX user group or world component? In order to allow {\em{no permissions}} to be seen and modified, Samba then overloads the NT {\texttt{\docbookhyphenatedot{Take Ownership}}} ACL attribute (which has no meaning in UNIX) and reports a component with no permissions as having the NT {\bfseries{O}} bit set. This was chosen, of course, to make it look like a zero, meaning zero permissions. More details on the decision behind this action are given below.
\subsubsection{Directory Permissions}
\label{id2566126}\hypertarget{id2566126}{}%

Directories on an NT NTFS file system have two different sets of permissions. The first set is the ACL set on the directory itself, which is usually displayed in the first set of parentheses in the normal {\texttt{\docbookhyphenatedot{RW}}} NT style. This first set of permissions is created by Samba in exactly the same way as normal file permissions are, described above, and is displayed in the same way.

The second set of directory permissions has no real meaning in the UNIX permissions world and represents the {\texttt{\docbookhyphenatedot{inherited}}} permissions that any file created within this directory would inherit.

Samba synthesizes these inherited permissions for NT by returning as an NT ACL the UNIX permission mode that a new file created by Samba on this share would receive.
\subsection{Modifying File or Directory Permissions}
\label{id2566163}\hypertarget{id2566163}{}%

Modifying file and directory permissions is as simple as changing the displayed permissions in the dialog box and clicking on {\sffamily \bfseries OK}. However, there are limitations that a user needs to be aware of, and also interactions with the standard Samba permission masks and mapping of DOS attributes that also need to be taken into account.

If the parameter \smbconfoption{nt acl support} is set to {\texttt{\docbookhyphenatedot{false}}}, any attempt to set security permissions will fail with an "Access Denied" message.

The first thing to note is that the {\sffamily \bfseries Add} button will not return a list of users in Samba (it will give an error message saying "The remote procedure call failed and did not execute"). This means that you can only manipulate the current user/group/world permissions listed in the dialog box. This actually works quite well because these are the only permissions that UNIX actually has.

If a permission triplet (either user, group, or world) is removed from the list of permissions in the NT dialog box, then when the {\sffamily \bfseries OK} button is pressed, it will be applied as {\em{no permissions}} on the UNIX side. If you view the permissions again, the {\em{no permissions}} entry will appear as the NT {\bfseries{O}} flag, as described above. This allows you to add permissions back to a file or directory once you have removed them from a triplet component.

Because UNIX supports only the {``}r{''}, {``}w{''}, and {``}x{''} bits of an NT ACL, if other NT security attributes such as {\texttt{\docbookhyphenatedot{Delete Access}}} are selected, they will be ignored when applied on the Samba server.

When setting permissions on a directory, the second set of permissions (in the second set of parentheses) is by default applied to all files within that directory. If this is not what you want, you must uncheck the {\sffamily \bfseries Replace permissions on existing files} checkbox in the NT dialog before clicking on {\sffamily \bfseries OK}.

If you wish to remove all permissions from a user/group/world component, you may either highlight the component and click on the {\sffamily \bfseries Remove} button or set the component to only have the special {\texttt{\docbookhyphenatedot{Take Ownership}}} permission (displayed as {\bfseries{O}}) highlighted.
\newpage \subsection{Interaction with the Standard Samba {``}create mask{''} Parameters}
\label{id2566306}\hypertarget{id2566306}{}%

There are four parameters that control interaction with the standard Samba {\ttfamily\itshape{\docbookhyphenatedot{create mask}}} parameters: 
\begin{itemize}
%--- Item
\item 
\smbconfoption{security mask}


%--- Item
\item 
\smbconfoption{force security mode}


%--- Item
\item 
\smbconfoption{directory security mask}


%--- Item
\item 
\smbconfoption{force directory security mode}

\end{itemize}


When a user clicks on {\sffamily \bfseries OK} to apply the permissions, Samba maps the given permissions into a user/group/world r/w/x triplet set, and then checks the changed permissions for a file against the bits set in the \smbconfoption{security mask} parameter. Any bits that were changed that are not set to {\em{1}} in this parameter are left alone in the file permissions.

Essentially, zero bits in the \smbconfoption{security mask} may be treated as a set of bits the user is {\em{not}} allowed to change, and one bits are those the user is allowed to change.

If not explicitly set, this parameter defaults to the same value as the \smbconfoption{create mask} parameter. To allow a user to modify all the user/group/world permissions on a file, set this parameter to 0777.

Next Samba checks the changed permissions for a file against the bits set in the \smbconfoption{force security mode} parameter. Any bits that were changed that correspond to bits set to {\em{1}} in this parameter are forced to be set.

Essentially, bits set in the {\ttfamily\itshape{\docbookhyphenatedot{force security mode}}} parameter may be treated as a set of bits that, when modifying security on a file, the user has always set to be {\em{on}}.

If not explicitly set, this parameter defaults to the same value as the \smbconfoption{force create mode} parameter. To allow a user to modify all the user/group/world permissions on a file with no restrictions, set this parameter to 000. The \smbconfoption{security mask} and {\ttfamily\itshape{\docbookhyphenatedot{force security mode}}} parameters are applied to the change request in that order.

For a directory, Samba performs the same operations as described above for a file except it uses the parameter {\ttfamily\itshape{\docbookhyphenatedot{directory security mask}}} instead of {\ttfamily\itshape{\docbookhyphenatedot{security mask}}}, and {\ttfamily\itshape{\docbookhyphenatedot{force directory security mode}}} parameter instead of {\ttfamily\itshape{\docbookhyphenatedot{force security mode}}}.

The \smbconfoption{directory security mask} parameter by default is set to the same value as the {\ttfamily\itshape{\docbookhyphenatedot{directory mask}}} parameter and the {\ttfamily\itshape{\docbookhyphenatedot{force directory security mode}}} parameter by default is set to the same value as the \smbconfoption{force directory mode} parameter. In this way Samba enforces the permission restrictions that an administrator can set on a Samba share, while still allowing users to modify the permission bits within that restriction.

If you want to set up a share that allows users full control in modifying the permission bits on their files and directories and does not force any particular bits to be set {\em{on}}, then set the following parameters in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file in that share-specific section:
\newpage 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	security mask = 0777
 	force security mode = 0
 	directory security mask = 0777
 	force directory security mode = 0
\end{lstlisting}
\subsection{Interaction with the Standard Samba File Attribute Mapping}
\label{id2566549}\hypertarget{id2566549}{}%

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Samba maps some of the DOS attribute bits (such as {``}read-only{''}) into the UNIX permissions of a file. This means there can be a conflict between the permission bits set via the security dialog and the permission bits set by the file attribute mapping.
\end{admonition}


If a file has no UNIX read access for the owner, it will show up as {``}read-only{''} in the standard file attributes tabbed dialog. Unfortunately, this dialog is the same one that contains the security information in another tab.

What this can mean is that if the owner changes the permissions to allow himself or herself read access using the security dialog, clicks on {\sffamily \bfseries OK} to get back to the standard attributes tab dialog, and clicks on {\sffamily \bfseries OK} on that dialog, then NT will set the file permissions back to read-only (as that is what the attributes still say in the dialog). This means that after setting permissions and clicking on {\sffamily \bfseries OK} to get back to the attributes dialog, you should always press {\sffamily \bfseries Cancel} rather than {\sffamily \bfseries OK} to ensure that your changes are not overridden.
\subsection{Windows NT/200X ACLs and POSIX ACLs Limitations}
\label{id2566620}\hypertarget{id2566620}{}%

Windows administrators are familiar with simple ACL controls, and they typically consider that UNIX user/group/other (ugo) permissions are inadequate and not sufficiently fine-grained.

Competing SMB implementations differ in how they handle Windows ACLs. Samba handles Windows ACLs from the perspective of UNIX file system administration and thus adopts the limitations of POSIX ACLs. Therefore, where POSIX ACLs lack a capability of the Windows NT/200X ACLs, the POSIX semantics and limitations are imposed on the Windows administrator.

POSIX ACLs present an interesting challenge to the UNIX administrator and therefore force a compromise to be applied to Windows ACLs administration. POSIX ACLs are not covered by an official standard; rather, the latest standard is a draft standard 1003.1e revision 17. This is the POSIX document on which the Samba implementation has been implemented.

UNIX vendors differ in the manner in which POSIX ACLs are implemented. There are a number of Linux file systems that support ACLs. Samba has to provide a way to make transparent all the differences between the various implementations of POSIX ACLs. The pressure for ACLs support in Samba has noticeably increased the pressure to standardize ACLs support in the UNIX world.

Samba has to deal with the complicated matter of handling the challenge of the Windows ACL that implements {\em{inheritance}}, a concept not anticipated by POSIX ACLs as implemented in UNIX file systems. Samba provides support for {\em{masks}} that permit normal ugo and ACLs functionality to be overrided. This further complicates the way in which Windows ACLs must be implemented.
\subsubsection{UNIX POSIX ACL Overview}
\label{id2566677}\hypertarget{id2566677}{}%

In examining POSIX ACLs we must consider the manner in which they operate for both files and directories. File ACLs have the following significance: 
\begin{Verbatim}[]

# file: testfile      <- the file name
# owner: jeremy       <-- the file owner
# group: users        <-- the POSIX group owner
user::rwx             <-- perms for the file owner (user)
user:tpot:r-x         <-- perms for the additional user `tpot'
group::r--            <-- perms for the file group owner (group)
group:engrs:r--       <-- perms for the additonal group `engineers'
mask:rwx              <-- the mask that is `ANDed' with groups
other::---            <-- perms applied to everyone else (other)

\end{Verbatim}
 Directory ACLs have the following signficance: 
\begin{Verbatim}[]

# file: testdir       <-- the directory name
# owner: jeremy       <-- the directory owner
# group: jeremy       <-- the POSIX group owner
user::rwx             <-- directory perms for owner (user)
group::rwx            <-- directory perms for owning group (group)
mask::rwx             <-- the mask that is `ANDed' with group perms
other:r-x             <-- perms applied to everyone else (other)
default:user::rwx     <-- inherited owner perms
default:user:tpot:rwx <-- inherited extra perms for user `tpot'
default:group::r-x    <-- inherited group perms
default:mask:rwx      <-- inherited default mask
default:other:---     <-- inherited permissions for everyone (other)

\end{Verbatim}

\subsubsection{Mapping of Windows File ACLs to UNIX POSIX ACLs}
\label{id2566721}\hypertarget{id2566721}{}%

Microsoft Windows NT4/200X ACLs must of necessity be mapped to POSIX ACLs. The mappings for file permissions are shown in \hyperlink{fdsacls}{Table {\ref{fdsacls}}}. The \# character means this flag is set only when the Windows administrator sets the {\texttt{\docbookhyphenatedot{Full Control}}} flag on the file.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{fdsacls}{}%
\captionswapskip{}{{\caption{How Windows File ACLs Map to UNIX POSIX File ACLs}\label{fdsacls}}}
\captionswapskip{}\begin{tabular}{|l|c|}
\hline 
\docbooktolatexalignll {{{\bfseries Windows ACE}}} & \docbooktolatexaligncl {{{\bfseries File Attribute Flag}}} \tabularnewline
 \hline 
{{Full Control}} & {{\#}} \tabularnewline
 \hline 
{{Traverse Folder/Execute File}} & {{x}} \tabularnewline
 \hline 
{{List Folder/Read Data}} & {{r}} \tabularnewline
 \hline 
{{Read Attributes}} & {{r}} \tabularnewline
 \hline 
{{Read Extended Attribures}} & {{r}} \tabularnewline
 \hline 
{{Create Files/Write Data}} & {{w}} \tabularnewline
 \hline 
{{Create Folders/Append Data}} & {{w}} \tabularnewline
 \hline 
{{Write Attributes}} & {{w}} \tabularnewline
 \hline 
{{Write Extended Attributes}} & {{w}} \tabularnewline
 \hline 
{{Delete Subfolders and Files}} & {{w}} \tabularnewline
 \hline 
{{Delete}} & {{\#}} \tabularnewline
 \hline 
{{Read Permissions}} & {{all}} \tabularnewline
 \hline 
{{Change Permissions}} & {{\#}} \tabularnewline
 \hline 
{{Take Ownership}} & {{\#}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


As can be seen from the mapping table, there is no one-to-one mapping capability, and therefore Samba must make a logical mapping that will permit Windows to operate more-or-less the way that is intended by the administrator.

In general the mapping of UNIX POSIX user/group/other permissions will be mapped to Windows ACLs. This has precedence over the creation of POSIX ACLs. POSIX ACLs are necessary to establish access controls for users and groups other than the user and group that own the file or directory.

The UNIX administrator can set any directory permission from within the UNIX environment. The Windows administrator is more restricted in that it is not possible from within Windows Explorer to remove read permission for the file owner.
\subsubsection{Mapping of Windows Directory ACLs to UNIX POSIX ACLs}
\label{id2566978}\hypertarget{id2566978}{}%

Interesting things happen in the mapping of UNIX POSIX directory permissions and UNIX POSIX ACLs to Windows ACEs (Access Control Entries, the discrete components of an ACL) are mapped to Windows directory ACLs.

Directory permissions function in much the same way as shown for file permissions, but there are some notable exceptions and a few peculiarities that the astute administrator will want to take into account in the setting up of directory permissions.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2567002}\hypertarget{id2567002}{}%

File, directory, and share access problems are common topics on the mailing list. The following are examples recently taken from the mailing list.
\subsection{Users Cannot Write to a Public Share}
\label{id2567013}\hypertarget{id2567013}{}%

The following complaint has frequently been voiced on the Samba mailing list: {``}We are facing some troubles with file/directory permissions. I can log on the domain as admin user (root), and there's a public share on which everyone needs to have permission to create/modify files, but only root can change the file, no one else can. We need to constantly go to the server to {\ttfamily\bfseries{\docbookhyphenatedot{chgrp -\dbz{}R users *}}} and {\ttfamily\bfseries{\docbookhyphenatedot{chown -\dbz{}R nobody *}}} to allow other users to change the file.{''}

Here is one way the problem can be solved:
\begin{enumerate}

\item{Go to the top of the directory that is shared.}

\item{Set the ownership to whatever public user and group you want 
\begin{Verbatim}[]

$ find `directory_name' -type d -exec chown user:group {}\;
$ find `directory_name' -type d -exec chmod 2775 {}\;
$ find `directory_name' -type f -exec chmod 0775 {}\;
$ find `directory_name' -type f -exec chown user:group {}\;

\end{Verbatim}
 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The above will set the {\texttt{\docbookhyphenatedot{SGID bit}}} on all directories. Read your UNIX/Linux man page on what that does. This ensures that all files and directories that are created in the directory tree will be owned by the current user and will be owned by the group that owns the directory in which it is created.
\end{admonition}

}

\item{Directory is {\ttfamily\itshape{\docbookhyphenatedot{/foodbar}}}: 
\begin{Verbatim}[]

$ chown jack:engr /foodbar

\end{Verbatim}
 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

This is the same as doing:

\begin{Verbatim}[]

$ chown jack /foodbar
$ chgrp engr /foodbar

\end{Verbatim}
\end{admonition}

}

\item{Now type: 
\begin{Verbatim}[]

$ chmod 2775 /foodbar
$ ls -al /foodbar/..

\end{Verbatim}
  You should see: 
\begin{Verbatim}[]

drwxrwsr-x  2 jack  engr    48 2003-02-04 09:55 foodbar

\end{Verbatim}
}

\item{Now type: 
\begin{Verbatim}[]

$ su - jill
$ cd /foodbar
$ touch Afile
$ ls -al

\end{Verbatim}
  You should see that the file {\texttt{\docbookhyphenatefilename{Afile}}} created by Jill will have ownership and permissions of Jack, as follows: 
\begin{Verbatim}[]

-rw-r--r--  1 jill  engr     0 2007-01-18 19:41 Afile

\end{Verbatim}
}

\item{If the user that must have write permission in the directory is not a member of the group {\em{engr}} set in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} entry for the share: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	force group = engr
\end{lstlisting}
}
\end{enumerate}
\subsection{File Operations Done as {\em{root}} with {\em{force user}} Set}
\label{id2567307}\hypertarget{id2567307}{}%

When you have a user in \smbconfoption{admin users}, Samba will always do file operations for this user as {\em{root}}, even if \smbconfoption{force user} has been set.
\subsection{MS Word with Samba Changes Owner of File}
\label{id2567335}\hypertarget{id2567335}{}%

{\em{Question:}} {``}When user B saves a word document that is owned by user A, the updated file is now owned by user B. Why is Samba doing this? How do I fix this?{''}

{\em{Answer:}} Word does the following when you modify/change a Word document: MS Word creates a new document with a temporary name. Word then closes the old document and deletes it, then renames the new document to the original document name. There is no mechanism by which Samba can in any way know that the new document really should be owned by the owners of the original file. Samba has no way of knowing that the file will be renamed by MS Word. As far as Samba is able to tell, the file that gets created is a new file, not one that the application (Word) is updating.

There is a workaround to solve the permissions problem. It involves understanding how you can manage file system behavior from within the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, as well as understanding how UNIX file systems work. Set on the directory in which you are changing Word documents: {\bfseries{chmod g+s `directory\_name'.}} This ensures that all files will be created with the group that owns the directory. In {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} share declaration section set:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	force create mode = 0660
 	force directory mode = 0770
\end{lstlisting}


These two settings will ensure that all directories and files that get created in the share will be readable/writable by the owner and group set on the directory itself.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter File and Record Locking 
% ------------------------------------------------------------- 	
\chapter{File and Record Locking}
\label{locking}\hypertarget{locking}{}%

\index{locking} One area that causes trouble for many network administrators is locking. The extent of the problem is readily evident from searches over the Internet.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2544437}\hypertarget{id2544437}{}%

\index{locking semantics} Samba provides all the same locking semantics that MS Windows clients expect and that MS Windows NT4/200x servers also provide.

\index{locking} The term {\em{locking}} has exceptionally broad meaning and covers a range of functions that are all categorized under this one term.

\index{opportunistic locking} \index{locking protocol} \index{performance advantage} Opportunistic locking is a desirable feature when it can enhance the perceived performance of applications on a networked client. However, the opportunistic locking protocol is not robust and therefore can encounter problems when invoked beyond a simplistic configuration or on extended slow or faulty networks. In these cases, operating system management of opportunistic locking and/or recovering from repetitive errors can offset the perceived performance advantage that it is intended to provide.

\index{registry} The MS Windows network administrator needs to be aware that file and record locking semantics (behavior) can be controlled either in Samba or by way of registry settings on the MS Windows client.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{disable locking} Sometimes it is necessary to disable locking control settings on the Samba server as well as on each MS Windows client!
\end{admonition}


% ------------------------   
% Section 
\section{Discussion}
\label{id2544522}\hypertarget{id2544522}{}%

\index{record locking} \index{deny modes} There are two types of locking that need to be performed by an SMB server. The first is {\em{record locking}} that allows a client to lock a range of bytes in an open file. The second is the {\em{deny modes}} that are specified when a file is open.

\index{locking semantics} \index{record locking} \index{locking} \index{byte ranges} \index{UNIX locking} Record locking semantics under UNIX are very different from record locking under Windows. Versions of Samba before 2.2 have tried to use the native fcntl() UNIX system call to implement proper record locking between different Samba clients. This cannot be fully correct for several reasons. The simplest is that a Windows client is allowed to lock a byte range up to 2\textasciicircum{}32 or 2\textasciicircum{}64, depending on the client OS. The UNIX locking only supports byte ranges up to 2\textasciicircum{}31. So it is not possible to correctly satisfy a lock request above 2\textasciicircum{}31. There are many more differences, too many to be listed here.

\index{record locking} \index{byte-range lock} Samba 2.2 and above implement record locking completely independently of the underlying UNIX system. If a byte-range lock that the client requests happens to fall into the range of 0 to 2\textasciicircum{}31, Samba hands this request down to the UNIX system. No other locks can be seen by UNIX, anyway.

\index{check for locks} \index{rpc.lockd} Strictly speaking, an SMB server should check for locks before every read and write call on a file. Unfortunately, with the way fcntl() works, this can be slow and may overstress the {\bfseries{rpc.lockd}}. This is almost always unnecessary because clients are independently supposed to make locking calls before reads and writes if locking is important to them. By default, Samba only makes locking calls when explicitly asked to by a client, but if you set \smbconfoption{strict locking} = yes, it will make lock checking calls on {\em{every}} read and write call.

\index{byte-range locking} You can also disable byte-range locking completely by using \smbconfoption{locking} = no. This is useful for those shares that do not support locking or do not need it (such as CD-ROMs). In this case, Samba fakes the return codes of locking calls to tell clients that everything is okay.

\index{deny modes} \index{DENY\_NONE} \index{DENY\_READ} \index{DENY\_WRITE} \index{DENY\_ALL} \index{DENY\_FCB} \index{DENY\_DOS} The second class of locking is the {\em{deny modes}}. These are set by an application when it opens a file to determine what types of access should be allowed simultaneously with its open. A client may ask for {\texttt{\docbookhyphenatedot{DENY\_NONE}}}, {\texttt{\docbookhyphenatedot{DENY\_READ}}}, {\texttt{\docbookhyphenatedot{DENY\_WRITE}}}, or {\texttt{\docbookhyphenatedot{DENY\_ALL}}}. There are also special compatibility modes called {\texttt{\docbookhyphenatedot{DENY\_FCB}}} and {\texttt{\docbookhyphenatedot{DENY\_DOS}}}.
\subsection{Opportunistic Locking Overview}
\label{id2526164}\hypertarget{id2526164}{}%

\index{opportunistic locking} \index{oplocks} \index{caching} Opportunistic locking (oplocks) is invoked by the Windows file system (as opposed to an API) via registry entries (on the server and the client) for the purpose of enhancing network performance when accessing a file residing on a server. Performance is enhanced by caching the file locally on the client that allows the following:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Read-ahead:}]\null{}
\index{Read-ahead} The client reads the local copy of the file, eliminating network latency.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Write caching:}]\null{}
\index{Write caching} The client writes to the local copy of the file, eliminating network latency.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Lock caching:}]\null{}
\index{Lock caching} The client caches application locks locally, eliminating network latency.
\end{description}

\index{performance enhancement} \index{oplocks} \index{deny-none} The performance enhancement of oplocks is due to the opportunity of exclusive access to the file ---  even if it is opened with deny-none ---  because Windows monitors the file's status for concurrent access from other processes.

{\sc{Windows Defines Four Kinds of Oplocks:}}

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Level1 Oplock}]\null{}
\index{Level1 Oplock} \index{redirector} \index{concurrent access} \index{cached local file} The redirector sees that the file was opened with deny none (allowing concurrent access), verifies that no other process is accessing the file, checks that oplocks are enabled, then grants deny-all/read-write/exclusive access to the file. The client now performs operations on the cached local file.

\index{oplock break} \index{flush local locks} \index{deferred open} \index{byte-range locking} If a second process attempts to open the file, the open is deferred while the redirector "breaks" the original oplock. The oplock break signals the caching client to write the local file back to the server, flush the local locks, and discard read-ahead data. The break is then complete, the deferred open is granted, and the multiple processes can enjoy concurrent file access as dictated by mandatory or byte-range locking options. However, if the original opening process opened the file with a share mode other than deny-none, then the second process is granted limited or no access, despite the oplock break.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Level2 Oplock}]\null{}
\index{Level2 Oplock} \index{Level1 oplock} \index{caching} Performs like a Level1 oplock, except caching is only operative for reads. All other operations are performed on the server disk copy of the file.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Filter Oplock}]\null{}
\index{Filter Oplock} Does not allow write or delete file access.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Batch Oplock}]\null{}
\index{Batch Oplock} Manipulates file openings and closings and allows caching of file attributes.
\end{description}

\index{oplocks} An important detail is that oplocks are invoked by the file system, not an application API. Therefore, an application can close an oplocked file, but the file system does not relinquish the oplock. When the oplock break is issued, the file system then simply closes the file in preparation for the subsequent open by the second process.

\index{Opportunistic locking} \index{client-side data caching} \index{data caching} \index{oplock break} {\em{Opportunistic locking}} is actually an improper name for this feature. The true benefit of this feature is client-side data caching, and oplocks is merely a notification mechanism for writing data back to the networked storage disk. The limitation of oplocks is the reliability of the mechanism to process an oplock break (notification) between the server and the caching client. If this exchange is faulty (usually due to timing out for any number of reasons), then the client-side caching benefit is negated.

\index{client-side caching} The actual decision that a user or administrator should consider is whether it is sensible to share among multiple users data that will be cached locally on a client. In many cases the answer is no. Deciding when to cache or not cache data is the real question, and thus oplocks should be treated as a toggle for client-side caching. Turn it {``}on{''} when client-side caching is desirable and reliable. Turn it {``}off{''} when client-side caching is redundant, unreliable, or counterproductive.

\index{oplocks} Oplocks is by default set to {``}on{''} by Samba on all configured shares, so careful attention should be given to each case to determine if the potential benefit is worth the potential for delays. The following recommendations will help to characterize the environment where oplocks may be effectively configured.

\index{oplocks} \index{high-availability} Windows oplocks is a lightweight performance-enhancing feature. It is not a robust and reliable protocol. Every implementation of oplocks should be evaluated as a trade-off between perceived performance and reliability. Reliability decreases as each successive rule above is not enforced. Consider a share with oplocks enabled, over a wide-area network, to a client on a South Pacific atoll, on a high-availability server, serving a mission-critical multiuser corporate database during a tropical storm. This configuration will likely encounter problems with oplocks.

\index{mission-critical} Oplocks can be beneficial to perceived client performance when treated as a configuration toggle for client-side data caching. If the data caching is likely to be interrupted, then oplock usage should be reviewed. Samba enables oplocks by default on all shares. Careful attention should be given to the client usage of shared data on the server, the server network reliability, and the oplocks configuration of each share. In mission-critical, high-availability environments, data integrity is often a priority. Complex and expensive configurations are implemented to ensure that if a client loses connectivity with a file server, a failover replacement will be available immediately to provide continuous data availability.

\index{Windows client failover} \index{transport connection loss} Windows client failover behavior is more at risk of application interruption than other platforms because it is dependent upon an established TCP transport connection. If the connection is interrupted ---  as in a file server failover ---  a new session must be established. It is rare for Windows client applications to be coded to recover correctly from a transport connection loss; therefore, most applications will experience some sort of interruption ---  at worst, abort and require restarting.

\index{caching writes} \index{caching reads} \index{oplock break} If a client session has been caching writes and reads locally due to oplocks, it is likely that the data will be lost when the application restarts or recovers from the TCP interrupt. When the TCP connection drops, the client state is lost. When the file server recovers, an oplock break is not sent to the client. In this case, the work from the prior session is lost. Observing this scenario with oplocks disabled and with the client writing data to the file server real-time, the failover will provide the data on disk as it existed at the time of the disconnect.

In mission-critical, high-availability environments, careful attention should be given to oplocks. Ideally, comprehensive testing should be done with all affected applications with oplocks enabled and disabled.
\subsubsection{Exclusively Accessed Shares}
\label{id2559891}\hypertarget{id2559891}{}%

Oplocks is most effective when it is confined to shares that are exclusively accessed by a single user, or by only one user at a time. Because the true value of oplocks is the local client caching of data, any operation that interrupts the caching mechanism will cause a delay.

Home directories are the most obvious examples of where the performance benefit of oplocks can be safely realized.
\subsubsection{Multiple-Accessed Shares or Files}
\label{id2559912}\hypertarget{id2559912}{}%

As each additional user accesses a file in a share with oplocks enabled, the potential for delays and resulting perceived poor performance increases. When multiple users are accessing a file on a share that has oplocks enabled, the management impact of sending and receiving oplock breaks and the resulting latency while other clients wait for the caching client to flush data offset the performance gains of the caching user.

As each additional client attempts to access a file with oplocks set, the potential performance improvement is negated and eventually results in a performance bottleneck.
\subsubsection{UNIX or NFS Client-Accessed Files}
\label{id2559937}\hypertarget{id2559937}{}%

\index{NFS clients} \index{data corruption} Local UNIX and NFS clients access files without a mandatory file-locking mechanism. Thus, these client platforms are incapable of initiating an oplock break request from the server to a Windows client that has a file cached. Local UNIX or NFS file access can therefore write to a file that has been cached by a Windows client, which exposes the file to likely data corruption.

If files are shared between Windows clients and either local UNIX or NFS users, turn oplocks off.
\subsubsection{Slow and/or Unreliable Networks}
\label{id2559973}\hypertarget{id2559973}{}%

\index{performance improvement} \index{WAN} \index{latency} The biggest potential performance improvement for oplocks occurs when the client-side caching of reads and writes delivers the most differential over sending those reads and writes over the wire. This is most likely to occur when the network is extremely slow, congested, or distributed (as in a WAN). However, network latency also has a high impact on the reliability of the oplock break mechanism, and thus increases the likelihood of encountering oplock problems that more than offset the potential perceived performance gain. Of course, if an oplock break never has to be sent, then this is the most advantageous scenario in which to utilize oplocks.

If the network is slow, unreliable, or a WAN, then do not configure oplocks if there is any chance of multiple users regularly opening the same file.
\subsubsection{Multiuser Databases}
\label{id2560022}\hypertarget{id2560022}{}%

\index{Multiuser databases} \index{management bottleneck} \index{oplocks disabled} Multiuser databases clearly pose a risk due to their very nature ---  they are typically heavily accessed by numerous users at random intervals. Placing a multiuser database on a share with oplocks enabled will likely result in a locking management bottleneck on the Samba server. Whether the database application is developed in-house or a commercially available product, ensure that the share has oplocks disabled.
\subsubsection{PDM Data Shares}
\label{id2560064}\hypertarget{id2560064}{}%

\index{PDM} \index{Process data management} \index{client-side data caching} \index{oplocks management} \index{disabling oplocks} Process data management (PDM) applications such as IMAN, Enovia, and Clearcase are increasing in usage with Windows client platforms and therefore with SMB datastores. PDM applications manage multiuser environments for critical data security and access. The typical PDM environment is usually associated with sophisticated client design applications that will load data locally as demanded. In addition, the PDM application will usually monitor the data state of each client. In this case, client-side data caching is best left to the local application and PDM server to negotiate and maintain. It is appropriate to eliminate the client OS from any caching tasks, and the server from any oplocks management, by disabling oplocks on the share.
\subsubsection{Beware of Force User}
\label{id2560123}\hypertarget{id2560123}{}%

\index{oplock break} Samba includes an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter called \smbconfoption{force user} that changes the user accessing a share from the incoming user to whatever user is defined by the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} variable. If oplocks is enabled on a share, the change in user access causes an oplock break to be sent to the client, even if the user has not explicitly loaded a file. In cases where the network is slow or unreliable, an oplock break can become lost without the user even accessing a file. This can cause apparent performance degradation as the client continually reconnects to overcome the lost oplock break.

Avoid the combination of the following:

\begin{itemize}
%--- Item
\item 
\smbconfoption{force user} in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} share configuration.


%--- Item
\item 
Slow or unreliable networks.


%--- Item
\item 
Oplocks enabled.

\end{itemize}
\subsubsection{Advanced Samba Oplocks Parameters}
\label{id2563199}\hypertarget{id2563199}{}%

\index{oplock parameters} \index{oplock mechanism} \index{implementing oplocks} Samba provides oplock parameters that allow the administrator to adjust various properties of the oplock mechanism to account for timing and usage levels. These parameters provide good versatility for implementing oplocks in environments where they would likely cause problems. The parameters are \smbconfoption{oplock break wait time}, and \smbconfoption{oplock contention limit}.

\index{turn oplocks off} For most users, administrators, and environments, if these parameters are required, then the better option is simply to turn oplocks off. The Samba SWAT help text for both parameters reads: {``}Do not change this parameter unless you have read and understood the Samba oplock code.{''} This is good advice.
\subsubsection{Mission-Critical, High-Availability}
\label{id2563263}\hypertarget{id2563263}{}%

In mission-critical, high-availability environments, data integrity is often a priority. Complex and expensive configurations are implemented to ensure that if a client loses connectivity with a file server, a failover replacement will be available immediately to provide continuous data availability.

Windows client failover behavior is more at risk of application interruption than other platforms because it is dependent upon an established TCP transport connection. If the connection is interrupted ---  as in a file server failover ---  a new session must be established. It is rare for Windows client applications to be coded to recover correctly from a transport connection loss; therefore, most applications will experience some sort of interruption ---  at worst, abort and require restarting.

If a client session has been caching writes and reads locally due to oplocks, it is likely that the data will be lost when the application restarts or recovers from the TCP interrupt. When the TCP connection drops, the client state is lost. When the file server recovers, an oplock break is not sent to the client. In this case, the work from the prior session is lost. Observing this scenario with oplocks disabled, if the client was writing data to the file server real-time, then the failover will provide the data on disk as it existed at the time of the disconnect.

In mission-critical, high-availability environments, careful attention should be given to oplocks. Ideally, comprehensive testing should be done with all affected applications with oplocks enabled and disabled.

% ------------------------   
% Section 
\section{Samba Oplocks Control}
\label{id2563321}\hypertarget{id2563321}{}%

Oplocks is a unique Windows file locking feature. It is not really file locking, but is included in most discussions of Windows file locking, so is considered a de facto locking feature. Oplocks is actually part of the Windows client file caching mechanism. It is not a particularly robust or reliable feature when implemented on the variety of customized networks that exist in enterprise computing.

Like Windows, Samba implements oplocks as a server-side component of the client caching mechanism. Because of the lightweight nature of the Windows feature design, effective configuration of oplocks requires a good understanding of its limitations, and then applying that understanding when configuring data access for each particular customized network and client usage state.

Oplocks essentially means that the client is allowed to download and cache a file on its hard drive while making changes; if a second client wants to access the file, the first client receives a break and must synchronize the file back to the server. This can give significant performance gains in some cases; some programs insist on synchronizing the contents of the entire file back to the server for a single change.

Level1 Oplocks (also known as just plain {``}oplocks{''}) is another term for opportunistic locking.

Level2 Oplocks provides opportunistic locking for a file that will be treated as {\em{read only}}. Typically this is used on files that are read-only or on files that the client has no initial intention to write to at time of opening the file.

Kernel Oplocks are essentially a method that allows the Linux kernel to co-exist with Samba's oplocked files, although this has provided better integration of MS Windows network file locking with the underlying OS. SGI IRIX and Linux are the only two OSs that are oplock-aware at this time.

Unless your system supports kernel oplocks, you should disable oplocks if you are accessing the same files from both UNIX/Linux and SMB clients. Regardless, oplocks should always be disabled if you are sharing a database file (e.g., Microsoft Access) between multiple clients, because any break the first client receives will affect synchronization of the entire file (not just the single record), which will result in a noticeable performance impairment and, more likely, problems accessing the database in the first place. Notably, Microsoft Outlook's personal folders (*.pst) react quite badly to oplocks. If in doubt, disable oplocks and tune your system from that point.

If client-side caching is desirable and reliable on your network, you will benefit from turning on oplocks. If your network is slow and/or unreliable, or you are sharing your files among other file sharing mechanisms (e.g., NFS) or across a WAN, or multiple people will be accessing the same files frequently, you probably will not benefit from the overhead of your client sending oplock breaks and will instead want to disable oplocks for the share.

Another factor to consider is the perceived performance of file access. If oplocks provide no measurable speed benefit on your network, it might not be worth the hassle of dealing with them.
\subsection{Example Configuration}
\label{id2563419}\hypertarget{id2563419}{}%

In the following section we examine two distinct aspects of Samba locking controls.
\subsubsection{Disabling Oplocks}
\label{id2563430}\hypertarget{id2563430}{}%

You can disable oplocks on a per-share basis with the following:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
[acctdata]
 	oplocks = False
 	level2 oplocks = False
\end{lstlisting}


The default oplock type is Level1. Level2 oplocks are enabled on a per-share basis in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

Alternately, you could disable oplocks on a per-file basis within the share:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	veto oplock files = /*.mdb/*.MDB/*.dbf/*.DBF/
\end{lstlisting}


If you are experiencing problems with oplocks, as apparent from Samba's log entries, you may want to play it safe and disable oplocks and Level2 oplocks.
\subsubsection{Disabling Kernel Oplocks}
\label{id2563502}\hypertarget{id2563502}{}%

Kernel oplocks is an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter that notifies Samba (if the UNIX kernel has the capability to send a Windows client an oplock break) when a UNIX process is attempting to open the file that is cached. This parameter addresses sharing files between UNIX and Windows with oplocks enabled on the Samba server: the UNIX process can open the file that is Oplocked (cached) by the Windows client and the smbd process will not send an oplock break, which exposes the file to the risk of data corruption. If the UNIX kernel has the ability to send an oplock break, then the kernel oplocks parameter enables Samba to send the oplock break. Kernel oplocks are enabled on a per-server basis in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	kernel oplocks = yes
\end{lstlisting}
 The default is no.

{\em{Veto oplocks}} is an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter that identifies specific files for which oplocks are disabled. When a Windows client opens a file that has been configured for veto oplocks, the client will not be granted the oplock, and all operations will be executed on the original file on disk instead of a client-cached file copy. By explicitly identifying files that are shared with UNIX processes and disabling oplocks for those files, the server-wide oplock configuration can be enabled to allow Windows clients to utilize the performance benefit of file caching without the risk of data corruption. Veto oplocks can be enabled on a per-share basis, or globally for the entire server, in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{far1}{Example {\ref{far1}}}.


\begin{example}%
\hypertarget{far1}{}%
\captionswapskip{}{{\caption{Share with Some Files Oplocked}\label{far1}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	veto oplock files = /filename.htm/*.txt/
 [share_name]
 	veto oplock files = /*.exe/filename.ext/
\end{lstlisting}
\end{example}



\smbconfoption{oplock break wait time} is an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter that adjusts the time interval for Samba to reply to an oplock break request. Samba recommends: {``}Do not change this parameter unless you have read and understood the Samba oplock code.{''} Oplock break wait time can only be configured globally in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	oplock break wait time =  0 (default)
\end{lstlisting}


{\em{Oplock break contention limit}} is an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter that limits the response of the Samba server to grant an oplock if the configured number of contending clients reaches the limit specified by the parameter. Samba recommends {``}Do not change this parameter unless you have read and understood the Samba oplock code.{''} Oplock break contention limit can be enabled on a per-share basis, or globally for the entire server, in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file as shown in \hyperlink{far3}{Example {\ref{far3}}}.


\begin{example}%
\hypertarget{far3}{}%
\captionswapskip{}{{\caption{Configuration with Oplock Break Contention Limit}\label{far3}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	oplock break contention limit =  2 (default)
 [share_name]
 	oplock break contention limit =  2 (default)
\end{lstlisting}
\end{example}



% ------------------------   
% Section 
\section{MS Windows Oplocks and Caching Controls}
\label{id2567525}\hypertarget{id2567525}{}%

There is a known issue when running applications (like Norton Antivirus) on a Windows 2000/ XP workstation computer that can affect any application attempting to access shared database files across a network. This is a result of a default setting configured in the Windows 2000/XP operating system. When a workstation attempts to access shared data files located on another Windows 2000/XP computer, the Windows 2000/XP operating system will attempt to increase performance by locking the files and caching information locally. When this occurs, the application is unable to properly function, which results in an {``}Access Denied{''} error message being displayed during network operations.

All Windows operating systems in the NT family that act as database servers for data files (meaning that data files are stored there and accessed by other Windows PCs) may need to have oplocks disabled in order to minimize the risk of data file corruption. This includes Windows 9x/Me, Windows NT, Windows 200x, and Windows XP. \label{id2567557}\begingroup\catcode`\#=12\footnote{
Microsoft has documented this in Knowledge Base article 300216.
}\endgroup\docbooktolatexmakefootnoteref{id2567557}

If you are using a Windows NT family workstation in place of a server, you must also disable oplocks on that workstation. For example, if you use a PC with the Windows NT Workstation operating system instead of Windows NT Server, and you have data files located on it that are accessed from other Windows PCs, you may need to disable oplocks on that system.

The major difference is the location in the Windows registry where the values for disabling oplocks are entered. Instead of the LanManServer location, the LanManWorkstation location may be used.

You can verify (change or add, if necessary) this registry value using the Windows Registry Editor. When you change this registry value, you will have to reboot the PC to ensure that the new setting goes into effect.

The location of the client registry entry for oplocks has changed in Windows 2000 from the earlier location in Microsoft Windows NT.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Windows 2000 will still respect the EnableOplocks registry value used to disable oplocks in earlier versions of Windows.
\end{admonition}


You can also deny the granting of oplocks by changing the following registry entries:


\begin{Verbatim}[]

	HKEY_LOCAL_MACHINE\System\
		CurrentControlSet\Services\MRXSmb\Parameters\

		OplocksDisabled REG_DWORD 0 or 1
		Default: 0 (not disabled)

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The OplocksDisabled registry value configures Windows clients to either request or not request oplocks on a remote file. To disable oplocks, the value of OplocksDisabled must be set to 1.
\end{admonition}



\begin{Verbatim}[]

	HKEY_LOCAL_MACHINE\System\
		CurrentControlSet\Services\LanmanServer\Parameters

		EnableOplocks REG_DWORD 0 or 1
		Default: 1 (Enabled by Default)

		EnableOpLockForceClose REG_DWORD 0 or 1
		Default: 0 (Disabled by Default)

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The EnableOplocks value configures Windows-based servers (including Workstations sharing files) to allow or deny oplocks on local files.
\end{admonition}


To force closure of open oplocks on close or program exit, EnableOpLockForceClose must be set to 1.

An illustration of how Level2 oplocks work follows:

\begin{itemize}
%--- Item
\item 
Station 1 opens the file requesting oplock.


%--- Item
\item 
Since no other station has the file open, the server grants station 1 exclusive oplock.


%--- Item
\item 
Station 2 opens the file requesting oplock.


%--- Item
\item 
Since station 1 has not yet written to the file, the server asks station 1 to break to Level2 oplock.


%--- Item
\item 
Station 1 complies by flushing locally buffered lock information to the server.


%--- Item
\item 
Station 1 informs the server that it has broken to level2 Oplock (alternately, station 1 could have closed the file).


%--- Item
\item 
The server responds to station 2's open request, granting it Level2 oplock. Other stations can likewise open the file and obtain Level2 oplock.


%--- Item
\item 
Station 2 (or any station that has the file open) sends a write request SMB. The server returns the write response.


%--- Item
\item 
The server asks all stations that have the file open to break to none, meaning no station holds any oplock on the file. Because the workstations can have no cached writes or locks at this point, they need not respond to the break-to-none advisory; all they need do is invalidate locally cashed read-ahead data.

\end{itemize}
\subsection{Workstation Service Entries}
\label{id2567711}\hypertarget{id2567711}{}%


\begin{Verbatim}[]

	\HKEY_LOCAL_MACHINE\System\
		CurrentControlSet\Services\LanmanWorkstation\Parameters

	UseOpportunisticLocking   REG_DWORD   0 or 1
	Default: 1 (true)

\end{Verbatim}


This indicates whether the redirector should use oplocks performance enhancement. This parameter should be disabled only to isolate problems.
\subsection{Server Service Entries}
\label{id2567732}\hypertarget{id2567732}{}%


\begin{Verbatim}[]

	\HKEY_LOCAL_MACHINE\System\
		CurrentControlSet\Services\LanmanServer\Parameters

	EnableOplocks   REG_DWORD   0 or 1
	Default: 1 (true)

\end{Verbatim}


This specifies whether the server allows clients to use oplocks on files. Oplocks are a significant performance enhancement, but have the potential to cause lost cached data on some networks, particularly WANs.


\begin{Verbatim}[]

	MinLinkThroughput   REG_DWORD   0 to infinite bytes per second
	Default: 0

\end{Verbatim}


This specifies the minimum link throughput allowed by the server before it disables raw I/O and oplocks for this connection.


\begin{Verbatim}[]

	MaxLinkDelay   REG_DWORD   0 to 100,000 seconds
	Default: 60

\end{Verbatim}


This specifies the maximum time allowed for a link delay. If delays exceed this number, the server disables raw I/O and oplocks for this connection.


\begin{Verbatim}[]

	OplockBreakWait   REG_DWORD   10 to 180 seconds
	Default: 35

\end{Verbatim}


This specifies the time that the server waits for a client to respond to an oplock break request. Smaller values can allow detection of crashed clients more quickly but can potentially cause loss of cached data.

% ------------------------   
% Section 
\section{Persistent Data Corruption}
\label{id2567796}\hypertarget{id2567796}{}%

If you have applied all of the settings discussed in this chapter but data corruption problems and other symptoms persist, here are some additional things to check out.

We have credible reports from developers that faulty network hardware, such as a single faulty network card, can cause symptoms similar to read caching and data corruption. If you see persistent data corruption even after repeated re-indexing, you may have to rebuild the data files in question. This involves creating a new data file with the same definition as the file to be rebuilt and transferring the data from the old file to the new one. There are several known methods for doing this that can be found in our knowledge base.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2567821}\hypertarget{id2567821}{}%

In some sites locking problems surface as soon as a server is installed; in other sites locking problems may not surface for a long time. Almost without exception, when a locking problem does surface, it will cause embarrassment and potential data corruption.

Over the past few years there have been a number of complaints on the Samba mailing lists that have claimed that Samba caused data corruption. Three causes have been identified so far:

\begin{itemize}
%--- Item
\item 
Incorrect configuration of oplocks (incompatible with the application being used). This is a common problem even where MS Windows NT4 or MS Windows 200x-based servers were in use. It is imperative that the software application vendors' instructions for configuration of file locking should be followed. If in doubt, disable oplocks on both the server and the client. Disabling of all forms of file caching on the MS Windows client may be necessary also.


%--- Item
\item 
Defective network cards, cables, or hubs/switches. This is generally a more prevalent factor with low-cost networking hardware, although occasionally there have also been problems with incompatibilities in more up-market hardware.


%--- Item
\item 
There have been some random reports of Samba log files being written over data files. This has been reported by very few sites (about five in the past 3 years) and all attempts to reproduce the problem have failed. The Samba Team has been unable to catch this happening and thus unable to isolate any particular cause. Considering the millions of systems that use Samba, for the sites that have been affected by this as well as for the Samba Team, this is a frustrating and vexing challenge. If you see this type of thing happening, please create a bug report on Samba Bugzilla\label{id2567876}\begingroup\catcode`\#=12\footnote{ {\textless}\url{https://bugzilla.samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2567876} without delay. Make sure that you give as much information as you possibly can to help isolate the cause and to allow replication of the problem (an essential step in problem isolation and correction).

\end{itemize}
\subsection{locking.tdb Error Messages}
\label{id2567887}\hypertarget{id2567887}{}%

{``}We are seeing lots of errors in the Samba logs, like:{''} 
\begin{Verbatim}[]

tdb(/usr/local/samba_2.2.7/var/locks/locking.tdb): rec_read bad magic
 0x4d6f4b61 at offset=36116

\end{Verbatim}
 {``}What do these mean?{''}

This error indicates a corrupted tdb. Stop all instances of smbd, delete locking.tdb, and restart smbd.
\subsection{Problems Saving Files in MS Office on Windows XP}
\label{id2567916}\hypertarget{id2567916}{}%
\index{KB 812937}
This is a bug in Windows XP. More information can be found in Microsoft Knowledge Base article 812937\label{id2567932}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/?id=812937}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2567932}
.\subsection{Long Delays Deleting Files over Network with XP SP1}
\label{id2567940}\hypertarget{id2567940}{}%

{``}It sometimes takes approximately 35 seconds to delete files over the network after XP SP1 has been applied.{''}
\index{KB 811492}
This is a bug in Windows XP. More information can be found in Microsoft Knowledge Base article 811492\label{id2567962}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/?id=811492}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2567962}
.
% ------------------------   
% Section 
\section{Additional Reading}
\label{id2567971}\hypertarget{id2567971}{}%

You may want to check for an updated documentation regarding file and record locking issues on the Microsoft Support\label{id2567980}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2567980} web site. Additionally, search for the word {\texttt{\docbookhyphenatedot{locking}}} on the Samba web\label{id2567992}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2567992} site.

Section of the Microsoft MSDN Library on opportunistic locking:

\index{KB 224992} Microsoft Knowledge Base, {``}Maintaining Transactional Integrity with OPLOCKS{''}, Microsoft Corporation, April 1999, Microsoft KB Article 224992\label{id2568016}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/?id=224992}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568016}.

\index{KB 296264} Microsoft Knowledge Base, {``}Configuring Opportunistic Locking in Windows 2000{''}, Microsoft Corporation, April 2001 Microsoft KB Article 296264\label{id2568038}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/?id=296264}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568038}.

\index{KB 129202} Microsoft Knowledge Base, {``}PC Ext: Explanation of Opportunistic Locking on Windows NT{''}, Microsoft Corporation, April 1995 Microsoft KB Article 129202\label{id2568061}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/?id=129202}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568061}.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Securing Samba 
% ------------------------------------------------------------- 	
\chapter{Securing Samba}
\label{securing-samba}\hypertarget{securing-samba}{}%

% ------------------------   
% Section 
\section{Introduction}
\label{id2475218}\hypertarget{id2475218}{}%

\index{security} \index{direct internet access} \index{firewall} \index{private network} \index{barriers} \index{deterents} \index{secured networks} The information contained in this chapter applies in general to all Samba installations. Security is everyone's concern in the information technology world. A surprising number of Samba servers are being installed on machines that have direct internet access, thus security is made more critical than it would have been had the server been located behind a firewall and on a private network. Paranoia regarding server security is causing some network administrators to insist on the installation of robust firewalls even on servers that are located inside secured networks. This chapter provides information to assist the administrator who understands how to create the needed barriers and deterents against {``}the enemy{''}, no matter where [s]he may come from.
\begin{quote}

A new apprentice reported for duty to the chief engineer of a boiler house. He said, {``}Here I am, if you will show me the boiler I'll start working on it.{''} Then engineer replied, {``}You're leaning on it!{''}
\end{quote}

Security concerns are just like that. You need to know a little about the subject to appreciate how obvious most of it really is. The challenge for most of us is to discover that first morsel of knowledge with which we may unlock the secrets of the masters.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2528937}\hypertarget{id2528937}{}%

\index{moderately secure} \index{perimeter firewall} \index{host security} \index{Samba security} There are three levels at which security principles must be observed in order to render a site at least moderately secure. They are the perimeter firewall, the configuration of the host server that is running Samba, and Samba itself.

Samba permits a most flexible approach to network security. As far as possible Samba implements the latest protocols to permit more secure MS Windows file and print operations.

\index{host-based protection} \index{interface-based exclusion} \index{resource-based exclusion} Samba can be secured from connections that originate from outside the local network. This can be done using {\em{host-based protection}}, using Samba's implementation of a technology known as {``}tcpwrappers,{''} or it may be done be using {\em{interface-based exclusion}} so smbd will bind only to specifically permitted interfaces. It is also possible to set specific share- or resource-based exclusions, for example, on the \smbconfsection{[IPC\$]} autoshare. The \smbconfsection{[IPC\$]} share is used for browsing purposes as well as to establish TCP/IP connections.

\index{Access Control Entries|textit{see} {ACE} } \index{ACL} \index{controls} Another method by which Samba may be secured is by setting Access Control Entries (ACEs) in an Access Control List (ACL) on the shares themselves. This is discussed in \hyperlink{AccessControls}{Chapter {\ref{AccessControls}}, {``}File, Directory, and Share Access Controls{''}}.

% ------------------------   
% Section 
\section{Technical Discussion of Protective Measures and Issues}
\label{id2526280}\hypertarget{id2526280}{}%

The key challenge of security is that protective measures suffice at best only to close the door on known exploits and breach techniques. Never assume that because you have followed these few measures, the Samba server is now an impenetrable fortress! Given the history of information systems so far, it is only a matter of time before someone will find yet another vulnerability.
\subsection{Using Host-Based Protection}
\label{id2526297}\hypertarget{id2526297}{}%

\index{outside threat} \index{insecure} \index{Internet} In many installations of Samba, the greatest threat comes from outside your immediate network. By default, Samba accepts connections from any host, which means that if you run an insecure version of Samba on a host that is directly connected to the Internet, you can be especially vulnerable.

\index{allow access} \index{range of hosts} One of the simplest fixes in this case is to use the \smbconfoption{hosts allow} and \smbconfoption{hosts deny} options in the Samba {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} configuration file to allow access to your server only from a specific range of hosts. An example might be: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	hosts allow = 127.0.0.1 192.168.2.0/24 192.168.3.0/24
 	hosts deny = 0.0.0.0/0
\end{lstlisting}


\index{localhost} \index{private networks} \index{called name} The above will allow SMB connections only from {\texttt{\docbookhyphenatedot{localhost}}} (your own computer) and from the two private networks 192.168.2 and 192.168.3. All other connections will be refused as soon as the client sends its first packet. The refusal will be marked as {\texttt{\docbookhyphenatedot{not listening on called name}}} error.
\subsection{User-Based Protection}
\label{id2562533}\hypertarget{id2562533}{}%

If you want to restrict access to your server to valid users only, then the following method may be of use. In the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} \smbconfsection{[global]} section put: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	valid users = @smbusers, jacko
\end{lstlisting}


\index{smbusers} This restricts all server access either to the user {\em{jacko}} or to members of the system group {\em{smbusers}}.
\subsection{Using Interface Protection}
\label{id2562585}\hypertarget{id2562585}{}%

\index{network interface} \index{accept connections} \index{Internet} By default, Samba accepts connections on any network interface that it finds on your system. That means if you have an ISDN line or a PPP connection to the Internet then Samba will accept connections on those links. This may not be what you want.

You can change this behavior using options like this: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	interfaces = eth* lo
 	bind interfaces only = yes
\end{lstlisting}


\index{interfaces} \index{loopback interface} \index{Ethernet adapters} \index{listen for connections} This tells Samba to listen for connections only on interfaces with a name starting with {\texttt{\docbookhyphenatedot{eth}}} such as {\texttt{\docbookhyphenatedot{eth0}}} or {\texttt{\docbookhyphenatedot{eth1}}}, plus on the loopback interface called {\texttt{\docbookhyphenatedot{lo}}}. The name you will need to use depends on what OS you are using. In the above, I used the common name for Ethernet adapters on Linux.

\index{PPP} \index{SMB} \index{cracker} \index{confirm address} If you use the above and someone tries to make an SMB connection to your host over a PPP interface called {\texttt{\docbookhyphenatedot{ppp0}}}, then [s]he will get a TCP connection refused reply. In that case, no Samba code is run at all, because the operating system has been told not to pass connections from that interface to any Samba process. However, the refusal helps a would-be cracker by confirming that the IP address provides valid active services.

\index{ignore connection} \index{refusing connection} \index{exploitation} \index{denial of service} \index{firewall} A better response would be to ignore the connection (from, for example, ppp0) altogether. The advantage of ignoring the connection attempt, as compared with refusing it, is that it foils those who probe an interface with the sole intention of finding valid IP addresses for later use in exploitation or denial of service attacks. This method of dealing with potential malicious activity demands the use of appropriate firewall mechanisms.
\subsection{Using a Firewall}
\label{firewallports}\hypertarget{firewallports}{}%

\index{deny access} \index{exposed} \index{firewall active} Many people use a firewall to deny access to services they do not want exposed outside their network. This can be a good idea, although I recommend using it in conjunction with the above methods so you are protected even if your firewall is not active for some reason.

If you are setting up a firewall, you need to know what TCP and UDP ports to allow and block. Samba uses the following: \index{Port 135/TCP} \index{Port 137/UDP} \index{Port 138/UDP} \index{Port 139/TCP} \index{Port 445/TCP}

\begin{tabular}{l}

Port 135/TCP - used by smbd  \\
Port 137/UDP - used by nmbd  \\
Port 138/UDP - used by nmbd  \\
Port 139/TCP - used by smbd  \\
Port 445/TCP - used by smbd  \\
\end{tabular}

\index{firewall setups} The last one is important because many older firewall setups may not be aware of it, given that this port was only added to the protocol in recent years.

\index{configuring a firewall} \index{high order ports} \index{block incoming packets} When configuring a firewall, the high order ports (1024-65535) are often used for outgoing connections and therefore should be permitted through the firewall. It is prudent to block incoming packets on the high order ports except for established connections.
\subsection{Using IPC\$ Share-Based Denials}
\label{id2564122}\hypertarget{id2564122}{}%

\index{IPC\$} \index{deny} \index{security hole} If the above methods are not suitable, then you could also place a more specific deny on the IPC\$ share that is used in the recently discovered security hole. This allows you to offer access to other shares while denying access to IPC\$ from potentially untrustworthy hosts.

To do this you could use: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[IPC$]
 	hosts allow = 192.168.115.0/24 127.0.0.1
 	hosts deny = 0.0.0.0/0
\end{lstlisting}


\index{IPC\$} \index{protection against attackers} \index{valid username/password} This instructs Samba that IPC\$ connections are not allowed from anywhere except the two listed network addresses (localhost and the 192.168.115 subnet). Connections to other shares are still allowed. Because the IPC\$ share is the only share that is always accessible anonymously, this provides some level of protection against attackers who do not know a valid username/password for your host.

\index{access denied} \index{IPC\$} \index{browse shares} If you use this method, then clients will be given an {\texttt{\docbookhyphenatedot{`access denied'}}} reply when they try to access the IPC\$ share. Those clients will not be able to browse shares and may also be unable to access some other resources. This is not recommended unless for some reason you cannot use one of the other methods just discussed.
\subsection{NTLMv2 Security}
\label{id2525615}\hypertarget{id2525615}{}%

\index{NTLMv2} To configure NTLMv2 authentication, the following registry keys are worth knowing about:


\begin{Verbatim}[]

		[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa]
		"lmcompatibilitylevel"=dword:00000003
		
\end{Verbatim}


The value 0x00000003 means to send NTLMv2 response only. Clients will use NTLMv2 authentication; use NTLMv2 session security if the server supports it. Domain controllers accept LM, NTLM, and NTLMv2 authentication.


\begin{Verbatim}[]

		[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0]
		"NtlmMinClientSec"=dword:00080000
		
\end{Verbatim}


The value 0x00080000 means permit only NTLMv2 session security. If either NtlmMinClientSec or NtlmMinServerSec is set to 0x00080000, the connection will fail if NTLMv2 session security is negotiated.

% ------------------------   
% Section 
\section{Upgrading Samba}
\label{id2525674}\hypertarget{id2525674}{}%

\index{updates} \index{important announcements} \index{security vulnerability} Please check regularly on {\textless}\url{http://www.samba.org/}{\textgreater} for updates and important announcements. Occasionally security releases are made, and it is highly recommended to upgrade Samba promptly when a security vulnerability is discovered. Check with your OS vendor for OS-specific upgrades.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2525717}\hypertarget{id2525717}{}%

If all Samba and host platform configurations were really as intuitive as one might like them to be, this chapter would not be necessary. Security issues are often vexing for a support person to resolve, not because of the complexity of the problem, but because most administrators who post what turns out to be a security problem request are totally convinced that the problem is with Samba.
\subsection{Smbclient Works on Localhost, but the Network Is Dead}
\label{id2525733}\hypertarget{id2525733}{}%

This is a common problem. Linux vendors tend to install a default firewall. With the default firewall in place, only traffic on the loopback adapter (IP address 127.0.0.1) is allowed through the firewall.

The solution is either to remove the firewall (stop it) or modify the firewall script to allow SMB networking traffic through. See \hyperlink{firewallports}{Section {\ref{firewallports}}} section.
\subsection{Why Can Users Access Other Users' Home Directories?}
\label{id2525760}\hypertarget{id2525760}{}%

{``}\index{mapping home directory} \index{own home directory} We are unable to keep individual users from mapping to any other user's home directory once they have supplied a valid password! They only need to enter their own password. I have not found any method to configure Samba so that users may map only their own home directory.{''}

{``}User xyzzy can map his home directory. Once mapped, user xyzzy can also map anyone else's home directory.{''}

\index{security flaw} \index{defined shares} This is not a security flaw, it is by design. Samba allows users to have exactly the same access to the UNIX file system as when they were logged on to the UNIX box, except that it only allows such views onto the file system as are allowed by the defined shares.

\index{UNIX home directories} \index{permissions} If your UNIX home directories are set up so that one user can happily {\bfseries{cd}} into another user's directory and execute {\bfseries{ls}}, the UNIX security solution is to change file permissions on the user's home directories so that the {\bfseries{cd}} and {\bfseries{ls}} are denied.

\index{security policies} \index{permissions} Samba tries very hard not to second guess the UNIX administrator's security policies and trusts the UNIX admin to set the policies and permissions he or she desires.

Samba allows the behavior you require. Simply put the \smbconfoption{only user} = \%S option in the \smbconfsection{[homes]} share definition.

The \smbconfoption{only user} works in conjunction with the \smbconfoption{users} = list, so to get the behavior you require, add the line: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	users = %S
\end{lstlisting}
 This is equivalent to adding 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	valid users = %S
\end{lstlisting}
 to the definition of the \smbconfsection{[homes]} share, as recommended in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Interdomain Trust Relationships 
% ------------------------------------------------------------- 	
\chapter{Interdomain Trust Relationships}
\label{InterdomainTrusts}\hypertarget{InterdomainTrusts}{}%

\index{Interdomain Trusts} \index{LDAP} \index{trusts} \index{samba-to-samba trusts} \index{Active Directory} \index{NT4-style domain} \index{trust relationships} \index{ADS} \index{LDAP-based} Samba-3 supports NT4-style domain trust relationships. This is a feature that many sites will want to use if they migrate to Samba-3 from an NT4-style domain and do not want to adopt Active Directory or an LDAP-based authentication backend. This chapter explains some background information regarding trust relationships and how to create them. It is now possible for Samba-3 to trust NT4 (and vice versa), as well as to create Samba-to-Samba trusts.

\index{winbind} \index{UID range} \index{GID range} \index{daemon} \index{winbindd} The use of interdomain trusts requires use of {\bfseries{winbind}}, so the {\bfseries{winbindd}} daemon must be running. Winbind operation in this mode is dependent on the specification of a valid UID range and a valid GID range in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. These are specified respectively using: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	idmap uid = 10000-20000
 	idmap gid = 10000-20000
\end{lstlisting}
 \index{passdb backend} \index{POSIX user accounts} \index{maximum value} \index{4294967295} The range of values specified must not overlap values used by the host operating system and must not overlap values used in the passdb backend for POSIX user accounts. The maximum value is limited by the upper-most value permitted by the host operating system. This is a UNIX kernel limited parameter. Linux kernel 2.6-based systems support a maximum value of 4294967295 (32-bit unsigned variable).

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{winbind} \index{trusting domain} \index{trusted domain} The use of winbind is necessary only when Samba is the trusting domain, not when it is the trusted domain.
\end{admonition}


% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2569791}\hypertarget{id2569791}{}%

\index{scalability} \index{trust relationships} Samba-3 can participate in Samba-to-Samba as well as in Samba-to-MS Windows NT4-style trust relationships. This imparts to Samba scalability similar to that with MS Windows NT4.

\index{scalable backend} \index{authentication database} \index{LDAP} \index{interdomain trusts} \index{ADS} Given that Samba-3 can function with a scalable backend authentication database such as LDAP, and given its ability to run in primary as well as backup domain control modes, the administrator would be well-advised to consider alternatives to the use of interdomain trusts simply because, by the very nature of how trusts function, this system is fragile. That was, after all, a key reason for the development and adoption of Microsoft Active Directory.

% ------------------------   
% Section 
\section{Trust Relationship Background}
\label{id2569865}\hypertarget{id2569865}{}%

\index{security domains} \index{nonhierarchical} \index{security structure} \index{large organizations} \index{delegation} \index{administrative responsibilities} MS Windows NT3/4-type security domains employ a nonhierarchical security structure. The limitations of this architecture as it effects the scalability of MS Windows networking in large organizations is well known. Additionally, the flat namespace that results from this design significantly impacts the delegation of administrative responsibilities in large and diverse organizations.

\index{ADS} \index{Kerberos} \index{LDAP} \index{limitations} \index{domain security} Microsoft developed Active Directory Service (ADS), based on Kerberos and LDAP, as a means of circumventing the limitations of the older technologies. Not every organization is ready or willing to embrace ADS. For small companies the older NT4-style domain security paradigm is quite adequate, and so there remains an entrenched user base for whom there is no direct desire to go through a disruptive change to adopt ADS.

\index{security domains} \index{access rights} \index{privileges} \index{trusts} \index{trusted domain} \index{trusting domain} \index{one direction} With Windows NT, Microsoft introduced the ability to allow different security domains to effect a mechanism so users from one domain may be given access rights and privileges in another domain. The language that describes this capability is couched in terms of {\em{trusts}}. Specifically, one domain will {\em{trust}} the users from another domain. The domain from which users can access another security domain is said to be a trusted domain. The domain in which those users have assigned rights and privileges is the trusting domain. With NT3.x/4.0 all trust relationships are always in one direction only, so if users in both domains are to have privileges and rights in each others' domain, then it is necessary to establish two relationships, one in each direction.

\index{security domain} \index{nontransitive} \index{trust relationship} \index{transitive} \index{explicit trust} Further, in an NT4-style MS security domain, all trusts are nontransitive. This means that if there are three domains (let's call them red, white, and blue), where red and white have a trust relationship, and white and blue have a trust relationship, then it holds that there is no implied trust between the red and blue domains. Relationships are explicit and not transitive.

\index{ADS} \index{security contexts} \index{trust relationships} \index{two-way trust} \index{Windows 2000} \index{security domains} \index{NT4-style domains} New to MS Windows 2000 ADS security contexts is the fact that trust relationships are two-way by default. Also, all inter-ADS domain trusts are transitive. In the case of the red, white, and blue domains, with Windows 2000 and ADS, the red and blue domains can trust each other. This is an inherent feature of ADS domains. Samba-3 implements MS Windows NT4-style interdomain trusts and interoperates with MS Windows 200x ADS security domains in similar manner to MS Windows NT4-style domains.

% ------------------------   
% Section 
\section{Native MS Windows NT4 Trusts Configuration}
\label{id2562955}\hypertarget{id2562955}{}%

\index{Interdomain Trusts!creating} \index{two-way trust} \index{security credentials} There are two steps to creating an interdomain trust relationship. To effect a two-way trust relationship, it is necessary for each domain administrator to create a trust account for the other domain to use in verifying security credentials.
\subsection{Creating an NT4 Domain Trust}
\label{id2562988}\hypertarget{id2562988}{}%

\index{domain trust} \index{trust relationships} \index{\textgreater{}Domain User Manager} \index{remote domain} \index{standard confirmation} For MS Windows NT4, all domain trust relationships are configured using the Domain User Manager. This is done from the Domain User Manager Policies entry on the menu bar. From the {\sffamily \bfseries Policy} menu, select {\sffamily \bfseries Trust Relationships}. Next to the lower box labeled {\sffamily \bfseries Permitted to Trust this Domain} are two buttons, {\sffamily \bfseries Add} and {\sffamily \bfseries Remove}. The {\sffamily \bfseries Add} button will open a panel in which to enter the name of the remote domain that will be able to assign access rights to users in your domain. You will also need to enter a password for this trust relationship, which the trusting domain will use when authenticating users from the trusted domain. The password needs to be typed twice (for standard confirmation).
\subsection{Completing an NT4 Domain Trust}
\label{id2562119}\hypertarget{id2562119}{}%

\index{trust relationship} \index{trusting domain} \index{trusted domain} \index{remote domain} \index{password assigned} \index{Interdomain Trusts!Completing} A trust relationship will work only when the other (trusting) domain makes the appropriate connections with the trusted domain. To consummate the trust relationship, the administrator launches the Domain User Manager from the menu selects {\sffamily \bfseries Policies}, then select {\sffamily \bfseries Trust Relationships}, and clicks on the {\sffamily \bfseries Add} button next to the box that is labeled {\sffamily \bfseries Trusted Domains}. A panel opens in which must be entered the name of the remote domain as well as the password assigned to that trust.
\subsection{Interdomain Trust Facilities}
\label{id2562206}\hypertarget{id2562206}{}%

\index{two-way trust} \index{trust relationship} \index{trust established} \index{one-way trust} \index{Windows NT4 domains} \index{Interdomain Trusts!Facilities} A two-way trust relationship is created when two one-way trusts are created, one in each direction. Where a one-way trust has been established between two MS Windows NT4 domains (let's call them DomA and DomB), the following facilities are created:

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{trusts1}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/trusts1}
{{\caption[{Trusts overview.}]{{{Trusts overview.}}}\label{trusts1}}}
\end{center}
\end{figure}


\begin{itemize}
%--- Item
\item 
DomA (completes the trust connection) {\ttfamily\itshape{\docbookhyphenatedot{Trusts}}} DomB.


%--- Item
\item 
DomA is the {\ttfamily\itshape{\docbookhyphenatedot{Trusting}}} domain.


%--- Item
\item 
DomB is the {\ttfamily\itshape{\docbookhyphenatedot{Trusted}}} domain (originates the trust account).


%--- Item
\item 
Users in DomB can access resources in DomA.


%--- Item
\item 
Users in DomA cannot access resources in DomB.


%--- Item
\item 
Global groups from DomB can be used in DomA.


%--- Item
\item 
Global groups from DomA cannot be used in DomB.


%--- Item
\item 
DomB does appear in the logon dialog box on client workstations in DomA.


%--- Item
\item 
DomA does not appear in the logon dialog box on client workstations in DomB.

\end{itemize}

\begin{itemize}
%--- Item
\item 
Users and groups in a trusting domain cannot be granted rights, permissions, or access to a trusted domain.


%--- Item
\item 
The trusting domain can access and use accounts (users/global groups) in the trusted domain.


%--- Item
\item 
Administrators of the trusted domain can be granted administrative rights in the trusting domain.


%--- Item
\item 
Users in a trusted domain can be given rights and privileges in the trusting domain.


%--- Item
\item 
Trusted domain global groups can be given rights and permissions in the trusting domain.


%--- Item
\item 
Global groups from the trusted domain can be made members in local groups on MS Windows domain member machines.

\end{itemize}

% ------------------------   
% Section 
\section{Configuring Samba NT-Style Domain Trusts}
\label{id2562398}\hypertarget{id2562398}{}%

\index{interdomain trust} This description is meant to be a fairly short introduction about how to set up a Samba server so that it can participate in interdomain trust relationships. Trust relationship support in Samba is at an early stage, so do not be surprised if something does not function as it should.

\index{peer domain} \index{trust relationship} \index{Windows NT4 Server} \index{between domains} Each of the procedures described next assumes the peer domain in the trust relationship is controlled by a Windows NT4 server. However, the remote end could just as well be another Samba-3 domain. It can be clearly seen, after reading this document, that combining Samba-specific parts of what's written in the following sections leads to trust between domains in a purely Samba environment.
\subsection{Samba as the Trusted Domain}
\label{samba-trusted-domain}\hypertarget{samba-trusted-domain}{}%

\index{trusted party} \index{special account} \index{trusting party} \index{PDC} \index{smbpasswd} In order to set the Samba PDC to be the trusted party of the relationship, you first need to create a special account for the domain that will be the trusting party. To do that, you can use the {\bfseries{smbpasswd}} utility. Creating the trusted domain account is similar to creating a trusted machine account. Suppose, your domain is called SAMBA, and the remote domain is called RUMBA. The first step will be to issue this command from your favorite shell:


\begin{Verbatim}[]

root#  smbpasswd -a -i rumba
New SMB password: XXXXXXXX
Retype SMB password: XXXXXXXX
Added user rumba$

\end{Verbatim}
 where {\texttt{\docbookhyphenatedot{-a}}} means to add a new account into the passdb database and {\texttt{\docbookhyphenatedot{-i}}} means to {``}create this account with the Interdomain trust flag{''}.

\index{account name} \index{remote domain} \index{password database} \index{/etc/passwd} The account name will be {``}rumba\${''} (the name of the remote domain). If this fails, you should check that the trust account has been added to the system password database ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}). If it has not been added, you can add it manually and then repeat the previous step.

\index{password} \index{new account} \index{confirm the trust} \index{Windows NT Server} After issuing this command, you will be asked to enter the password for the account. You can use any password you want, but be aware that Windows NT will not change this password until 7 days following account creation. After the command returns successfully, you can look at the entry for the new account (in the standard way as appropriate for your configuration) and see that the account's name is really RUMBA\$ and it has the {``}I{''} flag set in the flags field. Now you are ready to confirm the trust by establishing it from Windows NT Server.

\index{User Manager} \index{trusted domain name} \index{relationship password} \index{remote domain} \index{established} Open User Manager for Domains and from the {\sffamily \bfseries Policies} menu, select {\sffamily \bfseries Trust Relationships...}. Beside the {\sffamily \bfseries Trusted domains} list box, click the {\sffamily \bfseries Add...} button. You will be prompted for the trusted domain name and the relationship password. Type in SAMBA, as this is the name of the remote domain and the password used at the time of account creation. Click on {\sffamily \bfseries OK} and, if everything went without incident, you will see the {\texttt{\docbookhyphenatedot{Trusted domain relationship successfully established}}} message.
\subsection{Samba as the Trusting Domain}
\label{id2560930}\hypertarget{id2560930}{}%

\index{NT-controlled domain} \index{PDC} This time activities are somewhat reversed. Again, we'll assume that your domain controlled by the Samba PDC is called SAMBA and the NT-controlled domain is called RUMBA.

The very first step is to add an account for the SAMBA domain on RUMBA's PDC.

\index{User Manager} \index{trusted domain} \index{password} Launch the Domain User Manager, then from the menu select {\sffamily \bfseries Policies}, {\sffamily \bfseries Trust Relationships}. Now, next to the {\sffamily \bfseries Trusting Domains} box, press the {\sffamily \bfseries Add} button and type in the name of the trusted domain (SAMBA) and the password to use in securing the relationship.

\index{password} \index{confirm the password} The password can be arbitrarily chosen. It is easy to change the password from the Samba server whenever you want. After you confirm the password, your account is ready for use. Now its Samba's turn.

Using your favorite shell while logged in as root, issue this command: \index{net!rpc!trustdom establish}

{\texttt{\docbookhyphenatedot{root\#}}}{\ttfamily\bfseries{\docbookhyphenatedot{net rpc trustdom establish rumba}}}

\index{password} \index{interdomain connection} \index{ordinary connection} You will be prompted for the password you just typed on your Windows NT4 Server box. An error message, {\texttt{\docbookhyphenatedot{"NT\_\dbz{}STATUS\_\dbz{}NOLOGON\_\dbz{}INTERDOMAIN\_\dbz{}TRUST\_\dbz{}ACCOUNT,"}}} that may be reported periodically is of no concern and may safely be ignored. It means the password you gave is correct and the NT4 server says the account is ready for interdomain connection and not for ordinary connection. After that, be patient; it can take a while (especially in large networks), but eventually you should see the {\texttt{\docbookhyphenatedot{Success}}} message. Congratulations! Your trust relationship has just been established.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

You have to run this command as root because you must have write access to the {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}} file.
\end{admonition}


% ------------------------   
% Section 
\section{NT4-Style Domain Trusts with Windows 2000}
\label{id2561131}\hypertarget{id2561131}{}%

\index{trust relationship} \index{Windows 2000 server} \index{NT4-style} \index{mixed mode} Although Domain User Manager is not present in Windows 2000, it is also possible to establish an NT4-style trust relationship with a Windows 2000 domain controller running in mixed mode as the trusting server. It should also be possible for Samba to trust a Windows 2000 server; however, more testing is still needed in this area.

\index{interdomain trust} \index{trust account} \index{not transitive} \index{ADS} After \hyperlink{samba-trusted-domain}{Section {\ref{samba-trusted-domain}}} as described previously, open Active Directory Domains and Trusts on the AD controller of the domain whose resources you wish Samba users to have access to. Remember that since NT4-style trusts are not transitive, if you want your users to have access to multiple mixed-mode domains in your AD forest, you will need to repeat this process for each of those domains. With Active Directory domains and trusts open, right-click on the name of the Active Directory domain that will trust our Samba domain and choose {\sffamily \bfseries Properties}, then click on the {\sffamily \bfseries Trusts} tab. In the upper part of the panel, you will see a list box labeled {\sffamily \bfseries Domains trusted by this domain:} and an {\sffamily \bfseries Add...} button next to it. Press this button and, just as with NT4, you will be prompted for the trusted domain name and the relationship password. Press {\em{OK}} and after a moment, Active Directory will respond with {\texttt{\docbookhyphenatedot{The trusted domain has been added and the trust has been verified.}}} Your Samba users can now be granted access to resources in the AD domain.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2570887}\hypertarget{id2570887}{}%

Interdomain trust relationships should not be attempted on networks that are unstable or that suffer regular outages. Network stability and integrity are key concerns with distributed trusted domains.
\subsection{Browsing of Trusted Domain Fails}
\label{id2570899}\hypertarget{id2570899}{}%

{\em{Browsing from a machine in a trusted Windows 200x domain to a Windows 200x member of a trusting Samba domain, I get the following error:}} 
\begin{Verbatim}[]

The system detected a possible attempt to compromise security. Please
ensure that you can contact the server that authenticated you.

\end{Verbatim}


{\em{The event logs on the box I'm trying to connect to have entries regarding group policy not being applied because it is a member of a down-level domain.}}

If there is a computer account in the Windows 200x domain for the machine in question, and it is disabled, this problem can occur. If there is no computer account (removed or never existed), or if that account is still intact (i.e., you just joined it to another domain), everything seems to be fine. By default, when you unjoin a domain (the Windows 200x domain), the computer tries to automatically disable the computer account in the domain. If you are running as an account that has privileges to do this when you unjoin the machine, it is done; otherwise it is not done.
\subsection{Problems with LDAP ldapsam and Older Versions of smbldap-tools}
\label{id2510142}\hypertarget{id2510142}{}%

If you use the {\bfseries{smbldap-useradd}} script to create a trust account to set up interdomain trusts, the process of setting up the trust will fail. The account that was created in the LDAP database will have an account flags field that has {\texttt{\docbookhyphenatedot{[W ]}}}, when it must have {\texttt{\docbookhyphenatedot{[I ]}}} for interdomain trusts to work.

Here is a simple solution. Create a machine account as follows: 
\begin{Verbatim}[]

root#  smbldap-useradd -w domain_name

\end{Verbatim}
 Then set the desired trust account password as shown here: 
\begin{Verbatim}[]

root#  smbldap-passwd domain_name\$

\end{Verbatim}
 Using a text editor, create the following file: 
\begin{Verbatim}[]

dn: uid=domain_name$,ou=People,dc={your-domain},dc={your-top-level-domain}
changetype: modify
sambaAcctFlags: [I         ]

\end{Verbatim}
 Then apply the text file to the LDAP database as follows: 
\begin{Verbatim}[]

root#  ldapmodify -x -h localhost \
 -D "cn=Manager,dc={your-domain},dc={your-top-level-domain}" \
 -W -f /path-to/foobar

\end{Verbatim}
 Create a single-sided trust under the NT4 Domain User Manager, then execute: 
\begin{Verbatim}[]

root#  net rpc trustdom establish domain_name

\end{Verbatim}


It works with Samba-3 and NT4 domains, and also with Samba-3 and Windows 200x ADS in mixed mode. Both domain controllers, Samba and NT must have the same WINS server; otherwise, the trust will never work.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Hosting a Microsoft Distributed File System Tree 
% ------------------------------------------------------------- 	
\chapter{Hosting a Microsoft Distributed File System Tree}
\label{msdfs}\hypertarget{msdfs}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2542788}\hypertarget{id2542788}{}%

\index{distributed file system|textit{see} {DFS} } \index{physical locations} \index{higher availability} \index{load balancing} \index{logical directories} The distributed file system (DFS) provides a means of separating the logical view of files and directories that users see from the actual physical locations of these resources on the network. It allows for higher availability, smoother storage expansion, load balancing, and so on.

\index{DFS} \index{DFS tree} \index{DFS-aware} For information about DFS, refer to the Microsoft documentation\label{id2530877}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2530877}. This document explains how to host a DFS tree on a UNIX machine (for DFS-aware clients to browse) using Samba.

\index{DFS server} \index{share-level} \index{DFS junction} \index{DFS-aware} A Samba server can be made a DFS server by setting the global Boolean \smbconfoption{host msdfs} parameter in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. You designate a share as a DFS root using the share-level Boolean \smbconfoption{msdfs root} parameter. A DFS root directory on Samba hosts DFS links in the form of symbolic links that point to other servers. For example, a symbolic link {\texttt{\docbookhyphenatefilename{junction-\dbz{}>msdfs:storage1\docbooktolatexgobble\string\\share1}}} in the share directory acts as the DFS junction. When DFS-aware clients attempt to access the junction link, they are redirected to the storage location (in this case, {\ttfamily\itshape{\docbookhyphenatedot{\textbackslash \textbackslash storage1\textbackslash share1}}}).

\index{DFS-aware} \index{DFS tree} \index{DFS links} \index{DFS} DFS trees on Samba work with all DFS-aware clients ranging from Windows 95 to 200x. \hyperlink{dfscfg}{Example {\ref{dfscfg}}} shows how to setup a DFS tree on a Samba server. In the {\texttt{\docbookhyphenatefilename{/\dbz{}export/\dbz{}dfsroot}}} directory, you set up your DFS links to other servers on the network. 
\begin{Verbatim}[]

root# cd /export/dfsroot
root# chown root /export/dfsroot
root# chmod 755 /export/dfsroot
root# ln -s msdfs:storageA\\shareA linka
root# ln -s msdfs:serverB\\share,serverC\\share linkb

\end{Verbatim}


\begin{example}%
\hypertarget{dfscfg}{}%
\captionswapskip{}{{\caption{smb.conf with DFS Configured}\label{dfscfg}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	netbios name = GANDALF
 	host msdfs   = yes
 [dfs]
 	path = /export/dfsroot
 	msdfs root = yes
\end{lstlisting}
\end{example}


\index{DFS root} \index{msdfs links} \index{symbolic links} You should set up the permissions and ownership of the directory acting as the DFS root so that only designated users can create, delete, or modify the msdfs links. Also note that symlink names should be all lowercase. This limitation exists to have Samba avoid trying all the case combinations to get at the link name. Finally, set up the symbolic links to point to the network shares you want and start Samba.

\index{DFS-aware clients} \index{DFS tree} Users on DFS-aware clients can now browse the DFS tree on the Samba server at {\texttt{\docbookhyphenatedot{\textbackslash \textbackslash samba\textbackslash dfs}}}. Accessing links linka or linkb (which appear as directories to the client) takes users directly to the appropriate shares on the network.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2542584}\hypertarget{id2542584}{}%

\begin{itemize}
%--- Item
\item 
Windows clients need to be rebooted if a previously mounted non-DFS share is made a DFS root, or vice versa. A better way is to introduce a new share and make it the DFS root.


%--- Item
\item 
Currently, there's a restriction that msdfs symlink names should all be lowercase.


%--- Item
\item 
For security purposes, the directory acting as the root of the DFS tree should have ownership and permissions set so only designated users can modify the symbolic links in the directory.

\end{itemize}
\subsection{MSDFS UNIX Path Is Case-Critical}
\label{id2542619}\hypertarget{id2542619}{}%

A network administrator sent advice to the Samba mailing list after long sessions trying to determine why DFS was not working. His advice is worth noting.

{``}I spent some time trying to figure out why my particular DFS root wasn't working. I noted in the documentation that the symlink should be in all lowercase. It should be amended that the entire path to the symlink should all be in lowercase as well.{''}

{``}For example, I had a share defined as such:{''} 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[pub]
 	path = /export/home/Shares/public_share
 	msdfs root = yes
\end{lstlisting}
 {``}and I could not make my Windows 9x/Me (with the dfs client installed) follow this symlink:{''} 
\begin{Verbatim}[]

		damage1 -> msdfs:damage\test-share
		
\end{Verbatim}


{``}Running a debug level of 10 reveals:{''} 
\begin{Verbatim}[]

		[2003/08/20 11:40:33, 5] msdfs/msdfs.c:is_msdfs_link(176)
		  is_msdfs_link: /export/home/shares/public_share/* does not exist.
		
\end{Verbatim}
 {``}Curious. So I changed the directory name from {\texttt{\docbookhyphenatedot{.../Shares/...}}} to {\texttt{\docbookhyphenatedot{.../shares/...}}} (along with my service definition) and it worked!{''}
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Classical Printing Support 
% ------------------------------------------------------------- 	
\chapter{Classical Printing Support}
\label{classicalprinting}\hypertarget{classicalprinting}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2569051}\hypertarget{id2569051}{}%

\index{mission-critical} Printing is often a mission-critical service for the users. Samba can provide this service reliably and seamlessly for a client network consisting of Windows workstations.

\index{print service} \index{domain member server} \index{standalone server} \index{file serving} \index{dedicated print server} \index{print server} \index{printing support} \index{Point'n'Print} \index{Add Printer Wizard} \index{upload drivers} \index{manage drivers} \index{install drivers} \index{print accounting} \index{Common UNIX Printing System|textit{see} {CUPS} } A Samba print service may be run on a standalone or domain member server, side by side with file serving functions, or on a dedicated print server. It can be made as tightly or as loosely secured as needs dictate. Configurations may be simple or complex. Available authentication schemes are essentially the same as described for file services in previous chapters. Overall, Samba's printing support is now able to replace an NT or Windows 2000 print server full-square, with additional benefits in many cases. Clients may download and install drivers and printers through their familiar {\texttt{\docbookhyphenatedot{Point'n'Print}}} mechanism. Printer installations executed by {\texttt{\docbookhyphenatedot{Logon Scripts}}} are no problem. Administrators can upload and manage drivers to be used by clients through the familiar {\texttt{\docbookhyphenatedot{Add Printer Wizard}}}. As an additional benefit, driver and printer management may be run from the command line or through scripts, making it more efficient in case of large numbers of printers. If a central accounting of print jobs (tracking every single page and supplying the raw data for all sorts of statistical reports) is required, this function is best supported by the newer Common UNIX Printing System (CUPS) as the print subsystem underneath the Samba hood.

\index{BSD} \index{CUPS} This chapter outlines the fundamentals of Samba printing as implemented by the more traditional UNIX BSD- and System V-style printing systems. Much of the information in this chapter applies also to CUPS. If you use CUPS, you may be tempted to jump to the next chapter, but you will certainly miss a few things if you do. For further information refer to \hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Windows XP Professional} \index{Windows 200x/XP} \index{Windows NT4} Most of the following examples have been verified on Windows XP Professional clients. Where this document describes the responses to commands given, bear in mind that Windows 200x/XP clients are quite similar but may differ in minor details. Windows NT4 is somewhat different again.
\end{admonition}


% ------------------------   
% Section 
\section{Technical Introduction}
\label{id2569252}\hypertarget{id2569252}{}%

\index{printing support} \index{print subsystem} \index{printing system} Samba's printing support always relies on the installed print subsystem of the UNIX OS it runs on. Samba is a {\texttt{\docbookhyphenatedot{middleman.\dbz{}}}} It takes print files from Windows (or other SMB) clients and passes them to the real printing system for further processing; therefore, it needs to communicate with both sides: the Windows print clients and the UNIX printing system. Hence, we must differentiate between the various client OS types, each of which behave differently, as well as the various UNIX print subsystems, which themselves have different features and are accessed differently.

\index{UNIX printing} \index{CUPS} This chapter deals with the traditional way of UNIX printing. The next chapter covers in great detail the more modern CUPS.

\begin{admonition}{xslt/figures/important}{Important}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{CUPS} CUPS users, be warned: do not just jump on to the next chapter. You might miss important information only found here!
\end{admonition}


\index{print configuration} \index{problematic print} \index{print processing} \index{print filtering} It is apparent from postings on the Samba mailing list that print configuration is one of the most problematic aspects of Samba administration today. Many new Samba administrators have the impression that Samba performs some sort of print processing. Rest assured, Samba does not perform any type of print processing. It does not do any form of print filtering.

\index{data stream} \index{local spool area} \index{spooled file} \index{local system printing} Samba obtains from its clients a data stream (print job) that it spools to a local spool area. When the entire print job has been received, Samba invokes a local UNIX/Linux print command and passes the spooled file to it. It is up to the local system printing subsystems to correctly process the print job and to submit it to the printer.
\subsection{Client to Samba Print Job Processing}
\label{id2561703}\hypertarget{id2561703}{}%

Successful printing from a Windows client via a Samba print server to a UNIX printer involves six (potentially seven) stages:

\begin{enumerate}
%--- Item
\item 
Windows opens a connection to the printer share.


%--- Item
\item 
Samba must authenticate the user.


%--- Item
\item 
Windows sends a copy of the print file over the network into Samba's spooling area.


%--- Item
\item 
Windows closes the connection.


%--- Item
\item 
Samba invokes the print command to hand the file over to the UNIX print subsystem's spooling area.


%--- Item
\item 
The UNIX print subsystem processes the print job.


%--- Item
\item 
The print file may need to be explicitly deleted from the Samba spooling area. This item depends on your print spooler configuration settings.

\end{enumerate}
\subsection{Printing-Related Configuration Parameters}
\label{id2561762}\hypertarget{id2561762}{}%

\index{global-level} \index{service-level} \index{printing behavior} There are a number of configuration parameters to control Samba's printing behavior. Please refer to the man page for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} for an overview of these. As with other parameters, there are global-level (tagged with a {\em{G}} in the listings) and service-level ({\em{S}}) parameters.

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Global Parameters}]\null{}
These {\em{may not}} go into individual share definitions. If they go in by error, the {\bfseries{testparm}} utility can discover this (if you run it) and tell you so.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Service-Level Parameters}]\null{}
These may be specified in the \smbconfsection{[global]} section of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. In this case they define the default behavior of all individual or service-level shares (provided they do not have a different setting defined for the same parameter, thus overriding the global default).
\end{description}

% ------------------------   
% Section 
\section{Simple Print Configuration}
\label{id2561862}\hypertarget{id2561862}{}%

\index{BSD Printing} \index{simple printing} \index{enables clients to print} \index{print environment} \hyperlink{simpleprc}{Example {\ref{simpleprc}}} shows a simple printing configuration. If you compare this with your own, you may find additional parameters that have been preconfigured by your OS vendor. Following is a discussion and explanation of the parameters. This example does not use many parameters. However, in many environments these are enough to provide a valid {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file that enables all clients to print.

\begin{example}%
\hypertarget{simpleprc}{}%
\captionswapskip{}{{\caption{Simple Configuration with BSD Printing}\label{simpleprc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	printing = bsd
 	load printers = yes
 [printers]
 	path = /var/spool/samba
 	printable = yes
 	public = yes
 	writable = no
\end{lstlisting}
\end{example}


\index{testparm} \index{misconfigured settings} \index{pager program} This is only an example configuration. Samba assigns default values to all configuration parameters. The defaults are conservative and sensible. When a parameter is specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, this overwrites the default value. The {\bfseries{testparm}} utility when run as root is capable of reporting all settings, both default as well as {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file settings. {\bfseries{Testparm}} gives warnings for all misconfigured settings. The complete output is easily 360 lines and more, so you may want to pipe it through a pager program.

\index{configuration syntax} \index{syntax tolerates spelling errors} \index{case-insensitive} The syntax for the configuration file is easy to grasp. You should know that is not very picky about its syntax. As has been explained elsewhere in this book, Samba tolerates some spelling errors (such as \smbconfoption{browseable} instead of \smbconfoption{browsable}), and spelling is case-insensitive. It is permissible to use {\ttfamily\itshape{\docbookhyphenatedot{Yes/No}}} or {\ttfamily\itshape{\docbookhyphenatedot{True/False}}} for Boolean settings. Lists of names may be separated by commas, spaces, or tabs.
\subsection{Verifying Configuration with testparm}
\label{id2541988}\hypertarget{id2541988}{}%

\index{printing-related settings} \index{lp} \index{print} \index{spool} \index{driver} \index{ports} \index{testparm} \index{smbd} \index{print configuration} \index{printer shares} \index{spooling path} To see all (or at least most) printing-related settings in Samba, including the implicitly used ones, try the command outlined below. This command greps for all occurrences of {\texttt{\docbookhyphenatedot{lp}}}, {\texttt{\docbookhyphenatedot{print}}}, {\texttt{\docbookhyphenatedot{spool}}}, {\texttt{\docbookhyphenatedot{driver}}}, {\texttt{\docbookhyphenatedot{ports}}}, and {\texttt{\docbookhyphenatedot{[}}} in {\bfseries{testparm}}'s output. This provides a convenient overview of the running {\bfseries{smbd}} print configuration. This command does not show individually created printer shares or the spooling paths they may use. Here is the output of my Samba setup, with settings shown in \hyperlink{simpleprc}{Example {\ref{simpleprc}}}: 
\begin{Verbatim}[]

root# testparm -s -v | egrep "(lp|print|spool|driver|ports|\[)"
 Load smb config files from /etc/samba/smb.conf
 Processing section "[homes]"
 Processing section "[printers]"
 
 [global]
        smb ports = 139 445
        lpq cache time = 10
        load printers = Yes
        printcap name = /etc/printcap
        disable spoolss = No
        enumports command =
        addprinter command = 
        deleteprinter command = 
        show add printer wizard = Yes
        os2 driver map =
        printer admin =
        min print space = 0
        max print jobs = 1000
        printable = No
        printing = bsd
        print command = lpr -r -P'%p' %s
        lpq command = lpq -P'%p'
        lprm command = lprm -P'%p' %j
        lppause command =
        lpresume command =
        printer name =
        use client driver = No

 [homes]

 [printers]
        path = /var/spool/samba
        printable = Yes

\end{Verbatim}


You can easily verify which settings were implicitly added by Samba's default behavior. {\em{Remember: it may be important in your future dealings with Samba.}}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The {\bfseries{testparm}} in Samba-3 behaves differently from that in 2.2.x: used without the {``}-v{''} switch, it only shows you the settings actually written into! To see the complete configuration used, add the {``}-v{''} parameter to testparm.
\end{admonition}

\subsection{Rapid Configuration Validation}
\label{id2542191}\hypertarget{id2542191}{}%

\index{troubleshoot} \index{testparm} \index{parameters} \index{verify} Should you need to troubleshoot at any stage, please always come back to this point first and verify if {\bfseries{testparm}} shows the parameters you expect. To give you a warning from personal experience, try to just comment out the \smbconfoption{load printers} parameter. If your 2.2.x system behaves like mine, you'll see this:


\begin{Verbatim}[]

root# grep "load printers" /etc/samba/smb.conf
        #  load printers = Yes
        # This setting is commented out!!
 
root# testparm -v /etc/samba/smb.conf | egrep "(load printers)"
        load printers = Yes

\end{Verbatim}


\index{commenting out setting} \index{publishing printers} I assumed that commenting out of this setting should prevent Samba from publishing my printers, but it still did. It took some time to figure out the reason. But I am no longer fooled ... at least not by this. 
\begin{Verbatim}[]

root# grep -A1 "load printers" /etc/samba/smb.conf
        load printers = No
        # The above setting is what I want!
        #  load printers = Yes
        # This setting is commented out!

root# testparm -s -v smb.conf.simpleprinting | egrep "(load printers)"
        load printers = No

\end{Verbatim}


\index{explicitly set} Only when the parameter is explicitly set to \smbconfoption{load printers} = No would Samba conform with my intentions. So, my strong advice is:

\begin{itemize}
%--- Item
\item 
Never rely on commented-out parameters.


%--- Item
\item 
Always set parameters explicitly as you intend them to behave.


%--- Item
\item 
Use {\bfseries{testparm}} to uncover hidden settings that might not reflect your intentions.

\end{itemize}

The following is the most minimal configuration file: 
\begin{Verbatim}[]

root# cat /etc/samba/smb.conf-minimal
        [printers]

\end{Verbatim}


\index{testparm} \index{smbd} This example should show that you can use {\bfseries{testparm}} to test any Samba configuration file. Actually, we encourage you {\em{not}} to change your working system (unless you know exactly what you are doing). Don't rely on the assumption that changes will only take effect after you restart smbd! This is not the case. Samba rereads it every 60 seconds and on each new client connection. You might have to face changes for your production clients that you didn't intend to apply. You will now note a few more interesting things; {\bfseries{testparm}} is useful to identify what the Samba print configuration would be if you used this minimalistic configuration. Here is what you can expect to find: 
\begin{Verbatim}[]

root# testparm -v smb.conf-minimal | egrep "(print|lpq|spool|driver|ports|[)"
 Processing section "[printers]"
 WARNING: [printers] service MUST be printable!
 No path in service printers - using /tmp

        lpq cache time = 10
        load printers = Yes
        printcap name = /etc/printcap
        disable spoolss = No
        enumports command =
        addprinter command =
        deleteprinter command =
        show add printer wizard = Yes
        os2 driver map =
        printer admin =
        min print space = 0
        max print jobs = 1000
        printable = No
        printing = bsd
        print command = lpr -r -P%p %s
        lpq command = lpq -P%p
        printer name =
        use client driver = No

 [printers]
        printable = Yes

\end{Verbatim}


{\bfseries{testparm}} issued two warnings:

\begin{itemize}
%--- Item
\item 
We did not specify the \smbconfsection{[printers]} section as printable.


%--- Item
\item 
We did not tell Samba which spool directory to use.

\end{itemize}

\index{compile-time options} \index{} \index{} \index{} However, this was not fatal, and Samba will default to values that will work. Please, do not rely on this and do not use this example. This was included to encourage you to be careful to design and specify your setup to do precisely what you require. The outcome on your system may vary for some parameters given, since Samba may have been built with different compile-time options. {\em{Warning:}} do not put a comment sign {\em{at the end}} of a valid line. It will cause the parameter to be ignored (just as if you had put the comment sign at the front). At first I regarded this as a bug in my Samba versions. But the man page clearly says: {\texttt{\docbookhyphenatedot{Internal whitespace in a parameter value is retained verbatim.\dbz{}}}} This means that a line consisting of, for example, 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# This defines LPRng as the printing system
 	printing =  lprng
\end{lstlisting}


will regard the whole of the string after the {\texttt{\docbookhyphenatedot{=}}} sign as the value you want to define. This is an invalid value that will be ignored, and a default value will be used in its place.

% ------------------------   
% Section 
\section{Extended Printing Configuration}
\label{id2580894}\hypertarget{id2580894}{}%

\index{Extended BSD Printing} \index{BSD-style printing} \index{CUPS} \index{testparm} \hyperlink{extbsdpr}{Example {\ref{extbsdpr}}} shows a more verbose configuration for print-related settings in a BSD-style printing environment. What follows is a discussion and explanation of the various parameters. We chose to use BSD-style printing here because it is still the most commonly used system on legacy UNIX/Linux installations. New installations predominantly use CUPS, which is discussed in a separate chapter. The example explicitly names many parameters that do not need to be specified because they are set by default. You could use a much leaner {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, or you can use {\bfseries{testparm}} or {\bfseries{SWAT}} to optimize the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to remove all parameters that are set at default.

\begin{example}%
\hypertarget{extbsdpr}{}%
\captionswapskip{}{{\caption{Extended BSD Printing Configuration}\label{extbsdpr}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	printing = bsd
 	load printers = yes
 	show add printer wizard = yes
 	printcap name = /etc/printcap
 	printer admin = @ntadmin, root
 	max print jobs = 100
 	lpq cache time = 20
 	use client driver = no
 [printers]
 	comment = All Printers
 	printable = yes
 	path = /var/spool/samba
 	browseable = no
 	guest ok = yes
 	public = yes
 	read only = yes
 	writable = no       
 [my_printer_name]
 	comment = Printer with Restricted Access
 	path = /var/spool/samba_my_printer
 	printer admin = kurt
 	browseable = yes
 	printable = yes
 	writable = no
 	hosts allow = 0.0.0.0
 	hosts deny = turbo_xp, 10.160.50.23, 10.160.51.60
 	guest ok = no
\end{lstlisting}
\end{example}


\index{} \index{} \index{} This is an example configuration. You may not find all the settings that are in the configuration file that was provided by the OS vendor. Samba configuration parameters, if not explicitly set, default to a sensible value. To see all settings, as {\texttt{\docbookhyphenatedot{root}}} use the {\bfseries{testparm}} utility. {\bfseries{testparm}} gives warnings for misconfigured settings.
\subsection{Detailed Explanation Settings}
\label{id2581155}\hypertarget{id2581155}{}%

The following is a discussion of the settings from \hyperlink{extbsdpr}{Example {\ref{extbsdpr}}} \hyperlink{extbsdpr}{Example {\ref{extbsdpr}}}.
\subsubsection{The [global] Section}
\label{id2581175}\hypertarget{id2581175}{}%

\index{global section} \index{special sections} \index{individual section} \index{share} The \smbconfsection{[global]} section is one of four special sections (along with \smbconfsection{[homes]}, \smbconfsection{[printers]}, and \smbconfsection{[print\$]}). The \smbconfsection{[global]} contains all parameters that apply to the server as a whole. It is the place for parameters that have only a global meaning. It may also contain service-level parameters that define default settings for all other sections and shares. This way you can simplify the configuration and avoid setting the same value repeatedly. (Within each individual section or share, you may, however, override these globally set share settings and specify other values).

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{printing} = bsd }]\null{}
\index{default print commands} \index{RFC 1179} \index{printing} \index{CUPS} \index{LPD} \index{LPRNG} \index{SYSV} \index{HPUX} \index{AIX} \index{QNX} \index{PLP} \index{queue control} Causes Samba to use default print commands applicable for the BSD (also known as RFC 1179 style or LPR/LPD) printing system. In general, the {\ttfamily\itshape{\docbookhyphenatedot{printing}}} parameter informs Samba about the print subsystem it should expect. Samba supports CUPS, LPD, LPRNG, SYSV, HPUX, AIX, QNX, and PLP. Each of these systems defaults to a different \smbconfoption{print command} (and other queue control commands).

\begin{admonition}{xslt/figures/caution}{Caution}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{service-level} \index{SOFTQ printing system} The \smbconfoption{printing} parameter is normally a service-level parameter. Since it is included here in the \smbconfsection{[global]} section, it will take effect for all printer shares that are not defined differently. Samba-3 no longer supports the SOFTQ printing system.
\end{admonition}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{load printers} = yes }]\null{}
\index{printer shares} \index{printcap} \index{separate shares} \index{UNIX printer} Tells Samba to create automatically all available printer shares. Available printer shares are discovered by scanning the printcap file. All created printer shares are also loaded for browsing. If you use this parameter, you do not need to specify separate shares for each printer. Each automatically created printer share will clone the configuration options found in the \smbconfsection{[printers]} section. (The {\ttfamily\itshape{\docbookhyphenatedot{load printers = no}}} setting will allow you to specify each UNIX printer you want to share separately, leaving out some you do not want to be publicly visible and available).
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{show add printer wizard} = yes }]\null{}
\index{Add Printer Wizard} \index{Printers} \index{Network Neighborhood} \index{net view} \index{uploaded driver} Setting is normally enabled by default (even if the parameter is not specified in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}). It causes the {\sffamily \bfseries Add Printer Wizard} icon to appear in the {\sffamily \bfseries Printers} folder of the Samba host's share listing (as shown in {\sffamily \bfseries Network Neighborhood} or by the {\bfseries{net view}} command). To disable it, you need to explicitly set it to {\texttt{\docbookhyphenatedot{no}}} (commenting it out will not suffice). The {\ttfamily\itshape{\docbookhyphenatedot{Add Printer Wizard}}} lets you upload a printer driver to the \smbconfsection{[print\$]} share and associate it with a printer (if the respective queue exists before the action), or exchange a printer's driver for any other previously uploaded driver.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{max print jobs} = 100 }]\null{}
\index{print jobs} Sets the upper limit to 100 print jobs being active on the Samba server at any one time. Should a client submit a job that exceeds this number, a "no more space available on server" type of error message will be returned by Samba to the client. A setting of zero (the default) means there is {\em{no}} limit at all.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{printcap name} = /etc/printcap }]\null{}
\index{CUPS} \index{available printerd} \index{printcap} Tells Samba where to look for a list of available printer names. Where CUPS is used, make sure that a printcap file is written. This is controlled by the {\texttt{\docbookhyphenatedot{Printcap}}} directive in the {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} file.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{printer admin} = @ntadmin }]\null{}
\index{add drivers} \index{/etc/group} \index{printer share} \index{set printer properties} Members of the ntadmin group should be able to add drivers and set printer properties ({\texttt{\docbookhyphenatedot{ntadmin}}} is only an example name; it needs to be a valid UNIX group name); root is implicitly always a \smbconfoption{printer admin}. The {\texttt{\docbookhyphenatedot{@}}} sign precedes group names in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}}. A printer admin can do anything to printers via the remote administration interfaces offered by MS-RPC (see \hyperlink{cups-msrpc}{Section {\ref{cups-msrpc}}}). In larger installations, the \smbconfoption{printer admin} parameter is normally a per-share parameter. This permits different groups to administer each printer share.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{lpq cache time} = 20 }]\null{}
\index{lpq command} \index{lpq cache time} Controls the cache time for the results of the lpq command. It prevents the lpq command being called too often and reduces the load on a heavily used print server.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{use client driver} = no }]\null{}
\index{Windows NT/200x/XP} If set to {\texttt{\docbookhyphenatedot{yes}}}, only takes effect for Windows NT/200x/XP clients (and not for Win 95/98/ME). Its default value is {\texttt{\docbookhyphenatedot{No}}} (or {\texttt{\docbookhyphenatedot{False}}}). It must {\em{not}} be enabled on print shares (with a {\texttt{\docbookhyphenatedot{yes}}} or {\texttt{\docbookhyphenatedot{true}}} setting) that have valid drivers installed on the Samba server. For more detailed explanations, see the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.
\end{description}
\subsubsection{The [printers] Section}
\label{ptrsect}\hypertarget{ptrsect}{}%

\index{printers section} \index{printcap} The printers section is the second special section. If a section with this name appears in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}, users are able to connect to any printer specified in the Samba host's printcap file, because Samba on startup then creates a printer share for every printer name it finds in the printcap file. You could regard this section as a convenient shortcut to share all printers with minimal configuration. It is also a container for settings that should apply as default to all printers. (For more details, see the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page.) Settings inside this container must be share-level parameters.

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{comment} = All printers }]\null{}
The \smbconfoption{comment} is shown next to the share if a client queries the server, either via {\sffamily \bfseries Network Neighborhood} or with the {\bfseries{net view}} command, to list available shares.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{printable} = yes }]\null{}
The \smbconfsection{[printers]} service {\em{must}} be declared as printable. If you specify otherwise, smbd will refuse to load at startup. This parameter allows connected clients to open, write to, and submit spool files into the directory specified with the \smbconfoption{path} parameter for this service. It is used by Samba to differentiate printer shares from file shares.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{path} = /var/spool/samba }]\null{}
Must point to a directory used by Samba to spool incoming print files. {\em{It must not be the same as the spool directory specified in the configuration of your UNIX print subsystem!}} The path typically points to a directory that is world writable, with the {\em{sticky}} bit set to it.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{browseable} = no }]\null{}
Is always set to {\texttt{\docbookhyphenatedot{no}}} if \smbconfoption{printable} = yes. It makes the \smbconfsection{[printer]} share itself invisible in the list of available shares in a {\bfseries{net view}} command or in the Explorer browse list. (You will of course see the individual printers.)
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{guest ok} = yes }]\null{}
If this parameter is set to {\texttt{\docbookhyphenatedot{yes}}}, no password is required to connect to the printer's service. Access will be granted with the privileges of the \smbconfoption{guest account}. On many systems the guest account will map to a user named "nobody." This user will usually be found in the UNIX passwd file with an empty password, but with no valid UNIX login. On some systems the guest account might not have the privilege to be able to print. Test this by logging in as your guest user using {\bfseries{su - guest}} and run a system print command like:

{\ttfamily\bfseries{\docbookhyphenatedot{lpr -\dbz{}P printername /\dbz{}etc/\dbz{}motd}}}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{public} = yes }]\null{}
Is a synonym for \smbconfoption{guest ok} = yes. Since we have \smbconfoption{guest ok} = yes, it really does not need to be here. (This leads to the interesting question, {``}What if I by accident have two contradictory settings for the same share?{''} The answer is that the last one encountered by Samba wins. {\bfseries{testparm}} does not complain about different settings of the same parameter for the same share. You can test this by setting up multiple lines for the {\ttfamily\itshape{\docbookhyphenatedot{guest account}}} parameter with different usernames, and then run testparm to see which one is actually used by Samba.)
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{read only} = yes }]\null{}
Normally (for other types of shares) prevents users from creating or modifying files in the service's directory. However, in a {\em{printable}} service, it is {\em{always}} allowed to write to the directory (if user privileges allow the connection), but only via print spooling operations. Normal write operations are not permitted.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{writable} = no }]\null{}
Is a synonym for \smbconfoption{read only} = yes.
\end{description}
\subsubsection{Any [my\_printer\_name] Section}
\label{id2582031}\hypertarget{id2582031}{}%

\index{loading printer drivers} \index{name conflict} If a {\ttfamily\itshape{\docbookhyphenatedot{[my\_printer\_name]}}} section appears in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, which includes the parameter \smbconfoption{printable} = yes Samba will configure it as a printer share. Windows 9x/Me clients may have problems with connecting or loading printer drivers if the share name has more than eight characters. Do not name a printer share with a name that may conflict with an existing user or file share name. On client connection requests, Samba always tries to find file shares with that name first. If it finds one, it will connect to this and will not connect to a printer with the same name!
\newpage 
\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{comment} = Printer with Restricted Access }]\null{}
The comment says it all.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{path} = /var/spool/samba\_my\_printer }]\null{}
Sets the spooling area for this printer to a directory other than the default. It is not necessary to set it differently, but the option is available.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{printer admin} = kurt }]\null{}
The printer admin definition is different for this explicitly defined printer share from the general \smbconfsection{[printers]} share. It is not a requirement; we did it to show that it is possible.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{browseable} = yes }]\null{}
This makes the printer browseable so the clients may conveniently find it when browsing the {\sffamily \bfseries Network Neighborhood}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{printable} = yes }]\null{}
See \hyperlink{ptrsect}{Section {\ref{ptrsect}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{writable} = no }]\null{}
See \hyperlink{ptrsect}{Section {\ref{ptrsect}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{hosts allow} = 10.160.50.,10.160.51. }]\null{}
Here we exercise a certain degree of access control by using the \smbconfoption{hosts allow} and \smbconfoption{hosts deny} parameters. This is not by any means a safe bet. It is not a way to secure your printers. This line accepts all clients from a certain subnet in a first evaluation of access control.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{hosts deny} = turbo\_xp,10.160.50.23,10.160.51.60 }]\null{}
All listed hosts are not allowed here (even if they belong to the allowed subnets). As you can see, you could name IP addresses as well as NetBIOS hostnames here.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{guest ok} = no }]\null{}
This printer is not open for the guest account.
\end{description}
\subsubsection{Print Commands}
\label{id2582244}\hypertarget{id2582244}{}%

\index{print command} \index{print subsystem} \index{temporary location} \index{shell scripts} In each section defining a printer (or in the \smbconfsection{[printers]} section), a {\ttfamily\itshape{\docbookhyphenatedot{print command}}} parameter may be defined. It sets a command to process the files that have been placed into the Samba print spool directory for that printer. (That spool directory was, if you remember, set up with the \smbconfoption{path} parameter). Typically, this command will submit the spool file to the Samba host's print subsystem, using the suitable system print command. But there is no requirement that this needs to be the case. For debugging or some other reason, you may want to do something completely different than print the file. An example is a command that just copies the print file to a temporary location for further investigation when you need to debug printing. If you craft your own print commands (or even develop print command shell scripts), make sure you pay attention to the need to remove the files from the Samba spool directory. Otherwise, your hard disk may soon suffer from shortage of free space.
\subsubsection{Default UNIX System Printing Commands}
\label{id2582308}\hypertarget{id2582308}{}%

\index{default print command} You learned earlier that Samba, in most cases, uses its built-in settings for many parameters if it cannot find an explicitly stated one in its configuration file. The same is true for the \smbconfoption{print command}. The default print command varies depending on the \smbconfoption{printing} parameter setting. In the commands listed in \hyperlink{printOptions}{Table {\ref{printOptions}}} , you will notice some parameters of the form {\em{\%X}} where {\em{X}} is {\em{p, s, J}}, and so on. These letters stand for printer name, spool file, and job ID, respectively. They are explained in more detail in \hyperlink{printOptions}{Table {\ref{printOptions}}} presents an overview of key printing options but excludes the special case of CUPS, is discussed in \hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{printOptions}{}%
\captionswapskip{}{{\caption{Default Printing Settings}\label{printOptions}}}
\captionswapskip{}\begin{tabular}{|l|l|}
\hline 
{{{\bfseries Setting}}} & {{{\bfseries Default Printing Commands}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = bsd\docbooktolatexpipe{}aix\docbooktolatexpipe{}lprng\docbooktolatexpipe{}plp}} & {{print command is {\bfseries{lpr -r -P\%p \%s}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = sysv\docbooktolatexpipe{}hpux}} & {{print command is {\bfseries{lp -c -P\%p \%s; rm \%s}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = qnx}} & {{print command is {\bfseries{lp -r -P\%p -s \%s}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = bsd\docbooktolatexpipe{}aix\docbooktolatexpipe{}lprng\docbooktolatexpipe{}plp}} & {{lpq command is {\bfseries{lpq -P\%p}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = sysv\docbooktolatexpipe{}hpux}} & {{lpq command is {\bfseries{lpstat -o\%p}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = qnx}} & {{lpq command is {\bfseries{lpq -P\%p}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = bsd\docbooktolatexpipe{}aix\docbooktolatexpipe{}lprng\docbooktolatexpipe{}plp}} & {{lprm command is {\bfseries{lprm -P\%p \%j}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = sysv\docbooktolatexpipe{}hpux}} & {{lprm command is {\bfseries{cancel \%p-\%j}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = qnx}} & {{lprm command is {\bfseries{cancel \%p-\%j}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = bsd\docbooktolatexpipe{}aix\docbooktolatexpipe{}lprng\docbooktolatexpipe{}plp}} & {{lppause command is {\bfseries{lp -i \%p-\%j -H hold}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = sysv\docbooktolatexpipe{}hpux}} & {{lppause command (...is empty)}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = qnx}} & {{lppause command (...is empty)}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = bsd\docbooktolatexpipe{}aix\docbooktolatexpipe{}lprng\docbooktolatexpipe{}plp}} & {{lpresume command is {\bfseries{lp -i \%p-\%j -H resume}}}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = sysv\docbooktolatexpipe{}hpux}} & {{lpresume command (...is empty)}} \tabularnewline
 \hline 
{{\smbconfoption{printing} = qnx}} & {{lpresume command (...is empty)}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


\index{CUPS API} \index{cupsd.conf} \index{autogenerated printcap} \index{libcups} For {\ttfamily\itshape{\docbookhyphenatedot{printing = CUPS}}}, if Samba is compiled against libcups, it uses the CUPS API to submit jobs. (It is a good idea also to set \smbconfoption{printcap} = cups in case your {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} is set to write its autogenerated printcap file to an unusual place). Otherwise, Samba maps to the System V printing commands with the -oraw option for printing; that is, it uses {\bfseries{lp -c -d\%p -oraw; rm \%s}}. With {\ttfamily\itshape{\docbookhyphenatedot{printing = cups}}}, and if Samba is compiled against libcups, any manually set print command will be ignored!
\subsubsection{Custom Print Commands}
\label{id2582715}\hypertarget{id2582715}{}%

\index{print job} \index{spooling} After a print job has finished spooling to a service, the \smbconfoption{print command} will be used by Samba via a system() call to process the spool file. Usually the command specified will submit the spool file to the host's printing subsystem. But there is no requirement at all that this must be the case. The print subsystem may not remove the spool file on its own, so whatever command you specify, you should ensure that the spool file is deleted after it has been processed.

\index{traditional printing} \index{customized print commands} \index{built-in commands} \index{macros} There is no difficulty with using your own customized print commands with the traditional printing systems. However, if you do not wish to roll your own, you should be well informed about the default built-in commands that Samba uses for each printing subsystem (see \hyperlink{printOptions}{Table {\ref{printOptions}}}). In all the commands listed in the last paragraphs, you see parameters of the form {\em{\%X}}. These are {\em{macros}}, or shortcuts, used as placeholders for the names of real objects. At the time of running a command with such a placeholder, Samba will insert the appropriate value automatically. Print commands can handle all Samba macro substitutions. In regard to printing, the following ones do have special relevance:

\begin{itemize}
%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{\%s, \%f}}} ---  the path to the spool file name.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{\%p}}} ---  the appropriate printer name.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{\%J}}} ---  the job name as transmitted by the client.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{\%c}}} ---  the number of printed pages of the spooled job (if known).


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{\%z}}} ---  the size of the spooled print job (in bytes).

\end{itemize}

\index{default printer} The print command must contain at least one occurrence of {\ttfamily\itshape{\docbookhyphenatedot{\%s}}} or {\ttfamily\itshape{\docbookhyphenatedot{\%f}}}. The {\ttfamily\itshape{\docbookhyphenatedot{\%p}}} is optional. If no printer name is supplied, the {\ttfamily\itshape{\docbookhyphenatedot{\%p}}} will be silently removed from the print command. In this case, the job is sent to the default printer.

\index{global print command} \index{spool files} If specified in the \smbconfsection{[global]} section, the print command given will be used for any printable service that does not have its own print command specified. If there is neither a specified print command for a printable service nor a global print command, spool files will be created but not processed! Most importantly, print files will not be removed, so they will consume disk space.

\index{nobody account} \index{guest account} Printing may fail on some UNIX systems when using the {\em{nobody}} account. If this happens, create an alternative guest account and give it the privilege to print. Set up this guest account in the \smbconfsection{[global]} section with the {\ttfamily\itshape{\docbookhyphenatedot{guest account}}} parameter.

\index{environment variables} \index{print commands} \index{print job} You can form quite complex print commands. You need to realize that print commands are just passed to a UNIX shell. The shell is able to expand the included environment variables as usual. (The syntax to include a UNIX environment variable {\ttfamily\itshape{\docbookhyphenatedot{\$variable}}} in the Samba print command is {\ttfamily\itshape{\docbookhyphenatedot{\%\$variable}}}.) To give you a working \smbconfoption{print command} example, the following will log a print job to {\texttt{\docbookhyphenatefilename{/\dbz{}tmp/\dbz{}print.\dbz{}log}}}, print the file, then remove it. The semicolon ({``};{''} is the usual separator for commands in shell scripts:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	print command = echo Printing %s >> /tmp/print.log; lpr -P %p %s; rm %s
\end{lstlisting}


You may have to vary your own command considerably from this example depending on how you normally print files on your system. The default for the \smbconfoption{print command} parameter varies depending on the setting of the \smbconfoption{printing} parameter. Another example is:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	print command = /usr/local/samba/bin/myprintscript %p %s
\end{lstlisting}


% ------------------------   
% Section 
\section{Printing Developments Since Samba-2.2}
\label{cups-msrpc}\hypertarget{cups-msrpc}{}%

\index{LanMan} \index{MS-RPC} \index{SPOOLSS} Prior to Samba-2.2.x, print server support for Windows clients was limited to {\em{LanMan}} printing calls. This is the same protocol level as Windows 9x/Me PCs offer when they share printers. Beginning with the 2.2.0 release, Samba started to support the native Windows NT printing mechanisms. These are implemented via {\em{MS-RPC}} (Remote Procedure Calls). MS-RPCs use the {\em{SPOOLSS}} named pipe for all printing.

The additional functionality provided by the new SPOOLSS support includes:

\begin{itemize}
%--- Item
\item 
\index{Point'n'Print} Support for downloading printer driver files to Windows 95/98/NT/2000 clients upon demand ({\em{Point'n'Print}}).


%--- Item
\item 
\index{Add Printer Wizard} Uploading of printer drivers via the Windows NT {\em{Add Printer Wizard}} (APW) or the Imprints\label{id2583126}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://imprints.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2583126} tool set.


%--- Item
\item 
\index{MS-RPC} \index{printing calls} \index{StartDocPrinter} \index{EnumJobs()} \index{Win32 printing API} Support for the native MS-RPC printing calls such as StartDocPrinter, EnumJobs(), and so on. (See the MSDN documentation\label{id2583170}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://msdn.microsoft.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2583170} for more information on the Win32 printing API).


%--- Item
\item 
\index{ACL} \index{printer objects} Support for NT Access Control Lists (ACL) on printer objects.


%--- Item
\item 
\index{printer queue} Improved support for printer queue manipulation through the use of internal databases for spooled job information (implemented by various {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files).

\end{itemize}

\index{ADS} \index{LDAP} A benefit of updating is that Samba-3 is able to publish its printers to Active Directory (or LDAP).

\index{publish printers} A fundamental difference exists between MS Windows NT print servers and Samba operation. Windows NT permits the installation of local printers that are not shared. This is an artifact of the fact that any Windows NT machine (server or client) may be used by a user as a workstation. Samba will publish all printers that are made available, either by default or by specific declaration via printer-specific shares.

\index{SMB} \index{MS-RPC} \index{Everyone group} \index{privileges} \index{printer default permissions} Windows NT/200x/XP Professional clients do not have to use the standard SMB printer share; they can print directly to any printer on another Windows NT host using MS-RPC. This, of course, assumes that the client has the necessary privileges on the remote host that serves the printer resource. The default permissions assigned by Windows NT to a printer gives the print permissions to the well-known {\em{Everyone}} group. (The older clients of type Windows 9x/Me can only print to shared printers.)
\subsection{Point'n'Print Client Drivers on Samba Servers}
\label{id2583294}\hypertarget{id2583294}{}%

\index{printer drivers} There is much confusion about what all this means. The question is often asked, {``}Is it or is it not necessary for printer drivers to be installed on a Samba host in order to support printing from Windows clients?{''} The answer to this is no, it is not necessary.

\index{install drivers} \index{print queue} Windows NT/2000 clients can, of course, also run their APW to install drivers {\em{locally}} (which then connect to a Samba-served print queue). This is the same method used by Windows 9x/Me clients. (However, a bug existed in Samba 2.2.0 that made Windows NT/2000 clients require that the Samba server possess a valid driver for the printer. This was fixed in Samba 2.2.1).

\index{printer drivers} \index{uploading} But it is a new capability to install the printer drivers into the \smbconfsection{[print\$]} share of the Samba server, and a big convenience, too. Then {\em{all}} clients (including 95/98/ME) get the driver installed when they first connect to this printer share. The {\em{uploading}} or {\em{depositing}} of the driver into this \smbconfsection{[print\$]} share and the following binding of this driver to an existing Samba printer share can be achieved by different means:

\begin{itemize}
%--- Item
\item 
Running the {\em{APW}} on an NT/200x/XP Professional client (this does not work from 95/98/ME clients).


%--- Item
\item 
Using the {\em{Imprints}} toolset.


%--- Item
\item 
Using the {\em{smbclient}} and {\em{rpcclient}} command-line tools.


%--- Item
\item 
Using {\em{cupsaddsmb}} (only works for the CUPS printing system, not for LPR/LPD, LPRng, and so on).

\end{itemize}

\index{uploaded drivers} \index{Point'n'Print} Samba does not use these uploaded drivers in any way to process spooled files. These drivers are utilized entirely by the clients who download and install them via the {``}Point'n'Print{''} mechanism supported by Samba. The clients use these drivers to generate print files in the format the printer (or the UNIX print system) requires. Print files received by Samba are handed over to the UNIX printing system, which is responsible for all further processing, as needed.
\subsection{The Obsoleted [printer\$] Section}
\label{id2583450}\hypertarget{id2583450}{}%

\index{printer\$ share} \index{printer driver} Versions of Samba prior to 2.2 made it possible to use a share named {\ttfamily\itshape{\docbookhyphenatedot{[printer\$]}}}. This name was taken from the same named service created by Windows 9x/Me clients when a printer was shared by them. Windows 9x/Me printer servers always have a \smbconfsection{[printer\$]} service that provides read-only access (with no password required) to support printer driver downloads. However, Samba's initial implementation allowed for a parameter named {\ttfamily\itshape{\docbookhyphenatedot{printer driver location}}} to be used on a per-share basis. This specified the location of the driver files associated with that printer. Another parameter named {\ttfamily\itshape{\docbookhyphenatedot{printer driver}}} provided a means of defining the printer driver name to be sent to the client.

\index{printer driver file} \index{read-write access} \index{ACLs} These parameters, including the {\ttfamily\itshape{\docbookhyphenatedot{printer driver file}}} parameter, are now removed and cannot be used in installations of Samba-3. The share name \smbconfsection{[print\$]} is now used for the location of downloadable printer drivers. It is taken from the \smbconfsection{[print\$]} service created by Windows NT PCs when a printer is shared by them. Windows NT print servers always have a \smbconfsection{[print\$]} service that provides read-write access (in the context of its ACLs) to support printer driver downloads and uploads. This does not mean Windows 9x/Me clients are now thrown aside. They can use Samba's \smbconfsection{[print\$]} share support just fine.
\subsection{Creating the [print\$] Share}
\label{id2583558}\hypertarget{id2583558}{}%

\index{printer driver} In order to support the uploading and downloading of printer driver files, you must first configure a file share named \smbconfsection{[print\$]}. The public name of this share is hard coded in the MS Windows clients. It cannot be renamed, since Windows clients are programmed to search for a service of exactly this name if they want to retrieve printer driver files.

You should modify the server's file to add the global parameters and create the \smbconfsection{[print\$]} file share (of course, some of the parameter values, such as \smbconfoption{path}, are arbitrary and should be replaced with appropriate values for your site). See \hyperlink{prtdollar}{Example {\ref{prtdollar}}}.

\begin{example}%
\hypertarget{prtdollar}{}%
\captionswapskip{}{{\caption{[print\$] Example}\label{prtdollar}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 # members of the ntadmin group should be able to add drivers and set
 # printer properties. root is implicitly always a 'printer admin'.
 	printer admin = @ntadmin
 # ...
 [printers]
 # ...
 [print$]
 	comment = Printer Driver Download Area
 	path = /etc/samba/drivers
 	browseable = yes
 	guest ok = yes
 	read only = yes
 	write list = @ntadmin, root
\end{lstlisting}
\end{example}


Of course, you also need to ensure that the directory named by the \smbconfoption{path} parameter exists on the UNIX file system.
\subsection{[print\$] Stanza Parameters}
\label{id2583691}\hypertarget{id2583691}{}%

\index{special section} \index{special stanza} \index{potential printer} \index{driver download} \index{local print driver} The \smbconfsection{[print\$]} is a special section in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. It contains settings relevant to potential printer driver download and is used by Windows clients for local print driver installation. The following parameters are frequently needed in this share section:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{comment} = Printer Driver Download Area }]\null{}
The comment appears next to the share name if it is listed in a share list (usually Windows clients will not see it, but it will also appear up in a {\bfseries{smbclient -L sambaserver}} output).
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{path} = /etc/samba/printers }]\null{}
The path to the location of the Windows driver file deposit from the UNIX point of view.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{browseable} = no }]\null{}
Makes the \smbconfsection{[print\$]} share invisible to clients from the {\sffamily \bfseries Network Neighborhood}. By excuting from a {\bfseries{cmd}} shell: \null{}
\begin{Verbatim}[]

C:\>  net use g:\\sambaserver\print$

\end{Verbatim}
 you can still mount it from any client. This can also be done from the {\sffamily \bfseries Connect network drive menu\textgreater{}} from Windows Explorer.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{guest ok} = yes }]\null{}
Gives read-only access to this share for all guest users. Access may be granted to download and install printer drivers on clients. The requirement for {\ttfamily\itshape{\docbookhyphenatedot{guest ok = yes}}} depends on how your site is configured. If users will be guaranteed to have an account on the Samba host, then this is a non-issue.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

If all your Windows NT users are guaranteed to be authenticated by the Samba server (for example, if Samba authenticates via an NT domain server and the user has already been validated by the domain controller in order to log on to the Windows NT session), then guest access is not necessary. Of course, in a workgroup environment where you just want to print without worrying about silly accounts and security, then configure the share for guest access. You should consider adding \smbconfoption{map to guest} = Bad	User in the \smbconfsection{[global]} section as well. Make sure you understand what this parameter does before using it.
\end{admonition}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{read only} = yes }]\null{}
Because we do not want everybody to upload driver files (or even change driver settings), we tagged this share as not writable.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{write list} = @ntadmin, root }]\null{}
The \smbconfsection{[print\$]} was made read-only by the previous setting so we should create a {\ttfamily\itshape{\docbookhyphenatedot{write list}}} entry also. UNIX groups are denoted with a leading {``}@{''} character. Users listed here are allowed write-access (as an exception to the general public's read-only access), which they need to update files on the share. Normally, you will want to name only administrative-level user account in this setting. Check the file system permissions to make sure these accounts can copy files to the share. If this is a non-root account, then the account should also be mentioned in the global \smbconfoption{printer admin} parameter. See the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for more information on configuring file shares.
\end{description}
\subsection{The [print\$] Share Directory}
\label{id2583958}\hypertarget{id2583958}{}%

In order for a Windows NT print server to support the downloading of driver files by multiple client architectures, you must create several subdirectories within the \smbconfsection{[print\$]} service (i.e., the UNIX directory named by the \smbconfoption{path} parameter). These correspond to each of the supported client architectures. Samba follows this model as well. Just like the name of the \smbconfsection{[print\$]} share itself, the subdirectories must be exactly the names listed below (you may leave out the subdirectories of architectures you do not need to support).

Therefore, create a directory tree below the \smbconfsection{[print\$]} share for each architecture you wish to support like this: 
\begin{Verbatim}[]

[print$]--+
          |--W32X86           # serves drivers to Windows NT x86
          |--WIN40            # serves drivers to Windows 95/98
          |--W32ALPHA         # serves drivers to Windows NT Alpha_AXP
          |--W32MIPS          # serves drivers to Windows NT R4000
          |--W32PPC           # serves drivers to Windows NT PowerPC

\end{Verbatim}


\begin{admonition}{xslt/figures/important}{Required Permissions}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

In order to add a new driver to your Samba host, one of two conditions must hold true:

\begin{itemize}
%--- Item
\item 
The account used to connect to the Samba host must have a UID of 0 (i.e., a root account).


%--- Item
\item 
The account used to connect to the Samba host must be named in the {\em{printer admin}} list.

\end{itemize}

Of course, the connected account must still have write access to add files to the subdirectories beneath \smbconfsection{[print\$]}. Remember that all file shares are set to {``}read-only{''} by default.
\end{admonition}


Once you have created the required \smbconfsection{[print\$]} service and associated subdirectories, go to a Windows NT 4.0/200x/XP client workstation. Open {\sffamily \bfseries Network Neighborhood} or {\sffamily \bfseries My Network Places} and browse for the Samba host. Once you have located the server, navigate to its {\sffamily \bfseries Printers and Faxes} folder. You should see an initial listing of printers that matches the printer shares defined on your Samba host.

% ------------------------   
% Section 
\section{Installing Drivers into [print\$]}
\label{id2584093}\hypertarget{id2584093}{}%

Have you successfully created the \smbconfsection{[print\$]} share in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}, and have you forced Samba to reread its {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file? Good. But you are not yet ready to use the new facility. The client driver files need to be installed into this share. So far, it is still an empty share. Unfortunately, it is not enough to just copy the driver files over. They need to be correctly installed so that appropriate records for each driver will exist in the Samba internal databases so it can provide the correct drivers as they are requested from MS Windows clients. And that is a bit tricky, to say the least. We now discuss two alternative ways to install the drivers into \smbconfsection{[print\$]}:

\begin{itemize}
%--- Item
\item 
Using the Samba command-line utility {\bfseries{rpcclient}} with its various subcommands (here, {\bfseries{adddriver}} and {\bfseries{setdriver}}) from any UNIX workstation.


%--- Item
\item 
Running a GUI ({\sffamily \bfseries Printer Properties} and {\sffamily \bfseries Add Printer Wizard}) from any Windows NT/200x/XP client workstation.

\end{itemize}

The latter option is probably the easier one (even if the process may seem a little bit weird at first).
\subsection{Add Printer Wizard Driver Installation}
\label{id2584186}\hypertarget{id2584186}{}%

The printers initially listed in the Samba host's {\sffamily \bfseries Printers} folder accessed from a client's Explorer will have no real printer driver assigned to them. By default this driver name is set to a null string. This must be changed now. The local {\sffamily \bfseries Add Printer Wizard} (APW), run from NT/2000/XP clients, will help us in this task.

Installation of a valid printer driver is not straightforward. You must attempt to view the printer properties for the printer to which you want the driver assigned. Open Windows Explorer, open {\sffamily \bfseries Network Neighborhood}, browse to the Samba host, open Samba's {\sffamily \bfseries Printers} folder, right-click on the printer icon, and select {\sffamily \bfseries Properties...}. You are now trying to view printer and driver properties for a queue that has this default {\texttt{\docbookhyphenatedot{NULL}}} driver assigned. This will result in the following error message: {``}Device settings cannot be displayed. The driver for the specified printer is not installed, only spooler properties will be displayed. Do you want to install the driver now?{''}

Do {\em{not}} click on {\sffamily \bfseries Yes}! Instead, click on {\sffamily \bfseries No} in the error dialog. Now you will be presented with the printer properties window. From here, the way to assign a driver to a printer is open. You now have the choice of:

\begin{itemize}
%--- Item
\item 
Select a driver from the pop-up list of installed drivers. Initially this list will be empty.


%--- Item
\item 
Click on {\sffamily \bfseries New Driver} to install a new printer driver (which will start up the APW).

\end{itemize}

Once the APW is started, the procedure is exactly the same as the one you are familiar with in Windows (we assume here that you are familiar with the printer driver installations procedure on Windows NT). Make sure your connection is, in fact, set up as a user with \smbconfoption{printer admin} privileges (if in doubt, use {\bfseries{smbstatus}} to check for this). If you wish to install printer drivers for client operating systems other than Windows NT x86, you will need to use the {\sffamily \bfseries Sharing} tab of the printer properties dialog.

Assuming you have connected with an administrative (or root) account (as named by the \smbconfoption{printer admin} parameter), you will also be able to modify other printer properties such as ACLs and default device settings using this dialog. For the default device settings, please consider the advice given further in \hyperlink{inst-rpc}{Section {\ref{inst-rpc}}}.
\subsection{Installing Print Drivers Using rpcclient}
\label{inst-rpc}\hypertarget{inst-rpc}{}%

The second way to install printer drivers into \smbconfsection{[print\$]} and set them up in a valid way is to do it from the UNIX command line. This involves four distinct steps:

\begin{enumerate}
%--- Item
\item 
Gather information about required driver files and collect the files.


%--- Item
\item 
Deposit the driver files into the \smbconfsection{[print\$]} share's correct subdirectories (possibly by using {\bfseries{smbclient}}).


%--- Item
\item 
Run the {\bfseries{rpcclient}} command-line utility once with the {\bfseries{adddriver}} subcommand.


%--- Item
\item 
Run {\bfseries{rpcclient}} a second time with the {\bfseries{setdriver}} subcommand.

\end{enumerate}

We provide detailed hints for each of these steps in the paragraphs that follow.
\subsubsection{Identifying Driver Files}
\label{id2584451}\hypertarget{id2584451}{}%

\index{driver files} \index{driver CDROM} \index{inf file} To find out about the driver files, you have two options. You can check the contents of the driver CDROM that came with your printer. Study the {\texttt{\docbookhyphenatefilename{*.\dbz{}inf}}} files located on the CD-ROM. This may not be possible, since the {\texttt{\docbookhyphenatefilename{*.\dbz{}inf}}} file might be missing. Unfortunately, vendors have now started to use their own installation programs. These installations packages are often in some Windows platform archive format. Additionally, the files may be re-named during the installation process. This makes it extremely difficult to identify the driver files required.

\index{W32X86} Then you have the second option. Install the driver locally on a Windows client and investigate which filenames and paths it uses after they are installed. (You need to repeat this procedure for every client platform you want to support. We show it here for the W32X86 platform only, a name used by Microsoft for all Windows NT/200x/XP clients.)

\index{driver files} A good method to recognize the driver files is to print the test page from the driver's {\sffamily \bfseries Properties} dialog ({\sffamily \bfseries General} tab). Then look at the list of driver files named on the printout. You'll need to recognize what Windows (and Samba) are calling the {\sffamily \bfseries Driver File}, {\sffamily \bfseries Data File}, {\sffamily \bfseries Config File}, {\sffamily \bfseries Help File}, and (optionally) {\sffamily \bfseries Dependent Driver Files} (this may vary slightly for Windows NT). You need to note all filenames for the next steps.

\index{rpcclient} \index{enumdrivers} \index{getdriver} Another method to quickly test the driver filenames and related paths is provided by the {\bfseries{rpcclient}} utility. Run it with {\bfseries{enumdrivers}} or with the {\bfseries{getdriver}} subcommand, each at the {\texttt{\docbookhyphenatefilename{3}}} info level. In the following example, {\em{TURBO\_XP}} is the name of the Windows PC (in this case it was a Windows XP Professional laptop). I installed the driver locally to TURBO\_XP from a Samba server called {\texttt{\docbookhyphenatedot{KDE-BITSHOP}}}. We could run an interactive {\bfseries{rpcclient}} session; then we would get an {\bfseries{rpcclient /\textgreater{}}} prompt and would type the subcommands at this prompt. This is left as a good exercise for you. For now, we use {\bfseries{rpcclient}} with the {\texttt{\docbookhyphenatedot{-c}}} parameter to execute a single subcommand line and exit again. This is the method you use if you want to create scripts to automate the procedure for a large number of printers and drivers. Note the different quotation marks used to overcome the different spaces between words:


\begin{Verbatim}[]

root# rpcclient -U'Danka%xxxx' -c \
	'getdriver "Heidelberg Digimaster 9110 (PS)" 3' TURBO_XP
cmd = getdriver "Heidelberg Digimaster 9110 (PS)" 3

[Windows NT x86]
Printer Driver Info 3:
  Version: [2]
  Driver Name: [Heidelberg Digimaster 9110 (PS)]
  Architecture: [Windows NT x86]
  Driver Path: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.DLL]
  Datafile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.ppd]
  Configfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.DLL]
  Helpfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01U_de.HLP]
  
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.DLL]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.INI]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.dat]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.cat]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.def]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hre]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.vnd]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\Hddm91c1_de.hlp]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01Aux.dll]
  Dependentfiles: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\HDNIS01_de.NTF]
  
  Monitorname: []
  Defaultdatatype: []

\end{Verbatim}


\index{Driver File} \index{Driver Path} \index{WIN40} \index{W32X86} You may notice that this driver has quite a large number of {\sffamily \bfseries Dependent files} (there are worse cases, however). Also, strangely, the {\sffamily \bfseries Driver File} is tagged here {\sffamily \bfseries Driver Path}. We do not yet have support for the so-called WIN40 architecture installed. This name is used by Microsoft for the Windows 9x/Me platforms. If we want to support these, we need to install the Windows 9x/Me driver files in addition to those for W32X86 (i.e., the Windows NT 2000/XP clients) onto a Windows PC. This PC can also host the Windows 9x/Me drivers, even if it runs on Windows NT, 2000, or XP.

\index{UNC notation} \index{Windows Explorer} \index{} Since the \smbconfsection{[print\$]} share is usually accessible through the {\sffamily \bfseries Network Neighborhood}, you can also use the UNC notation from Windows Explorer to poke at it. The Windows 9x/Me driver files will end up in subdirectory {\texttt{\docbookhyphenatefilename{0}}} of the {\texttt{\docbookhyphenatefilename{WIN40}}} directory. The full path to access them is {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\WINDOWSHOST\docbooktolatexgobble\string\\print\$\docbooktolatexgobble\string\\WIN40\docbooktolatexgobble\string\\0\docbooktolatexgobble\string\\}}}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

More recent drivers on Windows 2000 and Windows XP are installed into the {``}3{''} subdirectory instead of the {``}2{''}. The version 2 of drivers, as used in Windows NT, were running in kernel mode. Windows 2000 changed this. While it still can use the kernel mode drivers (if this is enabled by the Admin), its native mode for printer drivers is user mode execution. This requires drivers designed for this purpose. These types of drivers install into the {``}3{''} subdirectory.
\end{admonition}

\subsubsection{Obtaining Driver Files from Windows Client [print\$] Shares}
\label{id2584866}\hypertarget{id2584866}{}%

Now we need to collect all the driver files we identified in our previous step. Where do we get them from? Well, why not retrieve them from the very PC and the same \smbconfsection{[print\$]} share that we investigated in our last step to identify the files? We can use {\bfseries{smbclient}} to do this. We will use the paths and names that were leaked to us by {\bfseries{getdriver}}. The listing is edited to include line breaks for readability: 
\begin{Verbatim}[]

root# smbclient //TURBO_XP/print\$ -U'Danka%xxxx' \ 
   -c 'cd W32X86/2;mget HD*_de.* hd*ppd Hd*_de.* Hddm*dll HDN*Aux.DLL'

added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
Got a positive name query response from 10.160.50.8 ( 10.160.50.8 )
Domain=[DEVELOPMENT] OS=[Windows 5.1] Server=[Windows 2000 LAN Manager]
Get file Hddm91c1_de.ABD? n
Get file Hddm91c1_de.def? y
getting file \W32X86\2\Hddm91c1_de.def of size 428 as Hddm91c1_de.def
Get file Hddm91c1_de.DLL? y
getting file \W32X86\2\Hddm91c1_de.DLL of size 876544 as Hddm91c1_de.DLL
[...]

\end{Verbatim}


After this command is complete, the files are in our current local directory. You probably have noticed that this time we passed several commands to the {\texttt{\docbookhyphenatedot{-c}}} parameter, separated by semicolons. This ensures that all commands are executed in sequence on the remote Windows server before {\bfseries{smbclient}} exits again.

\index{WIN40} Remember to repeat the procedure for the WIN40 architecture should you need to support Windows 9x/Me/XP clients. Remember too, the files for these architectures are in the {\texttt{\docbookhyphenatefilename{WIN40/\dbz{}0/\dbz{}}}} subdirectory. Once this is complete, we can run {\bfseries{smbclient. . .put}} to store the collected files on the Samba server's \smbconfsection{[print\$]} share.
\subsubsection{Installing Driver Files into [print\$]}
\label{id2585012}\hypertarget{id2585012}{}%

We are now going to locate the driver files into the \smbconfsection{[print\$]} share. Remember, the UNIX path to this share has been defined previously in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. You also have created subdirectories for the different Windows client types you want to support. If, for example, your \smbconfsection{[print\$]} share maps to the UNIX path {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}drivers/\dbz{}}}}, your driver files should now go here:

\begin{itemize}
%--- Item
\item 
For all Windows NT, 2000, and XP clients, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}drivers/\dbz{}W32X86/\dbz{}}}} but not (yet) into the {\texttt{\docbookhyphenatefilename{2}}} subdirectory.


%--- Item
\item 
For all Windows 95, 98, and Me clients, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}drivers/\dbz{}WIN40/\dbz{}}}} but not (yet) into the {\texttt{\docbookhyphenatefilename{0}}} subdirectory.

\end{itemize}

\index{smbclient} \index{getdriver} We again use smbclient to transfer the driver files across the network. We specify the same files and paths as were leaked to us by running {\bfseries{getdriver}} against the original {\em{Windows}} install. However, now we are going to store the files into a {\em{Samba/UNIX}} print server's \smbconfsection{[print\$]} share. 
\begin{Verbatim}[]

root# smbclient //SAMBA-CUPS/print\$ -U'root%xxxx' -c \
  'cd W32X86; put HDNIS01_de.DLL; \
  put Hddm91c1_de.ppd; put HDNIS01U_de.DLL;        \
  put HDNIS01U_de.HLP; put Hddm91c1_de.DLL;        \
  put Hddm91c1_de.INI; put Hddm91c1KMMin.DLL;      \
  put Hddm91c1_de.dat; put Hddm91c1_de.dat;        \
  put Hddm91c1_de.def; put Hddm91c1_de.hre;        \
  put Hddm91c1_de.vnd; put Hddm91c1_de.hlp;        \
  put Hddm91c1_de_reg.HLP; put HDNIS01Aux.dll;     \
  put HDNIS01_de.NTF'

added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
Got a positive name query response from 10.160.51.162 ( 10.160.51.162 )
Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a]
putting file HDNIS01_de.DLL as \W32X86\HDNIS01_de.DLL
putting file Hddm91c1_de.ppd as \W32X86\Hddm91c1_de.ppd
putting file HDNIS01U_de.DLL as \W32X86\HDNIS01U_de.DLL
putting file HDNIS01U_de.HLP as \W32X86\HDNIS01U_de.HLP
putting file Hddm91c1_de.DLL as \W32X86\Hddm91c1_de.DLL
putting file Hddm91c1_de.INI as \W32X86\Hddm91c1_de.INI
putting file Hddm91c1KMMin.DLL as \W32X86\Hddm91c1KMMin.DLL
putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat
putting file Hddm91c1_de.dat as \W32X86\Hddm91c1_de.dat
putting file Hddm91c1_de.def as \W32X86\Hddm91c1_de.def
putting file Hddm91c1_de.hre as \W32X86\Hddm91c1_de.hre
putting file Hddm91c1_de.vnd as \W32X86\Hddm91c1_de.vnd
putting file Hddm91c1_de.hlp as \W32X86\Hddm91c1_de.hlp
putting file Hddm91c1_de_reg.HLP as \W32X86\Hddm91c1_de_reg.HLP
putting file HDNIS01Aux.dll as \W32X86\HDNIS01Aux.dll
putting file HDNIS01_de.NTF as \W32X86\HDNIS01_de.NTF

\end{Verbatim}
 \index{PPD} \index{PostScript driver} \index{adddriver} Whew ---  that was a lot of typing! Most drivers are a lot smaller ---  many have only three generic PostScript driver files plus one PPD. While we did retrieve the files from the {\texttt{\docbookhyphenatefilename{2}}} subdirectory of the {\texttt{\docbookhyphenatefilename{W32X86}}} directory from the Windows box, we do not put them (for now) in this same subdirectory of the Samba box. This relocation will automatically be done by the {\bfseries{adddriver}} command, which we will run shortly (and do not forget to also put the files for the Windows 9x/Me architecture into the {\texttt{\docbookhyphenatefilename{WIN40/\dbz{}}}} subdirectory should you need them).
\subsubsection{smbclient to Confirm Driver Installation}
\label{id2585231}\hypertarget{id2585231}{}%

\index{smbclient} \index{SSH} For now we verify that our files are there. This can be done with {\bfseries{smbclient}}, too (but, of course, you can log in via SSH also and do this through a standard UNIX shell access):


\begin{Verbatim}[]

root# smbclient //SAMBA-CUPS/print\$ -U 'root%xxxx' \
	-c 'cd W32X86; pwd; dir; cd 2; pwd; dir'
 added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
Got a positive name query response from 10.160.51.162 ( 10.160.51.162 )
Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.8a]

Current directory is \\SAMBA-CUPS\print$\W32X86\
.                                  D        0  Sun May  4 03:56:35 2003
..                                 D        0  Thu Apr 10 23:47:40 2003
2                                   D        0  Sun May  4 03:56:18 2003
HDNIS01Aux.dll                      A    15356  Sun May  4 03:58:59 2003
Hddm91c1KMMin.DLL                   A    46966  Sun May  4 03:58:59 2003
HDNIS01_de.DLL                      A   434400  Sun May  4 03:58:59 2003
HDNIS01_de.NTF                      A   790404  Sun May  4 03:56:35 2003
Hddm91c1_de.DLL                     A   876544  Sun May  4 03:58:59 2003
Hddm91c1_de.INI                     A      101  Sun May  4 03:58:59 2003
Hddm91c1_de.dat                     A     5044  Sun May  4 03:58:59 2003
Hddm91c1_de.def                     A      428  Sun May  4 03:58:59 2003
Hddm91c1_de.hlp                     A    37699  Sun May  4 03:58:59 2003
Hddm91c1_de.hre                     A   323584  Sun May  4 03:58:59 2003
Hddm91c1_de.ppd                     A    26373  Sun May  4 03:58:59 2003
Hddm91c1_de.vnd                     A    45056  Sun May  4 03:58:59 2003
HDNIS01U_de.DLL                     A   165888  Sun May  4 03:58:59 2003
HDNIS01U_de.HLP                     A    19770  Sun May  4 03:58:59 2003
Hddm91c1_de_reg.HLP                 A   228417  Sun May  4 03:58:59 2003
              40976 blocks of size 262144. 709 blocks available

Current directory is \\SAMBA-CUPS\print$\W32X86\2\
.                                  D        0  Sun May  4 03:56:18 2003
..                                 D        0  Sun May  4 03:56:35 2003
ADOBEPS5.DLL                        A   434400  Sat May  3 23:18:45 2003
laserjet4.ppd                       A     9639  Thu Apr 24 01:05:32 2003
ADOBEPSU.DLL                        A   109568  Sat May  3 23:18:45 2003
ADOBEPSU.HLP                        A    18082  Sat May  3 23:18:45 2003
PDFcreator2.PPD                     A    15746  Sun Apr 20 22:24:07 2003
              40976 blocks of size 262144. 709 blocks available

\end{Verbatim}


\index{Point'n'Print} \index{printer driver files} \index{print queue} Notice that there are already driver files present in the {\texttt{\docbookhyphenatefilename{2}}} subdirectory (probably from a previous installation). Once the files for the new driver are there too, you are still a few steps away from being able to use them on the clients. The only thing you could do now is retrieve them from a client just like you retrieve ordinary files from a file share, by opening print\$ in Windows Explorer. But that wouldn't install them per Point'n'Print. The reason is that Samba does not yet know that these files are something special, namely {\em{printer driver files}}, and it does not know to which print queue(s) these driver files belong.
\subsubsection{Running rpcclient with adddriver}
\label{id2585371}\hypertarget{id2585371}{}%

\index{adddriver} \index{register driver files} \index{TDB database} Next, you must tell Samba about the special category of the files you just uploaded into the \smbconfsection{[print\$]} share. This is done by the {\bfseries{adddriver}} command. It will prompt Samba to register the driver files into its internal TDB database files. The following command and its output has been edited for readability: 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'adddriver "Windows NT x86" \
  "dm9110:HDNIS01_de.DLL: \
  Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP:   \
  NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI,          \
  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,   \
  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \
  HDNIS01Aux.dll,HDNIS01_de.NTF,                     \
  Hddm91c1_de_reg.HLP' SAMBA-CUPS

cmd = adddriver "Windows NT x86" \
  "dm9110:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL:   \
  HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI, \
  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,          \
  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL,        \
  HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP"

Printer Driver dm9110 successfully installed.

\end{Verbatim}


\index{NT\_STATUS\_UNSUCCESSFUL} \index{error message} \index{adddriver} After this step, the driver should be recognized by Samba on the print server. You need to be very careful when typing the command. Don't exchange the order of the fields. Some changes would lead to an {\texttt{\docbookhyphenatedot{NT\_STATUS\_UNSUCCESSFUL}}} error message. These become obvious. Other changes might install the driver files successfully but render the driver unworkable. So take care! Hints about the syntax of the adddriver command are in the man page. provides a more detailed description, should you need it.
\subsubsection{Checking adddriver Completion}
\label{id2585497}\hypertarget{id2585497}{}%

One indication for Samba's recognition of the files as driver files is the {\texttt{\docbookhyphenatedot{successfully installed}}} message. Another one is the fact that our files have been moved by the {\bfseries{adddriver}} command into the {\texttt{\docbookhyphenatefilename{2}}} subdirectory. You can check this again with {\bfseries{smbclient}}: 
\begin{Verbatim}[]

root# smbclient //SAMBA-CUPS/print\$ -Uroot%xx \
	-c 'cd W32X86;dir;pwd;cd 2;dir;pwd'
 added interface ip=10.160.51.162 bcast=10.160.51.255 nmask=255.255.252.0
 Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a]

  Current directory is \\SAMBA-CUPS\print$\W32X86\
  .                                  D        0  Sun May  4 04:32:48 2003
  ..                                 D        0  Thu Apr 10 23:47:40 2003
  2                                   D        0  Sun May  4 04:32:48 2003
                40976 blocks of size 262144. 731 blocks available 

  Current directory is \\SAMBA-CUPS\print$\W32X86\2\
  .                                  D        0  Sun May  4 04:32:48 2003
  ..                                 D        0  Sun May  4 04:32:48 2003
  DigiMaster.PPD                      A   148336  Thu Apr 24 01:07:00 2003
  ADOBEPS5.DLL                        A   434400  Sat May  3 23:18:45 2003
  laserjet4.ppd                       A     9639  Thu Apr 24 01:05:32 2003
  ADOBEPSU.DLL                        A   109568  Sat May  3 23:18:45 2003
  ADOBEPSU.HLP                        A    18082  Sat May  3 23:18:45 2003
  PDFcreator2.PPD                     A    15746  Sun Apr 20 22:24:07 2003
  HDNIS01Aux.dll                      A    15356  Sun May  4 04:32:18 2003
  Hddm91c1KMMin.DLL                   A    46966  Sun May  4 04:32:18 2003
  HDNIS01_de.DLL                      A   434400  Sun May  4 04:32:18 2003
  HDNIS01_de.NTF                      A   790404  Sun May  4 04:32:18 2003
  Hddm91c1_de.DLL                     A   876544  Sun May  4 04:32:18 2003
  Hddm91c1_de.INI                     A      101  Sun May  4 04:32:18 2003
  Hddm91c1_de.dat                     A     5044  Sun May  4 04:32:18 2003
  Hddm91c1_de.def                     A      428  Sun May  4 04:32:18 2003
  Hddm91c1_de.hlp                     A    37699  Sun May  4 04:32:18 2003
  Hddm91c1_de.hre                     A   323584  Sun May  4 04:32:18 2003
  Hddm91c1_de.ppd                     A    26373  Sun May  4 04:32:18 2003
  Hddm91c1_de.vnd                     A    45056  Sun May  4 04:32:18 2003
  HDNIS01U_de.DLL                     A   165888  Sun May  4 04:32:18 2003
  HDNIS01U_de.HLP                     A    19770  Sun May  4 04:32:18 2003
  Hddm91c1_de_reg.HLP                 A   228417  Sun May  4 04:32:18 2003
                40976 blocks of size 262144. 731 blocks available

\end{Verbatim}


Another verification is that the timestamp of the printing TDB files is now updated (and possibly their file size has increased).
\subsubsection{Check Samba for Driver Recognition}
\label{id2585603}\hypertarget{id2585603}{}%

\index{registered} Now the driver should be registered with Samba. We can easily verify this and will do so in a moment. However, this driver is not yet associated with a particular printer. We may check the driver status of the files by at least three methods:

\begin{itemize}
%--- Item
\item 
\index{Network Neighborhood} \index{Printers and Faxes} \index{printer icon} \index{Windows95/98/ME} \index{Windows NT/2000/XP} From any Windows client browse Network Neighborhood, find the Samba host, and open the Samba {\sffamily \bfseries Printers and Faxes} folder. Select any printer icon, right-click and select the printer {\sffamily \bfseries Properties}. Click the {\sffamily \bfseries Advanced} tab. Here is a field indicating the driver for that printer. A drop-down menu allows you to change that driver (be careful not to do this unwittingly). You can use this list to view all drivers known to Samba. Your new one should be among them. (Each type of client will see only its own architecture's list. If you do not have every driver installed for each platform, the list will differ if you look at it from Windows95/98/ME or Windows NT/2000/XP.)


%--- Item
\item 
\index{Network Neighborhood} From a Windows 200x/XP client (not Windows NT) browse {\sffamily \bfseries Network Neighborhood}, search for the Samba server, open the server's {\sffamily \bfseries Printers} folder, and right-click on the white background (with no printer highlighted). Select {\sffamily \bfseries Server Properties}. On the {\sffamily \bfseries Drivers} tab you will see the new driver listed. This view enables you to also inspect the list of files belonging to that driver (this does not work on Windows NT, but only on Windows 2000 and Windows XP; Windows NT does not provide the {\sffamily \bfseries Drivers} tab). An alternative and much quicker method for Windows 2000/XP to start this dialog is by typing into a DOS box (you must of course adapt the name to your Samba server instead of {\ttfamily\itshape{\docbookhyphenatedot{SAMBA-CUPS}}}): 
\begin{Verbatim}[]

	rundll32 printui.dll,PrintUIEntry /s /t2 /n\\SAMBA-CUPS
	
\end{Verbatim}



%--- Item
\item 
From a UNIX prompt, run this command (or a variant thereof), where {\ttfamily\itshape{\docbookhyphenatedot{SAMBA-CUPS}}} is the name of the Samba host and xxxx represents the actual Samba password assigned to root: 
\begin{Verbatim}[]

	rpcclient -U'root%xxxx' -c 'enumdrivers' SAMBA-CUPS
	
\end{Verbatim}


You will see a listing of all drivers Samba knows about. Your new one should be among them. But it is only listed under the {\ttfamily\itshape{\docbookhyphenatedot{[Windows NT x86]}}} heading, not under \smbconfsection{[Windows 4.0]}, since you didn't install that part. Or did you? In our example it is named {\texttt{\docbookhyphenatedot{dm9110}}}. Note that the third column shows the other installed drivers twice, one time for each supported architecture. Our new driver only shows up for Windows NT 4.0 or 2000. To have it present for Windows 95, 98, and Me, you'll have to repeat the whole procedure with the WIN40 architecture and subdirectory.

\end{itemize}
\subsubsection{Specific Driver Name Flexibility}
\label{id2585835}\hypertarget{id2585835}{}%

\index{adddriver} You can name the driver as you like. If you repeat the {\bfseries{adddriver}} step with the same files as before but with a different driver name, it will work the same: 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx         \
  -c 'adddriver "Windows NT x86"                     \
  "mydrivername:HDNIS01_de.DLL:              \
  Hddm91c1_de.ppd:HDNIS01U_de.DLL:HDNIS01U_de.HLP:   \
  NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI,          \
  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,   \
  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL, \
  HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP' SAMBA-CUPS
  

cmd = adddriver "Windows NT x86" \
 "mydrivername:HDNIS01_de.DLL:Hddm91c1_de.ppd:HDNIS01U_de.DLL:\
  HDNIS01U_de.HLP:NULL:RAW:Hddm91c1_de.DLL,Hddm91c1_de.INI,           \
  Hddm91c1_de.dat,Hddm91c1_de.def,Hddm91c1_de.hre,                    \
  Hddm91c1_de.vnd,Hddm91c1_de.hlp,Hddm91c1KMMin.DLL,                  \
  HDNIS01Aux.dll,HDNIS01_de.NTF,Hddm91c1_de_reg.HLP"

Printer Driver mydrivername successfully installed.

\end{Verbatim}


\index{print queue} \index{rpcclient} \index{adddriver} You will be able to bind that driver to any print queue (however, you are responsible that you associate drivers to queues that make sense with respect to target printers). You cannot run the {\bfseries{rpcclient}} {\bfseries{adddriver}} command repeatedly. Each run consumes the files you had put into the \smbconfsection{[print\$]} share by moving them into the respective subdirectories, so you must execute an {\bfseries{smbclient ... put}} command before each {\bfseries{rpcclient ... adddriver}} command.
\subsubsection{Running rpcclient with setdriver}
\label{id2585951}\hypertarget{id2585951}{}%

\index{mapping printer driver} \index{TDB} Samba needs to know which printer owns which driver. Create a mapping of the driver to a printer, and store this information in Samba's memory, the TDB files. The {\bfseries{rpcclient setdriver}} command achieves exactly this: 
\begin{Verbatim}[]

root# rpcclient -U'root%xxxx' -c 'setdriver dm9110 mydrivername' SAMBA-CUPS
 cmd = setdriver dm9110 mydrivername

Successfully set dm9110 to driver mydrivername.

\end{Verbatim}


Ah, no, I did not want to do that. Repeat, this time with the name I intended: 
\begin{Verbatim}[]

root# rpcclient -U'root%xxxx' -c 'setdriver dm9110 dm9110' SAMBA-CUPS
 cmd = setdriver dm9110 dm9110
Successfully set dm9110 to driver dm9110.

\end{Verbatim}


The syntax of the command is: 
\begin{Verbatim}[]

rpcclient -U'root%sambapassword' -c 'setdriver printername \
 drivername' SAMBA-Hostname. 

\end{Verbatim}
 Now we have done most of the work, but not all of it.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The {\bfseries{setdriver}} command will only succeed if the printer is already known to Samba. A bug in 2.2.x prevented Samba from recognizing freshly installed printers. You had to restart Samba, or at least send an HUP signal to all running smbd processes to work around this: {\ttfamily\bfseries{\docbookhyphenatedot{kill -\dbz{}HUP `pidof smbd`}}}.
\end{admonition}


% ------------------------   
% Section 
\section{Client Driver Installation Procedure}
\label{id2586096}\hypertarget{id2586096}{}%

As Don Quixote said, {``}The proof of the pudding is in the eating.{''} The proof for our setup lies in the printing. So let's install the printer driver onto the client PCs. This is not as straightforward as it may seem. Read on.
\subsection{First Client Driver Installation}
\label{id2586114}\hypertarget{id2586114}{}%

Especially important is the installation onto the first client PC (for each architectural platform separately). Once this is done correctly, all further clients are easy to set up and shouldn't need further attention. What follows is a description for the recommended first procedure. You now work from a client workstation. You should check that your connection is not unwittingly mapped to {\em{bad user}} nobody. In a DOS box type:

{\ttfamily\bfseries{\docbookhyphenatedot{net use \docbooktolatexgobble\string\\\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{SAMBA-\dbz{}SERVER}}}\docbooktolatexgobble\string\\print\$ /\dbz{}user:root}}}

Replace root, if needed, by another valid \smbconfoption{printer admin} user as given in the definition. Should you already be connected as a different user, you will get an error message. There is no easy way to get rid of that connection, because Windows does not seem to know a concept of logging off from a share connection (do not confuse this with logging off from the local workstation; that is a different matter). On Windows NT/200x, you can force a logoff from all smb/cifs connections by restarting the {\em{workstation}} service. You can try to close all Windows file explorers and Internet Explorer for Windows. As a last resort, you may have to reboot. Make sure there is no automatic reconnection set up. It may be easier to go to a different workstation and try from there. After you have made sure you are connected as a printer admin user (you can check this with the {\bfseries{smbstatus}} command on Samba), do this from the Windows workstation:
\begin{enumerate}

\item{Open {\sffamily \bfseries Network Neighborhood}.}

\item{Browse to Samba server.}

\item{Open its {\sffamily \bfseries Printers and Faxes} folder.}

\item{Highlight and right-click on the printer.}

\item{Select {\sffamily \bfseries Connect} (for Windows NT4/200x it is possibly {\sffamily \bfseries Install}).}
\end{enumerate}

A new printer (named {\ttfamily\itshape{\docbookhyphenatedot{printername}}} on Samba server) should now have appeared in your {\em{local}} Printer folder (check {\sffamily \bfseries Start} -\textgreater{} {\sffamily \bfseries Settings} -\textgreater{} {\sffamily \bfseries Control Panel} -\textgreater{} {\sffamily \bfseries Printers and Faxes}).

\index{print test page} Most likely you are tempted to try to print a test page. After all, you now can open the printer properties, and on the {\sffamily \bfseries General} tab there is a button offering to do just that. But chances are that you get an error message saying "{\texttt{\docbookhyphenatedot{Unable to print Test Page}}}." The reason might be that there is not yet a valid device mode set for the driver or that the {``}printer driver data{''} set is still incomplete.

You must make sure that a valid {\ttfamily\itshape{\docbookhyphenatedot{device mode}}} is set for the driver. We now explain what that means.
\subsection{Setting Device Modes on New Printers}
\label{prt-modeset}\hypertarget{prt-modeset}{}%

For a printer to be truly usable by a Windows NT/200x/XP client, it must possess:

\begin{itemize}
%--- Item
\item 
\index{device mode} A valid {\em{device mode}} generated by the driver for the printer (defining things like paper size, orientation and duplex settings).


%--- Item
\item 
\index{printer driver data} A complete set of {\em{printer driver data}} generated by the driver.

\end{itemize}

\index{ntprinters.tdb} \index{ntdrivers.tdb} \index{printing.tdb} \index{ntforms.tdb} \index{TDB database files} If either of these is incomplete, the clients can produce less than optimal output at best. In the worst cases, unreadable garbage or nothing at all comes from the printer, or it produces a harvest of error messages when attempting to print. Samba stores the named values and all printing-related information in its internal TDB database files {\texttt{\docbookhyphenatefilename{(\dbz{}ntprinters.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{ntdrivers.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{printing.\dbz{}tdb}}}, and {\texttt{\docbookhyphenatefilename{ntforms.\dbz{}tdb}}}).

The device mode and the set of printer driver data are basically collections of settings for all print queue properties, initialized in a sensible way. Device modes and printer driver data should initially be set on the print server (the Samba host) to healthy values so the clients can start to use them immediately. How do we set these initial healthy values? This can be achieved by accessing the drivers remotely from an NT (or 200x/XP) client, as discussed in the following paragraphs.

Be aware that a valid device mode can only be initiated by a \smbconfoption{printer admin} or root (the reason should be obvious). Device modes can be correctly set only by executing the printer driver program itself. Since Samba cannot execute this Win32 platform driver code, it sets this field initially to NULL (which is not a valid setting for clients to use). Fortunately, most drivers automatically generate the printer driver data that is needed when they are uploaded to the \smbconfsection{[print\$]} share with the help of the APW or rpcclient.

The generation and setting of a first valid device mode, however, requires some tickling from a client to set it on the Samba server. The easiest means of doing so is to simply change the page orientation on the server's printer. This executes enough of the printer driver program on the client for the desired effect to happen and feeds back the new device mode to our Samba server. You can use the native Windows NT/200x/XP printer properties page from a Window client for this:
Procedure to Initialize the Printer Driver Settings\begin{enumerate}

\item{Browse the {\sffamily \bfseries Network Neighborhood}.}

\item{Find the Samba server.}

\item{Open the Samba server's {\sffamily \bfseries Printers and Faxes} folder.}

\item{Highlight the shared printer in question.}

\item{Right-click on the printer (you may already be here if you followed the last section's description).}

\item{At the bottom of the context menu select {\sffamily \bfseries Properties} (if the menu still offers the {\sffamily \bfseries Connect} entry further above, you need to click on that one first to achieve the driver installation, as shown in the last section).}

\item{Go to the {\sffamily \bfseries Advanced} tab; click on {\sffamily \bfseries Printing Defaults}.}

\item{Change the {\sffamily \bfseries Portrait} page setting to {\sffamily \bfseries Landscape} (and back).}

\item{Make sure to apply changes between swapping the page orientation to cause the change to actually take effect.}

\item{While you are at it, you may also want to set the desired printing defaults here, which then apply to all future client driver installations.}
\end{enumerate}

This procedure executes the printer driver program on the client platform and feeds back the correct device mode to Samba, which now stores it in its TDB files. Once the driver is installed on the client, you can follow the analogous steps by accessing the {\em{local}} {\sffamily \bfseries Printers} folder, too, if you are a Samba printer admin user. From now on, printing should work as expected.

\index{default devmode} Samba includes a service-level parameter name {\ttfamily\itshape{\docbookhyphenatedot{default devmode}}} for generating a default device mode for a printer. Some drivers function well with Samba's default set of properties. Others may crash the client's spooler service. So use this parameter with caution. It is always better to have the client generate a valid device mode for the printer and store it on the server for you.
\subsection{Additional Client Driver Installation}
\label{id2586672}\hypertarget{id2586672}{}%

\index{additional driver} Every additional driver may be installed in the same way as just described. Browse {\bfseries{Network Neighborhood}}, open the {\sffamily \bfseries Printers} folder on Samba server, right-click on {\sffamily \bfseries Printer}, and choose {\sffamily \bfseries Connect...}. Once this completes (should be not more than a few seconds, but could also take a minute, depending on network conditions), you should find the new printer in your client workstation local {\sffamily \bfseries Printers and Faxes} folder.

You can also open your local {\sffamily \bfseries Printers and Faxes} folder by using this command on Windows 200x/XP Professional workstations: 
\begin{Verbatim}[]

rundll32 shell32.dll,SHHelpShortcuts_RunDLL PrintersFolder

\end{Verbatim}
 or this command on Windows NT 4.0 workstations: \index{rundll32} 
\begin{Verbatim}[]

rundll32 shell32.dll,Control_RunDLL MAIN.CPL @2

\end{Verbatim}


You can enter the commands either inside a {\sffamily \bfseries DOS box} window or in the {\sffamily \bfseries Run command...} field from the {\sffamily \bfseries Start} menu.
\subsection{Always Make First Client Connection as root or {``}printer admin{''}}
\label{id2586794}\hypertarget{id2586794}{}%

After you installed the driver on the Samba server (in its \smbconfsection{[print\$]} share), you should always make sure that your first client installation completes correctly. Make it a habit for yourself to build the very first connection from a client as \smbconfoption{printer admin}. This is to make sure that:

\begin{itemize}
%--- Item
\item 
A first valid {\em{device mode}} is really initialized (see above \hyperlink{prt-modeset}{Section {\ref{prt-modeset}}}) for more explanation details).


%--- Item
\item 
The default print settings of your printer for all further client installations are as you want them.

\end{itemize}

Do this by changing the orientation to landscape, click on {\sffamily \bfseries Apply}, and then change it back again. Next, modify the other settings (for example, you do not want the default media size set to {\sffamily \bfseries Letter} when you are all using {\sffamily \bfseries A4}, right? You may want to set the printer for {\sffamily \bfseries duplex} as the default, and so on).

\index{runas} To connect as root to a Samba printer, try this command from a Windows 200x/XP DOS box command prompt: 
\begin{Verbatim}[]

C:\> runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry /p /t3 /n 
	\\SAMBA-SERVER\printername"

\end{Verbatim}


You will be prompted for {\texttt{\docbookhyphenatedot{root}}}'s Samba password; type it, wait a few seconds, click on {\sffamily \bfseries Printing Defaults}, and proceed to set the job options that should be used as defaults by all clients. Alternatively, instead of root you can name one other member of the \smbconfoption{printer admin} from the setting.

Now all the other users downloading and installing the driver the same way (using {\texttt{\docbookhyphenatedot{Point'n'Print}}}) will have the same defaults set for them. If you miss this step, you'll get a lot of help desk calls from your users, but maybe you like to talk to people.

% ------------------------   
% Section 
\section{Other Gotchas}
\label{id2586955}\hypertarget{id2586955}{}%

Your driver is installed. It is now ready for Point'n'Print installation by the clients. You may have tried to download and use it on your first client machine, but wait. Let's make sure you are acquainted first with a few tips and tricks you may find useful. For example, suppose you did not set the defaults on the printer, as advised in the preceding paragraphs. Your users complain about various issues (such as, {``}We need to set the paper size for each job from Letter to A4 and it will not store it{''}).
\subsection{Setting Default Print Options for Client Drivers}
\label{id2586977}\hypertarget{id2586977}{}%

The last sentence might be viewed with mixed feelings by some users and Admins. They have struggled for hours and could not arrive at a point where their settings seemed to be saved. It is not their fault. The confusing thing is that in the multitabbed dialog that pops up when you right-click on the printer name and select {\sffamily \bfseries Properties}, you can arrive at two dialogs that appear identical, each claiming that they help you to set printer options in three different ways. Here is the definitive answer to the Samba default driver setting FAQ:

{\textbf{{{``}I can not set and save default print options for all users on Windows 200x/XP. Why not?{''}}.}}\ 
How are you doing it? I bet the wrong way. (It is not easy to find out, though.) There are three different ways to bring you to a dialog that seems to set everything. All three dialogs look the same, but only one of them does what you intend. You need to be Administrator or Print Administrator to do this for all users. Here is how I reproduce it in an XP Professional:

\begin{enumerate}[A]
%--- Item
\item 
The first {``}wrong{''} way: 
\begin{enumerate}[1]
%--- Item
\item 
Open the {\sffamily \bfseries Printers} folder.


%--- Item
\item 
Right-click on the printer ({\em{remoteprinter on cupshost}}) and select in context menu {\sffamily \bfseries Printing Preferences...}.


%--- Item
\item 
Look at this dialog closely and remember what it looks like.

\end{enumerate}



%--- Item
\item 
The second {``}wrong{''} way: .
\begin{enumerate}[1]
%--- Item
\item 
Open the {\sffamily \bfseries Printers} folder.


%--- Item
\item 
Right-click on the printer ({\em{remoteprinter on cupshost}}) and select in the context menu {\sffamily \bfseries Properties}


%--- Item
\item 
Click on the {\sffamily \bfseries General} tab.


%--- Item
\item 
Click on the {\sffamily \bfseries Printing Preferences...} button.


%--- Item
\item 
A new dialog opens. Keep this dialog open and go back to the parent dialog.

\end{enumerate}



%--- Item
\item 
The third and correct way (should you do this from the beginning, just carry out steps 1 and 2 from the second method above):

\begin{enumerate}[1]
%--- Item
\item 
Click on the {\sffamily \bfseries Advanced} tab. (If everything is {``}grayed out,{''} then you are not logged in as a user with enough privileges.)


%--- Item
\item 
Click on the {\sffamily \bfseries Printing Defaults} button.


%--- Item
\item 
On any of the two new tabs, click on the {\sffamily \bfseries Advanced} button.


%--- Item
\item 
A new dialog opens. Compare this one to the other. Are they identical when you compare one from {``}B.5{''} and one from A.3?

\end{enumerate}

\end{enumerate}

Do you see any difference in the two settings dialogs? I do not either. However, only the last one, which you arrived at with steps C.1 through C.6 will permanently save any settings which will then become the defaults for new users. If you want all clients to have the same defaults, you need to conduct these steps as administrator (\smbconfoption{printer admin}) before a client downloads the driver (the clients can later set their own per-user defaults by following procedures A or B above). Windows 200x/XP allow per-user default settings and the ones the administrator gives them before they set up their own. The parents of the identical-looking dialogs have a slight difference in their window names; one is called {\texttt{\docbookhyphenatedot{Default Print Values for Printer Foo on Server Bar}}} (which is the one you need) and the other is called {``}{\texttt{\docbookhyphenatedot{Print Settings for Printer Foo on Server Bar}}}{''}. The last one is the one you arrive at when you right-click on the printer and select {\sffamily \bfseries Print Settings...}. This is the one that you were taught to use back in the days of Windows NT, so it is only natural to try the same way with Windows 200x/XP. You would not dream that there is now a different path to arrive at an identical-looking, but functionally different, dialog to set defaults for all users.


\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Try (on Windows 200x/XP) to run this command (as a user with the right privileges): \index{rundll32}

{\ttfamily\bfseries{\docbookhyphenatedot{rundll32 printui.\dbz{}dll,PrintUIEntry /\dbz{}p /\dbz{}t3 /\dbz{}n\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{SAMBA-\dbz{}SERVER}}}\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{printersharename}}}}}}

To see the tab with the {\sffamily \bfseries Printing Defaults} button (the one you need), also run this command:

{\ttfamily\bfseries{\docbookhyphenatedot{rundll32 printui.\dbz{}dll,PrintUIEntry /\dbz{}p /\dbz{}t0 /\dbz{}n\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{SAMBA-\dbz{}SERVER}}}\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{printersharename}}}}}}

To see the tab with the {\sffamily \bfseries Printing Preferences} button (the one that does not set systemwide defaults), you can start the commands from inside a DOS box or from {\sffamily \bfseries Start} -\textgreater{} {\sffamily \bfseries Run}.
\end{admonition}

\subsection{Supporting Large Numbers of Printers}
\label{id2587349}\hypertarget{id2587349}{}%

One issue that has arisen during the recent development phase of Samba is the need to support driver downloads for hundreds of printers. Using Windows NT APW for this task is somewhat awkward (to say the least). If you do not want to acquire RSS pains from the printer installation clicking orgy alone, you need to think about a non-interactive script.

If more than one printer is using the same driver, the {\bfseries{rpcclient setdriver}} command can be used to set the driver associated with an installed queue. If the driver is uploaded to \smbconfsection{[print\$]} once and registered with the printing TDBs, it can be used by multiple print queues. In this case, you just need to repeat the {\bfseries{setprinter}} subcommand of {\bfseries{rpcclient}} for every queue (without the need to conduct the {\bfseries{adddriver}} repeatedly). The following is an example of how this can be accomplished:


\begin{Verbatim}[]

root# rpcclient SAMBA-CUPS -U root%secret -c 'enumdrivers'
 cmd = enumdrivers
 
 [Windows NT x86]
 Printer Driver Info 1:
   Driver Name: [infotec  IS 2075 PCL 6]
 
 Printer Driver Info 1:
   Driver Name: [DANKA InfoStream]
 
 Printer Driver Info 1:
   Driver Name: [Heidelberg Digimaster 9110 (PS)]
 
 Printer Driver Info 1:
   Driver Name: [dm9110]

 Printer Driver Info 1:
   Driver Name: [mydrivername]

 [....]

\end{Verbatim}
 
\begin{Verbatim}[]

root# rpcclient SAMBA-CUPS -U root%secret -c 'enumprinters'
 cmd = enumprinters
   flags:[0x800000]
   name:[\\SAMBA-CUPS\dm9110]
   description:[\\SAMBA-CUPS\dm9110,,110ppm HiVolume DANKA Stuttgart]
   comment:[110 ppm HiVolume DANKA Stuttgart]
 [....]

\end{Verbatim}
 
\begin{Verbatim}[]

root# rpcclient SAMBA-CUPS -U root%secret -c \
  'setdriver dm9110 "Heidelberg Digimaster 9110 (PS)"'
 cmd = setdriver dm9110 Heidelberg Digimaster 9110 (PPD)
 Successfully set dm9110 to driver Heidelberg Digimaster 9110 (PS).

\end{Verbatim}
 
\begin{Verbatim}[]

root# rpcclient SAMBA-CUPS -U root%secret -c 'enumprinters'
 cmd = enumprinters
   flags:[0x800000]
   name:[\\SAMBA-CUPS\dm9110]
   description:[\\SAMBA-CUPS\dm9110,Heidelberg Digimaster 9110 (PS),\
     110ppm HiVolume DANKA Stuttgart]
   comment:[110ppm HiVolume DANKA Stuttgart]
 [....]

\end{Verbatim}
 
\begin{Verbatim}[]

root# rpcclient SAMBA-CUPS -U root%secret -c 'setdriver dm9110 mydrivername'
 cmd = setdriver dm9110 mydrivername
 Successfully set dm9110 to mydrivername.

\end{Verbatim}
 
\begin{Verbatim}[]

root# rpcclient SAMBA-CUPS -U root%secret -c 'enumprinters'
 cmd = enumprinters
   flags:[0x800000]
   name:[\\SAMBA-CUPS\dm9110]
   description:[\\SAMBA-CUPS\dm9110,mydrivername,\
     110ppm HiVolume DANKA Stuttgart]
   comment:[110ppm HiVolume DANKA Stuttgart]
 [....]

\end{Verbatim}


It may not be easy to recognize that the first call to {\bfseries{enumprinters}} showed the {``}dm9110{''} printer with an empty string where the driver should have been listed (between the two commas in the description field). After the {\bfseries{setdriver}} command succeeds, all is well.
\subsection{Adding New Printers with the Windows NT APW}
\label{id2587610}\hypertarget{id2587610}{}%

By default, Samba exhibits all printer shares defined in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} in the {\sffamily \bfseries Printers} folder. Also located in this folder is the Windows NT Add Printer Wizard icon. The APW will be shown only if:

\begin{itemize}
%--- Item
\item 
The connected user is able to successfully execute an {\bfseries{OpenPrinterEx(\textbackslash \textbackslash server)}} with administrative privileges (i.e., root or \smbconfoption{printer admin}).

\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Try this from a Windows 200x/XP DOS box command prompt:

{\ttfamily\bfseries{\docbookhyphenatedot{runas /\dbz{}netonly /\dbz{}user:root rundll32 printui.\dbz{}dll,PrintUIEntry /\dbz{}p /\dbz{}t0 /\dbz{}n \docbooktolatexgobble\string\\\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{SAMBA-\dbz{}SERVER}}}\docbooktolatexgobble\string\\{\ttfamily\itshape{\docbookhyphenatedot{printersharename}}}}}}

Click on {\sffamily \bfseries Printing Preferences}.
\end{admonition}



%--- Item
\item 
... contains the setting \smbconfoption{show add printer wizard} = yes (the default).

\end{itemize}

The APW can do various things:

\begin{itemize}
%--- Item
\item 
Upload a new driver to the Samba \smbconfsection{[print\$]} share.


%--- Item
\item 
Associate an uploaded driver with an existing (but still driverless) print queue.


%--- Item
\item 
Exchange the currently used driver for an existing print queue with one that has been uploaded before.


%--- Item
\item 
Add an entirely new printer to the Samba host (only in conjunction with a working \smbconfoption{add printer command}. A corresponding \smbconfoption{delete printer command} for removing entries from the {\sffamily \bfseries Printers} folder may also be provided).

\end{itemize}

The last one (add a new printer) requires more effort than the previous ones. To use the APW to successfully add a printer to a Samba server, the \smbconfoption{add printer command} must have a defined value. The program hook must successfully add the printer to the UNIX print system (i.e., to {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}printcap}}}, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}printers.\dbz{}conf}}} or other appropriate files) and to {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} if necessary.

When using the APW from a client, if the named printer share does not exist, smbd will execute the \smbconfoption{add printer command} and reparse to attempt to locate the new printer share. If the share is still not defined, an error of "Access Denied" is returned to the client. The \smbconfoption{add printer command} is executed under the context of the connected user, not necessarily a root account. A \smbconfoption{map to guest} = bad user may have connected you unwittingly under the wrong privilege. You should check it by using the {\bfseries{smbstatus}} command.
\subsection{Error Message: {``}Cannot connect under a different Name{''}}
\label{id2587821}\hypertarget{id2587821}{}%

Once you are connected with the wrong credentials, there is no means to reverse the situation other than to close all Explorer windows, and perhaps reboot.

\begin{itemize}
%--- Item
\item 
\index{net use} The {\bfseries{net use \textbackslash \textbackslash SAMBA-SERVER\textbackslash sharename /user:root}} gives you an error message: {``}Multiple connections to a server or a shared resource by the same user utilizing several user names are not allowed. Disconnect all previous connections to the server, esp. the shared resource, and try again.{''}


%--- Item
\item 
Every attempt to {``}connect a network drive{''} to {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\SAMBASERVER\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\print\$}}} to {\texttt{\docbookhyphenatedot{z:}}} is countered by the pertinacious message: {``}This network folder is currently connected under different credentials (username and password). Disconnect first any existing connection to this network share in order to connect again under a different username and password{''}.

\end{itemize}

So you close all connections. You try again. You get the same message. You check from the Samba side, using {\bfseries{smbstatus}}. Yes, there are more connections. You kill them all. The client still gives you the same error message. You watch the smbd.log file on a high debug level and try reconnect. Same error message, but not a single line in the log. You start to wonder if there was a connection attempt at all. You run ethereal and tcpdump while you try to connect. Result: not a single byte goes on the wire. Windows still gives the error message. You close all Explorer windows and start it again. You try to connect ---  and this times it works! Windows seems to cache connection information somewhere and does not keep it up to date (if you are unlucky, you might need to reboot to get rid of the error message).

The easiest way to forcefully terminate all connections from your client to a server is by executing: 
\begin{Verbatim}[]

C:\>  net use * /delete

\end{Verbatim}
 This will also disconnect all mapped drives and will allow you create fresh connection as required.
\subsection{Take Care When Assembling Driver Files}
\label{id2587939}\hypertarget{id2587939}{}%

You need to be extremely careful when you take notes about the files belonging to a particular driver. Don't confuse the files for driver version {``}0{''} (for Windows 9x/Me, going into {\texttt{\docbookhyphenatefilename{[print\$]/\dbz{}WIN/\dbz{}0/\dbz{}}}}), driver version {\texttt{\docbookhyphenatefilename{2}}} (kernel mode driver for Windows NT, going into {\texttt{\docbookhyphenatefilename{[print\$]/\dbz{}W32X86/\dbz{}2/\dbz{}}}}; may be used on Windows 200x/XP also), and driver version {``}3{''} (non-kernel mode driver going into {\texttt{\docbookhyphenatefilename{[print\$]/\dbz{}W32X86/\dbz{}3/\dbz{}}}}; cannot be used on Windows NT). Quite often these different driver versions contain files that have the same name but actually are very different. If you look at them from the Windows Explorer (they reside in {\texttt{\docbookhyphenatefilename{\%WINDOWS\%\docbooktolatexgobble\string\\system32\docbooktolatexgobble\string\\spool\docbooktolatexgobble\string\\drivers\docbooktolatexgobble\string\\W32X86\docbooktolatexgobble\string\\}}}), you will probably see names in capital letters, while an {\bfseries{enumdrivers}} command from Samba would show mixed or lowercase letters, so it is easy to confuse them. If you install them manually using {\bfseries{rpcclient}} and subcommands, you may even succeed without an error message. Only later, when you try install on a client, you will encounter error messages like {\texttt{\docbookhyphenatedot{This server has no appropriate driver for the printer}}}.

Here is an example. You are invited to look closely at the various files, compare their names and their spelling, and discover the differences in the composition of the version 2 and 3 sets. Note: the version 0 set contained 40 {\ttfamily\itshape{\docbookhyphenatedot{Dependentfiles}}}, so I left it out for space reasons:


\begin{Verbatim}[]

root# rpcclient -U 'Administrator%secret' -c 'enumdrivers 3' 10.160.50.8 

 Printer Driver Info 3:
         Version: [3]
         Driver Name: [Canon iR8500 PS3]
         Architecture: [Windows NT x86]
         Driver Path: [\\10.160.50.8\print$\W32X86\3\cns3g.dll]
         Datafile: [\\10.160.50.8\print$\W32X86\3\iR8500sg.xpd]
         Configfile: [\\10.160.50.8\print$\W32X86\3\cns3gui.dll]
         Helpfile: [\\10.160.50.8\print$\W32X86\3\cns3g.hlp]
 
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aucplmNT.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\ucs32p.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\tnl32.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aussdrv.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cnspdc.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\aussapi.dat]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cns3407.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\CnS3G.cnt]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\NBAPI.DLL]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\NBIPC.DLL]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcview.exe]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcdspl.exe]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcedit.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcqm.exe]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcspl.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cfine32.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcr407.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\Cpcqm407.hlp]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cpcqm407.cnt]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\3\cns3ggr.dll]
 
         Monitorname: []
         Defaultdatatype: []

 Printer Driver Info 3:
         Version: [2]
         Driver Name: [Canon iR5000-6000 PS3]
         Architecture: [Windows NT x86]
         Driver Path: [\\10.160.50.8\print$\W32X86\2\cns3g.dll]
         Datafile: [\\10.160.50.8\print$\W32X86\2\IR5000sg.xpd]
         Configfile: [\\10.160.50.8\print$\W32X86\2\cns3gui.dll]
         Helpfile: [\\10.160.50.8\print$\W32X86\2\cns3g.hlp]
 
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\AUCPLMNT.DLL]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\aussdrv.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cnspdc.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\aussapi.dat]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cns3407.dll]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\CnS3G.cnt]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\NBAPI.DLL]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\NBIPC.DLL]
         Dependentfiles: [\\10.160.50.8\print$\W32X86\2\cns3gum.dll]
 
         Monitorname: [CPCA Language Monitor2]
         Defaultdatatype: []


\end{Verbatim}


If we write the {``}version 2{''} files and the {``}version 3{''} files into different text files and compare the result, we see this picture:


\begin{Verbatim}[]

root# sdiff 2-files 3-files


 cns3g.dll                     cns3g.dll
 iR8500sg.xpd                  iR8500sg.xpd
 cns3gui.dll                   cns3gui.dll
 cns3g.hlp                     cns3g.hlp
 AUCPLMNT.DLL                | aucplmNT.dll
                             > ucs32p.dll
                             > tnl32.dll
 aussdrv.dll                   aussdrv.dll
 cnspdc.dll                    cnspdc.dll
 aussapi.dat                   aussapi.dat
 cns3407.dll                   cns3407.dll
 CnS3G.cnt                     CnS3G.cnt
 NBAPI.DLL                     NBAPI.DLL
 NBIPC.DLL                     NBIPC.DLL
 cns3gum.dll                 | cpcview.exe
                             > cpcdspl.exe 
                             > cpcqm.exe
                             > cpcspl.dll
                             > cfine32.dll
                             > cpcr407.dll
                             > Cpcqm407.hlp
                             > cpcqm407.cnt
                             > cns3ggr.dll


\end{Verbatim}
 Do not be fooled! Driver files for each version with identical names may be different in their content, as you can see from this size comparison:


\begin{Verbatim}[]

root# for i in cns3g.hlp cns3gui.dll cns3g.dll; do                  \
           smbclient //10.160.50.8/print\$ -U 'Administrator%xxxx' \
           -c "cd W32X86/3; dir $i; cd .. ; cd 2; dir $i";      \
		   done

  CNS3G.HLP               A   122981  Thu May 30 02:31:00 2002
  CNS3G.HLP               A    99948  Thu May 30 02:31:00 2002

  CNS3GUI.DLL             A  1805824  Thu May 30 02:31:00 2002
  CNS3GUI.DLL             A  1785344  Thu May 30 02:31:00 2002

  CNS3G.DLL               A  1145088  Thu May 30 02:31:00 2002
  CNS3G.DLL               A    15872  Thu May 30 02:31:00 2002

\end{Verbatim}


In my example were even more differences than shown here. Conclusion: you must be careful to select the correct driver files for each driver version. Don't rely on the names alone, and don't interchange files belonging to different driver versions.
\subsection{Samba and Printer Ports}
\label{id2588192}\hypertarget{id2588192}{}%

\index{LPT1:} \index{COM1:} \index{FILE:} \index{available port} Windows NT/2000 print servers associate a port with each printer. These normally take the form of {\texttt{\docbookhyphenatefilename{LPT1:}}}, {\texttt{\docbookhyphenatefilename{COM1:}}}, {\texttt{\docbookhyphenatefilename{FILE:}}}, and so on. Samba must also support the concept of ports associated with a printer. By default, only one printer port, named {``}Samba Printer Port{''}, exists on a system. Samba does not really need such a {``}port{''} in order to print; rather it is a requirement of Windows clients. They insist on being told about an available port when they request this information; otherwise, they throw an error message at you. So Samba fakes the port information to keep the Windows clients happy.

\index{Printer Pooling} Samba does not support the concept of {\texttt{\docbookhyphenatedot{Printer Pooling}}} internally either. Printer pooling assigns a logical printer to multiple ports as a form of load balancing or failover.

If you require multiple ports to be defined for some reason or another (my users and my boss should not know that they are working with Samba), configure the \smbconfoption{enumports command}, which can be used to define an external program that generates a listing of ports on a system.
\subsection{Avoiding Common Client Driver Misconfiguration}
\label{id2588296}\hypertarget{id2588296}{}%

So now the printing works, but there are still problems. Most jobs print well, some do not print at all. Some jobs have problems with fonts, which do not look good. Some jobs print fast and some are dead-slow. We cannot cover it all, but we want to encourage you to read the brief paragraph about {``}Avoiding the Wrong PostScript Driver Settings{''} in \hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}}, \hyperlink{cups-avoidps1}{Section {\ref{cups-avoidps1}}}.

% ------------------------   
% Section 
\section{The Imprints Toolset}
\label{id2588332}\hypertarget{id2588332}{}%

\index{Imprints} The Imprints tool set provides a UNIX equivalent of the Windows NT APW. For complete information, please refer to the Imprints\label{id2588349}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://imprints.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2588349} Web site as well as the documentation included with the Imprints source distribution. This section provides only a brief introduction to the features of Imprints.

Unfortunately, the Imprints toolset is no longer maintained. As of December 2000, the project is in need of a new maintainer. The most important skill to have is Perl coding and an interest in MS-RPC-based printing used in Samba. If you wish to volunteer, please coordinate your efforts on the Samba technical mailing list. The toolset is still in usable form, but only for a series of older printer models where there are prepared packages to use. Packages for more up-to-date print devices are needed if Imprints should have a future. Information regarding the Imprints toolset can be obtained from the Imprints\label{id2588372}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://imprints.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2588372} home page.
\subsection{What Is Imprints?}
\label{id2588380}\hypertarget{id2588380}{}%

Imprints is a collection of tools for supporting these goals:

\begin{itemize}
%--- Item
\item 
Providing a central repository of information regarding Windows NT and 95/98 printer driver packages.


%--- Item
\item 
Providing the tools necessary for creating the Imprints printer driver packages.


%--- Item
\item 
Providing an installation client that will obtain printer drivers from a central Internet (or intranet) Imprints Server repository and install them on remote Samba and Windows NT4 print servers.

\end{itemize}
\subsection{Creating Printer Driver Packages}
\label{id2588416}\hypertarget{id2588416}{}%

The process of creating printer driver packages is beyond the scope of this document (refer to Imprints.txt, included with the Samba distribution for more information). In short, an Imprints driver package is a gzipped tarball containing the driver files, related INF files, and a control file needed by the installation client.
\subsection{The Imprints Server}
\label{id2588433}\hypertarget{id2588433}{}%

The Imprints server is really a database server that may be queried via standard HTTP mechanisms. Each printer entry in the database has an associated URL for the actual downloading of the package. Each package is digitally signed via GnuPG, which can be used to verify that the package downloaded is actually the one referred in the Imprints database. It is strongly recommended that this security check not be disabled.
\subsection{The Installation Client}
\label{id2588452}\hypertarget{id2588452}{}%

More information regarding the Imprints installation client is available from the documentation file {\texttt{\docbookhyphenatefilename{Imprints-\dbz{}Client-\dbz{}HOWTO.\dbz{}ps}}} that is included with the Imprints source package. The Imprints installation client comes in two forms:

\begin{itemize}
%--- Item
\item 
A set of command-line Perl scripts.


%--- Item
\item 
A GTK+-based graphical interface to the command-line Perl scripts.

\end{itemize}

The installation client (in both forms) provides a means of querying the Imprints database server for a matching list of known printer model names as well as a means to download and install the drivers on remote Samba and Windows NT print servers.

The basic installation process is in four steps, and Perl code is wrapped around smbclient and rpcclient.

\begin{itemize}
%--- Item
\item 
For each supported architecture for a given driver: 
\begin{enumerate}
%--- Item
\item 
rpcclient: Get the appropriate upload directory on the remote server.


%--- Item
\item 
smbclient: Upload the driver files.


%--- Item
\item 
rpcclient: Issues an AddPrinterDriver() MS-RPC.

\end{enumerate}



%--- Item
\item 
rpcclient: Issues an AddPrinterEx() MS-RPC to actually create the printer.

\end{itemize}

One of the problems encountered when implementing the Imprints tool set was the namespace issues between various supported client architectures. For example, Windows NT includes a driver named {``}Apple LaserWriter II NTX v51.8{''}, and Windows 95 calls its version of this driver {``}Apple LaserWriter II NTX{''}.

The problem is how to know what client drivers have been uploaded for a printer. An astute reader will remember that the Windows NT Printer Properties dialog only includes space for one printer driver name. A quick look in the Windows NT 4.0 system registry at:

{\texttt{\docbookhyphenatefilename{HKLM\docbooktolatexgobble\string\\System\docbooktolatexgobble\string\\CurrentControlSet\docbooktolatexgobble\string\\Control\docbooktolatexgobble\string\\Print\docbooktolatexgobble\string\\Environment}}}

will reveal that Windows NT always uses the NT driver name. This is okay because Windows NT always requires that at least the Windows NT version of the printer driver is present. Samba does not have the requirement internally; therefore, {``}How can you use the NT driver name if it has not already been installed?{''}

The way of sidestepping this limitation is to require that all Imprints printer driver packages include both the Intel Windows NT and 95/98 printer drivers and that the NT driver is installed first.

% ------------------------   
% Section 
\section{Adding Network Printers without User Interaction}
\label{id2588592}\hypertarget{id2588592}{}%

The following MS Knowledge Base article may be of some help if you need to handle Windows 2000 clients: {\em{How to Add Printers with No User Interaction in Windows 2000,}} (Microsoft KB 189105\label{id2588608}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;en-us;189105}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2588608}). It also applies to Windows XP Professional clients. The ideas sketched out in this section are inspired by this article, which describes a command-line method that can be applied to install network and local printers and their drivers. This is most useful if integrated in Logon Scripts. You can see what options are available by typing in the command prompt ({\bfseries{DOS box}}):

{\ttfamily\bfseries{\docbookhyphenatedot{rundll32 printui.\dbz{}dll,PrintUIEntry /\dbz{}?}}}

A window pops up that shows you all of the command-line switches available. An extensive list of examples is also provided. This is only for Windows 200x/XP; it does not work on Windows NT. Windows NT probably has some other tools in the respective Resource Kit. Here is a suggestion about what a client logon script might contain, with a short explanation of what the lines actually do (it works if 200x/XP Windows clients access printers via Samba, and works for Windows-based print servers too):


\begin{Verbatim}[]

rundll32 printui.dll,PrintUIEntry /dn /n "\\cupsserver\infotec2105-IPDS" /q
rundll32 printui.dll,PrintUIEntry /in /n "\\cupsserver\infotec2105-PS"
rundll32 printui.dll,PrintUIEntry /y /n "\\cupsserver\infotec2105-PS"

\end{Verbatim}


Here is a list of the used command-line parameters:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{/dn}]\null{}
deletes a network printer.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{/q}]\null{}
quiet modus.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{/n}]\null{}
names a printer.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{/in}]\null{}
adds a network printer connection.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{/y}]\null{}
sets printer as default printer.
\end{description}

\begin{itemize}
%--- Item
\item 
Line 1 deletes a possibly existing previous network printer {\em{infotec2105-IPDS}} (which had used native Windows drivers with LPRng that were removed from the server that was converted to CUPS). The {\bfseries{/q}} at the end prevents confirm or error dialog boxes from popping up. They should not be presented to the user logging on.


%--- Item
\item 
Line 2 adds the new printer {\em{infotec2105-PS}} (which actually is the same physical device but is now run by the new CUPS printing system and associated with the CUPS/Adobe PS drivers). The printer and its driver must have been added to Samba prior to the user logging in (e.g., by a procedure as discussed earlier in this chapter or by running {\bfseries{cupsaddsmb}}). The driver is now autodownloaded to the client PC where the user is about to log in.


%--- Item
\item 
Line 3 sets the default printer to this new network printer (there might be several other printers installed with this same method, and some may be local as well, so we decide for a default printer). The default printer selection may, of course, be different for different users.

\end{itemize}

The second line only works if the printer {\em{infotec2105-PS}} has an already working print queue on the {\texttt{\docbookhyphenatedot{cupsserver}}} and if the printer drivers have been successfully uploaded (via the {\bfseries{APW}}, {\bfseries{smbclient/rpcclient}}, or {\bfseries{cupsaddsmb}}) into the \smbconfsection{[print\$]} driver repository of Samba. Some Samba versions prior to version 3.0 required a restart of smbd after the printer install and the driver upload; otherwise the script (or any other client driver download) would fail.

Since there is no easy way to test for the existence of an installed network printer from the logon script, do not bother checking. Just allow the de-installation/re-installation to occur every time a user logs in; it's really quick anyway (1 to 2 seconds).

The additional benefits for this are:

\begin{itemize}
%--- Item
\item 
It puts in place any printer default setup changes automatically at every user logon.


%--- Item
\item 
It allows for {``}roaming{''} users' login to the domain from different workstations.

\end{itemize}

Since network printers are installed per user, this much simplifies the process of keeping the installation up to date. The few extra seconds at logon time will not really be noticeable. Printers can be centrally added, changed, and deleted at will on the server with no user intervention required from the clients (you just need to keep the logon scripts up to date).

% ------------------------   
% Section 
\section{The addprinter Command}
\label{id2588877}\hypertarget{id2588877}{}%

The {\bfseries{addprinter}} command can be configured to be a shell script or program executed by Samba. It is triggered by running the APW from a client against the Samba print server. The APW asks the user to fill in several fields (such as printer name, driver to be used, comment, port monitor, and so on). These parameters are passed on to Samba by the APW. If the addprinter command is designed in a way that it can create a new printer (through writing correct printcap entries on legacy systems or by executing the {\bfseries{lpadmin}} command on more modern systems) and create the associated share, then the APW will in effect really create a new printer on Samba and the UNIX print subsystem!

% ------------------------   
% Section 
\section{Migration of Classical Printing to Samba}
\label{id2588917}\hypertarget{id2588917}{}%

The basic NT-style printer driver management has not changed considerably in 3.0 over the 2.2.x releases (apart from many small improvements). Here migration should be quite easy, especially if you followed previous advice to stop using deprecated parameters in your setup. For migrations from an existing 2.0.x setup, or if you continued Windows 9x/Me-style printing in your Samba 2.2 installations, it is more of an effort. Please read the appropriate release notes and the HOWTO Collection for Samba-2.2.x. You can follow several paths. Here are possible scenarios for migration:

\begin{itemize}
%--- Item
\item 
You need to study and apply the new Windows NT printer and driver support. Previously used parameters {\ttfamily\itshape{\docbookhyphenatedot{printer driver file}}}, {\ttfamily\itshape{\docbookhyphenatedot{printer driver}}}, and {\ttfamily\itshape{\docbookhyphenatedot{printer driver location}}} are no longer supported.


%--- Item
\item 
If you want to take advantage of Windows NT printer driver support, you also need to migrate the Windows 9x/Me drivers to the new setup.


%--- Item
\item 
An existing {\texttt{\docbookhyphenatefilename{printers.\dbz{}def}}} file (the one specified in the now removed parameter {\ttfamily\itshape{\docbookhyphenatedot{printer driver file}}}) will no longer work with Samba-3. In 3.0, smbd attempts to locate Windows 9x/Me driver files for the printer in \smbconfsection{[print\$]} and additional settings in the TDB and only there; if it fails, it will {\em{not}} (as 2.2.x used to do) drop down to using a {\texttt{\docbookhyphenatefilename{printers.\dbz{}def}}} (and all associated parameters). The make\_printerdef tool is removed and there is no backward compatibility for this.


%--- Item
\item 
You need to install a Windows 9x/Me driver into the \smbconfsection{[print\$]} share for a printer on your Samba host. The driver files will be stored in the {``}WIN40/0{''} subdirectory of \smbconfsection{[print\$]}, and some other settings and information go into the printing-related TDBs.


%--- Item
\item 
If you want to migrate an existing {\texttt{\docbookhyphenatefilename{printers.\dbz{}def}}} file into the new setup, the only current solution is to use the Windows NT APW to install the NT drivers and the 9x/Me drivers. This can be scripted using smbclient and rpcclient. See the Imprints installation client on the Imprints\label{id2589044}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://imprints.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2589044} web site for example. See also the discussion of rpcclient usage in \hyperlink{CUPS-printing}{Chapter {\ref{CUPS-printing}}, {``}CUPS Printing Support{''}}.

\end{itemize}

% ------------------------   
% Section 
\section{Publishing Printer Information in Active Directory or LDAP}
\label{id2589064}\hypertarget{id2589064}{}%

This topic has also been addressed in \hyperlink{NetCommand}{Chapter {\ref{NetCommand}}, {``}Remote and Local Management: The Net Command{''}}. If you wish to volunteer your services to help document this further, please contact John H. Terpstra\label{id2589085}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mail://jht@samba.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2589085}.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2589094}\hypertarget{id2589094}{}%
\subsection{I Give My Root Password but I Do Not Get Access}
\label{id2589100}\hypertarget{id2589100}{}%

Do not confuse the root password, which is valid for the UNIX system (and in most cases stored in the form of a one-way hash in a file named {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}shadow}}}), with the password used to authenticate against Samba. Samba does not know the UNIX password. Root access to Samba resources requires that a Samba account for root must first be created. This is done with the {\bfseries{smbpasswd}} command as follows: 
\begin{Verbatim}[]

root#  smbpasswd -a root
New SMB password: secret
Retype new SMB password: secret

\end{Verbatim}

\subsection{My Print Jobs Get Spooled into the Spooling Directory, but Then Get Lost}
\label{id2589143}\hypertarget{id2589143}{}%

Do not use the existing UNIX print system spool directory for the Samba spool directory. It may seem convenient and a savings of space, but it only leads to problems. The two must be separate. The UNIX/Linux system print spool directory (e.g., {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}spool/\dbz{}cups}}}) is typically owned by a non-privileged user such as {\texttt{\docbookhyphenatedot{cups}}} or {\texttt{\docbookhyphenatedot{lp}}}. Additionally. the permissions on the spool directory are typically restrictive to the owner and/or group. On the other hand, the Samba spool directory must be world writable, and should have the 't' bit set to ensure that only a temporary spool file owner can change or delete the file.

Depending on the type of print spooling system in use on the UNIX/Linux host, files that the spool management application finds and that are not currently part of job queue that it is managing can be deleted. This may explain the observation that jobs are spooled (by Samba) into this directory and just disappear.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter CUPS Printing Support 
% ------------------------------------------------------------- 	
\chapter{CUPS Printing Support}
\label{CUPS-printing}\hypertarget{CUPS-printing}{}%

% ------------------------   
% Section 
\section{Introduction}
\label{id2577656}\hypertarget{id2577656}{}%
\subsection{Features and Benefits}
\label{id2577662}\hypertarget{id2577662}{}%

\index{default printing} The Common UNIX Print System (CUPS\label{id2577677}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.cups.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2577677}) has become quite popular. All major Linux distributions now ship it as their default printing system. To many, it is still a mystical tool. Mostly, it just works. People tend to regard it as a {``}black box{''} that they do not want to look into as long as it works. But once there is a little problem, they have trouble finding out where to start debugging it. Refer to \hyperlink{classicalprinting}{Chapter {\ref{classicalprinting}}, {``}Classical Printing Support{''}}, which contains much information that is also relevant to CUPS.

\index{CUPS} CUPS sports quite a few unique and powerful features. While its basic functions may be grasped quite easily, they are also new. Because it is different from other, more traditional printing systems, it is best not to try to apply any prior knowledge about printing to this new system. Rather, try to understand CUPS from the beginning. This documentation will lead you to a complete understanding of CUPS. Let's start with the most basic things first.
\subsection{Overview}
\label{id2577721}\hypertarget{id2577721}{}%

\index{print spooling system} \index{CUPS} \index{printer management system} \index{IETF} \index{Internet Printing Protocol|textit{see} {IPP} } \index{Internet Engineering Task Force|textit{see} {IETF} } \index{GUI} \index{KDEPrint} CUPS is more than just a print spooling system. It is a complete printer management system that complies with the new Internet Printing Protocol (IPP). IPP is an industry and Internet Engineering Task Force (IETF) standard for network printing. Many of its functions can be managed remotely (or locally) via a Web browser (giving you platform-independent access to the CUPS print server). Additionally, it has the traditional command line and several more modern GUI interfaces (GUI interfaces developed by third parties, like KDE's overwhelming KDEPrint\label{id2430554}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://printing.kde.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2430554}).

\index{raw printers} \index{smart printers} CUPS allows creation of {\em{raw}} printers (i.e., no print file format translation) as well as {\em{smart}} printers (i.e., CUPS does file format conversion as required for the printer). In many ways, this gives CUPS capabilities similar to the MS Windows print monitoring system. Of course, if you are a CUPS advocate, you would argue that CUPS is better! In any case, let us now explore how to configure CUPS for interfacing with MS Windows print clients via Samba.

% ------------------------   
% Section 
\section{Basic CUPS Support Configuration}
\label{id2489248}\hypertarget{id2489248}{}%

\index{CUPS} \index{cupsd.conf} \index{/etc/printcap} \index{Printcap} \index{PrintcapFormat} Printing with CUPS in the most basic {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} setup in Samba-3.0 (as was true for 2.2.x) requires just two parameters: \smbconfoption{printing} = cups and \smbconfoption{printcap} = cups. CUPS does not need a printcap file. However, the {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} configuration file knows of two related directives that control how such a file will be automatically created and maintained by CUPS for the convenience of third-party applications (example: {\ttfamily\itshape{\docbookhyphenatedot{Printcap /etc/printcap}}} and {\ttfamily\itshape{\docbookhyphenatedot{PrintcapFormat BSD}}}). Legacy programs often require the existence of a printcap file containing printer names or they will refuse to print. Make sure CUPS is set to generate and maintain a printcap file. For details, see {\bfseries{man cupsd.conf}} and other CUPS-related documentation, like the wealth of documents regarding the CUPS server itself available from the CUPS\label{id2570350}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://localhost:631/documentation.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2570350} web site.
\subsection{Linking smbd with libcups.so}
\label{id2570359}\hypertarget{id2570359}{}%

\index{libcups.so} Samba has a special relationship to CUPS. Samba can be compiled with CUPS library support. Most recent installations have this support enabled. By default, CUPS linking is compiled into smbd and other Samba binaries. Of course, you can use CUPS even if Samba is not linked against {\texttt{\docbookhyphenatefilename{libcups.\dbz{}so}}} ---  but there are some differences in required or supported configuration.

\index{libcups} \index{ldd} When Samba is compiled and linked with {\texttt{\docbookhyphenatefilename{libcups}}}, \smbconfoption{printcap} = cups uses the CUPS API to list printers, submit jobs, query queues, and so on. Otherwise it maps to the System V commands with an additional {\bfseries{-oraw}} option for printing. On a Linux system, you can use the {\bfseries{ldd}} utility to find out if smbd has been linked with the libcups library ({\bfseries{ldd}} may not be present on other OS platforms, or its function may be embodied by a different command): 
\begin{Verbatim}[]

root# ldd `which smbd`
libssl.so.0.9.6 => /usr/lib/libssl.so.0.9.6 (0x4002d000)
libcrypto.so.0.9.6 => /usr/lib/libcrypto.so.0.9.6 (0x4005a000)
libcups.so.2 => /usr/lib/libcups.so.2 (0x40123000)
[....]

\end{Verbatim}


\index{libcups.so.2} The line {\texttt{\docbookhyphenatedot{libcups.so.2 =\textgreater{} /usr/lib/libcups.so.2 (0x40123000)}}} shows there is CUPS support compiled into this version of Samba. If this is the case, and printing = cups is set, then {\em{any otherwise manually set print command in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} is ignored}}. This is an important point to remember!

\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Should it be necessary, for any reason, to set your own print commands, you can do this by setting \smbconfoption{printing} = sysv. However, you will lose all the benefits of tight CUPS-Samba integration. When you do this, you must manually configure the printing system commands (most important: \smbconfoption{print command}; other commands are \smbconfoption{lppause command}, \smbconfoption{lpresume command}, \smbconfoption{lpq command}, \smbconfoption{lprm command}, \smbconfoption{queuepause command} and \smbconfoption{queue resume command}).
\end{admonition}

\subsection{Simple smb.\dbz{}conf Settings for CUPS}
\label{id2569332}\hypertarget{id2569332}{}%

To summarize, \hyperlink{cups-exam-simple}{Example {\ref{cups-exam-simple}}} shows the simplest printing-related setup for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to enable basic CUPS support:

\begin{example}%
\hypertarget{cups-exam-simple}{}%
\captionswapskip{}{{\caption{Simplest Printing-Related smb.conf}\label{cups-exam-simple}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	load printers = yes
 	printing = cups
 	printcap name = cups
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	browseable = no
 	guest ok = yes
 	writable = no
 	printable = yes
 	printer admin = root, @ntadmins, @smbprintadm
\end{lstlisting}
\end{example}


\index{PDF} \index{PostScript} \index{printer driver} This is all you need for basic printing setup for CUPS. It will print all graphic, text, PDF, and PostScript files submitted from Windows clients. However, most of your Windows users would not know how to send these kinds of files to print without opening a GUI application. Windows clients tend to have local printer drivers installed, and the GUI application's print buttons start a printer driver. Your users also rarely send files from the command line. Unlike UNIX clients, they rarely submit graphic, text, or PDF formatted files directly to the spooler. They nearly exclusively print from GUI applications with a {``}printer driver{''} hooked between the application's native format and the print data stream. If the backend printer is not a PostScript device, the print data stream is {``}binary,{''} sensible only for the target printer. Read on to learn what problem this may cause and how to avoid it.
\subsection{More Complex CUPS smb.\dbz{}conf Settings}
\label{id2569498}\hypertarget{id2569498}{}%

\hyperlink{overridesettings}{Example {\ref{overridesettings}}} is a slightly more complex printing-related setup for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. It enables general CUPS printing support for all printers, but defines one printer share, which is set up differently.

\begin{example}%
\hypertarget{overridesettings}{}%
\captionswapskip{}{{\caption{Overriding Global CUPS Settings for One Printer}\label{overridesettings}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	printing = cups
 	printcap name = cups
 	load printers = yes
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	guest ok = yes
 	writable = no
 	printable = yes
 	printer admin = root, @ntadmins, @smbprintadm
 [special_printer]
 	comment = A special printer with his own settings
 	path = /var/spool/samba-special
 	printing = sysv
 	printcap = lpstat
 	print command = echo "NEW: `date`: printfile %f" >> /tmp/smbprn.log ; echo "     `date`: p-%p s-%s f-%f" >> /tmp/smbprn.log ; echo "     `date`: j-%j J-%J z-%z c-%c" >> /tmp/smbprn.log ; rm %f 
 	guest ok = no
 	writable = no
 	printable = yes
 	printer admin = kurt
 	hosts deny = 0.0.0.0
 	hosts allow = turbo_xp, 10.160.50.23, 10.160.51.60
\end{lstlisting}
\end{example}


This special share is only for testing purposes. It does not write the print job to a file. It just logs the job parameters known to Samba into the {\texttt{\docbookhyphenatefilename{/\dbz{}tmp/\dbz{}smbprn.\dbz{}log}}} file and deletes the job-file. Moreover, the \smbconfoption{printer admin} of this share is {``}kurt{''} (not the {``}@ntadmins{''} group), guest access is not allowed, the share isn't published to the Network Neighborhood (so you need to know it is there), and it allows access from only three hosts. To prevent CUPS from kicking in and taking over the print jobs for that share, we need to set \smbconfoption{printing} = sysv and \smbconfoption{printcap} = lpstat.

% ------------------------   
% Section 
\section{Advanced Configuration}
\label{id2579563}\hypertarget{id2579563}{}%

Before we delve into all the configuration options, let us clarify a few points. {\em{Network printing needs to be organized and set up correctly}}. This frequently doesn't happen. Legacy systems or small business LAN environments often lack design and good housekeeping.
\subsection{Central Spooling vs. {``}Peer-to-Peer{''} Printing}
\label{id2579581}\hypertarget{id2579581}{}%

\index{spooling} \index{spooling!central} \index{spooling!peer-to-peer} Many small office or home networks, as well as badly organized larger environments, allow each client a direct access to available network printers. This is generally a bad idea. It often blocks one client's access to the printer when another client's job is printing. It might freeze the first client's application while it is waiting to get rid of the job. Also, there are frequent complaints about various jobs being printed with their pages mixed with each other. A better concept is the use of a print server: it routes all jobs through one central system, which responds immediately, takes jobs from multiple concurrent clients, and transfers them to the printer(s) in the correct order.
\subsection{Raw Print Serving: Vendor Drivers on Windows Clients}
\label{id2579633}\hypertarget{id2579633}{}%

\index{spooling-only} \index{raw printing} Most traditionally configured UNIX print servers acting on behalf of Samba's Windows clients represented a really simple setup. Their only task was to manage the {``}raw{''} spooling of all jobs handed to them by Samba. This approach meant that the Windows clients were expected to prepare the print job file that is ready to be sent to the printing device. In this case, a native (vendor-supplied) Windows printer driver needs to be installed on each and every client for the target device.

\index{render} \index{vendor-provided drivers} It is possible to configure CUPS, Samba, and your Windows clients in the same traditional and simple way. When CUPS printers are configured for raw print-through mode operation, it is the responsibility of the Samba client to fully render the print job (file). The file must be sent in a format that is suitable for direct delivery to the printer. Clients need to run the vendor-provided drivers to do this. In this case, CUPS will not do any print file format conversion work.

The easiest printing configuration possible is raw print-through. This is achieved by installation of the printer as if it were physically attached to the Windows client. You then redirect output to a raw network print queue. This procedure may be followed to achieve this:
Configuration Steps for Raw CUPS Printing Support\begin{enumerate}

\item{\index{/etc/cups/mime.types} Edit {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} to uncomment the line near the end of the file that has: 
\begin{Verbatim}[]

#application/octet-...

\end{Verbatim}
}

\item{\index{/etc/cups/mime.convs} Do the same for the file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}}.}

\item{Add a raw printer using the Web interface. Point your browser at {\texttt{\docbookhyphenatedot{http://localhost:631}}}. Enter Administration, and add the printer following the prompts. Do not install any drivers for it. Choose Raw. Choose queue name {\texttt{\docbookhyphenatedot{Raw Queue}}}.}

\item{In the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file {\texttt{\docbookhyphenatedot{[printers]}}} section add \smbconfoption{use client driver} = Yes, and in the {\texttt{\docbookhyphenatedot{[global]}}} section add \smbconfoption{printing} = CUPS, plus \smbconfoption{printcap} = CUPS.}

\item{Install the printer as if it is a local printer, that is, Printing to {\texttt{\docbookhyphenatedot{LPT1:}}}.}

\item{Edit the configuration under the {\sffamily \bfseries Detail} tab and create a {\texttt{\docbookhyphenatedot{local port}}} that points to the raw printer queue that you have configured above. Example: {\texttt{\docbookhyphenatedot{\textbackslash \textbackslash server\textbackslash raw\_q}}}. Here, the name {\texttt{\docbookhyphenatedot{raw\_q}}} is the name you gave the print queue in the CUPS environment.}
\end{enumerate}
\subsection{Installation of Windows Client Drivers}
\label{id2579854}\hypertarget{id2579854}{}%

The printer drivers on the Windows clients may be installed in two functionally different ways:

\begin{itemize}
%--- Item
\item 
Manually install the drivers locally on each client, one by one; this yields the old LanMan style printing and uses a {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\sambaserver\docbooktolatexgobble\string\\printershare}}} type of connection.


%--- Item
\item 
\index{point 'n' print} Deposit and prepare the drivers (for later download) on the print server (Samba); this enables the clients to use {``}Point'n'Print{''} to get drivers semi-automatically installed the first time they access the printer; with this method NT/200x/XP clients use the {\em{SPOOLSS/MS-RPC}} type printing calls.

\end{itemize}

The second method is recommended for use over the first as it reduces the administrative efforts and prevents that different versions of the drivers are used accidentally.
\subsection{Explicitly Enable {``}raw{''} Printing for {\em{application/octet-stream}}}
\label{cups-raw}\hypertarget{cups-raw}{}%

\index{application/octet-stream} \index{raw printing} \index{MIME!raw} If you use the first option (drivers are installed on the client side), there is one setting to take care of: CUPS needs to be told that it should allow {``}raw{''} printing of deliberate (binary) file formats. The CUPS files that need to be correctly set for raw mode printers to work are:

\begin{itemize}
%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}}

\end{itemize}

Both contain entries (at the end of the respective files) that must be uncommented to allow RAW mode operation. In {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}}, make sure this line is present: 
\begin{Verbatim}[]

application/octet-stream

\end{Verbatim}
 \index{/etc/cups/mime.convs} \index{/etc/cups/mime.types} In {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}}, have this line: \index{application/vnd.cups-raw} 
\begin{Verbatim}[]

application/octet-stream   application/vnd.cups-raw   0   - 

\end{Verbatim}
 If these two files are not set up correctly for raw Windows client printing, you may encounter the dreaded {\texttt{\docbookhyphenatedot{Unable to convert file 0}}} in your CUPS {\texttt{\docbookhyphenatefilename{error\_\dbz{}log}}} file.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Editing the {\texttt{\docbookhyphenatefilename{mime.\dbz{}convs}}} and the {\texttt{\docbookhyphenatefilename{mime.\dbz{}types}}} file does not {\em{enforce}} {``}raw{''} printing, it only {\em{allows}} it.
\end{admonition}


{\textbf{{Background}.}}\ 
\index{application/octet-stream} \index{MIME type} That CUPS is a more security-aware printing system than traditional ones does not by default allow a user to send deliberate (possibly binary) data to printing devices. This could be easily abused to launch a {``}Denial of Service{''} attack on your printer(s), causing at least the loss of a lot of paper and ink. {``}Unknown{''} data are tagged by CUPS as {\ttfamily\itshape{\docbookhyphenatedot{MIME type: application/octet-stream}}} and not allowed to go to the printer. By default, you can only send other (known) MIME types {``}raw.{''} Sending data {``}raw{''} means that CUPS does not try to convert them and passes them to the printer untouched.


This is all you need to know to get the CUPS/Samba combo printing {``}raw{''} files prepared by Windows clients, which have vendor drivers locally installed. If you are not interested in background information about more advanced CUPS/Samba printing, simply skip the remaining sections of this chapter.
\subsection{Driver Upload Methods}
\label{id2597475}\hypertarget{id2597475}{}%

This section describes three familiar methods, plus one new one, by which printer drivers may be uploaded.

\index{point'n'print} If you want to use the MS-RPC-type printing, you must upload the drivers onto the Samba server first (\smbconfsection{[print\$]} share). For a discussion on how to deposit printer drivers on the Samba host (so the Windows clients can download and use them via {``}Point'n'Print{''}), please refer to the \hyperlink{classicalprinting}{Chapter {\ref{classicalprinting}}, {``}Classical Printing Support{''}} of this book. There you will find a description or reference to three methods of preparing the client drivers on the Samba server:

\begin{itemize}
%--- Item
\item 
\index{add printer wizard} The GUI, {``}Add Printer Wizard{''} {\em{upload-from-a-Windows-client}} method.


%--- Item
\item 
The command line, {``}smbclient/rpcclient{''} upload-from-a-UNIX-workstation method.


%--- Item
\item 
\index{imprints} The Imprints tool set method.

\end{itemize}

\index{cupsaddsmb} These three methods apply to CUPS all the same. The {\bfseries{cupsaddsmb}} utility is a new and more convenient way to load the Windows drivers into Samba and is provided if you use CUPS.

{\bfseries{cupsaddsmb}} is discussed in much detail later in this chapter. But we first explore the CUPS filtering system and compare the Windows and UNIX printing architectures.

% ------------------------   
% Section 
\section{Advanced Intelligent Printing with PostScript Driver Download}
\label{id2597584}\hypertarget{id2597584}{}%

\index{PostScript|textit{see also} {Ghostscript} } We now know how to set up a {``}dump{''} print server, that is, a server that spools print jobs {``}raw{''}, leaving the print data untouched.

You might need to set up CUPS in a smarter way. The reasons could be manifold:
\index{print statistics}\index{average print run}\index{print quota}
\begin{itemize}
%--- Item
\item 
Maybe your boss wants to get monthly statistics: Which printer did how many pages? What was the average data size of a job? What was the average print run per day? What are the typical hourly peaks in printing? Which department prints how much?


%--- Item
\item 
Maybe you are asked to set up a print quota system: Users should not be able to print more jobs once they have surpassed a given limit per period.


%--- Item
\item 
Maybe your previous network printing setup is a mess and must be re-organized from a clean beginning.


%--- Item
\item 
Maybe you are experiencing too many {``}blue screens{''} originating from poorly debugged printer drivers running in NT {``}kernel mode{''}?

\end{itemize}

These goals cannot be achieved by a raw print server. To build a server meeting these requirements, you'll first need to learn how CUPS works and how you can enable its features.

What follows is the comparison of some fundamental concepts for Windows and UNIX printing, then a description of the CUPS filtering system, how it works, and how you can tweak it.
\subsection{GDI on Windows, PostScript on UNIX}
\label{gdipost}\hypertarget{gdipost}{}%

\index{GDI} \index{PostScript} Network printing is one of the most complicated and error-prone day-to-day tasks any user or administrator may encounter. This is true for all OS platforms, and there are reasons it is so.

\index{PCL} \index{PDL} \index{PostScript} \index{Adobe} \index{page description languages|textit{see} {PDL} } You can't expect to throw just any file format at a printer and have it get printed. A file format conversion must take place. The problem is that there is no common standard for print file formats across all manufacturers and printer types. While PostScript (trademark held by Adobe) and, to an extent, PCL (trademark held by Hewlett-Packard) have developed into semi-official {``}standards{''} by being the most widely used page description languages (PDLs), there are still many manufacturers who {``}roll their own{''} (their reasons may be unacceptable license fees for using printer-embedded PostScript interpreters, and so on).
\subsection{Windows Drivers, GDI, and EMF}
\label{id2597766}\hypertarget{id2597766}{}%

\index{GDI} \index{EMF} \index{WYSIWYG} \index{Enhanced MetaFile|textit{see} {EMF} } In Windows OS, the format conversion job is done by the printer drivers. On MS Windows OS platforms all application programmers have at their disposal a built-in API, the graphical device interface (GDI), as part and parcel of the OS itself to base themselves on. This GDI core is used as one common unified ground for all Windows programs to draw pictures, fonts, and documents {\em{on screen}} as well as {\em{on paper}} (print). Therefore, printer driver developers can standardize on a well-defined GDI output for their own driver input. Achieving WYSIWYG (What You See Is What You Get) is relatively easy, because the on-screen graphic primitives, as well as the on-paper drawn objects, come from one common source. This source, the GDI, often produces a file format called Enhanced MetaFile (EMF). The EMF is processed by the printer driver and converted to the printer-specific file format.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{PDF} \index{Xprint} \index{core graphic engine} To the GDI foundation in MS Windows, Apple has chosen to put paper and screen output on a common foundation for its (BSD-UNIX-based, did you know?) Mac OS X and Darwin operating \index{X Window System} \index{PostScript} \index{PCL} \index{Xprint} systems. Apple's {\em{core graphic engine}} uses a {\em{PDF}} derivative for all display work.
\end{admonition}


The example in \hyperlink{1small}{Figure {\ref{1small}}} illustrates local Windows printing.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{1small}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/1small}
{{\caption[{Windows Printing to a Local Printer.}]{{{Windows Printing to a Local Printer.}}}\label{1small}}}
\end{center}
\end{figure}

\subsection{UNIX Printfile Conversion and GUI Basics}
\label{id2597905}\hypertarget{id2597905}{}%

\index{X Window System} \index{PostScript} \index{PCL} \index{Xprint} In UNIX and Linux, there is no comparable layer built into the OS kernel(s) or the X (screen display) server. Every application is responsible for itself to create its print output. Fortunately, most use PostScript and that at least gives some common ground. Unfortunately, there are many different levels of quality for this PostScript. And worse, there is a huge difference (and no common root) in the way the same document is displayed on screen and how it is presented on paper. WYSIWYG is more difficult to achieve. This goes back to the time, decades ago, when the predecessors of X.org, designing the UNIX foundations and protocols for graphical user interfaces, refused to take responsibility for {``}paper output{''}, as some had demanded at the time, and restricted itself to {``}on-screen only.{''} (For some years now, the {``}Xprint{''} project has been under development, attempting to build printing support into the X framework, including a PostScript and a PCL driver, but it is not yet ready for prime time.) You can see this unfavorable inheritance up to the present day by looking into the various {``}font{''} directories on your system; there are separate ones for fonts used for X display and fonts to be used on paper.

{\textbf{{Background}.}}\ 
\index{PostScript} \index{color} \index{linewidth} \index{scale} \index{distort} \index{rotate} \index{shift} \index{raster images} \index{display PostScript} \index{graphical objects} The PostScript programming language is an {``}invention{''} by Adobe, but its specifications have been published extensively. Its strength lies in its powerful abilities to describe graphical objects (fonts, shapes, patterns, lines, curves, and dots), their attributes (color, linewidth), and the way to manipulate (scale, distort, rotate, shift) them. Because of its open specification, anybody with the skill can start writing his or her own implementation of a PostScript interpreter and use it to display PostScript files on screen or on paper. Most graphical output devices are based on the concept of {``}raster images{''} or {``}pixels{''} (one notable exception is pen plotters). Of course, you can look at a PostScript file in its textual form and you will be reading its PostScript code, the language instructions that need to be interpreted by a rasterizer. Rasterizers produce pixel images, which may be displayed on screen by a viewer program or on paper by a printer.

\subsection{PostScript and Ghostscript}
\label{post-and-ghost}\hypertarget{post-and-ghost}{}%

\index{PostScript} \index{GhostScript|textit{see also} {PostScript} } \index{PostScript!RIP} \index{PostScript interpreter} \index{raster image processor|textit{see} {RIP} } So UNIX is lacking a common ground for printing on paper and displaying on screen. Despite this unfavorable legacy for UNIX, basic printing is fairly easy if you have PostScript printers at your disposal. The reason is that these devices have a built-in PostScript language {``}interpreter,{''} also called a raster image processor (RIP), (which makes them more expensive than other types of printers; throw PostScript toward them, and they will spit out your printed pages. The RIP does all the hard work of converting the PostScript drawing commands into a bitmap picture as you see it on paper, in a resolution as done by your printer. This is no different than PostScript printing a file from a Windows origin.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{PPD} \index{PPD-aware} \index{PostScript Printer Description|textit{see} {PPD} } Traditional UNIX programs and printing systems ---  while using PostScript ---  are largely not PPD-aware. PPDs are {``}PostScript Printer Description{''} files. They enable you to specify and control all options a printer supports: duplexing, stapling, and punching. Therefore, UNIX users for a long time couldn't choose many of the supported device and job options, unlike Windows or Apple users. But now there is CUPS. as illustrated in \hyperlink{2small}{Figure {\ref{2small}}}.
\end{admonition}


% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{2small}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/2small}
{{\caption[{Printing to a PostScript Printer.}]{{{Printing to a PostScript Printer.}}}\label{2small}}}
\end{center}
\end{figure}


\index{PDL} However, there are other types of printers out there. These do not know how to print PostScript. They use their own PDL, often proprietary. To print to them is much more demanding. Since your UNIX applications mostly produce PostScript, and since these devices do not understand PostScript, you need to convert the print files to a format suitable for your printer on the host before you can send it away.
\subsection{Ghostscript: The Software RIP for Non-PostScript Printers}
\label{id2598214}\hypertarget{id2598214}{}%

\index{GhostScript} Here is where Ghostscript kicks in. Ghostscript is the traditional (and quite powerful) PostScript interpreter used on UNIX platforms. It is a RIP in software, capable of doing a {\em{lot}} of file format conversions for a very broad spectrum of hardware devices as well as software file formats. Ghostscript technology and drivers are what enable PostScript printing to non-PostScript hardware. This is shown in \hyperlink{3small}{Figure {\ref{3small}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{3small}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/3small}
{{\caption[{Ghostscript as a RIP for Non-PostScript Printers.}]{{{Ghostscript as a RIP for Non-PostScript Printers.}}}\label{3small}}}
\end{center}
\end{figure}


\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{PNG} \index{AFPL} \index{ESP} Use the {``}gs -h{''} command to check for all built-in {``}devices{''} on your Ghostscript version. If you specify a parameter of {\ttfamily\itshape{\docbookhyphenatedot{-sDEVICE=png256}}} on your Ghostscript command line, you are asking Ghostscript to convert the input into a PNG file. Naming a {``}device{''} on the command line is the most important single parameter to tell Ghostscript exactly how it should render the input. New Ghostscript versions are released at fairly regular intervals, now by artofcode LLC. They are initially put under the {``}AFPL{''} license, but re-released under the GNU GPL as soon as the next AFPL version appears. GNU Ghostscript is probably the version installed on most Samba systems. But it has some deficiencies. \index{Ghostscript!ESP|textit{see} {ESP GhostScript} } Therefore, ESP Ghostscript was developed as an enhancement over GNU Ghostscript, with lots of bug-fixes, additional devices, and improvements. It is jointly maintained by developers from CUPS, Gutenprint, MandrakeSoft, SuSE, Red Hat, and Debian. It includes the {``}cups{''} device (essential to print to non-PS printers from CUPS).
\end{admonition}

\subsection{PostScript Printer Description (PPD) Specification}
\label{id2598334}\hypertarget{id2598334}{}%

\index{PPD} \index{PDL} \index{PostScript} While PostScript in essence is a PDL to represent the page layout in a device-independent way, real-world print jobs are always ending up being output on hardware with device-specific features. To take care of all the differences in hardware and to allow for innovations, Adobe has specified a syntax and file format for PostScript Printer Description (PPD) files. Every PostScript printer ships with one of these files.

PPDs contain all the information about general and special features of the given printer model: Which different resolutions can it handle? Does it have a duplexing unit? How many paper trays are there? What media types and sizes does it take? For each item, it also names the special command string to be sent to the printer (mostly inside the PostScript file) in order to enable it.

Information from these PPDs is meant to be taken into account by the printer drivers. Therefore, installed as part of the Windows PostScript driver for a given printer is the printer's PPD. Where it makes sense, the PPD features are presented in the drivers' UI dialogs to display to the user a choice of print options. In the end, the user selections are somehow written (in the form of special PostScript, PJL, JCL, or vendor-dependent commands) into the PostScript file created by the driver.

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{PDF} \index{PDF distilling} A PostScript file that was created to contain device-specific commands for achieving a certain print job output (e.g., duplexed, stapled, and punched) on a specific target machine may not print as expected, or may not be printable at all on other models; it also may not be fit for further processing by software (e.g., by a PDF distilling program).
\end{admonition}

\subsection{Using Windows-Formatted Vendor PPDs}
\label{id2598415}\hypertarget{id2598415}{}%

\index{CUPS} \index{PPDs} \index{PostScript} CUPS can handle all spec-compliant PPDs as supplied by the manufacturers for their PostScript models. Even if a vendor does not mention our favorite OS in his or her manuals and brochures, you can safely trust this: {\em{If you get the Windows NT version of the PPD, you can use it unchanged in CUPS}} and thus access the full power of your printer just like a Windows NT user could!

\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

To check the spec compliance of any PPD online, go to {\textless}\url{http://www.cups.org/testppd.php}{\textgreater} and upload your PPD. You will see the results displayed immediately. CUPS in all versions after 1.1.19 has a much stricter internal PPD parsing and checking code enabled; in case of printing trouble, this online resource should be one of your first pit stops.
\end{admonition}


\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{foomatic} \index{cupsomatic} For real PostScript printers, {\em{do not}} use the {\em{Foomatic}} or {\em{cupsomatic}} PPDs from Linuxprinting.org. With these devices, the original vendor-provided PPDs are always the first choice.
\end{admonition}


\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{W32X86/2} If you are looking for an original vendor-provided PPD of a specific device, and you know that an NT4 box (or any other Windows box) on your LAN has the PostScript driver installed, just use {\bfseries{smbclient //NT4-box/print\textbackslash \$ -U username}} to access the Windows directory where all printer driver files are stored. First look in the {\texttt{\docbookhyphenatefilename{W32X86/\dbz{}2}}} subdirectory for the PPD you are seeking.
\end{admonition}

\subsection{CUPS Also Uses PPDs for Non-PostScript Printers}
\label{id2598529}\hypertarget{id2598529}{}%

\index{non-PostScript} \index{PPD} \index{CUPS filtering} CUPS also uses specially crafted PPDs to handle non-PostScript printers. These PPDs are usually not available from the vendors (and no, you can't just take the PPD of a PostScript printer with the same model name and hope it works for the non-PostScript version too). To understand how these PPDs work for non-PS printers, we first need to dive deeply into the CUPS filtering and file format conversion architecture. Stay tuned.

% ------------------------   
% Section 
\section{The CUPS Filtering Architecture}
\label{id2598567}\hypertarget{id2598567}{}%

\index{CUPS filtering} \index{Ghostscript} \index{MIME type} \index{MIME recognition} \index{MIME conversion rules} The core of the CUPS filtering system is based on Ghostscript. In addition to Ghostscript, CUPS uses some other filters of its own. You (or your OS vendor) may have plugged in even more filters. CUPS handles all data file formats under the label of various MIME types. Every incoming print file is subjected to an initial autotyping. The autotyping determines its given MIME type. A given MIME type implies zero or more possible filtering chains relevant to the selected target printer. This section discusses how MIME types recognition and conversion rules interact. They are used by CUPS to automatically set up a working filtering chain for any given input data format.

If CUPS rasterizes a PostScript file natively to a bitmap, this is done in two stages:

\begin{itemize}
%--- Item
\item 
\index{generic raster format} \index{CUPS raster} The first stage uses a Ghostscript device named {``}cups{''} (this is since version 1.1.15) and produces a generic raster format called {``}CUPS raster{''}.


%--- Item
\item 
\index{raster driver} The second stage uses a {``}raster driver{''} that converts the generic CUPS raster to a device-specific raster.

\end{itemize}

\index{Ghostscript} \index{GNU Ghostscript} \index{ESP Ghostscript} Make sure your Ghostscript version has the {``}cups{''} device compiled in (check with {\bfseries{gs -h \docbooktolatexpipe{} grep cups}}). Otherwise you may encounter the dreaded {\texttt{\docbookhyphenatedot{Unable to convert file 0}}} in your CUPS error\_log file. To have {``}cups{''} as a device in your Ghostscript, you either need to patch GNU Ghostscript and recompile or use \index{ESP!Ghostscript}ESP Ghostscript\label{id2598718}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.cups.org/ghostscript.php}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2598718}. The superior alternative is ESP Ghostscript. It supports not just CUPS, but 300 other devices (while GNU Ghostscript supports only about 180). Because of this broad output device support, ESP Ghostscript is the first choice for non-CUPS spoolers, too. It is now recommended by Linuxprinting.org for all spoolers.

\index{cupsomatic} \index{foomatic} \index{foomatic-rip} \index{ESP Ghostscript} CUPS printers may be set up to use external rendering paths. One of the most common is provided by the Foomatic/cupsomatic concept from Linuxprinting.org\label{id2598759}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2598759}. This uses the classical Ghostscript approach, doing everything in one step. It does not use the {``}cups{''} device, but one of the many others. However, even for Foomatic/cupsomatic usage, best results and \index{ESP!Ghostscript} broadest printer model support is provided by ESP Ghostscript (more about Foomatic/cupsomatic, particularly the new version called now {\em{foomatic-rip}}, follows).
\subsection{MIME Types and CUPS Filters}
\label{id2598787}\hypertarget{id2598787}{}%

\index{MIME!filters} \index{MIME} \index{mime.types} \index{application/pdf} \index{autotyping} CUPS reads the file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} (and all other files carrying a {\texttt{\docbookhyphenatefilename{*.\dbz{}types}}} suffix in the same directory) upon startup. These files contain the MIME type recognition rules that are applied when CUPS runs its autotyping routines. The rule syntax is explained in the man page for {\texttt{\docbookhyphenatefilename{mime.\dbz{}types}}} and in the comments section of the {\texttt{\docbookhyphenatefilename{mime.\dbz{}types}}} file itself. A simple rule reads like this: \index{application/pdf} 
\begin{Verbatim}[]

application/pdf         pdf string(0,%PDF)

\end{Verbatim}
 \index{\%PDF} \index{.pdf} This means if a filename has a {\texttt{\docbookhyphenatefilename{.\dbz{}pdf}}} suffix or if the magic string {\em{\%PDF}} is right at the beginning of the file itself (offset 0 from the start), then it is a PDF file ({\ttfamily\itshape{\docbookhyphenatedot{application/pdf}}}). Another rule is this: 
\begin{Verbatim}[]

application/postscript  ai eps ps string(0,%!) string(0,<04>%!)

\end{Verbatim}
 \index{suffixes} \index{.ai} \index{.eps} \index{.ps} \index{generic PostScript} \index{application/postscript} If the filename has one of the suffixes {\texttt{\docbookhyphenatefilename{.\dbz{}ai}}}, {\texttt{\docbookhyphenatefilename{.\dbz{}eps}}}, {\texttt{\docbookhyphenatefilename{.\dbz{}ps}}}, or if the file itself starts with one of the strings {\em{\%!}} or {\em{\textless{}04\textgreater{}\%!}}, it is a generic PostScript file ({\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}}).

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{/etc/cups/} Don't confuse the other mime.types files your system might be using with the one in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}}}} directory.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{application/postscript} \index{PostScript} \index{filter} \index{PPD} \index{transformation} There is an important difference between two similar MIME types in CUPS: one is {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}}, the other is {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}. While {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}} is meant to be device-independent, job options for the file are still outside the PS file content, embedded in command line or environment variables by CUPS, {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}} may have the job options inserted into the PostScript data itself (where applicable). The transformation of the generic PostScript ({\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}}) to the device-specific version ({\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}) is the responsibility of the CUPS {\ttfamily\itshape{\docbookhyphenatedot{pstops}}} filter. pstops uses information contained in the PPD to do the transformation.
\end{admonition}


\index{ASCII} \index{HP-GL} \index{PDF} \index{PostScript} \index{DVI} \index{GIF} \index{PNG} \index{TIFF} \index{JPEG} \index{Photo-CD} \index{SUN-Raster} \index{PNM} \index{PBM} \index{SGI-RGB} \index{MIME} \index{filters} CUPS can handle ASCII text, HP-GL, PDF, PostScript, DVI, and many image formats (GIF, PNG, TIFF, JPEG, Photo-CD, SUN-Raster, PNM, PBM, SGI-RGB, and more) and their associated MIME types with its filters.
\subsection{MIME Type Conversion Rules}
\label{id2599180}\hypertarget{id2599180}{}%

\index{MIME} \index{application/pdf} \index{/etc/cups/mime.convs} \index{application/pdf} \index{application/postscript} CUPS reads the file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}} (and all other files named with a {\texttt{\docbookhyphenatefilename{*.\dbz{}convs}}} suffix in the same directory) upon startup. These files contain lines naming an input MIME type, an output MIME type, a format conversion filter that can produce the output from the input type, and virtual costs associated with this conversion. One example line reads like this: 
\begin{Verbatim}[]

application/pdf         application/postscript   33   pdftops

\end{Verbatim}
 \index{pdftops} This means that the {\ttfamily\itshape{\docbookhyphenatedot{pdftops}}} filter will take {\ttfamily\itshape{\docbookhyphenatedot{application/pdf}}} as input and produce {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}} as output; the virtual cost of this operation is 33 CUPS-\$. The next filter is more expensive, costing 66 CUPS-\$: \index{pdf} 
\begin{Verbatim}[]

application/vnd.hp-HPGL application/postscript   66   hpgltops

\end{Verbatim}
 \index{hpgltops} This is the {\ttfamily\itshape{\docbookhyphenatedot{hpgltops}}}, which processes HP-GL plotter files to PostScript. \index{application/octet-stream} 
\begin{Verbatim}[]

application/octet-stream

\end{Verbatim}
 Here are two more examples: \index{text/plain} \index{application/x-shell} \index{text/plain} \index{texttops} 
\begin{Verbatim}[]

application/x-shell     application/postscript   33    texttops
text/plain              application/postscript   33    texttops

\end{Verbatim}
 \index{application/x-shell} The last two examples name the {\ttfamily\itshape{\docbookhyphenatedot{texttops}}} filter to work on {\ttfamily\itshape{\docbookhyphenatedot{text/plain}}} as well as on {\ttfamily\itshape{\docbookhyphenatedot{application/x-shell}}}. (Hint: This differentiation is needed for the syntax highlighting feature of {\ttfamily\itshape{\docbookhyphenatedot{texttops}}}).
\subsection{Filtering Overview}
\label{id2599367}\hypertarget{id2599367}{}%

\index{MIME} There are many more combinations named in {\texttt{\docbookhyphenatefilename{mime.\dbz{}convs}}}. However, you are not limited to use the ones predefined there. You can plug in any filter you like to the CUPS framework. It must meet, or must be made to meet, some minimal requirements. If you find (or write) a cool conversion filter of some kind, make sure it complies with what CUPS needs and put in the right lines in {\texttt{\docbookhyphenatefilename{mime.\dbz{}types}}} and {\texttt{\docbookhyphenatefilename{mime.\dbz{}convs}}}; then it will work seamlessly inside CUPS.
\subsubsection{Filter Requirements}
\label{id2599405}\hypertarget{id2599405}{}%

The {``}CUPS requirements{''} for filters are simple. Take filenames or {\texttt{\docbookhyphenatefilename{stdin}}} as input and write to {\texttt{\docbookhyphenatefilename{stdout}}}. They should take these arguments:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{printer}]\null{}
The name of the printer queue (normally this is the name of the filter being run).
% \null and \mbox are tricks to induce different typesetting decisions
\item[{job}]\null{}
The numeric job ID for the job being printed.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{user}]\null{}
The string from the originating-user-name attribute.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{title}]\null{}
The string from the job-name attribute.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{copies}]\null{}
The numeric value from the number-copies attribute.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{options}]\null{}
The job options.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{filename}]\null{}
(optionally) The print request file (if missing, filters expect data fed through {\texttt{\docbookhyphenatefilename{stdin}}}). In most cases, it is easy to write a simple wrapper script around existing filters to make them work with CUPS.
\end{description}
\subsection{Prefilters}
\label{id2599516}\hypertarget{id2599516}{}%

\index{PostScript} \index{non-PostScript printers} \index{raster} As previously stated, PostScript is the central file format to any UNIX-based printing system. From PostScript, CUPS generates raster data to feed non-PostScript printers.

\index{prefilters} \index{PostScript} \index{ASCII text} \index{PDF} \index{DVI} \index{HP-GL.} \index{MIME type} \index{application/postscript} \index{pstops} \index{application/vnd.cups-postscript} But what happens if you send one of the supported non-PS formats to print? Then CUPS runs {``}prefilters{''} on these input formats to generate PostScript first. There are prefilters to create PostScript from ASCII text, PDF, DVI, or HP-GL. The outcome of these filters is always of MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}} (meaning that any device-specific print options are not yet embedded into the PostScript by CUPS and that the next filter to be called is pstops). Another prefilter is running on all supported image formats, the {\ttfamily\itshape{\docbookhyphenatedot{imagetops}}} filter. Its outcome is always of MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}} (not application/postscript), meaning it has the print options already embedded into the file. This is shown in \hyperlink{4small}{Figure {\ref{4small}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{4small}{}%
\includegraphics[scale=0.25]{Samba3-HOWTO/images/4small}
{{\caption[{Prefiltering in CUPS to Form PostScript.}]{{{Prefiltering in CUPS to Form PostScript.}}}\label{4small}}}
\end{center}
\end{figure}

\subsection{pstops}
\label{id2599667}\hypertarget{id2599667}{}%

\index{pstops} \index{application/postscript} \index{application/vnd.cups-postscript} \index{output duplexing} \index{stapling} \index{punching} \index{PostScript} {\em{pstops}} is a filter that is used to convert {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}} to {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}. As stated earlier, this filter inserts all device-specific print options (commands to the printer to ask for the duplexing of output, or stapling and punching it, and so on) into the PostScript file. An example is illustrated in \hyperlink{5small}{Figure {\ref{5small}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{5small}{}%
\includegraphics[scale=0.25]{Samba3-HOWTO/images/5small}
{{\caption[{Adding Device-Specific Print Options.}]{{{Adding Device-Specific Print Options.}}}\label{5small}}}
\end{center}
\end{figure}


This is not all. Other tasks performed by it are:

\begin{itemize}
%--- Item
\item 
Selecting the range of pages to be printed (e.g., you can choose to print only pages {``}3, 6, 8-11, 16, and 19-21{''}, or only odd-numbered pages).


%--- Item
\item 
Putting two or more logical pages on one sheet of paper (the so-called {``}number-up{''} function).


%--- Item
\item 
Counting the pages of the job to insert the accounting information into the {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}log/\dbz{}cups/\dbz{}page\_\dbz{}log}}}.

\end{itemize}
\subsection{pstoraster}
\label{id2599800}\hypertarget{id2599800}{}%

\index{pstoraster} \index{rasterization} \index{raster drivers} {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}} is at the core of the CUPS filtering system. It is responsible for the first stage of the rasterization process. Its input is of MIME type application/vnd.cups-postscript; its output is application/vnd.cups-raster. This output format is not yet meant to be printable. Its aim is to serve as a general-purpose input format for more specialized {\em{raster drivers}} that are able to generate device-specific printer data. This is shown in \hyperlink{cups-raster}{Figure {\ref{cups-raster}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{cups-raster}{}%
\includegraphics[scale=0.25]{Samba3-HOWTO/images/6small}
{{\caption[{PostScript to Intermediate Raster Format.}]{{{PostScript to Intermediate Raster Format.}}}\label{cups-raster}}}
\end{center}
\end{figure}


\index{CUPS raster} \index{generic raster} \index{IANA} \index{raster drivers} CUPS raster is a generic raster format with powerful features. It is able to include per-page information, color profiles, and more, to be used by the downstream raster drivers. Its MIME type is registered with IANA and its specification is, of course, completely open. It is designed to make it quite easy and inexpensive for manufacturers to develop Linux and UNIX raster drivers for their printer models should they choose to do so. CUPS always takes care of the first stage of rasterization so these vendors do not need to care about Ghostscript complications (in fact, there are currently more than one vendor financing the development of CUPS raster drivers). This is illustrated in \hyperlink{cups-raster2}{Figure {\ref{cups-raster2}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{cups-raster2}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/7small}
{{\caption[{CUPS-Raster Production Using Ghostscript.}]{{{CUPS-Raster Production Using Ghostscript.}}}\label{cups-raster2}}}
\end{center}
\end{figure}


\index{pstoraster} \index{GNU Ghostscript} \index{AFPL Ghostscript} \index{standalone filter} CUPS versions before version 1.1.15 shipped a binary (or source code) standalone filter, named {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}}. {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}}, which was derived from GNU Ghostscript 5.50 and could be installed instead of and in addition to any GNU or AFPL Ghostscript package without conflicting.

Since version 1.1.15, this feature has changed. The functions for this filter have been integrated back into Ghostscript (now based on GNU Ghostscript version 7.05). The {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}} filter is now a simple shell script calling {\bfseries{gs}} with the {\bfseries{-sDEVICE=cups}} parameter. If your Ghostscript fails when this command is executed: {\bfseries{gs -h \docbooktolatexpipe{}grep cups}}, you might not be able to print, update your Ghostscript.
\subsection{imagetops and imagetoraster}
\label{id2600001}\hypertarget{id2600001}{}%

\index{prefilter} \index{imagetoraster} In the section about prefilters, we mentioned the prefilter that generates PostScript from image formats. The {\ttfamily\itshape{\docbookhyphenatedot{imagetoraster}}} filter is used to convert directly from image to raster, without the intermediate PostScript stage. It is used more often than the previously mentioned prefilters. We summarize in a flowchart the image file filtering in \hyperlink{small8}{Figure {\ref{small8}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{small8}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/8small}
{{\caption[{Image Format to CUPS-Raster Format Conversion.}]{{{Image Format to CUPS-Raster Format Conversion.}}}\label{small8}}}
\end{center}
\end{figure}

\subsection{rasterto [printers specific]}
\label{id2600055}\hypertarget{id2600055}{}%

\index{rastertoalps} \index{rastertobj} \index{rastertoepson} \index{rastertoescp} \index{rastertopcl} \index{rastertoturboprint} \index{rastertoescp} \index{rastertohp} \index{rastertoprinter} \index{rastertoprinter} \index{Gutenprint} CUPS ships with quite a variety of raster drivers for processing CUPS raster. On my system, I find in /usr/lib/cups/filter/ the following: {\ttfamily\itshape{\docbookhyphenatedot{rastertoalps}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertobj}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertoepson}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertoescp}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertopcl}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertoturboprint}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertoapdk}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertodymo}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertoescp}}}, {\ttfamily\itshape{\docbookhyphenatedot{rastertohp}}}, and {\ttfamily\itshape{\docbookhyphenatedot{rastertoprinter}}}. Don't worry if you have fewer drivers than this; some of these are installed by commercial add-ons to CUPS (like {\ttfamily\itshape{\docbookhyphenatedot{rastertoturboprint}}}), and others (like {\ttfamily\itshape{\docbookhyphenatedot{rastertoprinter}}}) by third-party driver development projects (such as Gutenprint) wanting to cooperate as closely as possible with CUPS. See \hyperlink{small9}{Figure {\ref{small9}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{small9}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/9small}
{{\caption[{Raster to Printer-Specific Formats.}]{{{Raster to Printer-Specific Formats.}}}\label{small9}}}
\end{center}
\end{figure}

\subsection{CUPS Backends}
\label{id2600229}\hypertarget{id2600229}{}%

\index{CUPS filtering chain} \index{print queue} The last part of any CUPS filtering chain is a backend. Backends are special programs that send the print-ready file to the final device. There is a separate backend program for any transfer protocol for sending print jobs over the network, and one for every local interface. Every CUPS print queue needs to have a CUPS {``}device-URI{''} associated with it. The device URI is the way to encode the backend used to send the job to its destination. Network device-URIs use two slashes in their syntax, local device URIs only one, as you can see from the following list. Keep in mind that local interface names may vary greatly from my examples, if your OS is not Linux:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{usb}]\null{}
This backend sends print files to USB-connected printers. An example for the CUPS device-URI to use is {\texttt{\docbookhyphenatefilename{usb:/\dbz{}dev/\dbz{}usb/\dbz{}lp0}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{serial}]\null{}
This backend sends print files to serially connected printers. An example for the CUPS device-URI to use is {\texttt{\docbookhyphenatefilename{serial:/\dbz{}dev/\dbz{}ttyS0?baud=11500}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{parallel}]\null{}
This backend sends print files to printers connected to the parallel port. An example for the CUPS device-URI to use is {\texttt{\docbookhyphenatefilename{parallel:/\dbz{}dev/\dbz{}lp0}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SCSI}]\null{}
This backend sends print files to printers attached to the SCSI interface. An example for the CUPS device-URI to use is {\texttt{\docbookhyphenatefilename{scsi:/\dbz{}dev/\dbz{}sr1}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{lpd}]\null{}
This backend sends print files to LPR/LPD-connected network printers. An example for the CUPS device-URI to use is {\texttt{\docbookhyphenatefilename{lpd:/\dbz{}/\dbz{}remote\_\dbz{}host\_\dbz{}name/\dbz{}remote\_\dbz{}queue\_\dbz{}name}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{AppSocket/HP JetDirect}]\null{}
This backend sends print files to AppSocket (a.k.a., HP JetDirect) connected network printers. An example for the CUPS device-URI to use is {\texttt{\docbookhyphenatefilename{socket:/\dbz{}/\dbz{}10.\dbz{}11.\dbz{}12.\dbz{}13:9100}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{ipp}]\null{}
This backend sends print files to IPP-connected network printers (or to other CUPS servers). Examples for CUPS device-URIs to use are {\texttt{\docbookhyphenatefilename{ipp::/\dbz{}/\dbz{}192.\dbz{}193.\dbz{}194.\dbz{}195/\dbz{}ipp}}} (for many HP printers) and {\texttt{\docbookhyphenatefilename{ipp:/\dbz{}/\dbz{}remote\_\dbz{}cups\_\dbz{}server/\dbz{}printers/\dbz{}remote\_\dbz{}printer\_\dbz{}name}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{http}]\null{}
This backend sends print files to HTTP-connected printers. (The http:// CUPS backend is only a symlink to the ipp:// backend.) Examples for the CUPS device-URIs to use are {\texttt{\docbookhyphenatefilename{http::/\dbz{}/\dbz{}192.\dbz{}193.\dbz{}194.\dbz{}195:631/\dbz{}ipp}}} (for many HP printers) and {\texttt{\docbookhyphenatefilename{http:/\dbz{}/\dbz{}remote\_\dbz{}cups\_\dbz{}server:631/\dbz{}printers/\dbz{}remote\_\dbz{}printer\_\dbz{}name}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{smb}]\null{}
This backend sends print files to printers shared by a Windows host. Examples of CUPS device-URIs that may be used includes:


\begin{tabular}{l}

{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}workgroup/\dbz{}server/\dbz{}printersharename}}}  \\
{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}server/\dbz{}printersharename}}}  \\
{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}username:password@workgroup/\dbz{}server/\dbz{}printersharename}}}  \\
{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}username:password@server/\dbz{}printersharename}}}  \\
\end{tabular}


The smb:// backend is a symlink to the Samba utility {\ttfamily\itshape{\docbookhyphenatedot{smbspool}}} (does not ship with CUPS). If the symlink is not present in your CUPS backend directory, have your root user create it: {\bfseries{ln -s `which smbspool' /usr/lib/cups/backend/smb}}.
\end{description}

It is easy to write your own backends as shell or Perl scripts if you need any modification or extension to the CUPS print system. One reason could be that you want to create {``}special{''} printers that send the print jobs as email (through a {``}mailto:/{''} backend), convert them to PDF (through a {``}pdfgen:/{''} backend) or dump them to {``}/dev/null{''}. (In fact, I have the systemwide default printer set up to be connected to a devnull:/ backend: there are just too many people sending jobs without specifying a printer, and scripts and programs that do not name a printer. The systemwide default deletes the job and sends a polite email back to the \$USER asking him or her to always specify the correct printer name.)

\index{lpinfo} \index{CUPS backends} Not all of the mentioned backends may be present on your system or usable (depending on your hardware configuration). One test for all available CUPS backends is provided by the {\em{lpinfo}} utility. Used with the {\texttt{\docbookhyphenatedot{-v}}} parameter, it lists all available backends:


\begin{Verbatim}[]

	$ lpinfo -v
	
\end{Verbatim}

\subsection{The Role of cupsomatic/foomatic}
\label{id2600566}\hypertarget{id2600566}{}%

\index{cupsomatic} \index{foomatic} \index{PPDs} \index{Foomatic Printer} \index{Linuxprinting.org} {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} filters may be the most widely used on CUPS installations. You must be clear that these were not developed by the CUPS people. They are a third-party add-on to CUPS. They utilize the traditional Ghostscript devices to render jobs for CUPS. When troubleshooting, you should know about the difference. Here the whole rendering process is done in one stage, inside Ghostscript, using an appropriate device for the target printer. {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} uses PPDs that are generated from the Foomatic Printer \& Driver Database at Linuxprinting.org.

You can recognize these PPDs from the line calling the {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} filter: 
\begin{Verbatim}[]

*cupsFilter: "application/vnd.cups-postscript  0  cupsomatic"

\end{Verbatim}
 You may find this line among the first 40 or so lines of the PPD file. If you have such a PPD installed, the printer shows up in the CUPS Web interface with a {\ttfamily\itshape{\docbookhyphenatedot{foomatic}}} namepart for the driver description. {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} is a Perl script that runs Ghostscript with all the complicated command line options autoconstructed from the selected PPD and command line options given to the print job.

\index{point'n'print} \index{foomatic-rip} \index{Adobe specifications} \index{hi-res photo} \index{normal color} \index{grayscale} \index{draft} \index{media type} \index{resolution} \index{inktype} \index{dithering algorithm} However, {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} is now deprecated. Its PPDs (especially the first generation of them, still in heavy use out there) are not meeting the Adobe specifications. You might also suffer difficulties when you try to download them with {``}Point'n'Print{''} to Windows clients. A better and more powerful successor is now available: it is called {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}}. To use {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}} as a filter with CUPS, you need the new type of PPDs, which have a similar but different line: 
\begin{Verbatim}[]

*cupsFilter: "application/vnd.cups-postscript  0  foomatic-rip"

\end{Verbatim}
 The PPD-generating engine at Linuxprinting.org has been revamped. The new PPDs comply with the Adobe spec. They also provide a new way to specify different quality levels (hi-res photo, normal color, grayscale, and draft) with a single click, whereas before you could have required five or more different selections (media type, resolution, inktype, and dithering algorithm). There is support for custom-size media built in. There is support to switch print options from page to page in the middle of a job. And the best thing is that the new {\texttt{\docbookhyphenatedot{foomatic-rip}}} works seamlessly with all legacy spoolers too (like LPRng, BSD-LPD, PDQ, PPR, and so on), providing for them access to use PPDs for their printing.
\subsection{The Complete Picture}
\label{id2600807}\hypertarget{id2600807}{}%

If you want to see an overview of all the filters and how they relate to each other, the complete picture of the puzzle is at the end of this chapter.
\subsection{mime.\dbz{}convs}
\label{id2600821}\hypertarget{id2600821}{}%

CUPS autoconstructs all possible filtering chain paths for any given MIME type and every printer installed. But how does it decide in favor of or against a specific alternative? (There may be cases where there is a choice of two or more possible filtering chains for the same target printer.) Simple. You may have noticed the figures in the third column of the mime.convs file. They represent virtual costs assigned to this filter. Every possible filtering chain will sum up to a total {``}filter cost.{''} CUPS decides for the most {``}inexpensive{''} route.

\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{cupsd.conf} \index{FilterLimit} Setting {\ttfamily\itshape{\docbookhyphenatedot{FilterLimit 1000}}} in {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} will not allow more filters to run concurrently than will consume a total of 1000 virtual filter cost. This is an efficient way to limit the load of any CUPS server by setting an appropriate {``}FilterLimit{''} value. A FilterLimit of 200 allows roughly one job at a time, while a FilterLimit of 1000 allows approximately five jobs maximum at a time.
\end{admonition}

\subsection{{``}Raw{''} Printing}
\label{id2600891}\hypertarget{id2600891}{}%

\index{PPD} \index{lpadmin} \index{rawprinter} You can tell CUPS to print (nearly) any file {``}raw{''}. {``}Raw{''} means it will not be filtered. CUPS will send the file to the printer {``}as is{''} without bothering if the printer is able to digest it. Users need to take care themselves that they send sensible data formats only. Raw printing can happen on any queue if the {``}{\ttfamily\itshape{\docbookhyphenatedot{-o raw}}}{''} option is specified on the command line. You can also set up raw-only queues by simply not associating any PPD with it. This command: 
\begin{Verbatim}[]

$ lpadmin -P rawprinter -v socket://11.12.13.14:9100 -E

\end{Verbatim}
 sets up a queue named {``}rawprinter{''}, connected via the {``}socket{''} protocol (a.k.a. {``}HP JetDirect{''}) to the device at IP address 11.12.1.3.14, using port 9100. (If you had added a PPD with {\bfseries{-P /path/to/PPD}} to this command line, you would have installed a {``}normal{''} print queue.)

CUPS will automatically treat each job sent to a queue as a {``}raw{''} one if it can't find a PPD associated with the queue. However, CUPS will only send known MIME types (as defined in its own mime.types file) and refuse others.
\subsection{application/octet-stream Printing}
\label{id2601004}\hypertarget{id2601004}{}%

\index{/etc/cups/mime.types} \index{application/octet-stream} Any MIME type with no rule in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} file is regarded as unknown or {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}} and will not be sent. Because CUPS refuses to print unknown MIME types by default, you will probably have experienced that print jobs originating from Windows clients were not printed. You may have found an error message in your CUPS logs like:

{\texttt{\docbookhyphenatedot{Unable to convert file 0 to printable format for job}}}

To enable the printing of {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}} files, edit these two files:

\begin{itemize}
%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}}

\end{itemize}

\index{raw mode} Both contain entries (at the end of the respective files) that must be uncommented to allow raw mode operation for {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}}. In {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} make sure this line is present: \index{application/octet-stream} 
\begin{Verbatim}[]

application/octet-stream

\end{Verbatim}
 This line (with no specific autotyping rule set) makes all files not otherwise auto-typed a member of {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}}. In {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}}, have this line: 
\begin{Verbatim}[]

application/octet-stream   application/vnd.cups-raw   0   -

\end{Verbatim}
 \index{MIME} This line tells CUPS to use the {\em{Null Filter}} (denoted as {``}-{''}, doing nothing at all) on {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}}, and tag the result as {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-raw}}}. This last one is always a green light to the CUPS scheduler to now hand the file over to the backend connecting to the printer and sending it over.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Editing the {\texttt{\docbookhyphenatefilename{mime.\dbz{}convs}}} and the {\texttt{\docbookhyphenatefilename{mime.\dbz{}types}}} file does not {\em{enforce}} {``}raw{''} printing, it only {\em{allows}} it.
\end{admonition}


{\textbf{{Background}.}}\ 
\index{security-aware} \index{MIME type} \index{/etc/cups/mime.types} \index{/etc/cups/mime.convs} That CUPS is a more security-aware printing system than traditional ones does not by default allow one to send deliberate (possibly binary) data to printing devices. (This could be easily abused to launch a Denial of Service attack on your printer(s), causing at least the loss of a lot of paper and ink.) {``}Unknown{''} data are regarded by CUPS as {\em{MIME type}} {\em{application/octet-stream}}. While you {\em{can}} send data {``}raw{''}, the MIME type for these must be one that is known to CUPS and allowed by it. The file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} defines the {``}rules{''} of how CUPS recognizes MIME types. The file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}convs}}} decides which file conversion filter(s) may be applied to which MIME types.

\subsection{PostScript Printer Descriptions for Non-PostScript Printers}
\label{id2601291}\hypertarget{id2601291}{}%

\index{PPD} \index{non-PostScript} \index{PostScript} \index{RIP} \index{Ghostscript} \index{device-specific commands} Originally PPDs were meant to be used for PostScript printers only. Here, they help to send device-specific commands and settings to the RIP, which processes the job file. CUPS has extended this scope for PPDs to cover non-PostScript printers too. This was not difficult, because it is a standardized file format. In a way it was logical too: CUPS handles PostScript and uses a PostScript RIP (Ghostscript) to process the job files. The only difference is that a PostScript printer has the RIP built-in, for other types of printers the Ghostscript RIP runs on the host computer.

PPDs for a non-PostScript printer have a few lines that are unique to CUPS. The most important one looks similar to this: \index{application/vnd.cups-raster} 
\begin{Verbatim}[]

*cupsFilter: application/vnd.cups-raster  66   rastertoprinter

\end{Verbatim}
 It is the last piece in the CUPS filtering puzzle. This line tells the CUPS daemon to use as a last filter {\ttfamily\itshape{\docbookhyphenatedot{rastertoprinter}}}. This filter should be served as input an {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-raster}}} MIME type file. Therefore, CUPS should autoconstruct a filtering chain, which delivers as its last output the specified MIME type. This is then taken as input to the specified {\ttfamily\itshape{\docbookhyphenatedot{rastertoprinter}}} filter. After the last filter has done its work ({\ttfamily\itshape{\docbookhyphenatedot{rastertoprinter}}} is a Gutenprint filter), the file should go to the backend, which sends it to the output device.

CUPS by default ships only a few generic PPDs, but they are good for several hundred printer models. You may not be able to control different paper trays, or you may get larger margins than your specific model supports. See Table 21.1\hyperlink{cups-ppds}{Table {\ref{cups-ppds}}} for summary information.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{cups-ppds}{}%
\captionswapskip{}{{\caption{PPDs Shipped with CUPS}\label{cups-ppds}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
{{{\bfseries PPD file}}} & {{{\bfseries Printer type}}} \tabularnewline
 \hline 
{{deskjet.ppd}} & {{older HP inkjet printers and compatible}} \tabularnewline
 \hline 
{{deskjet2.ppd}} & {{newer HP inkjet printers and compatible}} \tabularnewline
 \hline 
{{dymo.ppd}} & {{label printers}} \tabularnewline
 \hline 
{{epson9.ppd}} & {{Epson 24-pin impact printers and compatible}} \tabularnewline
 \hline 
{{epson24.ppd}} & {{Epson 24-pin impact printers and compatible}} \tabularnewline
 \hline 
{{okidata9.ppd}} & {{Okidata 9-pin impact printers and compatible}} \tabularnewline
 \hline 
{{okidat24.ppd}} & {{Okidata 24-pin impact printers and compatible}} \tabularnewline
 \hline 
{{stcolor.ppd}} & {{older Epson Stylus Color printers}} \tabularnewline
 \hline 
{{stcolor2.ppd}} & {{newer Epson Stylus Color printers}} \tabularnewline
 \hline 
{{stphoto.ppd}} & {{older Epson Stylus Photo printers}} \tabularnewline
 \hline 
{{stphoto2.ppd}} & {{newer Epson Stylus Photo printers}} \tabularnewline
 \hline 
{{laserjet.ppd}} & {{all PCL printers}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsection{{\em{cupsomatic/foomatic-rip}} Versus {\em{Native CUPS}} Printing}
\label{id2601588}\hypertarget{id2601588}{}%

\index{cupsomatic} \index{foomatic-rip} Native CUPS rasterization works in two steps:

\begin{itemize}
%--- Item
\item 
\index{pstoraster} First is the {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}} step. It uses the special CUPS \index{ESP!Ghostscript} device from ESP Ghostscript 7.05.x as its tool.


%--- Item
\item 
Second is the {\ttfamily\itshape{\docbookhyphenatedot{rasterdriver}}} step. It uses various device-specific filters; there are several vendors who provide good quality filters for this step. Some are free software, some are shareware, and some are proprietary.

\end{itemize}

Often this produces better quality (and has several more advantages) than other methods. This is shown in \hyperlink{cupsomatic-dia}{Figure {\ref{cupsomatic-dia}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{cupsomatic-dia}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/10small}
{{\caption[{cupsomatic/foomatic Processing Versus Native CUPS.}]{{{cupsomatic/foomatic Processing Versus Native CUPS.}}}\label{cupsomatic-dia}}}
\end{center}
\end{figure}


One other method is the {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic/foomatic-rip}}} way. Note that {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} is {\em{not}} made by the CUPS developers. It is an independent contribution to printing development, made by people from Linuxprinting.org.\label{id2601717}\begingroup\catcode`\#=12\footnote{
See also {\textless}\url{http://www.cups.org/cups-help.html}{\textgreater}
}\endgroup\docbooktolatexmakefootnoteref{id2601717} {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} is no longer developed, maintained, or supported. It now been replaced by {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}}. {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}} is a complete rewrite of the old {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} idea, but very much improved and generalized to other (non-CUPS) spoolers. An upgrade to {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}} is strongly advised, especially if you are upgrading to a recent version of CUPS, too.

\index{cupsomatic} \index{foomatic} Like the old {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} method, the {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}} (new) method from Linuxprinting.org uses the traditional Ghostscript print file processing, doing everything in a single step. It therefore relies on all the other devices built into Ghostscript. The quality is as good (or bad) as Ghostscript rendering is in other spoolers. The advantage is that this method supports many printer models not supported (yet) by the more modern CUPS method.

Of course, you can use both methods side by side on one system (and even for one printer, if you set up different queues) and find out which works best for you.

\index{cupsomatic} \index{pstoraster} \index{rastertosomething} \index{rasterization} \index{Foomatic/cupsomatic} \index{rendering} {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} kidnaps the print file after the {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}} stage and deviates it through the CUPS-external, systemwide Ghostscript installation. Therefore, the print file bypasses the {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}} filter (and also bypasses the CUPS raster drivers {\ttfamily\itshape{\docbookhyphenatedot{rastertosomething}}}). After Ghostscript finished its rasterization, {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} hands the rendered file directly to the CUPS backend. \hyperlink{cupsomatic-dia}{Figure {\ref{cupsomatic-dia}}}, illustrates the difference between native CUPS rendering and the {\ttfamily\itshape{\docbookhyphenatedot{Foomatic/cupsomatic}}} method.
\subsection{Examples for Filtering Chains}
\label{id2601906}\hypertarget{id2601906}{}%

Here are a few examples of commonly occurring filtering chains to illustrate the workings of CUPS.

\index{HP JetDirect} \index{PostScript} \index{two-up} \index{duplex} Assume you want to print a PDF file to an HP JetDirect-connected PostScript printer, but you want to print pages 3-5, 7, and 11-13 only, and you want to print them {``}two-up{''} and {``}duplex{''}:

\begin{itemize}
%--- Item
\item 
Your print options (page selection as required, two-up, duplex) are passed to CUPS on the command line.


%--- Item
\item 
The (complete) PDF file is sent to CUPS and autotyped as {\ttfamily\itshape{\docbookhyphenatedot{application/pdf}}}.


%--- Item
\item 
The file therefore must first pass the {\ttfamily\itshape{\docbookhyphenatedot{pdftops}}} prefilter, which produces PostScript MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}} (a preview here would still show all pages of the original PDF).


%--- Item
\item 
The file then passes the {\ttfamily\itshape{\docbookhyphenatedot{pstops}}} filter that applies the command line options: it selects pages 2-5, 7, and 11-13, creates the imposed layout {``}two pages on one sheet{''}, and inserts the correct {``}duplex{''} command (as defined in the printer's PPD) into the new PostScript file; the file is now of PostScript MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}.


%--- Item
\item 
The file goes to the {\ttfamily\itshape{\docbookhyphenatedot{socket}}} backend, which transfers the job to the printers.

\end{itemize}

The resulting filter chain, therefore, is as shown in \hyperlink{pdftosocket}{Figure {\ref{pdftosocket}}}.
\index{pdftosocket}
% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{pdftosocket}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/pdftosocket}
{{\caption[{PDF to Socket Chain.}]{{{PDF to Socket Chain.}}}\label{pdftosocket}}}
\end{center}
\end{figure}


\index{USB} \index{Epson Stylus} \index{stphoto2.ppd} Assume you want to print the same filter to an USB-connected Epson Stylus Photo Printer installed with the CUPS {\texttt{\docbookhyphenatefilename{stphoto2.\dbz{}ppd}}}. The first few filtering stages are nearly the same:

\begin{itemize}
%--- Item
\item 
Your print options (page selection as required, two-up, duplex) are passed to CUPS on the command line.


%--- Item
\item 
The (complete) PDF file is sent to CUPS and autotyped as {\ttfamily\itshape{\docbookhyphenatedot{application/pdf}}}.


%--- Item
\item 
\index{pdftops} \index{PDF} The file must first pass the {\ttfamily\itshape{\docbookhyphenatedot{pdftops}}} prefilter, which produces PostScript MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}} (a preview here would still show all pages of the original PDF).


%--- Item
\item 
\index{pstops} \index{duplex printing} The file then passes the {``}pstops{''} filter that applies the command line options: it selects the pages 2-5, 7, and 11-13, creates the imposed layout {``}two pages on one sheet,{''} and inserts the correct {``}duplex{''} command (oops ---  this printer and PPD do not support duplex printing at all, so this option will be ignored) into the new PostScript file; the file is now of PostScript MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}.


%--- Item
\item 
The file then passes the {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}} stage and becomes MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/cups-raster}}}.


%--- Item
\item 
\index{rastertoepson} Finally, the {\ttfamily\itshape{\docbookhyphenatedot{rastertoepson}}} filter does its work (as indicated in the printer's PPD), creating the printer-specific raster data and embedding any user-selected print options into the print data stream.


%--- Item
\item 
The file goes to the {\ttfamily\itshape{\docbookhyphenatedot{usb}}} backend, which transfers the job to the printers.

\end{itemize}

The resulting filter chain therefore is as shown in \hyperlink{pdftoepsonusb}{Figure {\ref{pdftoepsonusb}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{pdftoepsonusb}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/pdftoepsonusb}
{{\caption[{PDF to USB Chain.}]{{{PDF to USB Chain.}}}\label{pdftoepsonusb}}}
\end{center}
\end{figure}

\subsection{Sources of CUPS Drivers/PPDs}
\label{id2602293}\hypertarget{id2602293}{}%

On the Internet you can now find many thousands of CUPS-PPD files (with their companion filters), in many national languages supporting more than 1,000 non-PostScript models.
\index{ESP!Print Pro}\index{PrintPro|textit{see} {ESP Print Pro} }
\begin{itemize}
%--- Item
\item 
ESP PrintPro\label{id2602331}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.easysw.com/printpro/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602331} (commercial, non-free) is packaged with more than 3,000 PPDs, ready for successful use {``}out of the box{''} on Linux, Mac OS X, IBM-AIX, HP-UX, Sun-Solaris, SGI-IRIX, Compaq Tru64, Digital UNIX, and other commercial Unices (it is written by the CUPS developers themselves and its sales help finance the further development of CUPS, as they feed their creators).


%--- Item
\item 
The Gutenprint Project\label{id2602352}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://gimp-print.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602352} (GPL, free software) provides around 140 PPDs (supporting nearly 400 printers, many driven to photo quality output), to be used alongside the Gutenprint CUPS filters.


%--- Item
\item 
TurboPrint\label{id2602366}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.turboprint.de/english.html/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602366} (shareware, non-free) supports roughly the same number of printers in excellent quality.


%--- Item
\item 
OMNI\label{id2602379}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www-124.ibm.com/developerworks/oss/linux/projects/omni/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602379} (LPGL, free) is a package made by IBM, now containing support for more than 400 printers, stemming from the inheritance of IBM OS/2 know-how ported over to Linux (CUPS support is in a beta stage at present).


%--- Item
\item 
HPIJS\label{id2602394}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://hpinkjet.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602394} (BSD-style licenses, free) supports approximately 150 of HP's own printers and also provides excellent print quality now (currently available only via the Foomatic path).


%--- Item
\item 
Foomatic/cupsomatic\label{id2602408}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602408} (LPGL, free) from Linuxprinting.org provide PPDs for practically every Ghostscript filter known to the world (including Omni, Gutenprint, and HPIJS).

\end{itemize}
\subsection{Printing with Interface Scripts}
\label{id2602421}\hypertarget{id2602421}{}%

\index{PCL} \index{lpadmin} CUPS also supports the use of {``}interface scripts{''} as known from System V AT\&T printing systems. These are often used for PCL printers, from applications that generate PCL print jobs. Interface scripts are specific to printer models. They have a role similar to PPDs for PostScript printers. Interface scripts may inject the Escape sequences as required into the print data stream if the user, for example, selects a certain paper tray, or changes paper orientation, or uses A3 paper. Interface scripts are practically unknown in the Linux realm. On HP-UX platforms they are more often used. You can use any working interface script on CUPS too. Just install the printer with the {\bfseries{-i}} option: 
\begin{Verbatim}[]

root# lpadmin -p pclprinter -v socket://11.12.13.14:9100 \
          -i /path/to/interface-script

\end{Verbatim}


Interface scripts might be the {``}unknown animal{''} to many. However, with CUPS they provide the easiest way to plug in your own custom-written filtering script or program into one specific print queue (some information about the traditional use of interface scripts is found at http://playground.sun.com/printing/documentation/interface.html\label{id2602494}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://playground.sun.com/printing/documentation/interface.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2602494}).

% ------------------------   
% Section 
\section{Network Printing (Purely Windows)}
\label{id2602508}\hypertarget{id2602508}{}%

Network printing covers a lot of ground. To understand what exactly goes on with Samba when it is printing on behalf of its Windows clients, let's first look at a {``}purely Windows{''} setup: Windows clients with a Windows NT print server.
\subsection{From Windows Clients to an NT Print Server}
\label{id2602525}\hypertarget{id2602525}{}%

Windows clients printing to an NT-based print server have two options. They may: \index{GDI} \index{EMF}

\begin{itemize}
%--- Item
\item 
Execute the driver locally and render the GDI output (EMF) into the printer-specific format on their own.


%--- Item
\item 
Send the GDI output (EMF) to the server, where the driver is executed to render the printer-specific output.

\end{itemize}

Both print paths are shown in the flowcharts in \hyperlink{small11}{Figure {\ref{small11}}}, and \hyperlink{small12}{Figure {\ref{small12}}}.
\subsection{Driver Execution on the Client}
\label{id2602587}\hypertarget{id2602587}{}%

In the first case, the print server must spool the file as raw, meaning it shouldn't touch the job file and try to convert it in any way. This is what a traditional UNIX-based print server can do too, and at a better performance and more reliably than an NT print server. This is what most Samba administrators probably are familiar with. One advantage of this setup is that this {``}spooling-only{''} print server may be used even if no driver(s) for UNIX is available. It is sufficient to have the Windows client drivers available and installed on the clients. This is illustrated in \hyperlink{small11}{Figure {\ref{small11}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{small11}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/11small}
{{\caption[{Print Driver Execution on the Client.}]{{{Print Driver Execution on the Client.}}}\label{small11}}}
\end{center}
\end{figure}

\subsection{Driver Execution on the Server}
\label{id2602635}\hypertarget{id2602635}{}%

\index{PostScript} \index{PCL} \index{ESC/P} \index{EMF} \index{GDI} The other path executes the printer driver on the server. The client transfers print files in EMF format to the server. The server uses the PostScript, PCL, ESC/P, or other driver to convert the EMF file into the printer-specific language. It is not possible for UNIX to do the same. Currently, there is no program or method to convert a Windows client's GDI output on a UNIX server into something a printer could understand. This is illustrated in \hyperlink{small12}{Figure {\ref{small12}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{small12}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/12small}
{{\caption[{Print Driver Execution on the Server.}]{{{Print Driver Execution on the Server.}}}\label{small12}}}
\end{center}
\end{figure}


However, something similar is possible with CUPS, so read on.

% ------------------------   
% Section 
\section{Network Printing (Windows Clients and UNIX/Samba Print Servers)}
\label{id2602720}\hypertarget{id2602720}{}%

Since UNIX print servers {\em{cannot}} execute the Win32 program code on their platform, the picture is somewhat different. However, this does not limit your options all that much. On the contrary, you may have a way here to implement printing features that are not possible otherwise.
\subsection{From Windows Clients to a CUPS/Samba Print Server}
\label{id2602738}\hypertarget{id2602738}{}%

Here is a simple recipe showing how you can take advantage of CUPS's powerful features for the benefit of your Windows network printing clients:

\begin{itemize}
%--- Item
\item 
Let the Windows clients send PostScript to the CUPS server.


%--- Item
\item 
Let the CUPS server render the PostScript into device-specific raster format.

\end{itemize}

This requires the clients to use a PostScript driver (even if the printer is a non-PostScript model. It also requires that you have a driver on the CUPS server.

First, to enable CUPS-based printing through Samba, the following options should be set in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file {\ttfamily\itshape{\docbookhyphenatedot{[global]}}} section:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	printing = cups
 	printcap = cups
\end{lstlisting}

When these parameters are specified, all manually set print directives (like \smbconfoption{print command} or \smbconfoption{lppause command}) in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} (as well as in Samba itself) will be ignored. Instead, Samba will directly interface with CUPS through its application program interface (API), as long as Samba has been compiled with CUPS library (libcups) support. If Samba has not been compiled with CUPS support, and if no other print commands are set up, then printing will use the {\em{System V}} AT\&T command set, with the -oraw option automatically passing through (if you want your own defined print commands to work with a Samba server that has CUPS support compiled in, simply use \smbconfoption{classicalprinting} = sysv). This is illustrated in \hyperlink{13small}{Figure {\ref{13small}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{13small}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/13small}
{{\caption[{Printing via CUPS/Samba Server.}]{{{Printing via CUPS/Samba Server.}}}\label{13small}}}
\end{center}
\end{figure}

\subsection{Samba Receiving Job-Files and Passing Them to CUPS}
\label{id2602870}\hypertarget{id2602870}{}%

Samba {\em{must}} use its own spool directory (it is set by a line similar to \smbconfoption{path} = /var/spool/samba, in the \smbconfsection{[printers]} or \smbconfsection{[printername]} section of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}). Samba receives the job in its own spool space and passes it into the spool directory of CUPS (the CUPS spool directory is set by the {\ttfamily\itshape{\docbookhyphenatedot{RequestRoot}}} directive in a line that defaults to {\ttfamily\itshape{\docbookhyphenatedot{RequestRoot /var/spool/cups}}}). CUPS checks the access rights of its spool directory and resets it to healthy values with every restart. We have seen quite a few people who used a common spooling space for Samba and CUPS, and struggled for weeks with this {``}problem.{''}

A Windows user authenticates only to Samba (by whatever means is configured). If Samba runs on the same host as CUPS, you only need to allow {``}localhost{''} to print. If it runs on different machines, you need to make sure the Samba host gets access to printing on CUPS.

% ------------------------   
% Section 
\section{Network PostScript RIP}
\label{id2602944}\hypertarget{id2602944}{}%

This section discusses the use of CUPS filters on the server ---  configuration where clients make use of a PostScript driver with CUPS-PPDs.

\index{PostScript} \index{PCL} \index{PJL} PPDs can control all print device options. They are usually provided by the manufacturer ---  if you own a PostScript printer, that is. PPD files are always a component of PostScript printer drivers on MS Windows or Apple Mac OS systems. They are ASCII files containing user-selectable print options, mapped to appropriate PostScript, PCL, or PJL commands for the target printer. Printer driver GUI dialogs translate these options {``}on the fly{''} into buttons and drop-down lists for the user to select.

CUPS can load, without any conversions, the PPD file from any Windows (NT is recommended) PostScript driver and handle the options. There is a Web browser interface to the print options (select {\textless}\url{http://localhost:631/printers/}{\textgreater} and click on one {\sffamily \bfseries Configure Printer} button to see it) or a command line interface (see {\bfseries{man lpoptions}} or see if you have {\bfseries{lphelp}} on your system). There are also some different GUI front-ends on Linux/UNIX, which can present PPD options to users. PPD options are normally meant to be evaluated by the PostScript RIP on the real PostScript printer.
\subsection{PPDs for Non-PS Printers on UNIX}
\label{id2603036}\hypertarget{id2603036}{}%

\index{PPD} CUPS does not limit itself to {``}real{''} PostScript printers in its use of PPDs. The CUPS developers have extended the scope of the PPD concept to also describe available device and driver options for non-PostScript printers through CUPS-PPDs.

This is logical, because CUPS includes a fully featured PostScript interpreter (RIP). This RIP is based on Ghostscript. It can process all received PostScript (and additionally many other file formats) from clients. All CUPS-PPDs geared to non-PostScript printers contain an additional line, starting with the keyword {\ttfamily\itshape{\docbookhyphenatedot{*cupsFilter}}}. This line tells the CUPS print system which printer-specific filter to use for the interpretation of the supplied PostScript. Thus CUPS lets all its printers appear as PostScript devices to its clients, because it can act as a PostScript RIP for those printers, processing the received PostScript code into a proper raster print format.
\subsection{PPDs for Non-PS Printers on Windows}
\label{id2603083}\hypertarget{id2603083}{}%

\index{PPD} CUPS-PPDs can also be used on Windows clients, on top of a {``}core{''} PostScript driver (now recommended is the CUPS PostScript Driver for Windows NT/200x/XP; you can also use the Adobe one, with limitations). This feature enables CUPS to do a few tricks no other spooler can do:

\begin{itemize}
%--- Item
\item 
Act as a networked PostScript RIP handling print files from all client platforms in a uniform way.


%--- Item
\item 
Act as a central accounting and billing server, since all files are passed through the pstops filter and are therefore logged in the CUPS {\texttt{\docbookhyphenatefilename{page\_\dbz{}log}}} file. {\em{Note:}} this cannot happen with {``}raw{''} print jobs, which always remain unfiltered per definition.


%--- Item
\item 
Enable clients to consolidate on a single PostScript driver, even for many different target printers.

\end{itemize}

Using CUPS PPDs on Windows clients enables them to control all print job settings just as a UNIX client can do.

% ------------------------   
% Section 
\section{Windows Terminal Servers (WTS) as CUPS Clients}
\label{id2603155}\hypertarget{id2603155}{}%

This setup may be of special interest to people experiencing major problems in WTS environments. WTS often need a multitude of non-PostScript drivers installed to run their clients' variety of different printer models. This often imposes the price of much increased instability.
\subsection{Printer Drivers Running in {``}Kernel Mode{''} Cause Many Problems}
\label{id2603170}\hypertarget{id2603170}{}%

Windows NT printer drivers, which run in {``}kernel mode{''}, introduce a high risk for the stability of the system if the driver is not really stable and well-tested. And there are a lot of bad drivers out there! Especially notorious is the example of the PCL printer driver that had an additional sound module running to notify users via soundcard of their finished jobs. Do I need to say that this one was also reliably causing {``}blue screens of death{''} on a regular basis?

PostScript drivers are generally well-tested. They are not known to cause any problems, even though they also run in kernel mode. This might be because until now there have been only two different PostScript drivers: the one from Adobe and the one from Microsoft. Both are well-tested and are as stable as you can imagine on Windows. The CUPS driver is derived from the Microsoft one.
\subsection{Workarounds Impose Heavy Limitations}
\label{id2603210}\hypertarget{id2603210}{}%

In an attempt to work around problems, site administrators have resorted to restricting the allowed drivers installed on their WTS to one generic PCL and one PostScript driver. This, however, restricts the number of printer options available for clients to use. Often they can't get out more than simplex prints from one standard paper tray, while their devices could do much better if driven by a different driver!
\subsection{CUPS: A {``}Magical Stone{''}?}
\label{id2603228}\hypertarget{id2603228}{}%

\index{PPD} \index{PostScript} Using a PostScript driver, enabled with a CUPS-PPD, seems to be a very elegant way to overcome all these shortcomings. There are, depending on the version of Windows OS you use, up to three different PostScript drivers now available: Adobe, Microsoft, and CUPS PostScript drivers. None of them is known to cause major stability problems on WTS (even if used with many different PPDs). The clients will be able to (again) choose paper trays, duplex printing, and other settings. However, there is a certain price for this too: a CUPS server acting as a PostScript RIP for its clients requires more CPU and RAM than when just acting as a {``}raw spooling{''} device. Plus, this setup is not yet widely tested, although the first feedbacks look very promising.
\subsection{PostScript Drivers with No Major Problems, Even in Kernel Mode}
\label{id2603274}\hypertarget{id2603274}{}%

\index{DDK} \index{W32X86} \index{PostScript} \index{Visual Studio} \index{Microsoft driver} \index{Adobe} More recent printer drivers on W200x and XP no longer run in kernel mode (unlike Windows NT). However, both operating systems can still use the NT drivers, running in kernel mode (you can roughly tell which is which as the drivers in subdirectory {``}2{''} of {``}W32X86{''} are {``}old{''} ones). As was said before, the Adobe as well as the Microsoft PostScript drivers are not known to cause any stability problems. The CUPS driver is derived from the Microsoft one. There is a simple reason for this: the MS DDK (Device Development Kit) for Windows NT (which used to be available at no cost to licensees of Visual Studio) includes the source code of the Microsoft driver, and licensees of Visual Studio are allowed to use and modify it for their own driver development efforts. This is what the CUPS people have done. The license does not allow them to publish the whole of the source code. However, they have released the {``}diff{''} under the GPL, and if you are the owner of an {``}MS DDK for Windows NT,{''} you can check the driver yourself.

% ------------------------   
% Section 
\section{Configuring CUPS for Driver Download}
\label{id2603364}\hypertarget{id2603364}{}%

As we have said before, all previously known methods to prepare client printer drivers on the Samba server for download and Point'n'Print convenience of Windows workstations are working with CUPS, too. These methods were described in \hyperlink{classicalprinting}{Chapter {\ref{classicalprinting}}, {``}Classical Printing Support{''}}. In reality, this is a pure Samba business and relates only to the Samba-Windows client relationship.
\subsection{{\em{cupsaddsmb}}: The Unknown Utility}
\label{id2603386}\hypertarget{id2603386}{}%

\index{cupsaddsmb} The {\ttfamily\itshape{\docbookhyphenatedot{cupsaddsmb}}} utility (shipped with all current CUPS versions) is an alternative method to transfer printer drivers into the Samba \smbconfsection{[print\$]} share. Remember, this share is where clients expect drivers deposited and set up for download and installation. It makes the sharing of any (or all) installed CUPS printers quite easy. {\bfseries{cupsaddsmb}} can use the Adobe PostScript driver as well as the newly developed CUPS PostScript driver for Windows NT/200x/XP. {\ttfamily\itshape{\docbookhyphenatedot{cupsaddsmb}}} does {\em{not}} work with arbitrary vendor printer drivers, but only with the {\em{exact}} driver files that are named in its man page.

The CUPS printer driver is available from the CUPS download site. Its package name is {\texttt{\docbookhyphenatefilename{cups-\dbz{}samba-\dbz{}[version].\dbz{}tar.\dbz{}gz}}}. It is preferred over the Adobe drivers because it has a number of advantages:

\begin{itemize}
%--- Item
\item 
It supports a much more accurate page accounting.


%--- Item
\item 
It supports banner pages and page labels on all printers.


%--- Item
\item 
It supports the setting of a number of job IPP attributes (such as job priority, page label, and job billing).

\end{itemize}

However, currently only Windows NT, 2000, and XP are supported by the CUPS drivers. You will also need to get the respective part of the Adobe driver if you need to support Windows 95, 98, and Me clients.
\subsection{Prepare Your smb.\dbz{}conf for cupsaddsmb}
\label{id2603486}\hypertarget{id2603486}{}%

Prior to running {\bfseries{cupsaddsmb}}, you need the settings in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} as shown in \hyperlink{cupsadd-ex}{Example {\ref{cupsadd-ex}}}.

\begin{example}%
\hypertarget{cupsadd-ex}{}%
\captionswapskip{}{{\caption{smb.conf for cupsaddsmb Usage}\label{cupsadd-ex}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 	load printers = yes
 	printing = cups
 	printcap name = cups
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	browseable = no
 # setting depends on your requirements
 	guest ok = yes
 	writable = no
 	printable = yes
 	printer admin = root
 [print$]
 	comment = Printer Drivers
 	path = /etc/samba/drivers
 	browseable = yes
 	guest ok = no
 	read only = yes
 	write list = root, @smbprintadm
\end{lstlisting}
\end{example}

\subsection{CUPS {``}PostScript Driver for Windows NT/200x/XP{''}}
\label{id2603663}\hypertarget{id2603663}{}%

\index{PostScript} CUPS users may get the exact same package from {\textless}\url{http://www.cups.org/software.html}{\textgreater}. It is a separate package from the CUPS-based software files, tagged as CUPS 1.1.x Windows NT/200x/XP Printer Driver for Samba (tar.gz, 192k). The filename to download is {\texttt{\docbookhyphenatefilename{cups-\dbz{}samba-\dbz{}1.\dbz{}1.\dbz{}x.\dbz{}tar.\dbz{}gz}}}. Upon untar and unzipping, it will reveal these files: 
\begin{Verbatim}[]

root# tar xvzf cups-samba-1.1.19.tar.gz
cups-samba.install
cups-samba.license
cups-samba.readme
cups-samba.remove
cups-samba.ss

\end{Verbatim}


\index{ESP!meta packager} \index{EPM|textit{see} {ESP meta packager} } These have been packaged with the ESP meta-packager software EPM. The {\texttt{\docbookhyphenatefilename{*.\dbz{}install}}} and {\texttt{\docbookhyphenatefilename{*.\dbz{}remove}}} files are simple shell scripts, which untar the {\texttt{\docbookhyphenatefilename{*.\dbz{}ss}}} (the {\texttt{\docbookhyphenatefilename{*.\dbz{}ss}}} is nothing else but a tar archive, which can be untarred by {``}tar{''} too). Then it puts the content into {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}drivers/\dbz{}}}}. This content includes three files: 
\begin{Verbatim}[]

root# tar tv cups-samba.ss
cupsdrvr.dll
cupsui.dll
cups.hlp  

\end{Verbatim}


The {\ttfamily\itshape{\docbookhyphenatedot{cups-samba.install}}} shell scripts are easy to handle: 
\begin{Verbatim}[]

root# ./cups-samba.install
[....]
Installing software...
Updating file permissions...
Running post-install commands...
Installation is complete.       

\end{Verbatim}


The script should automatically put the driver files into the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}drivers/\dbz{}}}} directory: 
\begin{Verbatim}[]

root# cp /usr/share/drivers/cups.hlp /usr/share/cups/drivers/

\end{Verbatim}


\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Due to a bug, one recent CUPS release puts the {\texttt{\docbookhyphenatefilename{cups.\dbz{}hlp}}} driver file into{\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}drivers/\dbz{}}}} instead of {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}drivers/\dbz{}}}}. To work around this, copy/move the file (after running the {\bfseries{./cups-samba.install}} script) manually to the correct place.
\end{admonition}


\index{DDK} This new CUPS PostScript driver is currently binary only, but free of charge. No complete source code is provided (yet). The reason is that it has been developed with the help of the Microsoft DDK and compiled with Microsoft Visual Studio 6. Driver developers are not allowed to distribute the whole of the source code as free software. However, CUPS developers released the {``}diff{''} in source code under the GPL, so anybody with a license for Visual Studio and a DDK will be able to compile for himself or herself.
\subsection{Recognizing Different Driver Files}
\label{id2603908}\hypertarget{id2603908}{}%

The CUPS drivers do not support the older Windows 95/98/Me, but only the Windows NT/2000/XP client.

Windows NT, 2000, and XP are supported by:

\begin{itemize}
%--- Item
\item 
cups.hlp


%--- Item
\item 
cupsdrvr.dll


%--- Item
\item 
cupsui.dll

\end{itemize}

Adobe drivers are available for the older Windows 95/98/Me as well as for Windows NT/2000/XP clients. The set of files is different from the different platforms.

Windows 95, 98, and ME are supported by:

\begin{itemize}
%--- Item
\item 
ADFONTS.MFM


%--- Item
\item 
ADOBEPS4.DRV


%--- Item
\item 
ADOBEPS4.HLP


%--- Item
\item 
DEFPRTR2.PPD


%--- Item
\item 
ICONLIB.DLL


%--- Item
\item 
PSMON.DLL

\end{itemize}

Windows NT, 2000, and XP are supported by:

\begin{itemize}
%--- Item
\item 
ADOBEPS5.DLL


%--- Item
\item 
ADOBEPSU.DLL


%--- Item
\item 
ADOBEPSU.HLP

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Adobe driver files} If both the Adobe driver files and the CUPS driver files for the support of Windows NT/200x/XP are presently installed on the server, the Adobe files will be ignored and the CUPS files will be used. If you prefer ---  for whatever reason ---  to use Adobe-only drivers, move away the three CUPS driver files. The Windows 9x/Me clients use the Adobe drivers in any case.
\end{admonition}

\subsection{Acquiring the Adobe Driver Files}
\label{id2604033}\hypertarget{id2604033}{}%

Acquiring the Adobe driver files seems to be unexpectedly difficult for many users. They are not available on the Adobe Web site as single files, and the self-extracting and/or self-installing Windows-.exe is not easy to locate either. You probably need to use the included native installer and run the installation process on one client once. This will install the drivers (and one generic PostScript printer) locally on the client. When they are installed, share the generic PostScript printer. After this, the client's \smbconfsection{[print\$]} share holds the Adobe files, which you can get with smbclient from the CUPS host.
\subsection{ESP Print Pro PostScript Driver for Windows NT/200x/XP}
\label{id2604059}\hypertarget{id2604059}{}%

\index{ESP!Print Pro} Users of the ESP Print Pro software are able to install the ESP print drivers package as an alternative to the Adobe PostScript drivers. To do so, retrieve the driver files from the normal download area of the ESP Print Pro software at Easy Software\label{id2604082}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.easysw.com/software.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2604082} web site. You need to locate the link labeled {``}SAMBA{''} among the {\sffamily \bfseries Download Printer Drivers for ESP Print Pro 4.x} area and download the package. Once installed, you can prepare any driver by simply highlighting the printer in the Printer Manager GUI and selecting {\sffamily \bfseries Export Driver...} from the menu. Of course, you need to have prepared Samba beforehand to handle the driver files; that is, set up the \smbconfsection{[print\$]} share, and so on. The ESP Print Pro package includes the CUPS driver files as well as a (licensed) set of Adobe drivers for the Windows 95/98/Me client family.
\subsection{Caveats to Be Considered}
\label{id2604122}\hypertarget{id2604122}{}%

\index{cupsaddsmb} \index{cups.hlp} \index{WIN40} \index{W32X86} Once you have run the install script (and possibly manually moved the {\texttt{\docbookhyphenatefilename{cups.\dbz{}hlp}}} file to {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}drivers/\dbz{}}}}), the driver is ready to be put into Samba's \smbconfsection{[print\$]} share (which often maps to {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}drivers/\dbz{}}}} and contains a subdirectory tree with {\em{WIN40}} and {\em{W32X86}} branches). You do this by running {\bfseries{cupsaddsmb}} (see also {\bfseries{man cupsaddsmb}} for CUPS since release 1.1.16).

\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Single Sign-On} \index{Domain Controller} You may need to put root into the smbpasswd file by running {\bfseries{smbpasswd}}; this is especially important if you should run this whole procedure for the first time and are not working in an environment where everything is configured for {\em{single sign-on}} to a Windows Domain Controller.
\end{admonition}


Once the driver files are in the \smbconfsection{[print\$]} share and are initialized, they are ready to be downloaded and installed by the Windows NT/200x/XP clients.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Win 9x/Me clients will not work with the CUPS PostScript driver. For these you still need to use the {\texttt{\docbookhyphenatefilename{ADOBE*.\dbz{}*}}} drivers, as previously stated.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

It is not harmful if you still have the {\texttt{\docbookhyphenatefilename{ADOBE*.\dbz{}*}}} driver files from previous installations in the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}drivers/\dbz{}}}} directory. The new {\bfseries{cupsaddsmb}} (from 1.1.16) will automatically prefer its own drivers if it finds both.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{""Printers"" folder} \index{Adobe PostScript} Should your Windows clients have had the old {\texttt{\docbookhyphenatefilename{ADOBE*.\dbz{}*}}} files for the Adobe PostScript driver installed, the download and installation of the new CUPS PostScript driver for Windows NT/200x/XP will fail at first. You need to wipe the old driver from the clients first. It is not enough to {``}delete{''} the printer, because the driver files will still be kept by the clients and re-used if you try to re-install the printer. To really get rid of the Adobe driver files on the clients, open the {\sffamily \bfseries Printers} folder (possibly via {\sffamily \bfseries Start -\textgreater{} Settings -\textgreater{} Control Panel -\textgreater{} Printers}), right-click on the folder background, and select {\sffamily \bfseries Server Properties}. When the new dialog opens, select the {\sffamily \bfseries Drivers} tab. On the list select the driver you want to delete and click the {\sffamily \bfseries Delete} button. This will only work if there is not one single printer left that uses that particular driver. You need to {``}delete{''} all printers using this driver in the {\sffamily \bfseries Printers} folder first. You will need Administrator privileges to do this.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{rpcclient!setdriver} \index{CUPS PostScript} Once you have successfully downloaded the CUPS PostScript driver to a client, you can easily switch all printers to this one by proceeding as described in \hyperlink{classicalprinting}{Chapter {\ref{classicalprinting}}, {``}Classical Printing Support{''}}. Either change a driver for an existing printer by running the {\sffamily \bfseries Printer Properties} dialog, or use {\bfseries{rpcclient}} with the {\bfseries{setdriver}} subcommand.
\end{admonition}

\subsection{Windows CUPS PostScript Driver Versus Adobe Driver}
\label{id2604424}\hypertarget{id2604424}{}%

Are you interested in a comparison between the CUPS and the Adobe PostScript drivers? For our purposes, these are the most important items that weigh in favor of CUPS:

\begin{itemize}
%--- Item
\item 
No hassle with the Adobe EULA.


%--- Item
\item 
No hassle with the question, {``}Where do I get the ADOBE*.* driver files?{''}


%--- Item
\item 
\index{PJL} The Adobe drivers (on request of the printer PPD associated with them) often put a PJL header in front of the main PostScript part of the print file. Thus, the print file starts with {\ttfamily\itshape{\docbookhyphenatedot{\textless{}1B \textgreater{}\%-12345X}}} or {\ttfamily\itshape{\docbookhyphenatedot{\textless{}escape\textgreater{}\%-12345X}}} instead of {\ttfamily\itshape{\docbookhyphenatedot{\%!PS}}}. This leads to the CUPS daemon autotyping the incoming file as a print-ready file, not initiating a pass through the {\ttfamily\itshape{\docbookhyphenatedot{pstops}}} filter (to speak more technically, it is not regarded as the generic MIME-type \index{application/postscript} {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}}, but as the more special MIME type \index{application/cups.vnd-postscript} {\ttfamily\itshape{\docbookhyphenatedot{application/cups.vnd-postscript}}}), which therefore also leads to the page accounting in {\ttfamily\itshape{\docbookhyphenatedot{/var/log/cups/page\_log}}} not receiving the exact number of pages; instead the dummy page number of {``}1{''} is logged in a standard setup).


%--- Item
\item 
The Adobe driver has more options to misconfigure the \index{Adobe driver} PostScript generated by it (like setting it inadvertently to {\sffamily \bfseries Optimize for Speed} instead of {\sffamily \bfseries Optimize for Portability}, which could lead to CUPS being unable to process it).


%--- Item
\item 
The CUPS PostScript driver output sent by Windows \index{CUPS PostScript driver} clients to the CUPS server is guaranteed to autotype as the generic MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/postscript}}}, thus passing through the CUPS {\ttfamily\itshape{\docbookhyphenatedot{pstops}}} filter and logging the correct number of pages in the {\texttt{\docbookhyphenatefilename{page\_\dbz{}log}}} for accounting and quota purposes.


%--- Item
\item 
\index{banner pages} The CUPS PostScript driver supports the sending of additional standard (IPP) print options by Windows NT/200x/XP clients. Such additional print options are naming the CUPS standard {\em{banner pages}} (or the custom ones, should they be installed at the time of driver download), using the CUPS page-label option, setting a job priority, and setting the scheduled time of printing (with the option to support additional useful IPP job attributes in the future).


%--- Item
\item 
The CUPS PostScript driver supports the inclusion of the new {\ttfamily\itshape{\docbookhyphenatedot{*cupsJobTicket}}} comments at the beginning of the PostScript file (which could be used in the future for all sorts of beneficial extensions on the CUPS side, but which will not disturb any other applications because they will regard it as a comment and simply ignore it).


%--- Item
\item 
The CUPS PostScript driver will be the heart of the fully fledged CUPS IPP client for Windows NT/200x/XP to be released soon (probably alongside the first beta release for CUPS 1.2).

\end{itemize}
\subsection{Run cupsaddsmb (Quiet Mode)}
\label{id2604646}\hypertarget{id2604646}{}%

\index{cupsaddsmb} \index{point 'n' print} The {\bfseries{cupsaddsmb}} command copies the needed files into your \smbconfsection{[print\$]} share. Additionally, the PPD associated with this printer is copied from {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}ppd/\dbz{}}}} to \smbconfsection{[print\$]}. There the files wait for convenient Windows client installations via Point'n'Print. Before we can run the command successfully, we need to be sure that we can authenticate toward Samba. If you have a small network, you are probably using user-level security (\smbconfoption{security} = user).

Here is an example of a successfully run {\bfseries{cupsaddsmb}} command: \index{banner pages} \index{cupsaddsmb} 
\begin{Verbatim}[]

root# cupsaddsmb -U root infotec_IS2027
Password for root required to access localhost via Samba: ['secret']

\end{Verbatim}


\index{cupsaddsmb} To share {\em{all}} printers and drivers, use the {\texttt{\docbookhyphenatedot{-a}}} parameter instead of a printer name. Since {\bfseries{cupsaddsmb}} {``}exports{''} the printer drivers to Samba, it should be obvious that it only works for queues with a CUPS driver associated.
\subsection{Run cupsaddsmb with Verbose Output}
\label{id2604783}\hypertarget{id2604783}{}%

\index{cupsaddsmb} Probably you want to see what's going on. Use the {\texttt{\docbookhyphenatedot{-v}}} parameter to get a more verbose output. The output below was edited for better readability: all {``}\textbackslash{''} at the end of a line indicate that I inserted an artificial line break plus some indentation here: \index{rpcclient!adddriver} \index{rpcclient!setdriver} 
\begin{Verbatim}[]

root# cupsaddsmb -U root -v infotec_2105
Password for root required to access localhost via GANDALF:
Running command: smbclient //localhost/print\$ -N -U'root%secret' \
    -c 'mkdir W32X86; \
    put /var/spool/cups/tmp/3e98bf2d333b5 W32X86/infotec_2105.ppd; \
	put /usr/share/cups/drivers/cupsdrvr.dll W32X86/cupsdrvr.dll; \
    put /usr/share/cups/drivers/cupsui.dll W32X86/cupsui.dll; \
    put /usr/share/cups/drivers/cups.hlp W32X86/cups.hlp'
added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a]
NT_STATUS_OBJECT_NAME_COLLISION making remote directory \W32X86
putting file /var/spool/cups/tmp/3e98bf2d333b5 as \W32X86/infotec_2105.ppd
putting file /usr/share/cups/drivers/cupsdrvr.dll as \W32X86/cupsdrvr.dll
putting file /usr/share/cups/drivers/cupsui.dll as \W32X86/cupsui.dll
putting file /usr/share/cups/drivers/cups.hlp as \W32X86/cups.hlp
  
Running command: rpcclient localhost -N -U'root%secret' 
   -c 'adddriver "Windows NT x86"   \
   "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \
    RAW:NULL"'
cmd = adddriver "Windows NT x86" \
   "infotec_2105:cupsdrvr.dll:infotec_2105.ppd:cupsui.dll:cups.hlp:NULL: \
	RAW:NULL"
Printer Driver infotec_2105 successfully installed.
  
Running command: smbclient //localhost/print\$ -N -U'root%secret' \
-c 'mkdir WIN40; \
    put /var/spool/cups/tmp/3e98bf2d333b5 WIN40/infotec_2105.PPD; \
	put /usr/share/cups/drivers/ADFONTS.MFM WIN40/ADFONTS.MFM;   \
    put /usr/share/cups/drivers/ADOBEPS4.DRV WIN40/ADOBEPS4.DRV; \
    put /usr/share/cups/drivers/ADOBEPS4.HLP WIN40/ADOBEPS4.HLP; \
    put /usr/share/cups/drivers/DEFPRTR2.PPD WIN40/DEFPRTR2.PPD; \
	put /usr/share/cups/drivers/ICONLIB.DLL WIN40/ICONLIB.DLL; \
	put /usr/share/cups/drivers/PSMON.DLL WIN40/PSMON.DLL;'
  added interface ip=10.160.51.60 bcast=10.160.51.255 nmask=255.255.252.0
  Domain=[CUPS-PRINT] OS=[UNIX] Server=[Samba 2.2.7a]
  NT_STATUS_OBJECT_NAME_COLLISION making remote directory \WIN40
  putting file /var/spool/cups/tmp/3e98bf2d333b5 as \WIN40/infotec_2105.PPD
  putting file /usr/share/cups/drivers/ADFONTS.MFM as \WIN40/ADFONTS.MFM
  putting file /usr/share/cups/drivers/ADOBEPS4.DRV as \WIN40/ADOBEPS4.DRV
  putting file /usr/share/cups/drivers/ADOBEPS4.HLP as \WIN40/ADOBEPS4.HLP
  putting file /usr/share/cups/drivers/DEFPRTR2.PPD as \WIN40/DEFPRTR2.PPD
  putting file /usr/share/cups/drivers/ICONLIB.DLL as \WIN40/ICONLIB.DLL
  putting file /usr/share/cups/drivers/PSMON.DLL as \WIN40/PSMON.DLL
  
  Running command: rpcclient localhost -N -U'root%secret' \
   -c 'adddriver "Windows 4.0"      \
   "infotec_2105:ADOBEPS4.DRV:infotec_2105.PPD:NULL:ADOBEPS4.HLP: \
   PSMON.DLL:RAW:ADOBEPS4.DRV,infotec_2105.PPD,ADOBEPS4.HLP,PSMON.DLL, \
    ADFONTS.MFM,DEFPRTR2.PPD,ICONLIB.DLL"'
	cmd = adddriver "Windows 4.0" "infotec_2105:ADOBEPS4.DRV:\
	infotec_2105.PPD:NULL:ADOBEPS4.HLP:PSMON.DLL:RAW:ADOBEPS4.DRV,\
	infotec_2105.PPD,ADOBEPS4.HLP,PSMON.DLL,ADFONTS.MFM,DEFPRTR2.PPD,\
	ICONLIB.DLL"
  Printer Driver infotec_2105 successfully installed.
  
  Running command: rpcclient localhost -N -U'root%secret'  \
   -c 'setdriver infotec_2105 infotec_2105'
  cmd = setdriver infotec_2105 infotec_2105
  Successfully set infotec_2105 to driver infotec_2105.

\end{Verbatim}


\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

You will see the root password for the Samba account printed on screen.
\end{admonition}


If you look closely, you'll discover your root password was transferred unencrypted over the wire, so beware! Also, if you look further, you may discover error messages like NT\_STATUS\_OBJECT\_NAME\_COLLISION in the output. This will occur when the directories WIN40 and W32X86 already existed in the \smbconfsection{[print\$]} driver download share (from a previous driver installation). These are harmless warning messages.
\subsection{Understanding cupsaddsmb}
\label{id2604922}\hypertarget{id2604922}{}%

\index{cupsaddsmb} What has happened? What did {\bfseries{cupsaddsmb}} do? There are five stages of the procedure:

\begin{enumerate}
%--- Item
\item 
\index{IPP} Call the CUPS server via IPP and request the driver files and the PPD file for the named printer.


%--- Item
\item 
Store the files temporarily in the local TEMPDIR (as defined in {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}}).


%--- Item
\item 
Connect via smbclient to the Samba server's \smbconfsection{[print\$]} share and put the files into the share's WIN40 (for Windows 9x/Me) and W32X86 (for Windows NT/200x/XP) subdirectories.


%--- Item
\item 
\index{rpcclient!adddriver} Connect via rpcclient to the Samba server and execute the {\bfseries{adddriver}} command with the correct parameters.


%--- Item
\item 
\index{rpcclient!setdriver} Connect via rpcclient to the Samba server a second time and execute the {\bfseries{setdriver}} command.

\end{enumerate}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

You can run the {\bfseries{cupsaddsmb}} utility with parameters to specify one remote host as Samba host and a second remote host as CUPS host. Especially if you want to get a deeper understanding, it is a good idea to try it and see more clearly what is going on (though in real life most people will have their CUPS and Samba servers run on the same host): 
\begin{Verbatim}[]

root# cupsaddsmb -H sambaserver -h cupsserver -v printer

\end{Verbatim}

\end{admonition}

\subsection{How to Recognize If cupsaddsmb Completed Successfully}
\label{id2605071}\hypertarget{id2605071}{}%

You {\em{must}} always check if the utility completed successfully in all fields. You need at minimum these three messages among the output:

\begin{enumerate}
%--- Item
\item 
{\em{Printer Driver infotec\_2105 successfully installed.}} \# (for the W32X86 == Windows NT/200x/XP architecture).


%--- Item
\item 
{\em{Printer Driver infotec\_2105 successfully installed.}} \# (for the WIN40 == Windows 9x/Me architecture).


%--- Item
\item 
{\em{Successfully set [printerXPZ] to driver [printerXYZ].}}

\end{enumerate}

These messages are probably not easily recognized in the general output. If you run {\bfseries{cupsaddsmb}} with the {\texttt{\docbookhyphenatedot{-a}}} parameter (which tries to prepare {\em{all}} active CUPS printer drivers for download), you might miss if individual printer drivers had problems installing properly. A redirection of the output will help you analyze the results in retrospective.

If you get: 
\begin{Verbatim}[]

SetPrinter call failed!
result was WERR_ACCESS_DENIED

\end{Verbatim}
 it means that you might have set \smbconfoption{use client driver} = yes for this printer. Setting it to {``}no{''} will solve the problem. Refer to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for explanation of the {\ttfamily\itshape{\docbookhyphenatedot{use client driver}}}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

It is impossible to see any diagnostic output if you do not run {\bfseries{cupsaddsmb}} in verbose mode. Therefore, we strongly recommend against use of the default quiet mode. It will hide any problems from you that might occur.
\end{admonition}

\subsection{cupsaddsmb with a Samba PDC}
\label{id2605192}\hypertarget{id2605192}{}%

\index{cupsaddsmb} \index{PDC} Can't get the standard {\bfseries{cupsaddsmb}} command to run on a Samba PDC? Are you asked for the password credential again and again, and the command just will not take off at all? Try one of these variations:


\begin{Verbatim}[]

root# cupsaddsmb -U MIDEARTH\\root -v printername
root# cupsaddsmb -H SAURON -U MIDEARTH\\root -v printername
root# cupsaddsmb -H SAURON -U MIDEARTH\\root -h cups-server -v printername

\end{Verbatim}


(Note the two backslashes: the first one is required to {``}escape{''} the second one).
\subsection{cupsaddsmb Flowchart}
\label{id2605276}\hypertarget{id2605276}{}%

\index{cupsaddsmb} \index{raw print} \hyperlink{small14}{Figure {\ref{small14}}} shows a chart about the procedures, command flows, and data flows of the {\bfseries{cupaddsmb}} command. Note again: cupsaddsmb is not intended to, and does not work with, raw print queues!

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{small14}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/14small}
{{\caption[{cupsaddsmb Flowchart.}]{{{cupsaddsmb Flowchart.}}}\label{small14}}}
\end{center}
\end{figure}

\subsection{Installing the PostScript Driver on a Client}
\label{id2605333}\hypertarget{id2605333}{}%

\index{point'n'print} \index{cupsaddsmb} After {\bfseries{cupsaddsmb}} is completed, your driver is prepared for the clients to use. Here are the steps you must perform to download and install it via Point'n'Print. From a Windows client, browse to the CUPS/Samba server:

\begin{itemize}
%--- Item
\item 
\index{""Printers"" folder} Open the {\sffamily \bfseries Printers} share of Samba in Network Neighborhood.


%--- Item
\item 
Right-click on the printer in question.


%--- Item
\item 
From the opening context menu select {\sffamily \bfseries Install...} or {\sffamily \bfseries Connect...} (depending on the Windows version you use).

\end{itemize}

After a few seconds, there should be a new printer in your client's {\em{local}} {\sffamily \bfseries Printers} folder. On Windows XP it will follow a naming convention of {\em{PrinterName on SambaServer}}. (In my current case it is infotec\_2105 on kde-bitshop). If you want to test it and send your first job from an application like Microsoft Word, the new printer appears in a {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\SambaServer\docbooktolatexgobble\string\\PrinterName}}} entry in the drop-down list of available printers.

\index{PPD} \index{Adobe PostScript driver} \index{net use lpt1:} {\bfseries{cupsaddsmb}} will only reliably work with CUPS version 1.1.15 or higher and with Samba version 2.2.4, or later. If it does not work, or if the automatic printer driver download to the clients does not succeed, you can still manually install the CUPS printer PPD on top of the Adobe PostScript driver on clients. Then point the client's printer queue to the Samba printer share for a UNC type of connection: 
\begin{Verbatim}[]

C:\> net use lpt1: \\sambaserver\printershare /user:ntadmin

\end{Verbatim}
 should you desire to use the CUPS networked PostScript RIP functions. (Note that user {``}ntadmin{''} needs to be a valid Samba user with the required privileges to access the printershare.) This sets up the printer connection in the traditional LanMan way (not using MS-RPC).
\subsection{Avoiding Critical PostScript Driver Settings on the Client}
\label{cups-avoidps1}\hypertarget{cups-avoidps1}{}%

Printing works, but there are still problems. Most jobs print well, some do not print at all. Some jobs have problems with fonts, which do not look very good. Some jobs print fast and some are dead-slow. Many of these problems can be greatly reduced or even completely eliminated if you follow a few guidelines. Remember, if your print device is not PostScript-enabled, you are treating your Ghostscript installation on your CUPS host with the output your client driver settings produce. Treat it well:

\begin{itemize}
%--- Item
\item 
Avoid the PostScript Output Option: Optimize for Speed setting. Use the Optimize for Portability instead (Adobe PostScript driver).


%--- Item
\item 
Don't use the Page Independence: NO setting. Instead, use Page Independence: YES (CUPS PostScript Driver).


%--- Item
\item 
Recommended is the True Type Font Downloading Option: Native True Type over Automatic and Outline; you should by all means avoid Bitmap (Adobe PostScript Driver).


%--- Item
\item 
Choose True Type Font: Download as Softfont into Printer over the default Replace by Device Font (for exotic fonts, you may need to change it back to get a printout at all; Adobe).


%--- Item
\item 
Sometimes you can choose PostScript Language Level: in case of problems try 2 instead of 3 (the latest ESP Ghostscript package handles Level 3 PostScript very well; Adobe).


%--- Item
\item 
Say Yes to PostScript Error Handler (Adobe).

\end{itemize}

% ------------------------   
% Section 
\section{Installing PostScript Driver Files Manually Using rpcclient}
\label{id2605577}\hypertarget{id2605577}{}%

Of course, you can run all the commands that are embedded into the cupsaddsmb convenience utility yourself, one by one, and upload and prepare the driver files for future client downloads.

\begin{enumerate}
%--- Item
\item 
Prepare Samba (a CUPS print queue with the name of the printer should be there. We are providing the driver now).


%--- Item
\item 
Copy all files to \smbconfsection{[print\$]}.


%--- Item
\item 
\index{rpcclient!adddriver} Run {\bfseries{rpcclient adddriver}} (for each client architecture you want to support).


%--- Item
\item 
\index{rpcclient!setdriver} Run {\bfseries{rpcclient setdriver.}}

\end{enumerate}

\index{rpcclient!enumports} \index{rpcclient!enumprinters} \index{rpcclient!enumdrivers} \index{rpcclient!setdriver} \index{rpcclient!adddriver} We are going to do this now. First, read the man page on {\ttfamily\itshape{\docbookhyphenatedot{rpcclient}}} to get a first idea. Look at all the printing-related subcommands: {\bfseries{enumprinters}}, {\bfseries{enumdrivers}}, {\bfseries{enumports}}, {\bfseries{adddriver}}, and {\bfseries{setdriver}} are among the most interesting ones. {\ttfamily\itshape{\docbookhyphenatedot{rpcclient}}} implements an important part of the MS-RPC protocol. You can use it to query (and command) a Windows NT (or 200x/XP) PC, too. MS-RPC is used by Windows clients, among other things, to benefit from the Point'n'Print features. Samba can now mimic this as well.
\subsection{A Check of the rpcclient man Page}
\label{id2605755}\hypertarget{id2605755}{}%

First let's check the {\ttfamily\itshape{\docbookhyphenatedot{rpcclient}}} man page. Here are two relevant passages:

\index{adddriver} \index{AddPrinterDriver()} \index{getdriverdir} {\bfseries{adddriver \textless{}arch\textgreater{} \textless{}config\textgreater{}}} Execute an {\bfseries{AddPrinterDriver()}} RPC to install the printer driver information on the server. The driver files should already exist in the directory returned by {\bfseries{getdriverdir}}. Possible values for {\ttfamily\itshape{\docbookhyphenatedot{arch}}} are the same as those for the {\bfseries{getdriverdir}} command. The {\ttfamily\itshape{\docbookhyphenatedot{config}}} parameter is defined as follows: 
\begin{Verbatim}[]

Long Printer Name:\
Driver File Name:\
Data File Name:\
Config File Name:\
Help File Name:\
Language Monitor Name:\
Default Data Type:\
Comma Separated list of Files

\end{Verbatim}


Any empty fields should be entered as the string {``}NULL{''}.

Samba does not need to support the concept of print monitors, since these only apply to local printers whose drivers can use a bidirectional link for communication. This field should be {``}NULL{''}. On a remote NT print server, the print monitor for a driver must already be installed before adding the driver or else the RPC will fail.

\index{setdriver} \index{SetPrinter()} {\bfseries{setdriver \textless{}printername\textgreater{} \textless{}drivername\textgreater{}}} Execute a {\bfseries{SetPrinter()}} command to update the printer driver associated with an installed printer. The printer driver must already be correctly installed on the print server.

\index{enumprinters} \index{enumdrivers} See also the {\bfseries{enumprinters}} and {\bfseries{enumdrivers}} commands to obtain a list of installed printers and drivers.
\subsection{Understanding the rpcclient man Page}
\label{id2605931}\hypertarget{id2605931}{}%

\index{rpcclient!adddriver} The {\em{exact}} format isn't made too clear by the man page, since you have to deal with some parameters containing spaces. Here is a better description for it. We have line-broken the command and indicated the breaks with {``}\textbackslash{''}. Usually you would type the command in one line without the line breaks: 
\begin{Verbatim}[]

adddriver "Architecture" \
   "LongPrinterName:DriverFile:DataFile:ConfigFile:HelpFile:\
   LanguageMonitorFile:DataType:ListOfFiles,Comma-separated"

\end{Verbatim}


What the man pages denote as a simple {\ttfamily\itshape{\docbookhyphenatedot{\textless{}config\textgreater{}}}} keyword in reality consists of eight colon-separated fields. The last field may take multiple (in some very insane cases, even 20 different additional) files. This might sound confusing at first. What the man pages call the {``}LongPrinterName{''} in reality should be called the {``}Driver Name{''}. You can name it anything you want, as long as you use this name later in the {\bfseries{rpcclient ... setdriver}} command. For practical reasons, many name the driver the same as the printer.

It isn't simple at all. I hear you asking: {``}How do I know which files are Driver File{''}, {``}Data File{''}, {``}Config File{''}, {``}Help File{''} and {``}Language Monitor File in each case?{''} For an answer, you may want to have a look at how a Windows NT box with a shared printer presents the files to us. Remember that this whole procedure has to be developed by the Samba Team by listening to the traffic caused by Windows computers on the wire. We may as well turn to a Windows box now and access it from a UNIX workstation. We will query it with {\bfseries{rpcclient}} to see what it tells us and try to understand the man page more clearly.
\subsection{Producing an Example by Querying a Windows Box}
\label{id2606039}\hypertarget{id2606039}{}%

\index{rpcclient!getdriver} \index{rpcclient!getprinter} We could run {\bfseries{rpcclient}} with a {\bfseries{getdriver}} or a {\bfseries{getprinter}} subcommand (in level 3 verbosity) against it. Just sit down at a UNIX or Linux workstation with the Samba utilities installed, then type the following command: 
\begin{Verbatim}[]

root# rpcclient -U'user%secret' NT-SERVER -c 'getdriver printername 3'

\end{Verbatim}


From the result it should become clear which is which. Here is an example from my installation: \index{rpcclient!getdriver} 
\begin{Verbatim}[]

root# rpcclient -U'Danka%xxxx' W200xSERVER \
    -c'getdriver "DANKA InfoStream Virtual Printer" 3'
    cmd = getdriver "DANKA InfoStream Virtual Printer" 3

 [Windows NT x86]
 Printer Driver Info 3:
         Version: [2]
         Driver Name: [DANKA InfoStream]
         Architecture: [Windows NT x86]
         Driver Path: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\PSCRIPT.DLL]
         Datafile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\INFOSTRM.PPD]
         Configfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\PSCRPTUI.DLL]
         Helpfile: [C:\WINNT\System32\spool\DRIVERS\W32X86\2\PSCRIPT.HLP]
 
         Dependentfiles: []
         Dependentfiles: []
         Dependentfiles: []
         Dependentfiles: []
         Dependentfiles: []
         Dependentfiles: []
         Dependentfiles: []
 
         Monitorname: []
         Defaultdatatype: []

\end{Verbatim}


Some printer drivers list additional files under the label {\ttfamily\itshape{\docbookhyphenatedot{Dependentfiles}}}, and these would go into the last field {\ttfamily\itshape{\docbookhyphenatedot{ListOfFiles,Comma-separated}}}. For the CUPS PostScript drivers, we do not need any (nor would we for the Adobe PostScript driver); therefore, the field will get a {``}NULL{''} entry.
\subsection{Requirements for adddriver and setdriver to Succeed}
\label{id2606175}\hypertarget{id2606175}{}%

\index{rpcclient!adddriver} \index{cupsaddsmb} \index{setdriver} From the man page (and from the quoted output of {\bfseries{cupsaddsmb}} above) it becomes clear that you need to have certain conditions in order to make the manual uploading and initializing of the driver files succeed. The two {\bfseries{rpcclient}} subcommands ({\bfseries{adddriver}} and {\bfseries{setdriver}}) need to encounter the following preconditions to complete successfully:

\begin{itemize}
%--- Item
\item 
You are connected as \smbconfoption{printer admin} or root (this is {\em{not}} the {``}Printer Operators{''} group in NT, but the {\em{printer admin}} group as defined in the \smbconfsection{[global]} section of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}).


%--- Item
\item 
Copy all required driver files to {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\SAMBA\docbooktolatexgobble\string\\print\$\docbooktolatexgobble\string\\w32x86}}} and {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\SAMBA\docbooktolatexgobble\string\\print\$\docbooktolatexgobble\string\\win40}}} as appropriate. They will end up in the {``}0{''} respective {``}2{''} subdirectories later. For now, {\em{do not}} put them there; they'll be automatically used by the {\bfseries{adddriver}} subcommand. (If you use {\bfseries{smbclient}} to put the driver files into the share, note that you need to escape the {``}\${''}: {\bfseries{smbclient //sambaserver/print\textbackslash \$ -U root.}})


%--- Item
\item 
The user you're connecting as must be able to write to the \smbconfsection{[print\$]} share and create subdirectories.


%--- Item
\item 
The printer you are going to set up for the Windows clients needs to be installed in CUPS already.


%--- Item
\item 
\index{rpcclient!setdriver} \index{rpcclient!enumprinters} The CUPS printer must be known to Samba; otherwise the {\bfseries{setdriver}} subcommand fails with an NT\_STATUS\_UNSUCCESSFUL error. To check if the printer is known by Samba, you may use the {\bfseries{enumprinters}} subcommand to {\bfseries{rpcclient}}. A long-standing bug prevented a proper update of the printer list until every smbd process had received a SIGHUP or was restarted. Remember this in case you've created the CUPS printer just recently and encounter problems: try restarting Samba.

\end{itemize}
\subsection{Manual Driver Installation in 15 Steps}
\label{id2606395}\hypertarget{id2606395}{}%

We are going to install a printer driver now by manually executing all required commands. Because this may seem a rather complicated process at first, we go through the procedure step by step, explaining every single action item as it comes up.
Manual Driver Installation\begin{enumerate}

\item{{\bf{Install the printer on CUPS.}}

\begin{Verbatim}[]

	root# lpadmin -p mysmbtstprn -v socket://10.160.51.131:9100 -E \
				-P canonIR85.ppd
	
\end{Verbatim}
  This installs a printer with the name {\ttfamily\itshape{\docbookhyphenatedot{mysmbtstprn}}} to the CUPS system. The printer is accessed via a socket (a.k.a. JetDirect or Direct TCP/IP) connection. You need to be root for this step.}

\item{{\bf{(Optional.) Check if the printer is recognized by Samba.}}
\index{rpcclient!enumprinters} 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'enumprinters' localhost \
  | grep -C2 mysmbtstprn
flags:[0x800000]
name:[\\kde-bitshop\mysmbtstprn]
description:[\\kde-bitshop\mysmbtstprn,,mysmbtstprn]
comment:[mysmbtstprn]

\end{Verbatim}
  This should show the printer in the list. If not, stop and restart the Samba daemon (smbd) or send a HUP signal: 
\begin{Verbatim}[]

root# kill -HUP `pidof smbd`

\end{Verbatim}
 Check again. Troubleshoot and repeat until successful. Note the {``}empty{''} field between the two commas in the {``}description{''} line. The driver name would appear here if there was one already. You need to know root's Samba password (as set by the {\bfseries{smbpasswd}} command) for this step and most of the following steps. Alternatively, you can authenticate as one of the users from the {``}write list{''} as defined in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} for \smbconfsection{[print\$]}.}

\item{{\bf{(Optional.) Check if Samba knows a driver for the printer.}}
\index{rpcclient!getprinter} \index{rpcclient!getdriver} 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2'\
 localhost | grep driver 

drivername:[]

root# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' \
 localhost | grep -C4 driv

servername:[\\kde-bitshop]
printername:[\\kde-bitshop\mysmbtstprn]
sharename:[mysmbtstprn]
portname:[Samba Printer Port]
drivername:[]
comment:[mysmbtstprn]
location:[]
sepfile:[]
printprocessor:[winprint]
 
root# rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost
 result was WERR_UNKNOWN_PRINTER_DRIVER

\end{Verbatim}
  None of the three commands shown above should show a driver. This step was done for the purpose of demonstrating this condition. An attempt to connect to the printer at this stage will prompt a message along the lines of, {``}The server does not have the required printer driver installed.{''}}

\item{{\bf{Put all required driver files into Samba's [print\$].}}

\begin{Verbatim}[]

root# smbclient //localhost/print\$ -U 'root%xxxx' \
	-c 'cd W32X86; \
	put /etc/cups/ppd/mysmbtstprn.ppd mysmbtstprn.PPD; \ 
	put /usr/share/cups/drivers/cupsui.dll cupsui.dll; \
	put /usr/share/cups/drivers/cupsdrvr.dll cupsdrvr.dll; \
	put /usr/share/cups/drivers/cups.hlp cups.hlp'

\end{Verbatim}
  (This command should be entered in one long single line. Line breaks and the line ends indicated by {``}\textbackslash{''} have been inserted for readability reasons.) This step is {\em{required}} for the next one to succeed. It makes the driver files physically present in the \smbconfsection{[print\$]} share. However, clients would still not be able to install them, because Samba does not yet treat them as driver files. A client asking for the driver would still be presented with a {``}not installed here{''} message.}

\item{{\bf{Verify where the driver files are now.}}

\begin{Verbatim}[]

root# ls -l /etc/samba/drivers/W32X86/
total 669
drwxr-sr-x    2 root     ntadmin       532 May 25 23:08 2
drwxr-sr-x    2 root     ntadmin       670 May 16 03:15 3
-rwxr--r--    1 root     ntadmin     14234 May 25 23:21 cups.hlp
-rwxr--r--    1 root     ntadmin    278380 May 25 23:21 cupsdrvr.dll
-rwxr--r--    1 root     ntadmin    215848 May 25 23:21 cupsui.dll
-rwxr--r--    1 root     ntadmin    169458 May 25 23:21 mysmbtstprn.PPD

\end{Verbatim}
  The driver files now are in the W32X86 architecture {``}root{''} of \smbconfsection{[print\$]}.}

\item{{\bf{Tell Samba that these are driver files (adddriver).}}
\index{rpcclient!adddriver} 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'adddriver "Windows NT x86" \
	"mydrivername:cupsdrvr.dll:mysmbtstprn.PPD: \
  cupsui.dll:cups.hlp:NULL:RAW:NULL"' \
  localhost
Printer Driver mydrivername successfully installed.

\end{Verbatim}
  You cannot repeat this step if it fails. It could fail even as a result of a simple typo. It will most likely have moved a part of the driver files into the {``}2{''} subdirectory. If this step fails, you need to go back to the fourth step and repeat it before you can try this one again. In this step, you need to choose a name for your driver. It is normally a good idea to use the same name as is used for the printer name; however, in big installations you may use this driver for a number of printers that obviously have different names, so the name of the driver is not fixed.}

\item{{\bf{Verify where the driver files are now.}}

\begin{Verbatim}[]

root# ls -l /etc/samba/drivers/W32X86/
total 1
drwxr-sr-x    2 root     ntadmin       532 May 25 23:22 2
drwxr-sr-x    2 root     ntadmin       670 May 16 03:15 3

root# ls -l /etc/samba/drivers/W32X86/2
total 5039
[....]
-rwxr--r--    1 root     ntadmin     14234 May 25 23:21 cups.hlp
-rwxr--r--    1 root     ntadmin    278380 May 13 13:53 cupsdrvr.dll
-rwxr--r--    1 root     ntadmin    215848 May 13 13:53 cupsui.dll
-rwxr--r--    1 root     ntadmin    169458 May 25 23:21 mysmbtstprn.PPD

\end{Verbatim}
  Notice how step 6 also moved the driver files to the appropriate subdirectory. Compare this with the situation after step 5.}

\item{{\bf{(Optional.) Verify if Samba now recognizes the driver.}}
\index{rpcclient!enumdrivers} 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'enumdrivers 3' \
	localhost | grep -B2 -A5 mydrivername
Printer Driver Info 3:
Version: [2]
Driver Name: [mydrivername]
Architecture: [Windows NT x86]
Driver Path: [\\kde-bitshop\print$\W32X86\2\cupsdrvr.dll]
Datafile: [\\kde-bitshop\print$\W32X86\2\mysmbtstprn.PPD]
Configfile: [\\kde-bitshop\print$\W32X86\2\cupsui.dll]
Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp]

\end{Verbatim}
  Remember, this command greps for the name you chose for the driver in step 6. This command must succeed before you can proceed.}

\item{{\bf{Tell Samba which printer should use these driver files (setdriver).}}
\index{rpcclient!setdriver} 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'setdriver mysmbtstprn mydrivername' \
	localhost
Successfully set mysmbtstprn to driver mydrivername

\end{Verbatim}
  Since you can bind any printer name (print queue) to any driver, this is a convenient way to set up many queues that use the same driver. You do not need to repeat all the previous steps for the setdriver command to succeed. The only preconditions are that {\bfseries{enumdrivers}} must find the driver and {\bfseries{enumprinters}} must find the printer.}

\item{{\bf{(Optional) Verify if Samba has recognized this association.}}
\index{rpcclient!getprinter} \index{rpcclient!getdriver} \index{rpcclient!enumprinters} 
\begin{Verbatim}[]

root# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \
  | grep driver
drivername:[mydrivername]
 
root# rpcclient -Uroot%xxxx -c 'getprinter mysmbtstprn 2' localhost \
  | grep -C4 driv
servername:[\\kde-bitshop]
printername:[\\kde-bitshop\mysmbtstprn]
sharename:[mysmbtstprn]
portname:[Done]
drivername:[mydrivername]
comment:[mysmbtstprn]
location:[]
sepfile:[]
printprocessor:[winprint]
 
root# rpcclient -U root%xxxx -c 'getdriver mysmbtstprn' localhost
[Windows NT x86]
Printer Driver Info 3:
     Version: [2]
     Driver Name: [mydrivername]
     Architecture: [Windows NT x86]
     Driver Path: [\\kde-bitshop\print$\W32X86\2\cupsdrvr.dll]
     Datafile: [\\kde-bitshop\print$\W32X86\2\mysmbtstprn.PPD]
     Configfile: [\\kde-bitshop\print$\W32X86\2\cupsui.dll]
     Helpfile: [\\kde-bitshop\print$\W32X86\2\cups.hlp]
     Monitorname: []
     Defaultdatatype: [RAW]
     Monitorname: []
     Defaultdatatype: [RAW]
 
root# rpcclient -Uroot%xxxx -c 'enumprinters' localhost \
	| grep mysmbtstprn
     name:[\\kde-bitshop\mysmbtstprn]
     description:[\\kde-bitshop\mysmbtstprn,mydrivername,mysmbtstprn]
     comment:[mysmbtstprn]


\end{Verbatim}
  \index{rpcclient!enumprinters} Compare these results with the ones from steps 2 and 3. Every one of these commands show the driver is installed. Even the {\bfseries{enumprinters}} command now lists the driver on the {``}description{''} line.}

\item{{\bf{(Optional.) Tickle the driver into a correct device mode.}}
\index{""Printers"" folder} You certainly know how to install the driver on the client. In case you are not particularly familiar with Windows, here is a short recipe: Browse the Network Neighborhood, go to the Samba server, and look for the shares. You should see all shared Samba printers. Double-click on the one in question. The driver should get installed and the network connection set up. Another way is to open the {\sffamily \bfseries Printers (and Faxes)} folder, right-click on the printer in question, and select {\sffamily \bfseries Connect} or {\sffamily \bfseries Install}. As a result, a new printer should appear in your client's local {\sffamily \bfseries Printers (and Faxes)} folder, named something like {\sffamily \bfseries printersharename on Sambahostname}.  It is important that you execute this step as a Samba printer admin (as defined in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}). Here is another method to do this on Windows XP. It uses a command line, which you may type into the {``}DOS box{''} (type root's smbpassword when prompted):  
\begin{Verbatim}[]

C:\> runas /netonly /user:root "rundll32 printui.dll,PrintUIEntry \
	/in /n \\sambaserver\mysmbtstprn"

\end{Verbatim}
  Change any printer setting once (like changing {\em{{\sffamily \bfseries portrait} to {\sffamily \bfseries landscape}}}), click on {\sffamily \bfseries Apply}, and change the setting back.}

\item{{\bf{Install the printer on a client (Point'n'Print).}}
\index{point 'n' print} 
\begin{Verbatim}[]

C:\> rundll32 printui.dll,PrintUIEntry /in /n "\\sambaserver\mysmbtstprn"

\end{Verbatim}
 If it does not work, it could be a permissions problem with the \smbconfsection{[print\$]} share.}

\item{{\bf{(Optional) Print a test page.}}
\index{rundll32} 
\begin{Verbatim}[]

C:\> rundll32 printui.dll,PrintUIEntry /p /n "\\sambaserver\mysmbtstprn"

\end{Verbatim}
  Then hit [TAB] five times, [ENTER] twice, [TAB] once, and [ENTER] again, and march to the printer.}

\item{{\bf{(Recommended.) Study the test page.}}
Hmmm. Just kidding! By now you know everything about printer installations and you do not need to read a word. Just put it in a frame and bolt it to the wall with the heading "MY FIRST RPCCLIENT-INSTALLED PRINTER" ---  why not just throw it away!}

\item{{\bf{(Obligatory.) Enjoy. Jump. Celebrate your success.}}

\begin{Verbatim}[]

root# echo "Cheeeeerioooooo! Success..." >> /var/log/samba/log.smbd

\end{Verbatim}
}
\end{enumerate}
\subsection{Troubleshooting Revisited}
\label{id2607384}\hypertarget{id2607384}{}%

\index{adddriver} The setdriver command will fail if in Samba's mind the queue is not already there. A successful installation displys the promising message that the: 
\begin{Verbatim}[]

Printer Driver ABC successfully installed.

\end{Verbatim}
 following the {\bfseries{adddriver}} parts of the procedure. But you may also see a disappointing message like this one: {\texttt{\docbookhyphenatedot{result was NT\_STATUS\_UNSUCCESSFUL}}}

\index{lpstat} \index{rpcclient} It is not good enough that you can see the queue in CUPS, using the {\bfseries{lpstat -p ir85wm}} command. A bug in most recent versions of Samba prevents the proper update of the queue list. The recognition of newly installed CUPS printers fails unless you restart Samba or send a HUP to all smbd processes. To verify if this is the reason why Samba does not execute the {\bfseries{setdriver}} command successfully, check if Samba {``}sees{''} the printer: \index{rpcclient!enumprinters} 
\begin{Verbatim}[]

root# rpcclient transmeta -N -U'root%xxxx' -c 'enumprinters 0'|grep ir85wm
        printername:[ir85wm]

\end{Verbatim}


An alternate command could be this: \index{rpcclient!getprinter} 
\begin{Verbatim}[]

root# rpcclient transmeta -N -U'root%secret' -c 'getprinter ir85wm' 
        cmd = getprinter ir85wm
        flags:[0x800000]
        name:[\\transmeta\ir85wm]
        description:[\\transmeta\ir85wm,ir85wm,DPD]
        comment:[CUPS PostScript-Treiber for Windows NT/200x/XP]

\end{Verbatim}


By the way, you can use these commands, plus a few more, of course, to install drivers on remote Windows NT print servers too!

% ------------------------   
% Section 
\section{The Printing *.\dbz{}tdb Files}
\label{id2607531}\hypertarget{id2607531}{}%

\index{TDB} \index{connections.tdb|textit{see also} {TDB} } \index{printing.tdb|textit{see also} {TDB} } \index{share\_info.tdb|textit{see also} {TDB} } \index{ntdrivers.tdb|textit{see also} {TDB} } \index{unexpected.tdb|textit{see also} {TDB} } \index{brlock.tdb|textit{see also} {TDB} } \index{locking.tdb|textit{see also} {TDB} } \index{ntforms.tdb|textit{see also} {TDB} } \index{messages.tdb|textit{see also} {TDB} } \index{ntprinters.tdb|textit{see also} {TDB} } \index{sessionid.tdb|textit{see also} {TDB} } \index{secrets.tdb|textit{see also} {TDB} } Some mystery is associated with the series of files with a tdb suffix appearing in every Samba installation. They are {\texttt{\docbookhyphenatefilename{connections.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{printing.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{share\_\dbz{}info.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{ntdrivers.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{unexpected.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{brlock.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{locking.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{ntforms.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{messages.\dbz{}tdb}}} , {\texttt{\docbookhyphenatefilename{ntprinters.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{sessionid.\dbz{}tdb}}}, and {\texttt{\docbookhyphenatefilename{secrets.\dbz{}tdb}}}. What is their purpose?
\subsection{Trivial Database Files}
\label{id2607744}\hypertarget{id2607744}{}%

\index{TDB} A Windows NT (print) server keeps track of all information needed to serve its duty toward its clients by storing entries in the Windows registry. Client queries are answered by reading from the registry, Administrator or user configuration settings that are saved by writing into the registry. Samba and UNIX obviously do not have such a Registry. Samba instead keeps track of all client-related information in a series of {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files. (TDB stands for trivial data base). These are often located in {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}lib/\dbz{}samba/\dbz{}}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}lock/\dbz{}samba/\dbz{}}}}. The printing-related files are {\texttt{\docbookhyphenatefilename{ntprinters.\dbz{}tdb}}}, {\texttt{\docbookhyphenatefilename{printing.\dbz{}tdb}}},{\texttt{\docbookhyphenatefilename{ntforms.\dbz{}tdb}}}, and {\texttt{\docbookhyphenatefilename{ntdrivers.\dbz{}tdb}}}.
\subsection{Binary Format}
\label{id2607813}\hypertarget{id2607813}{}%

{\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files are not human readable. They are written in a binary format. {``}Why not ASCII?{''}, you may ask. {``}After all, ASCII configuration files are a good and proven tradition on UNIX.{''} The reason for this design decision by the Samba Team is mainly performance. Samba needs to be fast; it runs a separate {\bfseries{smbd}} process for each client connection, in some environments many thousands of them. Some of these {\bfseries{smbds}} might need to write-access the same {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} file {\em{at the same time}}. The file format of Samba's {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files allows for this provision. Many smbd processes may write to the same {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} file at the same time. This wouldn't be possible with pure ASCII files.
\subsection{Losing *.\dbz{}tdb Files}
\label{id2607881}\hypertarget{id2607881}{}%

It is very important that all {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files remain consistent over all write and read accesses. However, it may happen that these files {\em{do}} get corrupted. (A {\bfseries{kill -9 `pidof smbd'}} while a write access is in progress could do the damage, as could a power interruption, etc.). In cases of trouble, a deletion of the old printing-related {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files may be the only option. After that, you need to re-create all print-related setups unless you have made a backup of the {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files in time.
\subsection{Using tdbbackup}
\label{id2607933}\hypertarget{id2607933}{}%

\index{TDB!backing up|textit{see} {tdbbackup} } \index{tdbbackup} Samba ships with a little utility that helps the root user of your system to backup your {\texttt{\docbookhyphenatefilename{*.\dbz{}tdb}}} files. If you run it with no argument, it prints a usage message: 
\begin{Verbatim}[]

root# tdbbackup
 Usage: tdbbackup [options] <fname...>
 
 Version:3.0a
   -h            this help message
   -s suffix     set the backup suffix
   -v            verify mode (restore if corrupt)

\end{Verbatim}


Here is how I backed up my {\texttt{\docbookhyphenatefilename{printing.\dbz{}tdb}}} file:


\begin{Verbatim}[]

root# ls
.              browse.dat     locking.tdb     ntdrivers.tdb printing.tdb
..             share_info.tdb connections.tdb messages.tdb  ntforms.tdb
printing.tdbkp unexpected.tdb brlock.tdb      gmon.out      namelist.debug  
ntprinters.tdb sessionid.tdb
 
root# tdbbackup -s .bak printing.tdb
 printing.tdb : 135 records
 
root# ls -l printing.tdb*
 -rw-------    1 root     root        40960 May  2 03:44 printing.tdb
 -rw-------    1 root     root        40960 May  2 03:44 printing.tdb.bak


\end{Verbatim}


% ------------------------   
% Section 
\section{CUPS Print Drivers from Linuxprinting.org}
\label{id2608053}\hypertarget{id2608053}{}%

\index{Linuxprinting.org} CUPS ships with good support for HP LaserJet-type printers. You can install the generic driver as follows: \index{lpadmin} 
\begin{Verbatim}[]

root# lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E -m laserjet.ppd

\end{Verbatim}


The {\texttt{\docbookhyphenatedot{-m}}} switch will retrieve the {\texttt{\docbookhyphenatefilename{laserjet.\dbz{}ppd}}} from the standard repository for not-yet-installed PPDs, which CUPS typically stores in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}model}}}. Alternatively, you may use {\texttt{\docbookhyphenatedot{-P /path/to/your.ppd}}}.

The generic {\texttt{\docbookhyphenatefilename{laserjet.\dbz{}ppd,}}} however, does not support every special option for every LaserJet-compatible model. It constitutes a sort of {``}least common denominator{''} of all the models. If for some reason you must pay for the commercially available ESP Print Pro drivers, your first move should be to consult the database on the Linuxprinting\label{id2608138}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/printer_list.cgi}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608138} Web site. Linuxprinting.org has excellent recommendations about which driver is best used for each printer. Its database is kept current by the tireless work of Till Kamppeter from Mandrakesoft, who is also the principal author of the {\bfseries{foomatic-rip}} utility.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{foomatic-rip} \index{cupsomatic} \index{Adobe PPD} The former {\bfseries{cupsomatic}} concept is now being replaced by the new successor, a much more powerful {\bfseries{foomatic-rip}}. {\bfseries{cupsomatic}} is no longer maintained. Here is the new URL to the Foomatic-3.0\label{id2608204}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/driver_list.cgi}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608204} database. If you upgrade to {\bfseries{foomatic-rip}}, remember to also upgrade to the new-style PPDs for your Foomatic-driven printers. foomatic-rip will not work with PPDs generated for the old {\bfseries{cupsomatic}}. The new-style PPDs are 100\% compliant with the Adobe PPD specification. They are also intended to be used by Samba and the cupsaddsmb utility, to provide the driver files for the Windows clients!
\end{admonition}

\subsection{foomatic-rip and Foomatic Explained}
\label{id2608232}\hypertarget{id2608232}{}%

\index{foomatic} \index{foomatic-rip} Nowadays, most Linux distributions rely on the utilities from the Linuxprinting.org\label{id2608256}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608256} to create their printing-related software (which, by the way, works on all UNIXes and on Mac OS X and Darwin, too). The utilities from this sire have a very end-user-friendly interface that allows for an easy update of drivers and PPDs for all supported models, all spoolers, all operating systems, and all package formats (because there is none). Its history goes back a few years.

Recently, Foomatic has achieved the astonishing milestone of 1,000 listed\label{id2608274}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/printer_list.cgi?make=Anyone}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608274} printer models. Linuxprinting.org keeps all the important facts about printer drivers, supported models, and which options are available for the various driver/printer combinations in its Foomatic\label{id2608284}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/foomatic.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608284} database. Currently there are 245 drivers\label{id2608290}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/driver_list.cgi}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608290} in the database. Many drivers support various models, and many models may be driven by different drivers ---  its your choice!
\subsubsection{690 {``}Perfect{''} Printers}
\label{id2608303}\hypertarget{id2608303}{}%

\index{Windows PPD} At present, there are 690 devices dubbed as working perfectly: 181 are {\em{mostly}} perfect, 96 are {\em{partially}} perfect, and 46 are paperweights. Keeping in mind that most of these are non-PostScript models (PostScript printers are automatically supported by CUPS to perfection by using their own manufacturer-provided Windows PPD), and that a multifunctional device never qualifies as working perfectly if it does not also scan and copy and fax under GNU/Linux ---  then this is a truly astonishing achievement! Three years ago the number was not more than 500, and Linux or UNIX printing at the time wasn't anywhere near the quality it is today.
\subsubsection{How the Printing HOWTO Started It All}
\label{id2608345}\hypertarget{id2608345}{}%

A few years ago Grant Taylor\label{id2608354}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www2.picante.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608354} started it all. The roots of today's Linuxprinting.org are in the first Linux Printing HOWTO\label{id2608362}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/foomatic2.9/howto/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608362} that he authored. As a side-project to this document, which served many Linux users and admins to guide their first steps in this complicated and delicate setup (to a scientist, printing is {``}applying a structured deposition of distinct patterns of ink or toner particles on paper substrates{''}), he started to build in a little Postgres database with information about the hardware and driver zoo that made up Linux printing of the time. This database became the core component of today's Foomatic collection of tools and data. In the meantime, it has moved to an XML representation of the data.
\subsubsection{Foomatic's Strange Name}
\label{id2608384}\hypertarget{id2608384}{}%

\index{foomatic} {``}Why the funny name?{''} you ask. When it really took off, around spring 2000, CUPS was far less popular than today, and most systems used LPD, LPRng, or even PDQ to print. CUPS shipped with a few generic drivers (good for a few hundred different printer models). These didn't support many device-specific options. CUPS also shipped with its own built-in rasterization filter ({\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}}, derived from Ghostscript). On the other hand, CUPS provided brilliant support for {\em{controlling}} all printer options through standardized and well-defined PPD files. Plus, CUPS was designed to be easily extensible.

Taylor already had in his database a respectable compilation of facts about many more printers and the Ghostscript {``}drivers{''} they run with. His idea, to generate PPDs from the database information and use them to make standard Ghostscript filters work within CUPS, proved to work very well. It also killed several birds with one stone:

\begin{itemize}
%--- Item
\item 
It made all current and future Ghostscript filter developments available for CUPS.


%--- Item
\item 
It made available a lot of additional printer models to CUPS users (because often the traditional Ghostscript way of printing was the only one available).


%--- Item
\item 
It gave all the advanced CUPS options (Web interface, GUI driver configurations) to users wanting (or needing) to use Ghostscript filters.

\end{itemize}
\subsubsection{cupsomatic, pdqomatic, lpdomatic, directomatic}
\label{id2608462}\hypertarget{id2608462}{}%

\index{cupsomatic} \index{CUPS-PPD} \index{PPD!CUPS|textit{see} {CUPS-PPD} } CUPS worked through a quickly hacked-up filter script named cupsomatic\label{id2608498}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/download.cgi?filename=cupsomatic\string&show=0}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608498}. cupsomatic ran the printfile through Ghostscript, constructing automatically the rather complicated command line needed. It just needed to be copied into the CUPS system to make it work. To configure the way cupsomatic controls the Ghostscript rendering process, it needs a CUPS-PPD. This PPD is generated directly from the contents of the database. For CUPS and the respective printer/filter combo, another Perl script named CUPS-O-Matic did the PPD generation. After that was working, Taylor implemented within a few days a similar thing for two other spoolers. Names chosen for the config-generator scripts were PDQ-O-Matic\label{id2608516}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/download.cgi?filename=lpdomatic\string&show=0}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608516} (for PDQ) and LPD-O-Matic\label{id2608523}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/download.cgi?filename=lpdomatic\string&show=0}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608523} (for ---  you guessed it ---  LPD); the configuration here didn't use PPDs but other spooler-specific files.

From late summer of that year, Till Kamppeter\label{id2608540}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/till/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608540} started to put work into the database. Kamppeter had been newly employed by Mandrakesoft\label{id2608548}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.mandrakesoft.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608548} to convert its printing system over to CUPS, after they had seen his FLTK\label{id2608556}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.fltk.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608556}-based XPP\label{id2608562}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://cups.sourceforge.net/xpp/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608562} (a GUI front-end to the CUPS lp-command). He added a huge amount of new information and new printers. He also developed the support for other spoolers, like PPR\label{id2608571}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://ppr.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608571} (via ppromatic), GNUlpr\label{id2608577}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://sourceforge.net/projects/lpr/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608577}, and LPRng\label{id2608584}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.lprng.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608584} (both via an extended lpdomatic) and spooler-less printing (directomatic\label{id2608591}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/download.cgi?filename=directomatic\string&show=0}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608591}).

So, to answer your question, {``}Foomatic{''} is the general name for all the overlapping code and data behind the {``}*omatic{''} scripts. Foomatic, up to versions 2.0.x, required (ugly) Perl data structures attached to Linuxprinting.org PPDs for CUPS. It had a different {``}*omatic{''} script for every spooler, as well as different printer configuration files.
\subsubsection{The {\em{Grand Unification}} Achieved}
\label{id2608621}\hypertarget{id2608621}{}%

\index{foomatic-rip} This has all changed in Foomatic versions 2.9 (beta) and released as {``}stable{''} 3.0. It has now achieved the convergence of all *omatic scripts and is called the foomatic-rip\label{id2608646}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip\string&show=0}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608646}. This single script is the unification of the previously different spooler-specific *omatic scripts. foomatic-rip is used by all the different spoolers alike, and because it can read PPDs (both the original PostScript printer PPDs and the Linuxprinting.org-generated ones), all of a sudden all supported spoolers can have the power of PPDs at their disposal. Users only need to plug foomatic-rip into their system. For users there is improved media type and source support ---  paper sizes and trays are easier to configure.

\index{PPDs} \index{Foomatic tutorial} \index{LinuxKongress2002} Also, the new generation of Linuxprinting.org PPDs no longer contains Perl data structures. If you are a distro maintainer and have used the previous version of Foomatic, you may want to give the new one a spin, but remember to generate a new-version set of PPDs via the new foomatic-db-engine!\label{id2608695}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/download/foomatic/foomatic-db-engine-3.0.0beta1.tar.gz}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608695}. Individual users just need to generate a single new PPD specific to their model by following the steps\label{id2608703}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/kpfeifle/LinuxKongress2002/Tutorial/II.Foomatic-User/II.tutorial-handout-foomatic-user.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608703} outlined in the Foomatic tutorial or in this chapter. This new development is truly amazing.

\index{foomatic-rip} \index{Adobe} \index{printer drivers} foomatic-rip is a very clever wrapper around the need to run Ghostscript with a different syntax, options, device selections, and/or filters for each different printer or spooler. At the same time, it can read the PPD associated with a print queue and modify the print job according to the user selections. Together with this comes the 100\% compliance of the new Foomatic PPDs with the Adobe spec. Some innovative features of the Foomatic concept may surprise users. It will support custom paper sizes for many printers and will support printing on media drawn from different paper trays within the same job (in both cases, even where there is no support for this from Windows-based vendor printer drivers).
\subsubsection{Driver Development Outside}
\label{id2608752}\hypertarget{id2608752}{}%

\index{Linuxprinting.org} Most driver development itself does not happen within Linuxprinting.org. Drivers are written by independent maintainers. Linuxprinting.org just pools all the information and stores it in its database. In addition, it also provides the Foomatic glue to integrate the many drivers into any modern (or legacy) printing system known to the world.

Speaking of the different driver development groups, most of the work is currently done in three projects:

\begin{itemize}
%--- Item
\item 
\index{Omni} Omni\label{id2608794}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www-124.ibm.com/developerworks/oss/linux/projects/omni/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608794} ---  a free software project by IBM that tries to convert its printer driver knowledge from good-ol' OS/2 times into a modern, modular, universal driver architecture for Linux/UNIX (still beta). This currently supports 437 models.


%--- Item
\item 
\index{HPIJS} HPIJS\label{id2608819}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://hpinkjet.sf.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608819} ---  a free software project by HP to provide the support for its own range of models (very mature, printing in most cases is perfect and provides true photo quality). This currently supports 369 models.


%--- Item
\item 
\index{Gutenprint} Gutenprint\label{id2608843}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://gimp-print.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608843} ---  a free software effort, started by Michael Sweet (also lead developer for CUPS), now directed by Robert Krawitz, which has achieved an amazing level of photo print quality (many Epson users swear that its quality is better than the vendor drivers provided by Epson for the Microsoft platforms). This currently supports 522 models.

\end{itemize}
\subsubsection{Forums, Downloads, Tutorials, Howtos (Also for Mac OS X and Commercial UNIX)}
\label{id2608861}\hypertarget{id2608861}{}%

Linuxprinting.org today is the one-stop shop to download printer drivers. Look for printer information and tutorials\label{id2608873}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org//kpfeifle/LinuxKongress2002/Tutorial/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608873} or solve printing problems in its popular forums\label{id2608880}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/newsportal/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608880}. This forum is not just for GNU/Linux users, but admins of commercial UNIX systems\label{id2608888}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/macosx/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608888} are also going there, and the relatively new Mac OS X forum\label{id2608895}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/newsportal/thread.php3?name=linuxprinting.macosx.general}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2608895} has turned out to be one of the most frequented forums after only a few weeks.

\index{Mandriva} \index{Mandrake} \index{Conectiva} Linuxprinting.org and the Foomatic driver wrappers around Ghostscript are now a standard tool-chain for printing on all the important distros. Most of them also have CUPS underneath. While in recent years most printer data had been added by Kamppeter, many additional contributions came from engineers with SuSE, Red Hat, Conectiva, Debian, and others. Vendor-neutrality is an important goal of the Foomatic project. Mandrake and Conectiva have merged and are now called Mandriva.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Till Kamppeter from Mandrakesoft is doing an excellent job in his spare time to maintain Linuxprinting.org and Foomatic. So if you use it often, please send him a note showing your appreciation.
\end{admonition}

\subsubsection{Foomatic Database-Generated PPDs}
\label{id2608947}\hypertarget{id2608947}{}%

\index{Foomatic database} \index{XML-based datasets} \index{kprinter} \index{gtklp} \index{xpp} \index{HP Photosmart} \index{Epson Stylus inkjet} \index{non-PostScript printers} \index{raster} The Foomatic database is an amazing piece of ingenuity in itself. Not only does it keep the printer and driver information, but it is organized in a way that it can generate PPD files on the fly from its internal XML-based datasets. While these PPDs are modeled to the Adobe specification of PPDs, the Linuxprinting.org/Foomatic-PPDs do not normally drive PostScript printers. They are used to describe all the bells and whistles you could ring or blow on an Epson Stylus inkjet, or an HP Photosmart, or what-have-you. The main trick is one little additional line, not envisaged by the PPD specification, starting with the {\ttfamily\itshape{\docbookhyphenatedot{*cupsFilter}}} keyword. It tells the CUPS daemon how to proceed with the PostScript print file (old-style Foomatic-PPDs named the cupsomatic filter script, while the new-style PPDs are now call foomatic-rip). This filter script calls Ghostscript on the host system (the recommended variant is ESP Ghostscript) to do the rendering work. foomatic-rip knows which filter or internal device setting it should ask from Ghostscript to convert the PostScript print job into a raster format ready for the target device. This usage of PPDs to describe the options of non-PostScript printers was the invention of the CUPS developers. The rest is easy. GUI tools (like KDE's marvelous kprinter\label{id2609048}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://printing.kde.org/overview/kprinter.phtml}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609048} or the GNOME gtklp\label{id2609055}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://gtklp.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609055} xpp and the CUPS Web interface) read the PPD as well and use this information to present the available settings to the user as an intuitive menu selection.
\subsection{foomatic-rip and Foomatic PPD Download and Installation}
\label{id2609068}\hypertarget{id2609068}{}%

Here are the steps to install a foomatic-rip-driven LaserJet 4 Plus-compatible printer in CUPS (note that recent distributions of SuSE, UnitedLinux and Mandrake may ship with a complete package of Foomatic-PPDs plus the {\bfseries{foomatic-rip}} utility. Going directly to Linuxprinting.org ensures that you get the latest driver/PPD files).

\begin{itemize}
%--- Item
\item 
Open your browser at the Linuxprinting.org printer list page.\label{id2609096}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/printer_list.cgi}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609096}


%--- Item
\item 
Check the complete list of printers in the database.\label{id2609108}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/printer_list.cgi?make=Anyone}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609108}.


%--- Item
\item 
Select your model and click on the link.


%--- Item
\item 
You'll arrive at a page listing all drivers working with this model (for all printers, there will always be {\em{one}} recommended driver. Try this one first).


%--- Item
\item 
In our case (HP LaserJet 4 Plus), we'll arrive at the default driver for the HP-LaserJet 4 Plus.\label{id2609137}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/show_printer.cgi?recnum=HP-LaserJet_4_Plus}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609137}


%--- Item
\item 
The recommended driver is ljet4.


%--- Item
\item 
Several links are provided here. You should visit them all if you are not familiar with the Linuxprinting.org database.


%--- Item
\item 
There is a link to the database page for the ljet4\label{id2609162}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/show_driver.cgi?driver=ljet4}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609162}. On the driver's page, you'll find important and detailed information about how to use that driver within the various available spoolers.


%--- Item
\item 
Another link may lead you to the home page of the author of the driver.


%--- Item
\item 
Important links are the ones that provide hints with setup instructions for CUPS\label{id2609183}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/cups-doc.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609183}; PDQ\label{id2609192}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/pdq-doc.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609192}; LPD, LPRng, and GNUlpr\label{id2609198}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/lpd-doc.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609198}); as well as PPR\label{id2609205}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/ppr-doc.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609205} or {``}spoolerless{''} printing\label{id2609215}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/direct-doc.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609215}.


%--- Item
\item 
You can view the PPD in your browser through this link: {\textless}\url{http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4\string&printer=HP-LaserJet_4_Plus\string&show=1}{\textgreater}


%--- Item
\item 
Most importantly, you can also generate and download the PPD\label{id2609244}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/ppd-o-matic.cgi?driver=ljet4\string&printer=HP-LaserJet_4_Plus\string&show=0}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609244}.


%--- Item
\item 
The PPD contains all the information needed to use our model and the driver; once installed, this works transparently for the user. Later you'll only need to choose resolution, paper size, and so on, from the Web-based menu, or from the print dialog GUI, or from the command line.


%--- Item
\item 
If you ended up on the drivers page\label{id2609266}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/show_driver.cgi?driver=ljet4}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609266}, you can choose to use the {``}PPD-O-Matic{''} online PPD generator program.


%--- Item
\item 
Select the exact model and check either {\sffamily \bfseries Download} or {\sffamily \bfseries Display PPD file} and click {\sffamily \bfseries Generate PPD file}.


%--- Item
\item 
If you save the PPD file from the browser view, please do not use cut and paste (since it could possibly damage line endings and tabs, which makes the PPD likely to fail its duty), but use {\sffamily \bfseries Save as...} in your browser's menu. (It is best to use the {\sffamily \bfseries Download} option directly from the Web page.)


%--- Item
\item 
Another interesting part on each driver page is the {\sffamily \bfseries Show execution details} button. If you select your printer model and click on that button, a complete Ghostscript command line will be displayed, enumerating all options available for that combination of driver and printer model. This is a great way to {``}learn Ghostscript by doing{''}. It is also an excellent cheat sheet for all experienced users who need to reconstruct a good command line for that darned printing script, but can't remember the exact syntax.


%--- Item
\item 
Sometime during your visit to Linuxprinting.org, save the PPD to a suitable place on your hard disk, say {\texttt{\docbookhyphenatefilename{/\dbz{}path/\dbz{}to/\dbz{}my-\dbz{}printer.\dbz{}ppd}}} (if you prefer to install your printers with the help of the CUPS Web interface, save the PPD to the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}cups/\dbz{}model/\dbz{}}}} path and restart cupsd).


%--- Item
\item 
Then install the printer with a suitable command line, like this:


\begin{Verbatim}[]

	root# lpadmin -p laserjet4plus -v parallel:/dev/lp0 -E \
		-P path/to/my-printer.ppd
	
\end{Verbatim}



%--- Item
\item 
For all the new-style {``}Foomatic-PPDs{''} from Linuxprinting.org, you also need a special CUPS filter named foomatic-rip.


%--- Item
\item 
The foomatic-rip Perl script itself also makes some interesting reading\label{id2609406}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/foomatic2.9/download.cgi?filename=foomatic-rip\string&show=1}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609406} because it is well documented by Kamppeter's in-line comments (even non-Perl hackers will learn quite a bit about printing by reading it).


%--- Item
\item 
Save foomatic-rip either directly in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}cups/\dbz{}filter/\dbz{}foomatic-\dbz{}rip}}} or somewhere in your \$PATH (and remember to make it world-executable). Again, do not save by copy and paste but use the appropriate link or the {\sffamily \bfseries Save as...} menu item in your browser.


%--- Item
\item 
If you save foomatic-rip in your \$PATH, create a symlink: 
\begin{Verbatim}[]

	root# cd /usr/lib/cups/filter/ ; ln -s `which foomatic-rip'
	
\end{Verbatim}


CUPS will discover this new available filter at startup after restarting cupsd.

\end{itemize}

Once you print to a print queue set up with the Foomatic PPD, CUPS will insert the appropriate commands and comments into the resulting PostScript job file. foomatic-rip is able to read and act upon these and uses some specially encoded Foomatic comments embedded in the job file. These in turn are used to construct (transparently for you, the user) the complicated Ghostscript command line telling the printer driver exactly how the resulting raster data should look and which printer commands to embed into the data stream. You need:

\begin{itemize}
%--- Item
\item 
A {``}foomatic+something{''} PPD ---  but this is not enough to print with CUPS (it is only {\em{one}} important component).


%--- Item
\item 
The {\ttfamily\itshape{\docbookhyphenatedot{foomatic-rip}}} filter script (Perl) in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}cups/\dbz{}filters/\dbz{}}}}.


%--- Item
\item 
Perl to make foomatic-rip run.


%--- Item
\item 
Ghostscript (because it is doing the main work, controlled by the PPD/foomatic-rip combo) to produce the raster data fit for your printer model's consumption.


%--- Item
\item 
Ghostscript {\em{must}} (depending on the driver/model) contain support for a certain device representing the selected driver for your model (as shown by {\bfseries{gs -h}}).


%--- Item
\item 
foomatic-rip needs a new version of PPDs (PPD versions produced for cupsomatic do not work with foomatic-rip).

\end{itemize}

% ------------------------   
% Section 
\section{Page Accounting with CUPS}
\label{id2609556}\hypertarget{id2609556}{}%

\index{CUPS!Page Accounting} Often there are questions regarding print quotas where Samba users (that is, Windows clients) should not be able to print beyond a certain number of pages or data volume per day, week, or month. This feature is dependent on the real print subsystem you're using. Samba's part is always to receive the job files from the clients (filtered {\em{or}} unfiltered) and hand them over to this printing subsystem.

Of course one could hack things with one's own scripts. But then there is CUPS. CUPS supports quotas that can be based on the size of jobs or on the number of pages or both, and can span any time period you want.
\subsection{Setting Up Quotas}
\label{id2609593}\hypertarget{id2609593}{}%

\index{CUPS!quotas} This is an example command of how root would set a print quota in CUPS, assuming an existing printer named {``}quotaprinter{''}: \index{lpadmin} 
\begin{Verbatim}[]

root# lpadmin -p quotaprinter -o job-quota-period=604800 \
	-o job-k-limit=1024 -o job-page-limit=100

\end{Verbatim}


This would limit every single user to print no more than 100 pages or 1024 KB of data (whichever comes first) within the last 604,800 seconds ( = 1 week).
\subsection{Correct and Incorrect Accounting}
\label{id2609650}\hypertarget{id2609650}{}%

For CUPS to count correctly, the printfile needs to pass the CUPS pstops filter; otherwise it uses a dummy count of {``}one{''}. Some print files do not pass it (e.g., image files), but then those are mostly one-page jobs anyway. This also means that proprietary drivers for the target printer running on the client computers and CUPS/Samba, which then spool these files as {``}raw{''} (i.e., leaving them untouched, not filtering them), will be counted as one-pagers too!

You need to send PostScript from the clients (i.e., run a PostScript driver there) to have the chance to get accounting done. If the printer is a non-PostScript model, you need to let CUPS do the job to convert the file to a print-ready format for the target printer. This is currently working for about a thousand different printer models. Linuxprinting.org has a driver list\label{id2609683}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linuxprinting.org/printer_list.cgi}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2609683}.
\subsection{Adobe and CUPS PostScript Drivers for Windows Clients}
\label{id2609692}\hypertarget{id2609692}{}%

\index{Adobe PostScript} \index{pstops} \index{PPD} \index{pstoraster} \index{PJL-header} Before CUPS 1.1.16, your only option was to use the Adobe PostScript driver on the Windows clients. The output of this driver was not always passed through the {\bfseries{pstops}} filter on the CUPS/Samba side, and therefore was not counted correctly (the reason is that it often, depending on the PPD being used, wrote a PJL-header in front of the real PostScript, which caused CUPS to skip {\bfseries{pstops}} and go directly to the {\bfseries{pstoraster}} stage).

From CUPS 1.1.16 and later releases, you can use the CUPS PostScript driver for Windows NT/200x/XP clients (which is tagged in the download area of {\texttt{\docbookhyphenatefilename{http:/\dbz{}/\dbz{}www.\dbz{}cups.\dbz{}org/\dbz{}}}} as the {\texttt{\docbookhyphenatefilename{cups-\dbz{}samba-\dbz{}1.\dbz{}1.\dbz{}16.\dbz{}tar.\dbz{}gz}}} package). It does {\em{not}} work for Windows 9x/Me clients, but it guarantees:

\begin{itemize}
%--- Item
\item 
\index{PJL} To not write a PJL-header.


%--- Item
\item 
To still read and support all PJL-options named in the driver PPD with its own means.


%--- Item
\item 
That the file will pass through the {\bfseries{pstops}} filter on the CUPS/Samba server.


%--- Item
\item 
To page-count correctly the print file.

\end{itemize}

You can read more about the setup of this combination in the man page for {\bfseries{cupsaddsmb}} (which is only present with CUPS installed, and only current from CUPS 1.1.16).
\subsection{The page\_log File Syntax}
\label{id2609838}\hypertarget{id2609838}{}%

\index{page\_log} These are the items CUPS logs in the {\texttt{\docbookhyphenatefilename{page\_\dbz{}log}}} for every page of a job:

\begin{itemize}
%--- Item
\item 
Printer name


%--- Item
\item 
User name


%--- Item
\item 
Job ID


%--- Item
\item 
Time of printing


%--- Item
\item 
Page number


%--- Item
\item 
Number of copies


%--- Item
\item 
A billing information string (optional)


%--- Item
\item 
The host that sent the job (included since version 1.1.19)

\end{itemize}

Here is an extract of my CUPS server's {\texttt{\docbookhyphenatefilename{page\_\dbz{}log}}} file to illustrate the format and included items:


\begin{Verbatim}[]

tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 1 3 #marketing 10.160.50.13
tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 2 3 #marketing 10.160.50.13
tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 3 3 #marketing 10.160.50.13
tec_IS2027 kurt 401 [22/Apr/2003:10:28:43 +0100] 4 3 #marketing 10.160.50.13
Dig9110 boss 402 [22/Apr/2003:10:33:22 +0100] 1 440 finance-dep 10.160.51.33

\end{Verbatim}


This was job ID {\ttfamily\itshape{\docbookhyphenatedot{401}}}, printed on {\ttfamily\itshape{\docbookhyphenatedot{tec\_IS2027}}} by user {\ttfamily\itshape{\docbookhyphenatedot{kurt}}}, a 64-page job printed in three copies, billed to {\ttfamily\itshape{\docbookhyphenatedot{\#marketing}}}, and sent from IP address {\texttt{\docbookhyphenatedot{10.160.50.13.}}} The next job had ID {\ttfamily\itshape{\docbookhyphenatedot{402}}}, was sent by user {\ttfamily\itshape{\docbookhyphenatedot{boss}}} from IP address {\texttt{\docbookhyphenatedot{10.160.51.33}}}, printed from one page 440 copies, and is set to be billed to {\ttfamily\itshape{\docbookhyphenatedot{finance-dep}}}.
\subsection{Possible Shortcomings}
\label{id2609988}\hypertarget{id2609988}{}%

What flaws or shortcomings are there with this quota system?

\begin{itemize}
%--- Item
\item 
The ones named above (wrongly logged job in case of printer hardware failure, and so on).


%--- Item
\item 
In reality, CUPS counts the job pages that are being processed in {\em{software}} (that is, going through the RIP) rather than the physical sheets successfully leaving the printing device. Thus, if there is a jam while printing the fifth sheet out of 1,000 and the job is aborted by the printer, the page count will still show the figure of 1,000 for that job.


%--- Item
\item 
All quotas are the same for all users (no flexibility to give the boss a higher quota than the clerk) and no support for groups.


%--- Item
\item 
No means to read out the current balance or the {``}used-up{''} number of current quota.


%--- Item
\item 
A user having used up 99 sheets of a 100 quota will still be able to send and print a 1,000 sheet job.


%--- Item
\item 
A user being denied a job because of a filled-up quota does not get a meaningful error message from CUPS other than {``}client-error-not-possible{''}.

\end{itemize}
\subsection{Future Developments}
\label{id2610058}\hypertarget{id2610058}{}%

This is the best system currently available, and there are huge improvements under development for CUPS 1.2:

\begin{itemize}
%--- Item
\item 
Page counting will go into the backends (these talk directly to the printer and will increase the count in sync with the actual printing process; thus, a jam at the fifth sheet will lead to a stop in the counting).


%--- Item
\item 
Quotas will be handled more flexibly.


%--- Item
\item 
Probably there will be support for users to inquire about their accounts in advance.


%--- Item
\item 
Probably there will be support for some other tools around this topic.

\end{itemize}
\subsection{Other Accounting Tools}
\label{id2610100}\hypertarget{id2610100}{}%

Other accounting tools that can be used includes: PrintAnalyzer, pyKota, printbill, LogReport. For more information regarding these tools you can try a Google search.

% ------------------------   
% Section 
\section{Additional Material}
\label{id2610116}\hypertarget{id2610116}{}%

A printer queue with {\em{no}} PPD associated to it is a {``}raw{''} printer, and all files will go directly there as received by the spooler. The exceptions are file types {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}} that need the pass-through feature enabled. {``}Raw{''} queues do not do any filtering at all; they hand the file directly to the CUPS backend. This backend is responsible for sending the data to the device (as in the {``}device URI{''} notation: {\texttt{\docbookhyphenatefilename{lpd:/\dbz{}/\dbz{}, socket:/\dbz{}/\dbz{}, smb:/\dbz{}/\dbz{}, ipp:/\dbz{}/\dbz{}, http:/\dbz{}/\dbz{}, parallel:/\dbz{}, serial:/\dbz{}, usb:/\dbz{}}}}, and so on).

cupsomatic/Foomatic are {\em{not}} native CUPS drivers and they do not ship with CUPS. They are a third-party add-on developed at Linuxprinting.org. As such, they are a brilliant hack to make all models (driven by Ghostscript drivers/filters in traditional spoolers) also work via CUPS, with the same (good or bad!) quality as in these other spoolers. {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} is only a vehicle to execute a Ghostscript command line at that stage in the CUPS filtering chain where normally the native CUPS {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}} filter would kick in. {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} bypasses {\ttfamily\itshape{\docbookhyphenatedot{pstoraster}}}, kidnaps the print file from CUPS, and redirects it to go through Ghostscript. CUPS accepts this because the associated cupsomatic/foomatic-PPD specifies: 
\begin{Verbatim}[]

*cupsFilter:  "application/vnd.cups-postscript 0 cupsomatic"

\end{Verbatim}
 This line persuades CUPS to hand the file to {\ttfamily\itshape{\docbookhyphenatedot{cupsomatic}}} once it has successfully converted it to the MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}. This conversion will not happen for jobs arriving from Windows that are autotyped {\ttfamily\itshape{\docbookhyphenatedot{application/octet-stream}}}, with the according changes in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} in place.

CUPS is widely configurable and flexible, even regarding its filtering mechanism. Another workaround in some situations would be to have in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}cups/\dbz{}mime.\dbz{}types}}} entries as follows: 
\begin{Verbatim}[]

application/postscript           application/vnd.cups-raw  0  -
application/vnd.cups-postscript  application/vnd.cups-raw  0  -

\end{Verbatim}
 This would prevent all PostScript files from being filtered (rather, they will through the virtual {\em{nullfilter}} denoted with {``}-{''}). This could only be useful for PostScript printers. If you want to print PostScript code on non-PostScript printers (provided they support ASCII text printing), an entry as follows could be useful: 
\begin{Verbatim}[]

*/*           application/vnd.cups-raw  0  -

\end{Verbatim}
 and would effectively send {\em{all}} files to the backend without further processing.

You could have the following entry: 
\begin{Verbatim}[]

application/vnd.cups-postscript application/vnd.cups-raw 0 \
	my_PJL_stripping_filter

\end{Verbatim}
 You will need to write a {\ttfamily\itshape{\docbookhyphenatedot{my\_PJL\_stripping\_filter}}} (which could be a shell script) that parses the PostScript and removes the unwanted PJL. This needs to conform to CUPS filter design (mainly, receive and pass the parameters printername, job-id, username, jobtitle, copies, print options, and possibly the filename). It is installed as world executable into {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}cups/\dbz{}filters/\dbz{}}}} and is called by CUPS if it encounters a MIME type {\ttfamily\itshape{\docbookhyphenatedot{application/vnd.cups-postscript}}}.

CUPS can handle {\ttfamily\itshape{\docbookhyphenatedot{-o job-hold-until=indefinite}}}. This keeps the job in the queue on hold. It will only be printed upon manual release by the printer operator. This is a requirement in many central reproduction departments, where a few operators manage the jobs of hundreds of users on some big machine, where no user is allowed to have direct access (such as when the operators often need to load the proper paper type before running the 10,000 page job requested by marketing for the mailing, and so on).

% ------------------------   
% Section 
\section{Autodeletion or Preservation of CUPS Spool Files}
\label{id2610337}\hypertarget{id2610337}{}%

\index{/var/spool/samba} \index{/var/spool/cups/} \index{cupsd.conf} Samba print files pass through two spool directories. One is the incoming directory managed by Samba (set in the \smbconfoption{path} = /var/spool/samba directive in the \smbconfsection{[printers]} section of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}). The other is the spool directory of your UNIX print subsystem. For CUPS it is normally {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}spool/\dbz{}cups/\dbz{}}}}, as set by the {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} directive {\texttt{\docbookhyphenatefilename{RequestRoot /\dbz{}var/\dbz{}spool/\dbz{}cups}}}.
\subsection{CUPS Configuration Settings Explained}
\label{id2610408}\hypertarget{id2610408}{}%

Some important parameter settings in the CUPS configuration file {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} are:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{PreserveJobHistory Yes}]\null{}
This keeps some details of jobs in cupsd's mind (well, it keeps the c12345, c12346, and so on, files in the CUPS spool directory, which does a similar job as the old-fashioned BSD-LPD control files). This is set to {``}Yes{''} as a default.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{PreserveJobFiles Yes}]\null{}
This keeps the job files themselves in cupsd's mind (it keeps the d12345, d12346, etc., files in the CUPS spool directory). This is set to {``}No{''} as the CUPS default.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{{``}MaxJobs 500{''}}]\null{}
This directive controls the maximum number of jobs that are kept in memory. Once the number of jobs reaches the limit, the oldest completed job is automatically purged from the system to make room for the new one. If all of the known jobs are still pending or active, then the new job will be rejected. Setting the maximum to 0 disables this functionality. The default setting is 0.
\end{description}

(There are also additional settings for {\ttfamily\itshape{\docbookhyphenatedot{MaxJobsPerUser}}} and {\ttfamily\itshape{\docbookhyphenatedot{MaxJobsPerPrinter}}}.)
\subsection{Preconditions}
\label{id2610497}\hypertarget{id2610497}{}%

For everything to work as it should, you need to have three things:

\begin{itemize}
%--- Item
\item 
A Samba smbd that is compiled against {\texttt{\docbookhyphenatefilename{libcups}}} (check on Linux by running {\ttfamily\bfseries{\docbookhyphenatedot{ldd `which smbd'}}}).


%--- Item
\item 
A Samba-{\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} setting of \smbconfoption{printing} = cups.


%--- Item
\item 
Another Samba {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} setting of \smbconfoption{printcap} = cups.

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

In this case, all other manually set printing-related commands (like \smbconfoption{print command}, \smbconfoption{lpq command}, \smbconfoption{lprm command}, \smbconfoption{lppause command}, and \smbconfoption{lpresume command}) are ignored, and they should normally have no influence whatsoever on your printing.
\end{admonition}

\subsection{Manual Configuration}
\label{id2610596}\hypertarget{id2610596}{}%

If you want to do things manually, replace the \smbconfoption{printing} = cups by \smbconfoption{printing} = bsd. Then your manually set commands may work (I haven't tested this), and a \smbconfoption{print command} = lp -d \%P \%s; rm \%s may do what you need.

% ------------------------   
% Section 
\section{Printing from CUPS to Windows-Attached Printers}
\label{id2610629}\hypertarget{id2610629}{}%

\index{smbspool} \index{backends} From time to time the question arises, how can you print {\em{to}} a Windows-attached printer {\em{from}} Samba? Normally the local connection from Windows host to printer would be done by USB or parallel cable, but this does not matter to Samba. From here only an SMB connection needs to be opened to the Windows host. Of course, this printer must be shared first. As you have learned by now, CUPS uses {\em{backends}} to talk to printers and other servers. To talk to Windows shared printers, you need to use the {\texttt{\docbookhyphenatefilename{smb}}} (surprise, surprise!) backend. Check if this is in the CUPS backend directory. This usually resides in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}cups/\dbz{}backend/\dbz{}}}}. You need to find an {\texttt{\docbookhyphenatefilename{smb}}} file there. It should be a symlink to {\texttt{\docbookhyphenatefilename{smbspool}}}, and the file must exist and be executable: 
\begin{Verbatim}[]

root# ls -l /usr/lib/cups/backend/
total 253
drwxr-xr-x    3 root   root     720 Apr 30 19:04 .
drwxr-xr-x    6 root   root     125 Dec 19 17:13 ..
-rwxr-xr-x    1 root   root   10692 Feb 16 21:29 canon
-rwxr-xr-x    1 root   root   10692 Feb 16 21:29 epson
lrwxrwxrwx    1 root   root       3 Apr 17 22:50 http -> ipp
-rwxr-xr-x    1 root   root   17316 Apr 17 22:50 ipp
-rwxr-xr-x    1 root   root   15420 Apr 20 17:01 lpd
-rwxr-xr-x    1 root   root    8656 Apr 20 17:01 parallel
-rwxr-xr-x    1 root   root    2162 Mar 31 23:15 pdfdistiller
lrwxrwxrwx    1 root   root      25 Apr 30 19:04 ptal -> /usr/sbin/ptal-cups
-rwxr-xr-x    1 root   root    6284 Apr 20 17:01 scsi
lrwxrwxrwx    1 root   root      17 Apr  2 03:11 smb -> /usr/bin/smbspool
-rwxr-xr-x    1 root   root    7912 Apr 20 17:01 socket
-rwxr-xr-x    1 root   root    9012 Apr 20 17:01 usb

root# ls -l `which smbspool`
-rwxr-xr-x    1 root   root  563245 Dec 28 14:49 /usr/bin/smbspool

\end{Verbatim}


If this symlink does not exist, create it: 
\begin{Verbatim}[]

root# ln -s `which smbspool` /usr/lib/cups/backend/smb

\end{Verbatim}


\index{smbspool} \index{troubleshooting} {\bfseries{smbspool}} was written by Mike Sweet from the CUPS folks. It is included and ships with Samba. It may also be used with print subsystems other than CUPS, to spool jobs to Windows printer shares. To set up printer {\ttfamily\itshape{\docbookhyphenatedot{winprinter}}} on CUPS, you need to have a driver for it. Essentially this means to convert the print data on the CUPS/Samba host to a format that the printer can digest (the Windows host is unable to convert any files you may send). This also means you should be able to print to the printer if it were hooked directly at your Samba/CUPS host. For troubleshooting purposes, this is what you should do to determine if that part of the process chain is in order. Then proceed to fix the network connection/authentication to the Windows host, and so on.

To install a printer with the {\ttfamily\itshape{\docbookhyphenatedot{smb}}} backend on CUPS, use this command:


\begin{Verbatim}[]

root# lpadmin -p winprinter -v smb://WINDOWSNETBIOSNAME/printersharename \
  -P /path/to/PPD

\end{Verbatim}


\index{PostScript printers} \index{PPD} \index{Windows NT PostScript driver} The PPD must be able to direct CUPS to generate the print data for the target model. For PostScript printers, just use the PPD that would be used with the Windows NT PostScript driver. But what can you do if the printer is only accessible with a password? Or if the printer's host is part of another workgroup? This is provided for: You can include the required parameters as part of the {\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}}}} device-URI like this:

\begin{itemize}
%--- Item
\item 
{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}WORKGROUP/\dbz{}WINDOWSNETBIOSNAME/\dbz{}printersharename}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}username:password@WORKGROUP/\dbz{}WINDOWSNETBIOSNAME/\dbz{}printersharename}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{smb:/\dbz{}/\dbz{}username:password@WINDOWSNETBIOSNAME/\dbz{}printersharename}}}

\end{itemize}

Note that the device URI will be visible in the process list of the Samba server (e.g., when someone uses the {\bfseries{ps -aux}} command on Linux), even if the username and passwords are sanitized before they get written into the log files. This is an inherently insecure option; however, it is the only one. Don't use it if you want to protect your passwords. Better share the printer in a way that does not require a password! Printing will only work if you have a working NetBIOS name resolution up and running. Note that this is a feature of CUPS and you do not necessarily need to have smbd running.

% ------------------------   
% Section 
\section{More CUPS Filtering Chains}
\label{id2610921}\hypertarget{id2610921}{}%

The diagrams in \hyperlink{cups1}{Figure {\ref{cups1}}} and \hyperlink{cups2}{Figure {\ref{cups2}}} show how CUPS handles print jobs.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{cups1}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/cups1}
{{\caption[{Filtering Chain 1.}]{{{Filtering Chain 1.}}}\label{cups1}}}
\end{center}
\end{figure}


% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{cups2}{}%
\includegraphics[scale=0.45]{Samba3-HOWTO/images/cups2}
{{\caption[{Filtering Chain with cupsomatic}]{{{Filtering Chain with cupsomatic}}}\label{cups2}}}
\end{center}
\end{figure}


% ------------------------   
% Section 
\section{Common Errors}
\label{id2610984}\hypertarget{id2610984}{}%
\subsection{Windows 9x/Me Client Can't Install Driver}
\label{id2610991}\hypertarget{id2610991}{}%

For Windows 9x/Me, clients require the printer names to be eight characters (or {``}8 plus 3 chars suffix{''}) max; otherwise, the driver files will not get transferred when you want to download them from Samba.
\subsection{{``}cupsaddsmb{''} Keeps Asking for Root Password in Never-ending Loop}
\label{root-ask-loop}\hypertarget{root-ask-loop}{}%

Have you set \smbconfoption{security} = user? Have you used {\bfseries{smbpasswd}} to give root a Samba account? You can do two things: open another terminal and execute {\bfseries{smbpasswd -a root}} to create the account and continue entering the password into the first terminal. Or, break out of the loop by pressing Enter twice (without trying to type a password).

If the error is {``}Tree connect failed: NT\_STATUS\_BAD\_NETWORK\_NAME{''}, you may have forgotten to create the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}drivers}}} directory.
\subsection{{``}cupsaddsmb{''} or {``}rpcclient addriver{''} Emit Error}
\label{id2611065}\hypertarget{id2611065}{}%

If {\bfseries{cupsaddsmb}}, or {\bfseries{rpcclient addriver}} emit the error message WERR\_BAD\_PASSWORD, refer to \hyperlink{root-ask-loop}{Section {\ref{root-ask-loop}}}.
\subsection{{``}cupsaddsmb{''} Errors}
\label{id2611101}\hypertarget{id2611101}{}%

The use of {``}cupsaddsmb{''} gives {``}No PPD file for printer...{''} message while PPD file is present. What might the problem be?

Have you enabled printer sharing on CUPS? This means, do you have a {\texttt{\docbookhyphenatedot{<Location /\dbz{}printers>.\dbz{}.\dbz{}.\dbz{}.\dbz{}</\dbz{}Location>}}} section in CUPS server's {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} that does not deny access to the host you run {``}cupsaddsmb{''} from? It {\em{could}} be an issue if you use cupsaddsmb remotely, or if you use it with a {\texttt{\docbookhyphenatedot{-h}}} parameter: {\ttfamily\bfseries{\docbookhyphenatedot{cupsaddsmb -\dbz{}H sambaserver -\dbz{}h cupsserver -\dbz{}v printername}}}.

Is your {\ttfamily\itshape{\docbookhyphenatedot{TempDir}}} directive in {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} set to a valid value, and is it writable?
\subsection{Client Can't Connect to Samba Printer}
\label{id2611178}\hypertarget{id2611178}{}%

Use {\bfseries{smbstatus}} to check which user you are from Samba's point of view. Do you have the privileges to write into the \smbconfsection{[print\$]} share?
\subsection{New Account Reconnection from Windows 200x/XP Troubles}
\label{id2611202}\hypertarget{id2611202}{}%

Once you are connected as the wrong user (for example, as {\texttt{\docbookhyphenatedot{nobody}}}, which often occurs if you have \smbconfoption{map to guest} = bad user), Windows Explorer will not accept an attempt to connect again as a different user. There will not be any bytes transferred on the wire to Samba, but still you'll see a stupid error message that makes you think Samba has denied access. Use {\bfseries{smbstatus}} to check for active connections. Kill the PIDs. You still can't re-connect, and you get the dreaded {\texttt{\docbookhyphenatedot{You can't connect with a second account from the same machine}}} message as soon as you try. And you do not see a single byte arriving at Samba (see logs; use {``}ethereal{''}) indicating a renewed connection attempt. Shut all Explorer Windows. This makes Windows forget what it has cached in its memory as established connections. Then reconnect as the right user. The best method is to use a DOS terminal window and {\em{first}} do {\ttfamily\bfseries{\docbookhyphenatedot{net use z: \docbooktolatexgobble\string\\\docbooktolatexgobble\string\\GANDALF\docbooktolatexgobble\string\\print\$ /\dbz{}user:root}}}. Check with {\bfseries{smbstatus}} that you are connected under a different account. Now open the {\sffamily \bfseries Printers} folder (on the Samba server in the {\sffamily \bfseries Network Neighborhood}), right-click on the printer in question, and select {\sffamily \bfseries Connect....}.
\subsection{Avoid Being Connected to the Samba Server as the Wrong User}
\label{id2611289}\hypertarget{id2611289}{}%

\index{smbstatus} You see per {\bfseries{smbstatus}} that you are connected as user nobody, but you want to be root or printer admin. This is probably due to \smbconfoption{map to guest} = bad user, which silently connected you under the guest account when you gave (maybe by accident) an incorrect username. Remove \smbconfoption{map to guest} if you want to prevent this.
\subsection{Upgrading to CUPS Drivers from Adobe Drivers}
\label{id2611329}\hypertarget{id2611329}{}%

This information came from a mailing list posting regarding problems experienced when upgrading from Adobe drivers to CUPS drivers on Microsoft Windows NT/200x/XP clients.

First delete all old Adobe-using printers. Then delete all old Adobe drivers. (On Windows 200x/XP, right-click in the background of {\sffamily \bfseries Printers} folder, select {\sffamily \bfseries Server Properties...}, select tab {\sffamily \bfseries Drivers}, and delete here).
\subsection{Can't Use {``}cupsaddsmb{''} on Samba Server, Which Is a PDC}
\label{id2611369}\hypertarget{id2611369}{}%

Do you use the {``}naked{''} root user name? Try to do it this way: {\ttfamily\bfseries{\docbookhyphenatedot{cupsaddsmb -\dbz{}U {\ttfamily\itshape{\docbookhyphenatedot{DOMAINNAME}}}\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\root -\dbz{}v {\ttfamily\itshape{\docbookhyphenatedot{printername}}}}}}\textgreater{} (note the two backslashes: the first one is required to {``}escape{''} the second one).
\subsection{Deleted Windows 200x Printer Driver Is Still Shown}
\label{id2611405}\hypertarget{id2611405}{}%

Deleting a printer on the client will not delete the driver too (to verify, right-click on the white background of the {\sffamily \bfseries Printers} folder, select {\sffamily \bfseries Server Properties} and click on the {\sffamily \bfseries Drivers} tab). These same old drivers will be re-used when you try to install a printer with the same name. If you want to update to a new driver, delete the old ones first. Deletion is only possible if no other printer uses the same driver.
\subsection{Windows 200x/XP Local Security Policies}
\label{id2611441}\hypertarget{id2611441}{}%
\index{Local security policies}\index{unsigned drivers}
Local security policies may not allow the installation of unsigned drivers ---  {``}local security policies{''} may not allow the installation of printer drivers at all.
\subsection{Administrator Cannot Install Printers for All Local Users}
\label{id2611476}\hypertarget{id2611476}{}%

\index{SMB printers} \index{IPP client} Windows XP handles SMB printers on a {``}per-user{''} basis. This means every user needs to install the printer himself or herself. To have a printer available for everybody, you might want to use the built-in IPP client capabilities of Win XP. Add a printer with the print path of {\ttfamily\itshape{\docbookhyphenatedot{http://cupsserver:631/printers/printername}}}. We're still looking into this one. Maybe a logon script could automatically install printers for all users.
\subsection{Print Change, Notify Functions on NT Clients}
\label{id2611518}\hypertarget{id2611518}{}%

For print change, notify functions on NT++ clients. These need to run the {\bfseries{Server}} service first (renamed to {\bfseries{File \& Print Sharing for MS Networks}} in XP).
\subsection{Windows XP SP1}
\label{id2611544}\hypertarget{id2611544}{}%

Windows XP SP1 introduced a Point and Print Restriction Policy (this restriction does not apply to {``}Administrator{''} or {``}Power User{''} groups of users). In Group Policy Object Editor, go to {\sffamily \bfseries User Configuration -\textgreater{} Administrative Templates -\textgreater{} Control Panel -\textgreater{} Printers}. The policy is automatically set to {\texttt{\docbookhyphenatedot{Enabled}}} and the {\texttt{\docbookhyphenatedot{Users can only Point and Print to machines in their Forest}}} . You probably need to change it to {\texttt{\docbookhyphenatedot{Disabled}}} or {\texttt{\docbookhyphenatedot{Users can only Point and Print to these servers}}} to make driver downloads from Samba possible.
\subsection{Print Options for All Users Can't Be Set on Windows 200x/XP}
\label{id2611591}\hypertarget{id2611591}{}%

How are you doing it? I bet the wrong way (it is not easy to find out, though). There are three different ways to bring you to a dialog that {\em{seems}} to set everything. All three dialogs {\em{look}} the same, yet only one of them does what you intend. You need to be Administrator or Print Administrator to do this for all users. Here is how I do it on XP:

\begin{enumerate}[A]
%--- Item
\item 
The first wrong way: .
\begin{enumerate}
%--- Item
\item 
Open the {\sffamily \bfseries Printers} folder.


%--- Item
\item 
Right-click on the printer ({\sffamily \bfseries remoteprinter on cupshost}) and select in context menu {\sffamily \bfseries Printing Preferences...}


%--- Item
\item 
Look at this dialog closely and remember what it looks like.

\end{enumerate}



%--- Item
\item 
The second wrong way: .
\begin{enumerate}
%--- Item
\item 
Open the {\sffamily \bfseries Printers} folder.


%--- Item
\item 
Right-click on the printer ({\sffamily \bfseries remoteprinter on cupshost}) and select the context menu {\sffamily \bfseries Properties}.


%--- Item
\item 
Click on the {\sffamily \bfseries General} tab.


%--- Item
\item 
Click on the button {\sffamily \bfseries Printing Preferences...}


%--- Item
\item 
A new dialog opens. Keep this dialog open and go back to the parent dialog.

\end{enumerate}



%--- Item
\item 
The third and correct way: 
\begin{enumerate}
%--- Item
\item 
Open the {\sffamily \bfseries Printers} folder.


%--- Item
\item 
Right-click on the printer ({\sffamily \bfseries remoteprinter on cupshost}) and select the context menu {\sffamily \bfseries Properties}.


%--- Item
\item 
Click on the {\sffamily \bfseries Advanced} tab. (If everything is {``}grayed out,{''} then you are not logged in as a user with enough privileges).


%--- Item
\item 
Click on the {\sffamily \bfseries Printing Defaults...} button.


%--- Item
\item 
On any of the two new tabs, click on the {\sffamily \bfseries Advanced...} button.


%--- Item
\item 
A new dialog opens. Compare this one to the other identical-looking one from step {``}B.5{''} or A.3".

\end{enumerate}


\end{enumerate}

Do you see any difference? I don't either. However, only the last one, which you arrived at with steps {``}C.1. to C.6.{''}, will save any settings permanently and be the defaults for new users. If you want all clients to get the same defaults, you need to conduct these steps {\em{as Administrator}} (\smbconfoption{printer admin} in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}) {\em{before}} a client downloads the driver (the clients can later set their own {\em{per-user defaults}} by following the procedures {\em{A}} or {\em{B}}).
\subsection{Most Common Blunders in Driver Settings on Windows Clients}
\label{id2611875}\hypertarget{id2611875}{}%

Don't use {\ttfamily\itshape{\docbookhyphenatedot{Optimize for Speed}}}, but use {\ttfamily\itshape{\docbookhyphenatedot{Optimize for Portability}}} instead (Adobe PS Driver). Don't use {\ttfamily\itshape{\docbookhyphenatedot{Page Independence: No}}}. Always settle with {\ttfamily\itshape{\docbookhyphenatedot{Page Independence: Yes}}} (Microsoft PS Driver and CUPS PS Driver for Windows NT/200x/XP). If there are problems with fonts, use {\ttfamily\itshape{\docbookhyphenatedot{Download as Softfont into printer}}} (Adobe PS Driver). For {\sffamily \bfseries TrueType Download Options} choose {\texttt{\docbookhyphenatedot{Outline}}}. Use PostScript Level 2 if you are having trouble with a non-PS printer and if there is a choice.
\subsection{cupsaddsmb Does Not Work with Newly Installed Printer}
\label{id2611932}\hypertarget{id2611932}{}%

Symptom: The last command of {\bfseries{cupsaddsmb}} does not complete successfully. If the {\bfseries{cmd = setdriver printername printername}} result was NT\_STATUS\_UNSUCCESSFUL, then possibly the printer was not yet recognized by Samba. Did it show up in Network Neighborhood? Did it show up in {\bfseries{rpcclient hostname -c `enumprinters'}}? Restart smbd (or send a {\bfseries{kill -HUP}} to all processes listed by {\bfseries{smbstatus}}, and try again.
\subsection{Permissions on /\dbz{}var/\dbz{}spool/\dbz{}samba/\dbz{} Get Reset After Each Reboot}
\label{id2611982}\hypertarget{id2611982}{}%

Have you ever by accident set the CUPS spool directory to the same location ({\ttfamily\itshape{\docbookhyphenatedot{RequestRoot /var/spool/samba/}}} in {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} or the other way round: {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}spool/\dbz{}cups/\dbz{}}}} is set as \smbconfoption{path}\textgreater{} in the \smbconfsection{[printers]} section)? These {\ttfamily\itshape{\docbookhyphenatedot{must}}} be different. Set {\ttfamily\itshape{\docbookhyphenatedot{RequestRoot /var/spool/cups/}}} in {\texttt{\docbookhyphenatefilename{cupsd.\dbz{}conf}}} and \smbconfoption{path} = 
/var/spool/samba in the \smbconfsection{[printers]} section of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. Otherwise, cupsd will sanitize permissions to its spool directory with each restart and printing will not work reliably.
\subsection{Print Queue Called {``}lp{''} Mishandles Print Jobs}
\label{id2612067}\hypertarget{id2612067}{}%

In this case a print queue called {``}lp{''} intermittently swallows jobs and spits out completely different ones from what was sent.

\index{lp} \index{Implicit Classes} \index{BrowseShortNames} It is a bad idea to name any printer {``}lp{''}. This is the traditional UNIX name for the default printer. CUPS may be set up to do an automatic creation of Implicit Classes. This means, to group all printers with the same name to a pool of devices and load-balance the jobs across them in a round-robin fashion. Chances are high that someone else has a printer named {``}lp{''} too. You may receive that person's jobs and send your own to his or her device unwittingly. To have tight control over the printer names, set {\ttfamily\itshape{\docbookhyphenatedot{BrowseShortNames No}}}. It will present any printer as {\ttfamily\itshape{\docbookhyphenatedot{printername@cupshost}}}, which gives you better control over what may happen in a large networked environment.
\subsection{Location of Adobe PostScript Driver Files for {``}cupsaddsmb{''}}
\label{id2612140}\hypertarget{id2612140}{}%

Use {\bfseries{smbclient}} to connect to any Windows box with a shared PostScript printer: {\bfseries{smbclient //windowsbox/print\textbackslash \$ -U guest}}. You can navigate to the {\texttt{\docbookhyphenatefilename{W32X86/\dbz{}2}}} subdir to {\bfseries{mget ADOBE*}} and other files or to {\texttt{\docbookhyphenatefilename{WIN40/\dbz{}0}}} to do the same. Another option is to download the {\texttt{\docbookhyphenatefilename{*.\dbz{}exe}}} packaged files from the Adobe Web site.

% ------------------------   
% Section 
\section{Overview of the CUPS Printing Processes}
\label{id2612195}\hypertarget{id2612195}{}%

A complete overview of the CUPS printing processes can be found in \hyperlink{a_small}{Figure {\ref{a_small}}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{a_small}{}%
\includegraphics[scale=0.45]{Samba3-HOWTO/images/a_small}
{{\caption[{CUPS Printing Overview.}]{{{CUPS Printing Overview.}}}\label{a_small}}}
\end{center}
\end{figure}

\cleardoublepage 
% -------------------------------------------------------------
% Chapter Stackable VFS modules 
% ------------------------------------------------------------- 	
\chapter{Stackable VFS modules}
\label{VFS}\hypertarget{VFS}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2579250}\hypertarget{id2579250}{}%

\index{Virtual File System|textit{see} {VFS} } \index{modules} \index{loaded modules} Stackable VFS (Virtual File System) modules support was new to Samba-3 and has proven quite popular. Samba passes each request to access the UNIX file system through the loaded VFS modules. This chapter covers the modules that come with the Samba source and provides references to some external modules.

% ------------------------   
% Section 
\section{Discussion}
\label{id2579288}\hypertarget{id2579288}{}%

\index{IRIX} \index{GNU/Linux} If not supplied with your platform distribution binary Samba package, you may have problems compiling these modules, as shared libraries are compiled and linked in different ways on different systems. They currently have been tested against GNU/Linux and IRIX.

\index{VFS modules} \index{modules} \index{recycle bin} To use the VFS modules, create a share similar to the one below. The important parameter is the \smbconfoption{vfs objects} parameter where you can list one or more VFS modules by name. For example, to log all access to files and put deleted files in a recycle bin, see \hyperlink{vfsrecyc}{Example {\ref{vfsrecyc}}}:

\begin{example}%
\hypertarget{vfsrecyc}{}%
\captionswapskip{}{{\caption{smb.conf with VFS modules}\label{vfsrecyc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[audit]
 	comment = Audited /data directory
 	path = /data
 	vfs objects = audit recycle
 	writeable = yes
 	browseable = yes
\end{lstlisting}
\end{example}


\index{virus scanner} \index{scanner module} \index{recycle bin} The modules are used in the order in which they are specified. Let's say that you want to both have a virus scanner module and a recycle bin module. It is wise to put the virus scanner module as the first one so that it is the first to get run and may detect a virus immediately, before any action is performed on that file. \smbconfoption{vfs objects} = vscan-clamav recycle

\index{/usr/local/samba/lib/vfs} \index{/usr/lib/samba/vfs} Samba will attempt to load modules from the {\texttt{\docbookhyphenatefilename{/\dbz{}lib}}} directory in the root directory of the Samba installation (usually {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}samba/\dbz{}vfs}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}lib/\dbz{}vfs}}}).

\index{modules} \index{VFS} \index{multiple modules} \index{multiple VFS} Some modules can be used twice for the same share. This can be done using a configuration similar to the one shown in \hyperlink{multimodule}{Example {\ref{multimodule}}}. 
\begin{example}%
\hypertarget{multimodule}{}%
\captionswapskip{}{{\caption{smb.conf with multiple VFS modules}\label{multimodule}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[test]
 	comment = VFS TEST
 	path = /data
 	writeable = yes
 	browseable = yes
 	vfs objects = example:example1 example example:test
 	example1: parameter = 1
 	example:  parameter = 5
 	test:     parameter = 7
\end{lstlisting}
\end{example}



% ------------------------   
% Section 
\section{Included Modules}
\label{id2571161}\hypertarget{id2571161}{}%
\subsection{audit}
\label{id2571167}\hypertarget{id2571167}{}%

\index{audit file access} A simple module to audit file access to the syslog facility. The following operations are logged: 
\begin{itemize}
%--- Item
\item 
share


%--- Item
\item 
connect/disconnect


%--- Item
\item 
directory opens/create/remove


%--- Item
\item 
file open/close/rename/unlink/chmod

\end{itemize}

\subsection{default\_quota}
\label{id2593693}\hypertarget{id2593693}{}%

This module allows the default quota values, in the windows explorer GUI, to be stored on a Samba-3 server. The challenge is that linux filesystems only store quotas for users and groups, but no default quotas.

Samba returns NO\_LIMIT as the default quotas by default and refuses to update them. With this module you can store the default quotas that are reported to a windows client, in the quota record of a user. By default the root user is taken because quota limits for root are typically not enforced.

This module takes 2 parametric entries in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. The default prefix for each is the {``}default\_quota{''}. This can be overwrittem when you load the module in the {\em{vfs modules}} parameter like this: 
\begin{Verbatim}[]

vfs objects = default_quota:myprefix

\end{Verbatim}


The parametric entries that may be specified for the default\_quotas module are:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{myprefix:uid}]\null{}
This parameter takes a integer argument that specifies the uid of the quota record that will be used for storing the default user quotas.

The default value is 0 (for root user). An example of use is: \null{}
\begin{Verbatim}[]

vfs objects = default_quota
default_quota:	uid = 65534

\end{Verbatim}
 The above demonstrates the case where the {\texttt{\docbookhyphenatedot{myprefix}}} was omitted, thus the default prefix is the name of the module. When a {\texttt{\docbookhyphenatedot{myprefix}}} parameter is specified the above can be re-written like this: \null{}
\begin{Verbatim}[]

vfs objects = default_quota:myprefix
myprefix:	uid = 65534

\end{Verbatim}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{myprefix:uid nolimit}]\null{}
This parameter takes a boolean argument that specifies if the stored default quota values also be reported for the user record, or if the value {\texttt{\docbookhyphenatedot{NO\_LIMIT}}} should be reported to the windows client for the user specified by the {\ttfamily\itshape{\docbookhyphenatedot{prefix:uid}}} parameter.

The default value is {\texttt{\docbookhyphenatedot{yes}}} (which means to report NO\_LIMIT). An example of use is shown here: \null{}
\begin{Verbatim}[]

vfs objects = default_quota:myprefix
myprefix:	uid nolimit = no

\end{Verbatim}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{myprefix:gid}]\null{}
This parameter takes an integer argument, it's just like the {\ttfamily\itshape{\docbookhyphenatedot{prefix\textgreater{}:uid}}} but for group quotas. NOTE: group quotas are not supported from the windows explorer.

The default value is 0 (for root group). An example of use is shown here: \null{}
\begin{Verbatim}[]

vfs objects = default_quota
default_quota:	gid = 65534

\end{Verbatim}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{myprefix:gid nolimit}]\null{}
This parameter takes a boolean argument, just like the {\ttfamily\itshape{\docbookhyphenatedot{prefix\textgreater{}:uid nolimit}}} but for group quotas. NOTE: group quotas are not supported from the windows explorer.

The default value is {\texttt{\docbookhyphenatedot{yes}}} (which means to report NO\_LIMIT). An example of use is shown here: \null{}
\begin{Verbatim}[]

vfs objects = default_quota
default_quota:	uid nolimit = no

\end{Verbatim}

\end{description}

An example of use of multiple parametric specifications is shown here: 
\begin{Verbatim}[]

...
vfs objects = default_quota:quotasettings
quotasettings:	uid nolimit = no
quotasettings:	gid = 65534
quotasettings:	gid nolimit = no
...

\end{Verbatim}

\subsection{extd\_audit}
\label{id2593917}\hypertarget{id2593917}{}%

\index{audit module} \index{extd\_audit module} \index{smbd} This module is identical with the {\bfseries{audit}} module above except that it sends audit logs to both syslog as well as the {\bfseries{smbd}} log files. The \smbconfoption{log level} for this module is set in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

Valid settings and the information that will be recorded are shown in \hyperlink{xtdaudit}{Table {\ref{xtdaudit}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{xtdaudit}{}%
\captionswapskip{}{{\caption{Extended Auditing Log Information}\label{xtdaudit}}}
\captionswapskip{}\begin{tabular}{|c|c|}
\hline 
\docbooktolatexaligncl {{{\bfseries Log Level}}} & {{{\bfseries Log Details - File and Directory Operations}}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{0}} & \docbooktolatexalignll {{Make Directory, Remove Directory, Unlink}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{1}} & \docbooktolatexalignll {{Open Directory, Rename File, Change Permissions/ACLs}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{2}} & \docbooktolatexalignll {{Open \& Close File}} \tabularnewline
 \hline 
\docbooktolatexaligncl {{10}} & \docbooktolatexalignll {{Maximum Debug Level}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}

\subsubsection{Configuration of Auditing}
\label{id2570090}\hypertarget{id2570090}{}%

\index{logging} This auditing tool is more felxible than most people readily will recognize. There are a number of ways by which useful logging information can be recorded.

\begin{itemize}
%--- Item
\item 
Syslog can be used to record all transaction. This can be disabled by setting in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file {\ttfamily\itshape{\docbookhyphenatedot{syslog = 0}}}.


%--- Item
\item 
Logging can take place to the default log file ({\texttt{\docbookhyphenatefilename{log.\dbz{}smbd}}}) for all loaded VFS modules just by setting in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file {\ttfamily\itshape{\docbookhyphenatedot{log level = 0 vfs:x}}}, where x is the log level. This will disable general logging while activating all logging of VFS module activity at the log level specified.


%--- Item
\item 
Detailed logging can be obtained per user, per client machine, etc. This requires the above together with the creative use of the {\ttfamily\itshape{\docbookhyphenatedot{log file}}} settings.

An example of detailed per-user and per-machine logging can be obtained by setting \smbconfoption{log file} = /var/log/samba/\%U.\%m.log.

\end{itemize}

Auditing information often must be preserved for a long time. So that the log files do not get rotated it is essential that the \smbconfoption{max log size} = 0 be set in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.
\subsection{fake\_perms}
\label{fakeperms}\hypertarget{fakeperms}{}%

\index{fake\_perms} \index{Roaming Profile} \index{writeable} \index{read only} This module was created to allow Roaming Profile files and directories to be set (on the Samba server under UNIX) as read only. This module will, if installed on the Profiles share, report to the client that the Profile files and directories are writeable. This satisfies the client even though the files will never be overwritten as the client logs out or shuts down.
\subsection{recycle}
\label{id2596905}\hypertarget{id2596905}{}%

\index{recycle} \index{unlink calls} \index{recycle directory} A Recycle Bin-like module. Where used, unlink calls will be intercepted and files moved to the recycle directory instead of being deleted. This gives the same effect as the {\sffamily \bfseries Recycle Bin} on Windows computers.

\index{recycle} \index{.recycle} \index{recycle:keeptree} \index{deleted files} The {\sffamily \bfseries Recycle Bin} will not appear in Windows Explorer views of the network file system (share) nor on any mapped drive. Instead, a directory called {\texttt{\docbookhyphenatefilename{.\dbz{}recycle}}} will be automatically created when the first file is deleted and {\ttfamily\itshape{\docbookhyphenatedot{recycle:repository}}} is not configured. If {\ttfamily\itshape{\docbookhyphenatedot{recycle:repository}}} is configured, the name of the created directory depends on {\ttfamily\itshape{\docbookhyphenatedot{recycle:repository}}}. Users can recover files from the recycle bin. If the {\ttfamily\itshape{\docbookhyphenatedot{recycle:keeptree}}} has been specified, deleted files will be found in a path identical with that from which the file was deleted.

Supported options for the {\bfseries{recycle}} module are as follow: 
\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:repository}]\null{}
\index{recycle:repository} Path of the directory where deleted files should be moved.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:directory\_mode}]\null{}
\index{directory\_mode} Set it to the octal mode you want for the recycle directory. With this mode the recycle directory will be created if it not exists and the first file is deleted. If {\ttfamily\itshape{\docbookhyphenatedot{recycle:subdir\_mode}}} is not set, these mode also apply to sub directories. If {\ttfamily\itshape{\docbookhyphenatedot{directory\_mode}}} not exists, the default mode 0700 is used.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:subdir\_mode}]\null{}
\index{recycle:subdir\_mode} Set it to the octal mode you want for the sub directories of the recycle directory. With this mode the sub directories will be created. If {\ttfamily\itshape{\docbookhyphenatedot{recycle:subdir\_mode}}} is not set, the sub directories will be created with the mode from {\ttfamily\itshape{\docbookhyphenatedot{directory\_mode}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:keeptree}]\null{}
\index{recycle:keeptree} Specifies whether the directory structure should be kept or if the files in the directory that is being deleted should be kept separately in the recycle bin.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:versions}]\null{}
\index{recycle:versions} If this option is set, two files with the same name that are deleted will both be kept in the recycle bin. Newer deleted versions of a file will be called {``}Copy \#x of {\ttfamily\itshape{\docbookhyphenatedot{filename}}}{''}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:touch}]\null{}
\index{recycle:touch} Specifies whether a file's access date should be touched when the file is moved to the recycle bin.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:touch\_mtime}]\null{}
\index{recycle:touch} Specifies whether a file's last modify date date should be touched when the file is moved to the recycle bin.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:maxsize}]\null{}
\index{recycle:maxsize} Files that are larger than the number of bytes specified by this parameter will not be put into the recycle bin.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:exclude}]\null{}
\index{recycle:exclude} List of files that should not be put into the recycle bin when deleted, but deleted in the regular way.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:exclude\_dir}]\null{}
\index{recycle:exclude\_dir} Contains a list of directories. When files from these directories are deleted, they are not put into the recycle bin but are deleted in the regular way.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{recycle:noversions}]\null{}
\index{recycle:noversions} Specifies a list of paths (wildcards such as * and ? are supported) for which no versioning should be used. Only useful when {\em{recycle:versions}} is enabled.
\end{description}

\subsection{netatalk}
\label{id2578478}\hypertarget{id2578478}{}%

\index{netatalk} A netatalk module will ease co-existence of Samba and netatalk file sharing services.

Advantages compared to the old netatalk module: \index{.AppleDouble}
\begin{itemize}
%--- Item
\item 
Does not care about creating .AppleDouble forks, just keeps them in sync.


%--- Item
\item 
If a share in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} does not contain .AppleDouble item in hide or veto list, it will be added automatically.

\end{itemize}

\subsection{shadow\_copy}
\label{id2578531}\hypertarget{id2578531}{}%

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{shadow\_copy} {\em{THIS IS NOT A BACKUP, ARCHIVAL, OR VERSION CONTROL SOLUTION!}}

\index{version control} With Samba or Windows servers, shadow\_copy is designed to be an end-user tool only. It does not replace or enhance your backup and archival solutions and should in no way be considered as such. Additionally, if you need version control, implement a version control system. You have been warned.
\end{admonition}


The shadow\_copy module allows you to setup functionality that is similar to MS shadow copy services. When setup properly, this module allows Microsoft shadow copy clients to browse "shadow copies" on Samba shares. You will need to install the shadow copy client. You can get the MS shadow copy client here.\label{id2578577}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/windowsserver2003/downloads/shadowcopyclient.mspx}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2578577}. Note the additional requirements for pre-Windows XP clients. I did not test this functionality with any pre-Windows XP clients. You should be able to get more information about MS Shadow Copy from the Microsoft's site\label{id2578590}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/windowsserver2003/techinfo/overview/scr.mspx}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2578590}.

\index{shadow\_copy} \index{VFS module} \index{shadow\_copy module} \index{LVM} \index{EVMS} \index{Logical Volume Manager|textit{see} {LVM} } The shadow\_copy VFS module requires some underlying file system setup with some sort of Logical Volume Manager (LVM) such as LVM1, LVM2, or EVMS. Setting up LVM is beyond the scope of this document; however, we will outline the steps we took to test this functionality for {\em{example purposes only.}} You need to make sure the LVM implementation you choose to deploy is ready for production. Make sure you do plenty of tests.

Here are some common resources for LVM and EVMS:

\begin{itemize}
%--- Item
\item 
Sistina's LVM1 and LVM2\label{id2593334}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.sistina.com/products_lvm_download.htm}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2593334}


%--- Item
\item 
Enterprise Volume Management System (EVMS)\label{id2593347}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://evms.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2593347}


%--- Item
\item 
The LVM HOWTO\label{id2593358}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://tldp.org/HOWTO/LVM-HOWTO/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2593358}


%--- Item
\item 
See Learning Linux LVM, Part 1\label{id2593370}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www-106.ibm.com/developerworks/linux/library/l-lvm/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2593370} and Learning Linux LWM, Part 2\label{id2593376}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www-106.ibm.com/developerworks/library/l-lvm2.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2593376} for Daniel Robbins' well-written, two part tutorial on Linux and LVM using LVM source code and reiserfs.

\end{itemize}
\subsubsection{Shadow Copy Setup}
\label{id2593389}\hypertarget{id2593389}{}%

\index{XFS file system} \index{Debian Sarge} At the time of this writing, not much testing has been done. I tested the shadow copy VFS module with a specific scenario which was not deployed in a production environment, but more as a proof of concept. The scenario involved a Samba-3 file server on Debian Sarge with an XFS file system and LVM1. I do NOT recommend you use this as a solution without doing your own due diligence with regard to all the components presented here. That said, following is an basic outline of how I got things going.

\begin{enumerate}
%--- Item
\item 
{\textbf{{Installed Operating System}.}}\ 
In my tests, I used Debian Sarge\label{id2475608}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.debian.org/devel/debian-installer/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2475608} (i.e., testing) on an XFS file system. Setting up the OS is a bit beyond the scope of this document. It is assumed that you have a working OS capable of running Samba.



%--- Item
\item 
{\textbf{{Install \& Configure Samba}.}}\ 
See the \hyperlink{introduction}{Part {\ref{introduction}}} of this HOWTO for more detail on this. It doesn't matter if it is a Domain Controller or Member File Server, but it is assumed that you have a working Samba 3.0.3 or later server running.



%--- Item
\item 
{\textbf{{Install \& Configure LVM}.}}\ 
\index{shadow copies} \index{Snapshots} Before you can make shadow copies available to the client, you have to create the shadow copies. This is done by taking some sort of file system snapshot. Snapshots are a typical feature of Logical Volume Managers such as LVM, so we first need to have that setup.


The following is provided as an example and will be most helpful for Debian users. Again, this was tested using the "testing" or "Sarge" distribution.

\begin{itemize}
%--- Item
\item 
\index{lvm10 package} \index{devfsd package} \index{Debian} \index{xfsprogs} \index{apt-get} Install lvm10 and devfsd packages if you have not done so already. On Debian systems, you are warned of the interaction of devfs and lvm1 which requires the use of devfs filenames. Running {\bfseries{apt-get update \&\& apt-get install lvm10 devfsd xfsprogs}} should do the trick for this example.


%--- Item
\item 
\index{create volume} \index{create partition} \index{fdisk} \index{cfdisk} \index{Linux LVM} Now you need to create a volume. You will need to create a partition (or partitions) to add to your volume. Use your favorite partitioning tool (e.g., Linux fdisk, cfdisk, etc.). The partition type should be set to 0x8e for "Linux LVM." In this example, we will use /dev/hdb1.

\index{Linux LVM partition} \index{LVM volume} \index{modprobe} Once you have the Linux LVM partition (type 0x8e), you can run a series of commands to create the LVM volume. You can use several disks and/or partitions, but we will use only one in this example. You may also need to load the kernel module with something like {\bfseries{modprobe lvm-mod}} and set your system up to load it on reboot by adding it to ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}modules}}}).


%--- Item
\item 
\index{pvcreate} Create the physical volume with {\bfseries{pvcreate /dev/hdb1}}


%--- Item
\item 
\index{vgcreate} \index{volume group} Create the volume group and add /dev/hda1 to it with {\bfseries{vgcreate shadowvol /dev/hdb1}}

\index{vgdisplay} You can use {\bfseries{vgdisplay}} to review information about the volume group.


%--- Item
\item 
\index{lvcreate} Now you can create the logical volume with something like {\bfseries{lvcreate -L400M -nsh\_test shadowvol}}

\index{/dev/shadowvol} This creates the logical volume of 400 MBs named "sh\_test" in the volume group we created called shadowvol. If everything is working so far, you should see them in {\texttt{\docbookhyphenatefilename{/\dbz{}dev/\dbz{}shadowvol}}}.


%--- Item
\item 
\index{mkfs.xfs} Now we should be ready to format the logical volume we named sh\_test with {\bfseries{mkfs.xfs /dev/shadowvol/sh\_test}}

\index{logical volume} \index{LVM} \index{freezing} \index{resizing} \index{growing} You can format the logical volume with any file system you choose, but make sure to use one that allows you to take advantage of the additional features of LVM such as freezing, resizing, and growing your file systems.

\index{LVM volume} \index{shadow\_copy} \index{module} Now we have an LVM volume where we can play with the shadow\_copy VFS module.


%--- Item
\item 
\index{mkdir} \index{permissions} \index{chmod} Now we need to prepare the directory with something like 
\begin{Verbatim}[]

root#  mkdir -p /data/shadow_share

\end{Verbatim}
 or whatever you want to name your shadow copy-enabled Samba share. Make sure you set the permissions so that you can use it. If in doubt, use {\bfseries{chmod 777 /data/shadow\_share}} and tighten the permissions once you get things working.


%--- Item
\item 
\index{mount} Mount the LVM volume using something like {\bfseries{mount /dev/shadowvol/sh\_test /data/shadow\_share}}

\index{/etc/fstab} You may also want to edit your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}fstab}}} so that this partition mounts during the system boot.

\end{itemize}


%--- Item
\item 
{\textbf{{Install \& Configure the shadow\_copy VFS Module}.}}\ 
Finally we get to the actual shadow\_copy VFS module. The shadow\_copy VFS module should be available in Samba 3.0.3 and higher. The smb.conf configuration is pretty standard. Here is our example of a share configured with the shadow\_copy VFS module:


\begin{example}%
\hypertarget{vfsshadow}{}%
\captionswapskip{}{{\caption{Share With shadow\_copy VFS}\label{vfsshadow}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[shadow_share]
 	comment = Shadow Copy Enabled Share
 	path = /data/shadow_share
 	vfs objects = shadow_copy
 	writeable = yes
 	browseable = yes
\end{lstlisting}
\end{example}



%--- Item
\item 
{\textbf{{Create Snapshots and Make Them Available to shadow\_copy.so}.}}\ 
\index{shadow\_copy} \index{LVM snapshots} \index{module} Before you can browse the shadow copies, you must create them and mount them. This will most likely be done with a script that runs as a cron job. With this particular solution, the shadow\_copy VFS module is used to browse LVM snapshots. Those snapshots are not created by the module. They are not made available by the module either. This module allows the shadow copy-enabled client to browse the snapshots you take and make available.


Here is a simple script used to create and mount the snapshots: 
\begin{Verbatim}[]

#!/bin/bash
# This is a test, this is only a test
SNAPNAME=`date +%Y.%m.%d-%H.%M.%S`
xfs_freeze -f /data/shadow_share/
lvcreate -L10M -s -n $SNAPNAME /dev/shadowvol/sh_test
xfs_freeze -u /data/shadow_share/
mkdir /data/shadow_share/@GMT-$SNAPNAME
mount /dev/shadowvol/$SNAPNAME \
       /data/shadow_share/@GMT-$SNAPNAME -onouuid,ro

\end{Verbatim}
 Note that the script does not handle other things like remounting snapshots on reboot.


%--- Item
\item 
{\textbf{{Test From Client}.}}\ 
To test, you will need to install the shadow copy client which you can obtain from the Microsoft web site.\label{id2578238}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/windowsserver2003/downloads/shadowcopyclient.mspx}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2578238} I only tested this with an XP client so your results may vary with other pre-XP clients. Once installed, with your XP client you can right-click on specific files or in the empty space of the shadow\_share and view the "properties." If anything has changed, then you will see it on the "Previous Versions" tab of the properties window.


\end{enumerate}

% ------------------------   
% Section 
\section{VFS Modules Available Elsewhere}
\label{id2578259}\hypertarget{id2578259}{}%

\index{VFS modules} This section contains a listing of various other VFS modules that have been posted but do not currently reside in the Samba CVS tree for one reason or another (e.g., it is easy for the maintainer to have his or her own CVS tree).

No statements about the stability or functionality of any module should be implied due to its presence here.
\subsection{DatabaseFS}
\label{id2578285}\hypertarget{id2578285}{}%

\index{DatabaseFS} URL: Taylors University DatabaeFS\label{id2578301}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.css.tayloru.edu/~elorimer/databasefs/index.php}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2578301}

By Eric Lorimer.\label{id2578313}\begingroup\catcode`\#=12\footnote{ {\textless}\url{mailto:elorimer@css.tayloru.edu}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2578313}

I have created a VFS module that implements a fairly complete read-only filesystem. It presents information from a database as a filesystem in a modular and generic way to allow different databases to be used. (Originally designed for organizing MP3s under directories such as {``}Artists,{''} {``}Song Keywords,{''} and so on. I have since easily applied it to a student roster database.) The directory structure is stored in the database itself and the module makes no assumptions about the database structure beyond the table it requires to run.

Any feedback would be appreciated: comments, suggestions, patches, and so on. If nothing else, it might prove useful for someone else who wishes to create a virtual filesystem.
\subsection{vscan}
\label{id2595575}\hypertarget{id2595575}{}%
\index{vscan}
URL: Open Anti-Virus vscan\label{id2595590}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.openantivirus.org/projects.php#samba-vscan}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2595590}

\index{samba-vscan} samba-vscan is a proof-of-concept module for Samba, which provides on-access anti-virus support for files shared using Samba. samba-vscan supports various virus scanners and is maintained by Rainer Link.
\subsection{vscan-clamav}
\label{id2595616}\hypertarget{id2595616}{}%

Samba users have been using the RPMS from SerNet without a problem. OpenSUSE Linux users have also used the vscan scanner for quite some time with excellent results. It does impact overall write performance though.

The following share stanza is a good guide for those wanting to configure vscan-clamav:

\begin{Verbatim}[]

[share]
vfs objects = vscan-clamav
vscan-clamav: config-file = /etc/samba/vscan-clamav.conf

\end{Verbatim}

The following example of the {\texttt{\docbookhyphenatefilename{vscan-\dbz{}clamav.\dbz{}conf}}} file may help to get this fully operational:

\begin{Verbatim}[]

VFS: Vscan ClamAV Control File
#
# /etc/samba/vscan-clamav.conf
#

[samba-vscan]
; run-time configuration for vscan-samba using
; clamd
; all options are set to default values

; do not scan files larger than X bytes. If set to 0 (default),
; this feature is disable (i.e. all files are scanned)
max file size = 10485760

; log all file access (yes/no). If set to yes, every access will
; be logged. If set to no (default), only access to infected files
; will be logged
verbose file logging = no

; if set to yes (default), a file will be scanned while opening
scan on open = yes
; if set to yes, a file will be scanned while closing (default is yes)
scan on close = yes

; if communication to clamd fails, should access to file denied?
; (default: yes)
deny access on error = no

; if daemon failes with a minor error (corruption, etc.),
; should access to file denied?
; (default: yes)
deny access on minor error = no

; send a warning message via Windows Messenger service
; when virus is found?
; (default: yes)
send warning message = yes

; what to do with an infected file
; quarantine: try to move to quantine directory
; delete:     delete infected file
; nothing:    do nothing (default)
infected file action = quarantine

; where to put infected files - you really want to change this!
quarantine directory  = /opt/clamav/quarantine
; prefix for files in quarantine
quarantine prefix = vir-

; as Windows tries to open a file multiple time in a (very) short time
; of period, samba-vscan use a last recently used file mechanism to avoid
; multiple scans of a file. This setting specified the maximum number of
; elements of the last recently used file list. (default: 100)
max lru files entries = 100

; an entry is invalidad after lru file entry lifetime (in seconds).
; (Default: 5)
lru file entry lifetime = 5

; exclude files from being scanned based on the MIME-type! Semi-colon
; seperated list (default: empty list). Use this with care!
exclude file types =

; socket name of clamd (default: /var/run/clamd). Setting will be ignored if
; libclamav is used
clamd socket name = /tmp/clamd

; limits, if vscan-clamav was build for using the clamav library (libclamav)
; instead of clamd

; maximum number of files in archive (default: 1000)
libclamav max files in archive = 1000

; maximum archived file size, in bytes (default: 10 MB)
libclamav max archived file size = 5242880

; maximum recursion level (default: 5)
libclamav max recursion level = 5

\end{Verbatim}

Obviously, a running clam daemon is necessary for this to work. This is a working example for me using ClamAV. The ClamAV documentation should provide additional configuration examples. On your system these may be located under the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}doc/\dbz{}}}} directory. Some examples may also target other virus scanners, any of which can be used.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Winbind: Use of Domain Accounts 
% ------------------------------------------------------------- 	
\chapter{Winbind: Use of Domain Accounts}
\label{winbind}\hypertarget{winbind}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2594021}\hypertarget{id2594021}{}%

\index{holy grail} \index{heterogeneous computing} Integration of UNIX and Microsoft Windows NT through a unified logon has been considered a {``}holy grail{''} in heterogeneous computing environments for a long time.

\index{interoperability} \index{domain user} \index{domain group} \index{group ownership} There is one other facility without which UNIX and Microsoft Windows network interoperability would suffer greatly. It is imperative that there be a mechanism for sharing files across UNIX systems and to be able to assign domain user and group ownerships with integrity.

\index{Pluggable Authentication Modules|textit{see} {PAM} } \index{winbind} \index{NSS} \index{RPC} {\em{winbind}} is a component of the Samba suite of programs that solves the unified logon problem. Winbind uses a UNIX implementation of Microsoft RPC calls, Pluggable Authentication Modules (PAMs), and the name service switch (NSS) to allow Windows NT domain users to appear and operate as UNIX users on a UNIX machine. This chapter describes the Winbind system, the functionality it provides, how it is configured, and how it works internally.

Winbind provides three separate functions:

\begin{itemize}
%--- Item
\item 
\index{ADS} \index{NT4 domain} Authentication of user credentials (via PAM). This makes it possible to log onto a UNIX/Linux system using user and group accounts from a Windows NT4 (including a Samba domain) or an Active Directory domain.


%--- Item
\item 
\index{identity resolution} \index{NSS} Identity resolution (via NSS). This is the default when winbind is not used.


%--- Item
\item 
\index{UID} \index{GID} \index{SID} \index{idmap uid} \index{idmap gid} \index{idmap backend} \index{LDAP} Winbind maintains a database called winbind\_idmap.tdb in which it stores mappings between UNIX UIDs, GIDs, and NT SIDs. This mapping is used only for users and groups that do not have a local UID/GID. It stores the UID/GID allocated from the idmap uid/gid range that it has mapped to the NT SID. If {\ttfamily\itshape{\docbookhyphenatedot{idmap backend}}} has been specified as {\texttt{\docbookhyphenatedot{ldap:ldap://hostname[:389]}}}, then instead of using a local mapping, Winbind will obtain this information from the LDAP database.

\end{itemize}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{winbindd} \index{starting samba!winbindd} \index{/etc/passwd} \index{/etc/group} \index{smbd} \index{NSS} If {\bfseries{winbindd}} is not running, smbd (which calls {\bfseries{winbindd}}) will fall back to using purely local information from {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} and no dynamic mapping will be used. On an operating system that has been enabled with the NSS, the resolution of user and group information will be accomplished via NSS.
\end{admonition}


% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{winbind_idmap}{}%
\includegraphics[scale=0.45]{Samba3-HOWTO/images/idmap_winbind_no_loop}
{{\caption[{Winbind Idmap}]{{{Winbind Idmap}}}\label{winbind_idmap}}}
\end{center}
\end{figure}


% ------------------------   
% Section 
\section{Introduction}
\label{id2575026}\hypertarget{id2575026}{}%

It is well known that UNIX and Microsoft Windows NT have different models for representing user and group information and use different technologies for implementing them. This fact has made it difficult to integrate the two systems in a satisfactory manner.

\index{synchronization problems} \index{passwords} One common solution in use today has been to create identically named user accounts on both the UNIX and Windows systems and use the Samba suite of programs to provide file and print services between the two. This solution is far from perfect, however, because adding and deleting users on both sets of machines becomes a chore, and two sets of passwords are required ---  both of which can lead to synchronization problems between the UNIX and Windows systems and confusion for users.

We divide the unified logon problem for UNIX machines into three smaller problems:

\begin{itemize}
%--- Item
\item 
Obtaining Windows NT user and group information.


%--- Item
\item 
Authenticating Windows NT users.


%--- Item
\item 
Password changing for Windows NT users.

\end{itemize}

\index{unified logon} \index{duplication of information} Ideally, a prospective solution to the unified logon problem would satisfy all the above components without duplication of information on the UNIX machines and without creating additional tasks for the system administrator when maintaining users and groups on either system. The Winbind system provides a simple and elegant solution to all three components of the unified logon problem.

% ------------------------   
% Section 
\section{What Winbind Provides}
\label{id2571569}\hypertarget{id2571569}{}%

\index{Windows account management} \index{UNIX users} \index{UNIX groups} \index{NT domain} Winbind unifies UNIX and Windows NT account management by allowing a UNIX box to become a full member of an NT domain. Once this is done, the UNIX box will see NT users and groups as if they were {``}native{''} UNIX users and groups, allowing the NT domain to be used in much the same manner that NIS+ is used within UNIX-only environments.

\index{Winbind hooks} \index{domain controller} \index{NSS} \index{redirection} The end result is that whenever a program on the UNIX machine asks the operating system to look up a user or group name, the query will be resolved by asking the NT domain controller for the specified domain to do the lookup. Because Winbind hooks into the operating system at a low level (via the NSS name resolution modules in the C library), this redirection to the NT domain controller is completely transparent.

\index{user and group} \index{domain user} Users on the UNIX machine can then use NT user and group names as they would {``}native{''} UNIX names. They can chown files so they are owned by NT domain users or even login to the UNIX machine and run a UNIX X-Window session as a domain user.

\index{domain controller} The only obvious indication that Winbind is being used is that user and group names take the form {\texttt{\docbookhyphenatedot{DOMAIN\textbackslash user}}} and {\texttt{\docbookhyphenatedot{DOMAIN\textbackslash group}}}. This is necessary because it allows Winbind to determine that redirection to a domain controller is wanted for a particular lookup and which trusted domain is being referenced.

\index{PAM-enabled} \index{domain controller} Additionally, Winbind provides an authentication service that hooks into the PAM system to provide authentication via an NT domain to any PAM-enabled applications. This capability solves the problem of synchronizing passwords between systems, since all passwords are stored in a single location (on the domain controller).
\subsection{Target Uses}
\label{id2571727}\hypertarget{id2571727}{}%

\index{infrastructure} Winbind is targeted at organizations that have an existing NT-based domain infrastructure into which they wish to put UNIX workstations or servers. Winbind will allow these organizations to deploy UNIX workstations without having to maintain a separate account infrastructure. This greatly simplifies the administrative overhead of deploying UNIX workstations into an NT-based organization.

\index{Appliances} \index{Winbind} Another interesting way in which we expect Winbind to be used is as a central part of UNIX-based appliances. Appliances that provide file and print services to Microsoft-based networks will be able to use Winbind to provide seamless integration of the appliance into the domain.
\subsection{Handling of Foreign SIDs}
\label{id2571775}\hypertarget{id2571775}{}%

\index{foreign SID} The term {\em{foreign SID}} is often met with the reaction that it is not relevant to a particular environment. The following documents an interchange that took place on the Samba mailing list. It is a good example of the confusion often expressed regarding the use of winbind.

\index{local domain} Fact: Winbind is needed to handle users who use workstations that are NOT part of the local domain.

\index{PDC} Response: {``}Why? I've used Samba with workstations that are not part of my domains lots of times without using winbind. I thought winbind was for using Samba as a member server in a domain controlled by another Samba/Windows PDC.{''}

\index{UID} \index{GID} \index{foreign user} If the Samba server will be accessed from a domain other than the local Samba domain, or if there will be access from machines that are not local domain members, winbind will permit the allocation of UIDs and GIDs from the assigned pool that will keep the identity of the foreign user separate from users that are members of the Samba domain.

\index{PDC} \index{domain member} \index{domain non-member} \index{SID} This means that winbind is eminently useful in cases where a single Samba PDC on a local network is combined with both domain member and domain non-member workstations. If winbind is not used, the user george on a Windows workstation that is not a domain member will be able to access the files of a user called george in the account database of the Samba server that is acting as a PDC. When winbind is used, the default condition is that the local user george will be treated as the account DOMAIN\textbackslash george and the foreign (non-member of the domain) account will be treated as MACHINE\textbackslash george because each has a different SID.

% ------------------------   
% Section 
\section{How Winbind Works}
\label{id2468604}\hypertarget{id2468604}{}%

\index{winbindd} \index{UNIX domain socket} \index{NSS} \index{PAM} The Winbind system is designed around a client/server architecture. A long-running {\bfseries{winbindd}} daemon listens on a UNIX domain socket waiting for requests to arrive. These requests are generated by the NSS and PAM clients and are processed sequentially.

The technologies used to implement Winbind are described in detail below.
\subsection{Microsoft Remote Procedure Calls}
\label{id2571344}\hypertarget{id2571344}{}%

\index{Microsoft Remote Procedure Call|textit{see} {MSRPC} } \index{PDC} \index{remote management} \index{user authentication} \index{print spooling} Over the last few years, efforts have been underway by various Samba Team members to implement various aspects of the Microsoft Remote Procedure Call (MSRPC) system. This system is used for most network-related operations between Windows NT machines, including remote management, user authentication, and print spooling. Although initially this work was done to aid the implementation of Primary Domain Controller (PDC) functionality in Samba, it has also yielded a body of code that can be used for other purposes.

\index{MSRPC} \index{enumerate domain users} \index{enumerate domain groups} Winbind uses various MSRPC calls to enumerate domain users and groups and to obtain detailed information about individual users or groups. Other MSRPC calls can be used to authenticate NT domain users and to change user passwords. By directly querying a Windows PDC for user and group information, Winbind maps the NT account information onto UNIX user and group names.
\subsection{Microsoft Active Directory Services}
\label{id2571431}\hypertarget{id2571431}{}%

\index{LDAP} \index{Kerberos} \index{Winbind} \index{native mode} Since late 2001, Samba has gained the ability to interact with Microsoft Windows 2000 using its {``}native mode{''} protocols rather than the NT4 RPC services. Using LDAP and Kerberos, a domain member running Winbind can enumerate users and groups in exactly the same way as a Windows 200x client would, and in so doing provide a much more efficient and effective Winbind implementation.
\subsection{Name Service Switch}
\label{id2571479}\hypertarget{id2571479}{}%

\index{NSS} \index{networked workstation} \index{NIS} \index{DNS} The NSS is a feature that is present in many UNIX operating systems. It allows system information such as hostnames, mail aliases, and user information to be resolved from different sources. For example, a standalone UNIX workstation may resolve system information from a series of flat files stored on the local file system. A networked workstation may first attempt to resolve system information from local files, and then consult an NIS database for user information or a DNS server for hostname information.

\index{NSS} \index{MSRPC} \index{trusted domain} \index{local users} \index{local groups} The NSS application programming interface allows Winbind to present itself as a source of system information when resolving UNIX usernames and groups. Winbind uses this interface and information obtained from a Windows NT server using MSRPC calls to provide a new source of account enumeration. Using standard UNIX library calls, you can enumerate the users and groups on a UNIX machine running Winbind and see all users and groups in an NT domain plus any trusted domain as though they were local users and groups.

\index{NSS} \index{/etc/nsswitch.conf} \index{passwd} The primary control file for NSS is {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}}. When a UNIX application makes a request to do a lookup, the C library looks in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} for a line that matches the service type being requested; for example, the {``}passwd{''} service type is used when user or group names are looked up. This config line specifies which implementations of that service should be tried and in what order. If the passwd config line is: 
\begin{Verbatim}[]

passwd: files example

\end{Verbatim}
 \index{/lib/libnss\_files.so} \index{/lib/libnss\_example.so} \index{resolver functions} then the C library will first load a module called {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}libnss\_\dbz{}files.\dbz{}so}}} followed by the module {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}libnss\_\dbz{}example.\dbz{}so}}}. The C library will dynamically load each of these modules in turn and call resolver functions within the modules to try to resolve the request. Once the request is resolved, the C library returns the result to the application.

\index{NSS} \index{libnss\_winbind.so} \index{/etc/nsswitch.conf} This NSS interface provides an easy way for Winbind to hook into the operating system. All that needs to be done is to put {\texttt{\docbookhyphenatefilename{libnss\_\dbz{}winbind.\dbz{}so}}} in {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}}}} then add {``}winbind{''} into {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} at the appropriate place. The C library will then call Winbind to resolve user and group names.
\subsection{Pluggable Authentication Modules}
\label{id2572429}\hypertarget{id2572429}{}%

\index{PAM} \index{authentication methods} \index{authorization} \index{NIS database} PAMs provide a system for abstracting authentication and authorization technologies. With a PAM module, it is possible to specify different authentication methods for different system applications without having to recompile these applications. PAM is also useful for implementing a particular policy for authorization. For example, a system administrator may only allow console logins from users stored in the local password file but only allow users resolved from an NIS database to log in over the network.

\index{PAM} \index{Winbind} \index{authentication management} \index{password management} \index{PDC} Winbind uses the authentication management and password management PAM interface to integrate Windows NT users into a UNIX system. This allows Windows NT users to log in to a UNIX machine and be authenticated against a suitable PDC. These users can also change their passwords and have this change take effect directly on the PDC.

\index{PAM} \index{/etc/pam.d/} \index{pam\_winbind.so} \index{/lib/security/} PAM is configured by providing control files in the directory {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}}}} for each of the services that require authentication. When an authentication request is made by an application, the PAM code in the C library looks up this control file to determine what modules to load to do the authentication check and in what order. This interface makes adding a new authentication service for Winbind very easy: simply copy the {\texttt{\docbookhyphenatefilename{pam\_\dbz{}winbind.\dbz{}so}}} module to {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}security/\dbz{}}}}, and the PAM control files for relevant services are updated to allow authentication via Winbind. See the PAM documentation in \hyperlink{pam}{Chapter {\ref{pam}}, {``}PAM-Based Distributed Authentication{''}}, for more information.
\subsection{User and Group ID Allocation}
\label{id2575225}\hypertarget{id2575225}{}%

\index{RID} \index{Winbind} \index{UNIX ID} When a user or group is created under Windows NT/200x, it is allocated a numerical relative identifier (RID). This is slightly different from UNIX, which has a range of numbers that are used to identify users and the same range used to identify groups. It is Winbind's job to convert RIDs to UNIX ID numbers and vice versa. When Winbind is configured, it is given part of the UNIX user ID space and a part of the UNIX group ID space in which to store Windows NT users and groups. If a Windows NT user is resolved for the first time, it is allocated the next UNIX ID from the range. The same process applies for Windows NT groups. Over time, Winbind will have mapped all Windows NT users and groups to UNIX user IDs and group IDs.

\index{ID mapping database} \index{tdb} \index{UNIX ID} \index{RID} The results of this mapping are stored persistently in an ID mapping database held in a tdb database. This ensures that RIDs are mapped to UNIX IDs in a consistent way.
\subsection{Result Caching}
\label{id2575305}\hypertarget{id2575305}{}%

\index{SAM} \index{caching scheme} \index{Winbind} \index{ADS} \index{PDC} An active directory system can generate a lot of user and group name lookups. To reduce the network cost of these lookups, Winbind uses a caching scheme based on the SAM sequence number supplied by NT domain controllers. User or group information returned by a PDC is cached by Winbind along with a sequence number also returned by the PDC. This sequence number is incremented by Windows NT whenever any user or group information is modified. If a cached entry has expired, the sequence number is requested from the PDC and compared against the sequence number of the cached entry. If the sequence numbers do not match, then the cached information is discarded and up-to-date information is requested directly from the PDC.

% ------------------------   
% Section 
\section{Installation and Configuration}
\label{id2575365}\hypertarget{id2575365}{}%
\subsection{Introduction}
\label{id2575371}\hypertarget{id2575371}{}%

\index{Winbind} \index{PDC} \index{authentication control} This section describes the procedures used to get Winbind up and running. Winbind is capable of providing access and authentication control for Windows Domain users through an NT or Windows 200x PDC for regular services, such as telnet and ftp, as well for Samba services.

\begin{itemize}
%--- Item
\item 
{\em{Why should I do this?}}

\index{Samba administrator} \index{authentication mechanisms} \index{domain members} \index{accounts} This allows the Samba administrator to rely on the authentication mechanisms on the Windows NT/200x PDC for the authentication of domain members. Windows NT/200x users no longer need to have separate accounts on the Samba server.


%--- Item
\item 
{\em{Who should be reading this document?}}

\index{PDC} \index{Windows NT/200x} This document is designed for system administrators. If you are implementing Samba on a file server and wish to (fairly easily) integrate existing Windows NT/200x users from your PDC onto the Samba server, this document is for you.

\end{itemize}
\subsection{Requirements}
\label{id2575491}\hypertarget{id2575491}{}%

\index{PAM} \index{back up} \index{boot disk`} If you have a Samba configuration file that you are currently using, {\em{BACK IT UP!}} If your system already uses PAM, {\em{back up the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d}}} directory contents!}} If you haven't already made a boot disk, {\em{MAKE ONE NOW!}}

\index{PAM configuration} \index{/etc/pam.d} \index{single-user mode} Messing with the PAM configuration files can make it nearly impossible to log in to your machine. That's why you want to be able to boot back into your machine in single-user mode and restore your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d}}} to the original state it was in if you get frustrated with the way things are going.

\index{winbindd} \index{daemon} The latest version of Samba-3 includes a functioning winbindd daemon. Please refer to the main Samba Web page\label{id2575594}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2575594}, or better yet, your closest Samba mirror site for instructions on downloading the source code.

\index{domain users} \index{shares and files} \index{PAM} \index{development libraries} To allow domain users the ability to access Samba shares and files, as well as potentially other services provided by your Samba machine, PAM must be set up properly on your machine. In order to compile the Winbind modules, you should have at least the PAM development libraries installed on your system. Please refer to the PAM Web site {\textless}\url{http://www.kernel.org/pub/linux/libs/pam/}{\textgreater}.
\subsection{Testing Things Out}
\label{id2575647}\hypertarget{id2575647}{}%

\index{smbd} \index{nmbd} \index{winbindd} \index{/etc/pam.d} \index{PAM} Before starting, it is probably best to kill off all the Samba-related daemons running on your server. Kill off all smbd, nmbd, and winbindd processes that may be running. To use PAM, make sure that you have the standard PAM package that supplies the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d}}} directory structure, including the PAM modules that are used by PAM-aware services, several PAM libraries, and the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}doc}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}man}}} entries for PAM. Winbind is built better in Samba if the pam-devel package is also installed. This package includes the header files needed to compile PAM-aware applications.
\subsubsection{Configure nsswitch.\dbz{}conf and the Winbind Libraries on Linux and Solaris}
\label{id2575737}\hypertarget{id2575737}{}%

\index{PAM} \index{pam-devel} \index{Winbind} \index{/etc/nsswitch.conf} PAM is a standard component of most current generation UNIX/Linux systems. Unfortunately, few systems install the {\texttt{\docbookhyphenatefilename{pam-\dbz{}devel}}} libraries that are needed to build PAM-enabled Samba. Additionally, Samba-3 may auto-install the Winbind files into their correct locations on your system, so before you get too far down the track, be sure to check if the following configuration is really necessary. You may only need to configure {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}}.

The libraries needed to run the winbindd daemon through nsswitch need to be copied to their proper locations:

\index{libnss\_winbind.so} 
\begin{Verbatim}[]

root# cp ../samba/source/nsswitch/libnss_winbind.so /lib

\end{Verbatim}


I also found it necessary to make the following symbolic link:

{\texttt{\docbookhyphenatedot{root\#}}} {\ttfamily\bfseries{\docbookhyphenatedot{ln -\dbz{}s /\dbz{}lib/\dbz{}libnss\_\dbz{}winbind.\dbz{}so /\dbz{}lib/\dbz{}libnss\_\dbz{}winbind.\dbz{}so.\dbz{}2}}}

And, in the case of Sun Solaris: \index{nss\_winbind.so.1} 
\begin{Verbatim}[]

root# ln -s /usr/lib/libnss_winbind.so /usr/lib/libnss_winbind.so.1
root# ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.1
root# ln -s /usr/lib/libnss_winbind.so /usr/lib/nss_winbind.so.2

\end{Verbatim}


\index{/etc/nsswitch.conf} As root, edit {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} to allow user and group entries to be visible from the winbindd daemon. My {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file looked like this after editing: 
\begin{Verbatim}[]

passwd:     files winbind
shadow:     files
group:      files winbind

\end{Verbatim}


\index{winbindd} \index{ldconfig} \index{libnss\_winbind} \index{grep} \index{dynamic link loader} The libraries needed by the {\bfseries{winbindd}} daemon will be automatically entered into the {\bfseries{ldconfig}} cache the next time your system reboots, but it is faster (and you do not need to reboot) if you do it manually: 
\begin{Verbatim}[]

root# /sbin/ldconfig -v | grep winbind

\end{Verbatim}
 This makes {\texttt{\docbookhyphenatefilename{libnss\_\dbz{}winbind}}} available to winbindd and reports the current search path that is used by the dynamic link loader. The use of the {\bfseries{grep}} filters the output of the {\bfseries{ldconfig}} command so that we may see proof that this library is indeed recognized by the dynamic link loader.

\index{dynamic link loader} \index{crle} \index{/usr/local/lib} \index{link loader configuration} \index{object module dependencies} The Sun Solaris dynamic link loader management tool is called {\bfseries{crle}}. The use of this tool is necessary to instruct the dynamic link loader to search directories that contain library files that were not supplied as part of the original operating system platform. The following example shows how to use this tool to add the directory {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}lib}}} to the dynamic link loader's search path: 
\begin{Verbatim}[]

root#  crle -u -l /usr/lib:/usr/local/lib

\end{Verbatim}
 When executed without arguments, {\bfseries{crle}} reports the current dynamic link loader configuration. This is demonstrated here: 
\begin{Verbatim}[]

root#  crle

Configuration file [version 4]: /var/ld/ld.config
  Default Library Path (ELF):   /lib:/usr/lib:/usr/local/lib
  Trusted Directories (ELF):    /lib/secure:/usr/lib/secure  (system default)

Command line:
  crle -c /var/ld/ld.config -l /lib:/usr/lib:/usr/local/lib

\end{Verbatim}
 From this it is apparent that the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}lib}}} directory is included in the search dynamic link libraries in order to satisfy object module dependencies.
\subsubsection{NSS Winbind on AIX}
\label{id2596277}\hypertarget{id2596277}{}%

(This section is only for those running AIX.)

\index{AIX} \index{Winbind} \index{/usr/lib/security} \index{authentication module API} \index{/usr/lib/security/methods.cfg} \index{PAM module} The Winbind AIX identification module gets built as {\texttt{\docbookhyphenatefilename{libnss\_\dbz{}winbind.\dbz{}so}}} in the nsswitch directory of the Samba source. This file can be copied to {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}security}}}, and the AIX naming convention would indicate that it should be named WINBIND. A stanza like the following: 
\begin{Verbatim}[]

WINBIND:
        program = /usr/lib/security/WINBIND
        options = authonly

\end{Verbatim}
 can then be added to {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}security/\dbz{}methods.\dbz{}cfg}}}. This module only supports identification, but there have been reports of success using the standard Winbind PAM module for authentication. Use caution configuring loadable authentication modules, since misconfiguration can make it impossible to log on to the system. Information regarding the AIX authentication module API can be found in the {``}Kernel Extensions and Device Support Programming Concepts for AIX{''} document that describes the Loadable Authentication Module Programming Interface\label{id2596370}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixprggd/kernextc/sec_load_mod.htm}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2596370} for AIX. Further information on administering the modules can be found in the System Management Guide: Operating System and Devices.\label{id2596380}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://publibn.boulder.ibm.com/doc_link/en_US/a_doc_lib/aixbman/baseadmn/iandaadmin.htm}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2596380}
\subsubsection{Configure smb.conf}
\label{id2596390}\hypertarget{id2596390}{}%

\index{winbind} \index{man page} \index{winbindd} Several parameters are needed in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to control the behavior of winbindd. These are described in more detail in the winbindd(8) man page. My {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, as shown in \hyperlink{winbindcfg}{Example {\ref{winbindcfg}}}, was modified to include the necessary entries in the [global] section.

\begin{example}%
\hypertarget{winbindcfg}{}%
\captionswapskip{}{{\caption{smb.conf for Winbind Setup}\label{winbindcfg}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 # separate domain and username with '\textbackslash ', like DOMAIN\textbackslash username
 	winbind separator = \
 # use uids from 10000 to 20000 for domain users
 	idmap uid = 10000-20000
 # use gids from 10000 to 20000 for domain groups
 	idmap gid = 10000-20000
 # allow enumeration of winbind users and groups
 	winbind enum users = yes
 	winbind enum groups = yes
 # give winbind users a real shell (only needed if they have telnet access)
 	template homedir = /home/winnt/%D/%U
 	template shell = /bin/bash
\end{lstlisting}
\end{example}

\subsubsection{Join the Samba Server to the PDC Domain}
\label{id2596541}\hypertarget{id2596541}{}%

\index{domain security} \index{PDC} \index{BDC} All machines that will participate in domain security should be members of the domain. This applies also to the PDC and all BDCs.

\index{joining domain} \index{domain join} \index{net!rpc!join} \index{smbd} \index{PDC} \index{domain controller} \index{MS DCE RPC} \index{DCE RPC} \index{RPC} The process of joining a domain requires the use of the {\bfseries{net rpc join}} command. This process communicates with the domain controller it will register with (usually the PDC) via MS DCE RPC. This means, of course, that the {\bfseries{smbd}} process must be running on the target domain controller. It is therefore necessary to temporarily start Samba on a PDC so that it can join its own domain.

\index{PDC} \index{administrative privileges} \index{Administrator} Enter the following command to make the Samba server join the domain, where {\ttfamily\itshape{\docbookhyphenatedot{PDC}}} is the name of your PDC and {\ttfamily\itshape{\docbookhyphenatedot{Administrator}}} is a domain user who has administrative privileges in the domain.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{domain controller} \index{PDC} \index{tcp ports} \index{udp ports} Before attempting to join a machine to the domain, verify that Samba is running on the target domain controller (usually PDC) and that it is capable of being reached via ports 137/udp, 135/tcp, 139/tcp, and 445/tcp (if Samba or Windows Server 2Kx).
\end{admonition}


\index{net!rpc!join} The use of the {\bfseries{net rpc join}} facility is shown here: 
\begin{Verbatim}[]

root# /usr/local/samba/bin/net rpc join -S PDC -U Administrator

\end{Verbatim}
 The proper response to the command should be {``}Joined the domain {\ttfamily\itshape{\docbookhyphenatedot{DOMAIN}}}{''} where {\ttfamily\itshape{\docbookhyphenatedot{DOMAIN}}} is your domain name.
\subsubsection{Starting and Testing the winbindd Daemon}
\label{id2596788}\hypertarget{id2596788}{}%

\index{startup script} \index{winbindd} \index{Winbind services} Eventually, you will want to modify your Samba startup script to automatically invoke the winbindd daemon when the other parts of Samba start, but it is possible to test out just the Winbind portion first. To start up Winbind services, enter the following command as root: 
\begin{Verbatim}[]

root# /usr/local/samba/sbin/winbindd

\end{Verbatim}
 Use the appropriate path to the location of the {\bfseries{winbindd}} executable file.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Winbind} \index{/usr/local/samba} The command to start up Winbind services assumes that Samba has been installed in the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba}}} directory tree. You may need to search for the location of Samba files if this is not the location of {\bfseries{winbindd}} on your system.
\end{admonition}


\index{paranoid} \index{daemon running} I'm always paranoid and like to make sure the daemon is really running. 
\begin{Verbatim}[]

root# ps -ae | grep winbindd

\end{Verbatim}


\index{winbindd} This command should produce output like the following if the daemon is running. 
\begin{Verbatim}[]

3025 ?        00:00:00 winbindd

\end{Verbatim}


\index{PDC} \index{wbinfo} Now, for the real test, try to get some information about the users on your PDC: 
\begin{Verbatim}[]

root# /usr/local/samba/bin/wbinfo -u

\end{Verbatim}
 This should echo back a list of users on your Windows users on your PDC. For example, I get the following response: 
\begin{Verbatim}[]

CEO\Administrator
CEO\burdell
CEO\Guest
CEO\jt-ad
CEO\krbtgt
CEO\TsInternetUser

\end{Verbatim}
 Obviously, I have named my domain {``}CEO{''} and my \smbconfoption{winbind separator} is {``}\textbackslash{''}.

\index{wbinfo} \index{PDC} You can do the same sort of thing to get group information from the PDC: 
\begin{Verbatim}[]

root# /usr/local/samba/bin/wbinfo -g
CEO\Domain Admins
CEO\Domain Users
CEO\Domain Guests
CEO\Domain Computers
CEO\Domain Controllers
CEO\Cert Publishers
CEO\Schema Admins
CEO\Enterprise Admins
CEO\Group Policy Creator Owners

\end{Verbatim}


\index{getent} \index{PDC} \index{/etc/passwd} \index{UID} \index{GID} \index{home directories} \index{default shells} The function {\bfseries{getent}} can now be used to get unified lists of both local and PDC users and groups. Try the following command: 
\begin{Verbatim}[]

root# getent passwd

\end{Verbatim}
 You should get a list that looks like your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}} list followed by the domain users with their new UIDs, GIDs, home directories, and default shells.

The same thing can be done for groups with the command: 
\begin{Verbatim}[]

root# getent group

\end{Verbatim}

\subsubsection{Fix the init.d Startup Scripts}
\label{id2590769}\hypertarget{id2590769}{}%
\subparagraph*{Linux}
\label{id2590775}\hypertarget{id2590775}{}%

\index{winbindd daemon} \index{smbd} \index{nmbd} \index{/etc/init.d/smb} \index{/etc/init.d/samba} \index{/usr/local/samba/bin} \index{} \index{} \index{} The winbindd daemon needs to start up after the smbd and nmbd daemons are running. To accomplish this task, you need to modify the startup scripts of your system. They are located at {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}init.\dbz{}d/\dbz{}smb}}} in Red Hat Linux and in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}init.\dbz{}d/\dbz{}samba}}} in Debian Linux. Edit your script to add commands to invoke this daemon in the proper sequence. My startup script starts up smbd, nmbd, and winbindd from the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}bin}}} directory directly. The {\bfseries{start}} function in the script looks like this: 
\begin{Verbatim}[]

start() {
        KIND="SMB"
        echo -n $"Starting $KIND services: "
        daemon /usr/local/samba/bin/smbd $SMBDOPTIONS
        RETVAL=$?
        echo
        KIND="NMB"
        echo -n $"Starting $KIND services: "
        daemon /usr/local/samba/bin/nmbd $NMBDOPTIONS
        RETVAL2=$?
        echo
        KIND="Winbind"
        echo -n $"Starting $KIND services: "
        daemon /usr/local/samba/sbin/winbindd
        RETVAL3=$?
        echo
        [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \
		touch /var/lock/subsys/smb || RETVAL=1
        return $RETVAL
}

\end{Verbatim}


If you would like to run winbindd in dual daemon mode, replace the line: 
\begin{Verbatim}[]

        daemon /usr/local/samba/sbin/winbindd

\end{Verbatim}
 in the example above with: 
\begin{Verbatim}[]

        daemon /usr/local/samba/sbin/winbindd -B

\end{Verbatim}
.

The {\bfseries{stop}} function has a corresponding entry to shut down the services and looks like this:


\begin{Verbatim}[]

stop() {
        KIND="SMB"
        echo -n $"Shutting down $KIND services: "
        killproc smbd
        RETVAL=$?
        echo
        KIND="NMB"
        echo -n $"Shutting down $KIND services: "
        killproc nmbd
        RETVAL2=$?
        echo
        KIND="Winbind"
        echo -n $"Shutting down $KIND services: "
        killproc winbindd
        RETVAL3=$?
        [ $RETVAL -eq 0 -a $RETVAL2 -eq 0 -a $RETVAL3 -eq 0 ] && \
		 rm -f /var/lock/subsys/smb
        echo ""
        return $RETVAL
}

\end{Verbatim}

\subparagraph*{Solaris}
\label{id2590970}\hypertarget{id2590970}{}%

Winbind does not work on Solaris 9; see \hyperlink{winbind-solaris9}{Section {\ref{winbind-solaris9}}} for details.

\index{Solaris 9} \index{/etc/init.d/samba.server} \index{/usr/local/samba/bin} \index{smbd} \index{nmbd} \index{winbindd} On Solaris, you need to modify the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}init.\dbz{}d/\dbz{}samba.\dbz{}server}}} startup script. It usually only starts smbd and nmbd but should now start winbindd, too. If you have Samba installed in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}bin}}}, the file could contains something like this:


\begin{Verbatim}[]

	##
	## samba.server
	##

	if [ ! -d /usr/bin ]
	then                    # /usr not mounted
		exit
	fi

	killproc() {            # kill the named process(es)
		pid=`/usr/bin/ps -e |
		     /usr/bin/grep -w $1 |
		     /usr/bin/sed -e 's/^  *//' -e 's/ .*//'`
		[ "$pid" != "" ] && kill $pid
	}

	# Start/stop processes required for Samba server

	case "$1" in

	'start')
	#
	# Edit these lines to suit your installation (paths, workgroup, host)
	#
	echo Starting SMBD
	   /usr/local/samba/bin/smbd -D -s \
		/usr/local/samba/smb.conf

	echo Starting NMBD
	   /usr/local/samba/bin/nmbd -D -l \
		/usr/local/samba/var/log -s /usr/local/samba/smb.conf

	echo Starting Winbind Daemon
	   /usr/local/samba/sbin/winbindd
	   ;;

	'stop')
	   killproc nmbd
	   killproc smbd
	   killproc winbindd
	   ;;

	*)
	   echo "Usage: /etc/init.d/samba.server { start | stop }"
	   ;;
	esac

\end{Verbatim}


Again, if you would like to run Samba in dual daemon mode, replace: 
\begin{Verbatim}[]

/usr/local/samba/sbin/winbindd

\end{Verbatim}
 in the script above with: 
\begin{Verbatim}[]

/usr/local/samba/sbin/winbindd -B

\end{Verbatim}

\subparagraph*{Restarting}
\label{id2591087}\hypertarget{id2591087}{}%

\index{daemons} \index{local user} If you restart the smbd, nmbd, and winbindd daemons at this point, you should be able to connect to the Samba server as a domain member just as if you were a local user.
\subsubsection{Configure Winbind and PAM}
\label{id2591133}\hypertarget{id2591133}{}%

\index{winbindd} \index{authentication} \index{PAM} \index{/etc/pam.d} If you have made it this far, you know that {\bfseries{winbindd}} and Samba are working together. If you want to use Winbind to provide authentication for other services, keep reading. The PAM configuration files need to be altered in this step. (Did you remember to make backups of your original {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d}}} files? If not, do it now.)

\index{NSS} \index{../source/nsswitch} \index{pam\_winbind.so} \index{/lib/security} \index{Solaris} \index{/usr/lib/security} You will need a PAM module to use winbindd with these other services. This module will be compiled in the {\texttt{\docbookhyphenatefilename{.\dbz{}.\dbz{}/\dbz{}source/\dbz{}nsswitch}}} directory by invoking the command: 
\begin{Verbatim}[]

root# make nsswitch/pam_winbind.so

\end{Verbatim}
 from the {\texttt{\docbookhyphenatefilename{.\dbz{}.\dbz{}/\dbz{}source}}} directory. The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}winbind.\dbz{}so}}} file should be copied to the location of your other PAM security modules. On my Red Hat system, this was the {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}security}}} directory. On Solaris, the PAM security modules reside in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}lib/\dbz{}security}}}. 
\begin{Verbatim}[]

root# cp ../samba/source/nsswitch/pam_winbind.so /lib/security

\end{Verbatim}

\subparagraph*{Linux/FreeBSD-Specific PAM Configuration}
\label{id2591304}\hypertarget{id2591304}{}%

\index{/etc/pam.d/samba} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}samba}}} file does not need to be changed. I just left this file as it was: 
\begin{Verbatim}[]

auth    required  /lib/security/pam_stack.so service=system-auth
account required  /lib/security/pam_stack.so service=system-auth

\end{Verbatim}


\index{Winbind} \index{authentication service} \index{login} \index{console} \index{telnet logins} \index{ftp service} \index{/etc/xinetd.d} \index{/etc/inetd.conf} \index{/etc/xinetd.d/telnet} The other services that I modified to allow the use of Winbind as an authentication service were the normal login on the console (or a terminal session), telnet logins, and ftp service. In order to enable these services, you may first need to change the entries in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}xinetd.\dbz{}d}}} (or {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}inetd.\dbz{}conf}}}). Red Hat Linux 7.1 and later uses the new xinetd.d structure, in this case you need to change the lines in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}xinetd.\dbz{}d/\dbz{}telnet}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}xinetd.\dbz{}d/\dbz{}wu-\dbz{}ftp}}} from: 
\begin{Verbatim}[]

	enable = no

\end{Verbatim}
 to 
\begin{Verbatim}[]

	enable = yes

\end{Verbatim}


\index{ftp services} \index{home directory template} \index{domain users} For ftp services to work properly, you will also need to either have individual directories for the domain users already present on the server or change the home directory template to a general directory for all domain users. These can be easily set using the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} global entry \smbconfoption{template homedir}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{pam\_mkhomedir} The directory in \smbconfoption{template homedir} is not created automatically! Use pam\_mkhomedir or pre-create the directories of users to make sure users can log in on UNIX with their own home directory.
\end{admonition}


\index{/etc/pam.d/ftp} \index{Winbind} \index{ftp access} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}ftp}}} file can be changed to allow Winbind ftp access in a manner similar to the samba file. My {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}ftp}}} file was changed to look like this: 
\begin{Verbatim}[]

auth       required     /lib/security/pam_listfile.so item=user sense=deny \
	 file=/etc/ftpusers onerr=succeed
auth       sufficient   /lib/security/pam_winbind.so
auth       required     /lib/security/pam_stack.so service=system-auth
auth       required     /lib/security/pam_shells.so
account    sufficient   /lib/security/pam_winbind.so
account    required     /lib/security/pam_stack.so service=system-auth
session    required     /lib/security/pam_stack.so service=system-auth

\end{Verbatim}


\index{/etc/pam.d/login} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}login}}} file can be changed in nearly the same way. It now looks like this: 
\begin{Verbatim}[]

auth       required     /lib/security/pam_securetty.so
auth       sufficient   /lib/security/pam_winbind.so
auth       sufficient   /lib/security/pam_unix.so use_first_pass
auth       required     /lib/security/pam_stack.so service=system-auth
auth       required     /lib/security/pam_nologin.so
account    sufficient   /lib/security/pam_winbind.so
account    required     /lib/security/pam_stack.so service=system-auth
password   required     /lib/security/pam_stack.so service=system-auth
session    required     /lib/security/pam_stack.so service=system-auth
session    optional     /lib/security/pam_console.so

\end{Verbatim}
 \index{pam\_winbind.so} \index{pam\_securetty.so} \index{pam\_unix.so} In this case, I added the 
\begin{Verbatim}[]
auth sufficient /lib/security/pam_winbind.so
\end{Verbatim}
 lines as before, but also added the 
\begin{Verbatim}[]
required pam_securetty.so
\end{Verbatim}
 above it to disallow root logins over the network. I also added a 
\begin{Verbatim}[]
sufficient /lib/security/pam_unix.so
use_first_pass
\end{Verbatim}
 line after the {\bfseries{winbind.so}} line to get rid of annoying double prompts for passwords.
\subparagraph*{Solaris-Specific Configuration}
\label{id2594442}\hypertarget{id2594442}{}%

\index{/etc/pam.conf} \index{} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}} needs to be changed. I changed this file so my Domain users can log on both locally as well as with telnet. The following are the changes that I made. You can customize the {\texttt{\docbookhyphenatefilename{pam.\dbz{}conf}}} file as per your requirements, but be sure of those changes because in the worst case it will leave your system nearly impossible to boot. 
\begin{Verbatim}[]

#
#ident "@(#)pam.conf 1.14 99/09/16 SMI"
#
# Copyright (c) 1996-1999, Sun Microsystems, Inc.
# All Rights Reserved.
#
# PAM configuration
#
# Authentication management
#
login   auth required   /usr/lib/security/pam_winbind.so
login auth required  /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
login auth required  /usr/lib/security/$ISA/pam_dial_auth.so.1 try_first_pass
#
rlogin  auth sufficient /usr/lib/security/pam_winbind.so
rlogin  auth sufficient /usr/lib/security/$ISA/pam_rhosts_auth.so.1
rlogin auth required  /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
#
dtlogin auth sufficient /usr/lib/security/pam_winbind.so
dtlogin auth required  /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
#
rsh auth required /usr/lib/security/$ISA/pam_rhosts_auth.so.1
other   auth sufficient /usr/lib/security/pam_winbind.so
other auth required /usr/lib/security/$ISA/pam_unix.so.1 try_first_pass
#
# Account management
#
login   account sufficient      /usr/lib/security/pam_winbind.so
login account requisite /usr/lib/security/$ISA/pam_roles.so.1
login account required /usr/lib/security/$ISA/pam_unix.so.1
#
dtlogin account sufficient      /usr/lib/security/pam_winbind.so
dtlogin account requisite /usr/lib/security/$ISA/pam_roles.so.1
dtlogin account required /usr/lib/security/$ISA/pam_unix.so.1
#
other   account sufficient      /usr/lib/security/pam_winbind.so
other account requisite /usr/lib/security/$ISA/pam_roles.so.1
other account required /usr/lib/security/$ISA/pam_unix.so.1
#
# Session management
#
other session required /usr/lib/security/$ISA/pam_unix.so.1
#
# Password management
#
#other   password sufficient     /usr/lib/security/pam_winbind.so
other password required /usr/lib/security/$ISA/pam_unix.so.1
dtsession auth required /usr/lib/security/$ISA/pam_unix.so.1
#
# Support for Kerberos V5 authentication (uncomment to use Kerberos)
#
#rlogin auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
#login auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
#dtlogin auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
#other auth optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass
#dtlogin account optional /usr/lib/security/$ISA/pam_krb5.so.1
#other account optional /usr/lib/security/$ISA/pam_krb5.so.1
#other session optional /usr/lib/security/$ISA/pam_krb5.so.1
#other password optional /usr/lib/security/$ISA/pam_krb5.so.1 try_first_pass

\end{Verbatim}


\index{winbind.so} I also added a {\ttfamily\itshape{\docbookhyphenatedot{try\_first\_pass}}} line after the {\texttt{\docbookhyphenatefilename{winbind.\dbz{}so}}} line to get rid of annoying double prompts for passwords.

Now restart your Samba and try connecting through your application that you configured in the pam.conf.

% ------------------------   
% Section 
\section{Conclusion}
\label{id2594562}\hypertarget{id2594562}{}%

\index{Winbind} \index{NSS} \index{PAM} \index{RPC calls} \index{domain users} The Winbind system, through the use of the NSS, PAMs, and appropriate Microsoft RPC calls, have allowed us to provide seamless integration of Microsoft Windows NT domain users on a UNIX system. The result is a great reduction in the administrative cost of running a mixed UNIX and NT network.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2594613}\hypertarget{id2594613}{}%

Winbind has a number of limitations in its current released version that we hope to overcome in future releases:

\begin{itemize}
%--- Item
\item 
Winbind is currently only available for the Linux, Solaris, AIX, and IRIX operating systems, although ports to other operating systems are certainly possible. For such ports to be feasible, we require the C library of the target operating system to support the NSS and PAM systems. This is becoming more common as NSS and PAM gain support among UNIX vendors.


%--- Item
\item 
The mappings of Windows NT RIDs to UNIX IDs is not made algorithmically and depends on the order in which unmapped users or groups are seen by Winbind. It may be difficult to recover the mappings of RID to UNIX ID if the file containing this information is corrupted or destroyed.


%--- Item
\item 
Currently the Winbind PAM module does not take into account possible workstation and logon time restrictions that may be set for Windows NT users; this is instead up to the PDC to enforce.

\end{itemize}
\subsection{NSCD Problem Warning}
\label{id2594657}\hypertarget{id2594657}{}%

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Do not under any circumstances run {\bfseries{nscd}} on any system on which {\bfseries{winbindd}} is running.
\end{admonition}


If {\bfseries{nscd}} is running on the UNIX/Linux system, then even though NSSWITCH is correctly configured, it will not be possible to resolve domain users and groups for file and directory controls.
\subsection{Winbind Is Not Resolving Users and Groups}
\label{id2594694}\hypertarget{id2594694}{}%

{``}My {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is correctly configured. I have specified \smbconfoption{idmap uid} = 12000, and \smbconfoption{idmap gid} = 3000-3500 and {\bfseries{winbind}} is running. When I do the following, it all works fine.{''}


\begin{Verbatim}[]

root# wbinfo -u
MIDEARTH\maryo
MIDEARTH\jackb
MIDEARTH\ameds
...
MIDEARTH\root

root# wbinfo -g
MIDEARTH\Domain Users
MIDEARTH\Domain Admins
MIDEARTH\Domain Guests
...
MIDEARTH\Accounts

root# getent passwd
root:x:0:0:root:/root:/bin/bash
bin:x:1:1:bin:/bin:/bin/bash
...
maryo:x:15000:15003:Mary Orville:/home/MIDEARTH/maryo:/bin/false

\end{Verbatim}


{``}But the following command just fails:{''} 
\begin{Verbatim}[]

root# chown maryo a_file
chown: `maryo': invalid user

\end{Verbatim}
 {``}This is driving me nuts! What can be wrong?{''}

Same problem as the one above. Your system is likely running {\bfseries{nscd}}, the name service caching daemon. Shut it down, do not restart it! You will find your problem resolved. Alternately, fix the operation of nscd to resolve the problem.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Advanced Network Management 
% ------------------------------------------------------------- 	
\chapter{Advanced Network Management}
\label{AdvancedNetworkManagement}\hypertarget{AdvancedNetworkManagement}{}%

\index{access control} This section documents peripheral issues that are of great importance to network administrators who want to improve network resource access control, to automate the user environment, and to make their lives a little easier.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2463628}\hypertarget{id2463628}{}%

Often the difference between a working network environment and a well-appreciated one can best be measured by the {\em{little things}} that make everything work more harmoniously. A key part of every network environment solution is the ability to remotely manage MS Windows workstations, remotely access the Samba server, provide customized logon scripts, as well as other housekeeping activities that help to sustain more reliable network operations.

This chapter presents information on each of these areas. They are placed here, and not in other chapters, for ease of reference.

% ------------------------   
% Section 
\section{Remote Server Administration}
\label{id2579402}\hypertarget{id2579402}{}%

{``}How do I get User Manager and Server Manager?{''}

\index{User Manager} \index{Server Manager} \index{Event Viewer} Since I do not need to buy an NT4 server, how do I get the User Manager for Domains and the Server Manager?

\index{Nexus.exe} \index{Windows 9x/Me} Microsoft distributes a version of these tools called {\texttt{\docbookhyphenatefilename{Nexus.\dbz{}exe}}} for installation on Windows 9x/Me systems. The tools set includes:

\begin{itemize}
%--- Item
\item 
Server Manager


%--- Item
\item 
User Manager for Domains


%--- Item
\item 
Event Viewer

\end{itemize}

Download the archived file at the Microsoft Nexus\label{id2594178}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2594178} link.

\index{SRVTOOLS.EXE} \index{User Manager for Domains} \index{Server Manager} The Windows NT 4.0 version of the User Manager for Domains and Server Manager are available from Microsoft via ftp\label{id2594218}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2594218}.

% ------------------------   
% Section 
\section{Remote Desktop Management}
\label{id2594227}\hypertarget{id2594227}{}%

\index{remote desktop management} \index{network environment} There are a number of possible remote desktop management solutions that range from free through costly. Do not let that put you off. Sometimes the most costly solution is the most cost effective. In any case, you will need to draw your own conclusions as to which is the best tool in your network environment.
\subsection{Remote Management from NoMachine.Com}
\label{id2530009}\hypertarget{id2530009}{}%

\index{NoMachine.Com} The following information was posted to the Samba mailing list at Apr 3 23:33:50 GMT 2003. It is presented in slightly edited form (with author details omitted for privacy reasons). The entire answer is reproduced below with some comments removed.

{``}\index{remote desktop capabilities} I have a wonderful Linux/Samba server running as PDC for a network. Now I would like to add remote desktop capabilities so users outside could login to the system and get their desktop up from home or another country.{''}

{``}\index{Windows Terminal server} \index{BDC} \index{PDC} \index{remote login} Is there a way to accomplish this? Do I need a Windows Terminal server? Do I need to configure it so it is a member of the domain or a BDC or PDC? Are there any hacks for MS Windows XP to enable remote login even if the computer is in a domain?{''}

Answer provided: Check out the new offer of {``}NX{''} software from NoMachine\label{id2530088}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.nomachine.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2530088}.

\index{Remote X protocol} \index{VNC/RFB} \index{rdesktop/RDP} It implements an easy-to-use interface to the Remote X protocol as well as incorporating VNC/RFB and rdesktop/RDP into it, but at a speed performance much better than anything you may have ever seen.

\index{modem/ISDN} Remote X is not new at all, but what they did achieve successfully is a new way of compression and caching technologies that makes the thing fast enough to run even over slow modem/ISDN connections.

\index{KDE konqueror} \index{mouse-over} \index{rdesktop} \index{} I test drove their (public) Red Hat machine in Italy, over a loaded Internet connection, with enabled thumbnail previews in KDE konqueror, which popped up immediately on {``}mouse-over{''}. From inside that (remote X) session I started a rdesktop session on another, a Windows XP machine. To test the performance, I played Pinball. I am proud to announce that my score was 631,750 points at first try.

\index{NX} \index{TightVNC} \index{rdesktop} \index{Remote X} NX performs better on my local LAN than any of the other {``}pure{''} connection methods I use from time to time: TightVNC, rdesktop or Remote X. It is even faster than a direct crosslink connection between two nodes.

\index{Remote X} \index{KDE session} \index{copy'n'paste} I even got sound playing from the Remote X app to my local boxes, and had a working {``}copy'n'paste{''} from an NX window (running a KDE session in Italy) to my Mozilla mailing agent. These guys are certainly doing something right!

I recommend test driving NX to anybody with a only a passing interest in remote computing the NX\label{id2579194}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.nomachine.com/testdrive.php}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2579194} utility.

Just download the free-of-charge client software (available for Red Hat, SuSE, Debian and Windows) and be up and running within 5 minutes (they need to send you your account data, though, because you are assigned a real UNIX account on their testdrive.nomachine.com box).

They plan to get to the point were you can have NX application servers running as a cluster of nodes, and users simply start an NX session locally and can select applications to run transparently (apps may even run on another NX node, but pretend to be on the same as used for initial login, because it displays in the same window. You also can run it full-screen, and after a short time you forget that it is a remote session at all).

\index{GPL} Now the best thing for last: All the core compression and caching technologies are released under the GPL and available as source code to anybody who wants to build on it! These technologies are working, albeit started from the command line only (and very inconvenient to use in order to get a fully running remote X session up and running).

To answer your questions:

\begin{itemize}
%--- Item
\item 
You do not need to install a terminal server; XP has RDP support built in.


%--- Item
\item 
NX is much cheaper than Citrix ---  and comparable in performance, probably faster.


%--- Item
\item 
You do not need to hack XP ---  it just works.


%--- Item
\item 
You log into the XP box from remote transparently (and I think there is no need to change anything to get a connection, even if authentication is against a domain).


%--- Item
\item 
The NX core technologies are all Open Source and released under the GPL ---  you can now use a (very inconvenient) command line at no cost, but you can buy a comfortable (proprietary) NX GUI front end for money.


%--- Item
\item 
\index{OSS/Free Software} \index{LTSP} \index{KDE} \index{GNOME} \index{NoMachine} NoMachine is encouraging and offering help to OSS/Free Software implementations for such a front-end too, even if it means competition to them (they have written to this effect even to the LTSP, KDE, and GNOME developer mailing lists).

\end{itemize}
\subsection{Remote Management with ThinLinc}
\label{id2578818}\hypertarget{id2578818}{}%

Another alternative for remote access is {\em{ThinLinc}} from Cendio.

\index{ThinLinc} \index{terminal server} \index{Linux} \index{Solaris} \index{TightVNC} \index{SSH} \index{NFS} \index{PulseAudio} ThinLinc is a terminal server solution that is available for Linux and Solaris based on standard protocols such as SSH, TightVNC, NFS and PulseAudio.

\index{LAN} \index{thin client} ThinLinc an be used both in the LAN environment to implement a Thin Client strategy for an organization, and as secure remote access solution for people working from remote locations, even over smallband connections. ThinLinc is free to use for a single concurrent user.

\index{Citrix} \index{Windows Terminal Server} \index{Java} The product can also be used as a frontend to access Windows Terminal Server or Citrix farms, or even Windows XP machines, securing the connection via the ssh protocol. The client is available both for Linux (supporting all Linux distributions as well as numerous thin terminals) and for Windows. A Java-based Web client is also available.

ThinLinc may be evaluated by connecting to Cendio's demo system, see Cendio's\label{id2578948}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.cendio.com}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2578948} web site testdrive\label{id2568855}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.cendio.com/testdrive}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568855} center.

Cendio is a major contributor to several open source projects including TightVNC\label{id2568867}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.tightvnc.com}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568867}, PulseAudio\label{id2568875}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://pulseaudio.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568875} , unfsd, Python\label{id2568883}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.python.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568883} and rdesktop\label{id2568891}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.rdesktop.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568891}.

% ------------------------   
% Section 
\section{Network Logon Script Magic}
\label{id2568903}\hypertarget{id2568903}{}%

There are several opportunities for creating a custom network startup configuration environment.

\begin{itemize}
%--- Item
\item 
No Logon Script.


%--- Item
\item 
Simple universal Logon Script that applies to all users.


%--- Item
\item 
Use of a conditional Logon Script that applies per-user or per-group attributes.


%--- Item
\item 
Use of Samba's preexec and postexec functions on access to the NETLOGON share to create a custom logon script and then execute it.


%--- Item
\item 
User of a tool such as KixStart.

\end{itemize}

The Samba source code tree includes two logon script generation/execution tools. See {\texttt{\docbookhyphenatefilename{examples}}} directory {\texttt{\docbookhyphenatefilename{genlogon}}} and {\texttt{\docbookhyphenatefilename{ntlogon}}} subdirectories.

The following listings are from the genlogon directory.

\index{genlogon.pl} This is the {\texttt{\docbookhyphenatefilename{genlogon.\dbz{}pl}}} file: 
\begin{Verbatim}[]

	#!/usr/bin/perl
	#
	# genlogon.pl
	#
	# Perl script to generate user logon scripts on the fly, when users
	# connect from a Windows client. This script should be called from 
	# smb.conf with the %U, %G and %L parameters. I.e:
	#
	#       root preexec = genlogon.pl %U %G %L
	#
	# The script generated will perform
	# the following:
	#
	# 1. Log the user connection to /var/log/samba/netlogon.log
	# 2. Set the PC's time to the Linux server time (which is maintained
	#    daily to the National Institute of Standards Atomic clock on the
	#    internet.
	# 3. Connect the user's home drive to H: (H for Home).
	# 4. Connect common drives that everyone uses.
	# 5. Connect group-specific drives for certain user groups.
	# 6. Connect user-specific drives for certain users.
	# 7. Connect network printers.

	# Log client connection
	#($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
	($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time);
	open LOG, ">>/var/log/samba/netlogon.log";
	print LOG "$mon/$mday/$year $hour:$min:$sec";
	print LOG " - User $ARGV[0] logged into $ARGV[1]\n";
	close LOG;

	# Start generating logon script
	open LOGON, ">/shared/netlogon/$ARGV[0].bat";
	print LOGON "\@ECHO OFF\r\n";

	# Connect shares just use by Software Development group
	if ($ARGV[1] eq "SOFTDEV" || $ARGV[0] eq "softdev")
	{
		print LOGON "NET USE M: \\\\$ARGV[2]\\SOURCE\r\n";
	}

	# Connect shares just use by Technical Support staff
	if ($ARGV[1] eq "SUPPORT" || $ARGV[0] eq "support")
	{
		print LOGON "NET USE S: \\\\$ARGV[2]\\SUPPORT\r\n";
	}

	# Connect shares just used by Administration staff
	If ($ARGV[1] eq "ADMIN" || $ARGV[0] eq "admin")
	{
		print LOGON "NET USE L: \\\\$ARGV[2]\\ADMIN\r\n";
		print LOGON "NET USE K: \\\\$ARGV[2]\\MKTING\r\n";
	}

	# Now connect Printers. We handle just two or three users a little
	# differently, because they are the exceptions that have desktop
	# printers on LPT1: - all other user's go to the LaserJet on the
	# server.
	if ($ARGV[0] eq 'jim'
	    || $ARGV[0] eq 'yvonne')
	{
		print LOGON "NET USE LPT2: \\\\$ARGV[2]\\LJET3\r\n";
		print LOGON "NET USE LPT3: \\\\$ARGV[2]\\FAXQ\r\n";
	}
	else
	{
		print LOGON "NET USE LPT1: \\\\$ARGV[2]\\LJET3\r\n";
		print LOGON "NET USE LPT3: \\\\$ARGV[2]\\FAXQ\r\n";
	}

	# All done! Close the output file.
	close LOGON;

\end{Verbatim}


Those wishing to use a more elaborate or capable logon processing system should check out these sites:

\begin{itemize}
%--- Item
\item 
{\textless}\url{http://www.craigelachie.org/rhacer/ntlogon}{\textgreater}


%--- Item
\item 
{\textless}\url{http://www.kixtart.org}{\textgreater}

\end{itemize}
\subsection{Adding Printers without User Intervention}
\label{id2519765}\hypertarget{id2519765}{}%

\index{rundll32} Printers may be added automatically during logon script processing through the use of: 
\begin{Verbatim}[]

C:\> rundll32 printui.dll,PrintUIEntry /?

\end{Verbatim}
 See the documentation in the Microsoft Knowledge Base article 189105\label{id2570594}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.asp?scid=kb;en-us;189105}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2570594}.
\subsection{Limiting Logon Connections}
\label{id2570604}\hypertarget{id2570604}{}%

Sometimes it is necessary to limit the number of concurrent connections to a Samba shared resource. For example, a site may wish to permit only one network logon per user.

The Samba {\ttfamily\itshape{\docbookhyphenatedot{preexec script}}} parameter can be used to permit only one connection per user. Though this method is not foolproof and may have side effects, the following contributed method may inspire someone to provide a better solution.

This is not a perfect solution because Windows clients can drop idle connections with an auto-reconnect capability that could result in the appearance that a share is no longer in use, while actually it is. Even so, it demonstrates the principle of use of the {\ttfamily\itshape{\docbookhyphenatedot{preexec script}}} parameter.

The following share configuration demonstrates use of the script shown in \hyperlink{Tpees}{Example {\ref{Tpees}}}. 
\begin{Verbatim}[]

[myshare]
	...
	preexec script = /sbin/PermitSingleLogon.sh
	preexec close = Yes
	...

\end{Verbatim}


\begin{example}%
\hypertarget{Tpees}{}%
\captionswapskip{}{{\caption{Script to Enforce Single Resource Logon}\label{Tpees}}}
\captionswapskip{}
\begin{Verbatim}[]

#!/bin/bash

IFS="-"
RESULT=$(smbstatus -S -u $1 2> /dev/null | awk 'NF \
        > 6 {print $1}' | sort | uniq -d)

if [ "X${RESULT}" == X  ]; then
  exit 0
else
  exit 1
fi

\end{Verbatim}
\end{example}

\cleardoublepage 
% -------------------------------------------------------------
% Chapter System and Account Policies 
% ------------------------------------------------------------- 	
\chapter{System and Account Policies}
\label{PolicyMgmt}\hypertarget{PolicyMgmt}{}%

\index{validation} This chapter summarizes the current state of knowledge derived from personal practice and knowledge from Samba mailing list subscribers. Before reproduction of posted information, every effort has been made to validate the information given. Where additional information was uncovered through this validation, it is provided also.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2463504}\hypertarget{id2463504}{}%

\index{Group Policies} \index{users} \index{groups} When MS Windows NT 3.5 was introduced, the hot new topic was the ability to implement Group Policies for users and groups. Then along came MS Windows NT4 and a few sites started to adopt this capability. How do we know that? By the number of {``}boo-boos{''} (or mistakes) administrators made and then requested help to resolve.

\index{group policies} \index{Group Policy Objects|textit{see} {GPO} } \index{GPOs} \index{ADS} \index{group policy objects|textit{see} {GPOs} } By the time that MS Windows 2000 and Active Directory was released, administrators got the message: Group Policies are a good thing! They can help reduce administrative costs and actually make happier users. But adoption of the true potential of MS Windows 200x Active Directory and Group Policy Objects (GPOs) for users and machines were picked up on rather slowly. This was obvious from the Samba mailing list back in 2000 and 2001 when there were few postings regarding GPOs and how to replicate them in a Samba environment.

\index{exploit opportunities} Judging by the traffic volume since mid 2002, GPOs have become a standard part of the deployment in many sites. This chapter reviews techniques and methods that can be used to exploit opportunities for automation of control over user desktops and network client workstations.

% ------------------------   
% Section 
\section{Creating and Managing System Policies}
\label{id2468060}\hypertarget{id2468060}{}%

\index{NETLOGON} \index{domain controller} \index{registry} \index{affect users} Under MS Windows platforms, particularly those following the release of MS Windows NT4 and MS Windows 95, it is possible to create a type of file that would be placed in the NETLOGON share of a domain controller. As the client logs onto the network, this file is read and the contents initiate changes to the registry of the client machine. This file allows changes to be made to those parts of the registry that affect users, groups of users, or machines.

\index{Config.POL} \index{poledit.exe} \index{policy editor} For MS Windows 9x/Me, this file must be called {\texttt{\docbookhyphenatefilename{Config.\dbz{}POL}}} and may be generated using a tool called {\texttt{\docbookhyphenatefilename{poledit.\dbz{}exe}}}, better known as the Policy Editor. The policy editor was provided on the Windows 98 installation CD-ROM, but disappeared again with the introduction of MS Windows Me. From comments of MS Windows network administrators, it would appear that this tool became a part of the MS Windows Me Resource Kit.

\index{System Policy Editor} MS Windows NT4 server products include the {\em{System Policy Editor}} under {\sffamily \bfseries Start -\textgreater{} Programs -\textgreater{} Administrative Tools}. For MS Windows NT4 and later clients, this file must be called {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}}.

\index{MMC} New with the introduction of MS Windows 2000 was the Microsoft Management Console or MMC. This tool is the new wave in the ever-changing landscape of Microsoft methods for management of network access and security. Every new Microsoft product or technology seems to make the old rules obsolete and introduces newer and more complex tools and methods. To Microsoft's credit, the MMC does appear to be a step forward, but improved functionality comes at a great price.

\index{network policies} \index{system policies} \index{Profiles} \index{Policies} Before embarking on the configuration of network and system policies, it is highly advisable to read the documentation available from Microsoft's Web site regarding Implementing Profiles and Policies in Windows NT 4.0\label{id2568366}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.microsoft.com/ntserver/techresources/management/prof_policies.asp}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2568366}. There are a large number of documents in addition to this old one that should also be read and understood. Try searching on the Microsoft Web site for {``}Group Policies{''}.

What follows is a brief discussion with some helpful notes. The information provided here is incomplete ---  you are warned.
\subsection{Windows 9x/ME Policies}
\label{id2568388}\hypertarget{id2568388}{}%

\index{Group Policy Editor} \index{tools\textbackslash reskit\textbackslash netadmin\textbackslash poledit} You need the Windows 98 Group Policy Editor to set up Group Profiles under Windows 9x/Me. It can be found on the original full-product Windows 98 installation CD-ROM under {\texttt{\docbookhyphenatefilename{tools\docbooktolatexgobble\string\\reskit\docbooktolatexgobble\string\\netadmin\docbooktolatexgobble\string\\poledit}}}. Install this using the Add/Remove Programs facility, and then click on {\sffamily \bfseries Have Disk}.

\index{NTConfig.POL} \index{Config.POL} Use the Group Policy Editor to create a policy file that specifies the location of user profiles and/or {\texttt{\docbookhyphenatefilename{My Documents}}}, and so on. Then save these settings in a file called {\texttt{\docbookhyphenatefilename{Config.\dbz{}POL}}} that needs to be placed in the root of the \smbconfsection{[NETLOGON]} share. If Windows 98 is configured to log onto the Samba domain, it will automatically read this file and update the Windows 9x/Me registry of the machine as it logs on.

Further details are covered in the Windows 98 Resource Kit documentation.

\index{registry} If you do not take the correct steps, then every so often Windows 9x/Me will check the integrity of the registry and restore its settings from the backup copy of the registry it stores on each Windows 9x/Me machine. So, you will occasionally notice things changing back to the original settings.

\index{grouppol.inf} \index{Group Policy} Install the Group Policy handler for Windows 9x/Me to pick up Group Policies. Look on the Windows 98 CD-ROM in {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\tools\docbooktolatexgobble\string\\reskit\docbooktolatexgobble\string\\netadmin\docbooktolatexgobble\string\\poledit}}}. Install Group Policies on a Windows 9x/Me client by double-clicking on {\texttt{\docbookhyphenatefilename{grouppol.\dbz{}inf}}}. Log off and on again a couple of times and see if Windows 98 picks up Group Policies. Unfortunately, this needs to be done on every Windows 9x/Me machine that uses Group Policies.
\subsection{Windows NT4-Style Policy Files}
\label{id2568524}\hypertarget{id2568524}{}%

\index{ntconfig.pol} \index{poledit.exe} \index{Policy Editor} \index{domain policies} To create or edit {\texttt{\docbookhyphenatefilename{ntconfig.\dbz{}pol}}}, you must use the NT Server Policy Editor, {\bfseries{poledit.exe}}, which is included with NT4 Server but not with NT workstation. There is a Policy Editor on an NT4 Workstation but it is not suitable for creating domain policies. Furthermore, although the Windows 95 Policy Editor can be installed on an NT4 workstation/server, it will not work with NT clients. However, the files from the NT Server will run happily enough on an NT4 workstation.

\index{poledit.exe} \index{common.adm} \index{winnt.adm} \index{c:\textbackslash winnt\textbackslash inf} You need {\texttt{\docbookhyphenatefilename{poledit.\dbz{}exe}}}, {\texttt{\docbookhyphenatefilename{common.\dbz{}adm}}}, and {\texttt{\docbookhyphenatefilename{winnt.\dbz{}adm}}}. It is convenient to put the two {\texttt{\docbookhyphenatefilename{*.\dbz{}adm}}} files in the {\texttt{\docbookhyphenatefilename{c:\docbooktolatexgobble\string\\winnt\docbooktolatexgobble\string\\inf}}} directory, which is where the binary will look for them unless told otherwise. This directory is normally {``}hidden.{''}

\index{Policy Editor} \index{Nt4sp6ai.exe} \index{poledit.exe} \index{Zero Administration Kit} The Windows NT Policy Editor is also included with the Service Pack 3 (and later) for Windows NT 4.0. Extract the files using {\bfseries{servicepackname /x}} ---  that's {\bfseries{Nt4sp6ai.exe /x}} for Service Pack 6a. The Policy Editor, {\bfseries{poledit.exe}}, and the associated template files (*.adm) should be extracted as well. It is also possible to download the policy template files for Office97 and get a copy of the Policy Editor. Another possible location is with the Zero Administration Kit available for download from Microsoft.
\subsubsection{Registry Spoiling}
\label{id2574559}\hypertarget{id2574559}{}%

\index{NTConfig.POL} \index{HKEY\_LOCAL\_MACHINE} With NT4-style registry-based policy changes, a large number of settings are not automatically reversed as the user logs off. The settings that were in the {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} file were applied to the client machine registry and apply to the hive key HKEY\_LOCAL\_MACHINE are permanent until explicitly reversed. This is known as tattooing. It can have serious consequences downstream, and the administrator must be extremely careful not to lock out the ability to manage the machine at a later date.
\subsection{MS Windows 200x/XP Professional Policies}
\label{id2574599}\hypertarget{id2574599}{}%

\index{registry} Windows NT4 system policies allow the setting of registry parameters specific to users, groups, and computers (client workstations) that are members of the NT4-style domain. Such policy files will work with MS Windows 200x/XP clients also.

New to MS Windows 2000, Microsoft recently introduced a style of Group Policy that confers a superset of capabilities compared with NT4-style policies. Obviously, the tool used to create them is different, and the mechanism for implementing them is much improved.

\index{GPOs} \index{Administrative Templates} The older NT4-style registry-based policies are known as {\em{Administrative Templates}} in MS Windows 2000/XP GPOs. The latter includes the ability to set various security configurations, enforce Internet Explorer browser settings, change and redirect aspects of the users desktop (including the location of {\texttt{\docbookhyphenatefilename{My Documents}}} files, as well as intrinsics of where menu items will appear in the Start menu). An additional new feature is the ability to make available particular software Windows applications to particular users and/or groups.

\index{NTConfig.POL} \index{NETLOGON} \index{local registry values} Remember, NT4 policy files are named {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} and are stored in the root of the NETLOGON share on the domain controllers. A Windows NT4 user enters a username and password and selects the domain name to which the logon will attempt to take place. During the logon process, the client machine reads the {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} file from the NETLOGON share on the authenticating server and modifies the local registry values according to the settings in this file.

\index{SYSVOL} \index{NETLOGON} \index{replicated} \index{ADS} \index{domain controllers} \index{Group Policy Container|textit{see} {GPC} } \index{Group Policy Template|textit{see} {GPT} } \index{replicated SYSVOL} Windows 200x GPOs are feature-rich. They are not stored in the NETLOGON share, but rather part of a Windows 200x policy file is stored in the Active Directory itself and the other part is stored in a shared (and replicated) volume called the SYSVOL folder. This folder is present on all Active Directory domain controllers. The part that is stored in the Active Directory itself is called the Group Policy Container (GPC), and the part that is stored in the replicated share called SYSVOL is known as the Group Policy Template (GPT).

\index{GPOs} With NT4 clients, the policy file is read and executed only as each user logs onto the network. MS Windows 200x policies are much more complex ---  GPOs are processed and applied at client machine startup (machine specific part), and when the user logs onto the network, the user-specific part is applied. In MS Windows 200x-style policy management, each machine and/or user may be subject to any number of concurrently applicable (and applied) policy sets (GPOs). Active Directory allows the administrator to also set filters over the policy settings. No such equivalent capability exists with NT4-style policy files.
\subsubsection{Administration of Windows 200x/XP Policies}
\label{id2574803}\hypertarget{id2574803}{}%

\index{GPOs} \index{System Policy Editor} \index{poledit.exe} \index{MMC snap-in} \index{Poledit} Instead of using the tool called the System Policy Editor, commonly called Poledit (from the executable name {\bfseries{poledit.exe}}), GPOs are created and managed using a Microsoft Management Console (MMC) snap-in as follows:
\begin{enumerate}

\item{Go to the Windows 200x/XP menu {\sffamily \bfseries Start-\textgreater{}Programs-\textgreater{}Administrative Tools} and select the MMC snap-in called {\sffamily \bfseries Active Directory Users and Computers}}

\item{\index{organizational unit|textit{see} {OU} } Select the domain or organizational unit (OU) that you wish to manage, then right-click to open the context menu for that object, and select the {\sffamily \bfseries Properties}.}

\item{Left-click on the {\sffamily \bfseries Group Policy} tab, then left-click on the New tab. Type a name for the new policy you will create.}

\item{Left-click on the {\sffamily \bfseries Edit} tab to commence the steps needed to create the GPO.}
\end{enumerate}

All policy configuration options are controlled through the use of policy administrative templates. These files have an .adm extension, both in NT4 as well as in Windows 200x/XP. Beware, however, the .adm files are not interchangeable across NT4 and Windows 200x. The latter introduces many new features as well as extended definition capabilities. It is well beyond the scope of this documentation to explain how to program .adm files; for that, refer to the Microsoft Windows Resource Kit for your particular version of MS Windows.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{gpolmig.exe} \index{NTConfig.POL} \index{resource kit} The MS Windows 2000 Resource Kit contains a tool called {\bfseries{gpolmig.exe}}. This tool can be used to migrate an NT4 {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} file into a Windows 200x style GPO. Be VERY careful how you use this powerful tool. Please refer to the resource kit manuals for specific usage information.
\end{admonition}

\subsubsection{Custom System Policy Templates}
\label{id2571889}\hypertarget{id2571889}{}%

Over the past year, there has been a bit of talk regarding the creation of customized templates for the Windows Sytem Policy Editor. A recent announcement on the Samba mailing list is worthy of mention.

Mike Petersen has announced the availability of a template file he has created. This custom System Policy Editor Template will allow you to successfully control Microsoft Windows workstations from an SMB server, such as Samba. This template has been tested on a few networks, although if you find any problems with any of these policies, or have any ideas for additional policies, let me know at mailto:mgpeter@pcc-services.com. This Template includes many policies for Windows XP to allow it to behave better in a professional environment.

For further information please see the Petersen\label{id2571918}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.pcc-services.com/custom_poledit.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2571918} Computer Consulting web site. There is a download link for the template file.

% ------------------------   
% Section 
\section{Managing Account/User Policies}
\label{id2571931}\hypertarget{id2571931}{}%

\index{Policies} \index{policy file} \index{registry settings} Policies can define a specific user's settings or the settings for a group of users. The resulting policy file contains the registry settings for all users, groups, and computers that will be using the policy file. Separate policy files for each user, group, or computer are not necessary.

\index{NTConfig.POL} If you create a policy that will be automatically downloaded from validating domain controllers, you should name the file {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}}. As system administrator, you have the option of renaming the policy file and, by modifying the Windows NT-based workstation, directing the computer to update the policy from a manual path. You can do this by either manually changing the registry or by using the System Policy Editor. This can even be a local path such that each machine has its own policy file, but if a change is necessary to all machines, it must be made individually to each workstation.

\index{NTConfig.POL} \index{NETLOGON} When a Windows NT4/200x/XP machine logs onto the network, the client looks in the NETLOGON share on the authenticating domain controller for the presence of the {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} file. If one exists, it is downloaded, parsed, and then applied to the user's part of the registry.

\index{GPOs} \index{ADS} \index{NTConfig.POL} \index{NT4 style policy updates} MS Windows 200x/XP clients that log onto an MS Windows Active Directory security domain may additionally acquire policy settings through GPOs that are defined and stored in Active Directory itself. The key benefit of using AD GPOs is that they impose no registry {\em{spoiling}} effect. This has considerable advantage compared with the use of {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} (NT4) style policy updates.

\index{account restrictions} \index{Common restrictions} In addition to user access controls that may be imposed or applied via system and/or group policies in a manner that works in conjunction with user profiles, the user management environment under MS Windows NT4/200x/XP allows per-domain as well as per-user account restrictions to be applied. Common restrictions that are frequently used include:

\index{Account Controls} 
\begin{itemize}
%--- Item
\item 
Logon hours


%--- Item
\item 
Password aging


%--- Item
\item 
Permitted logon from certain machines only


%--- Item
\item 
Account type (local or global)


%--- Item
\item 
User rights

\end{itemize}


\index{Domain User Manager} \index{NTConfig.POL} Samba-3.0.20 does not yet implement all account controls that are common to MS Windows NT4/200x/XP. While it is possible to set many controls using the Domain User Manager for MS Windows NT4, only password expiry is functional today. Most of the remaining controls at this time have only stub routines that may eventually be completed to provide actual control. Do not be misled by the fact that a parameter can be set using the NT4 Domain User Manager or in the {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}}.

% ------------------------   
% Section 
\section{Management Tools}
\label{id2572159}\hypertarget{id2572159}{}%

Anyone who wishes to create or manage Group Policies will need to be familiar with a number of tools. The following sections describe a few key tools that will help you to create a low-maintenance user environment.
\subsection{Samba Editreg Toolset}
\label{id2572172}\hypertarget{id2572172}{}%

\index{editreg} \index{NTUser.DAT} \index{NTConfig.POL} A new tool called {\bfseries{editreg}} is under development. This tool can be used to edit registry files (called {\texttt{\docbookhyphenatefilename{NTUser.\dbz{}DAT}}}) that are stored in user and group profiles. {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} files have the same structure as the {\texttt{\docbookhyphenatefilename{NTUser.\dbz{}DAT}}} file and can be edited using this tool. {\bfseries{editreg}} is being built with the intent to enable {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} files to be saved in text format and to permit the building of new {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} files with extended capabilities. It is proving difficult to realize this capability, so do not be surprised if this feature does not materialize. Formal capabilities will be announced at the time that this tool is released for production use.
\subsection{Windows NT4/200x}
\label{id2573028}\hypertarget{id2573028}{}%

\index{regedt32.exe} \index{Group Policy Editor} \index{MMC} The tools that may be used to configure these types of controls from the MS Windows environment are the NT4 User Manager for Domains, the NT4 System and Group Policy Editor, and the Registry Editor (regedt32.exe). Under MS Windows 200x/XP, this is done using the MMC with appropriate {``}snap-ins,{''} the registry editor, and potentially also the NT4 System and Group Policy Editor.
\subsection{Samba PDC}
\label{id2573070}\hypertarget{id2573070}{}%

\index{smbpasswd} \index{pdbedit} \index{NET} \index{rpcclient} With a Samba domain controller, the new tools for managing user account and policy information include: {\bfseries{smbpasswd}}, {\bfseries{pdbedit}}, {\bfseries{net}}, and {\bfseries{rpcclient}}. The administrator should read the man pages for these tools and become familiar with their use.

% ------------------------   
% Section 
\section{System Startup and Logon Processing Overview}
\label{id2573138}\hypertarget{id2573138}{}%

The following attempts to document the order of processing the system and user policies following a system reboot and as part of the user logon:

\begin{enumerate}
%--- Item
\item 
\index{Remote Procedure Call System Service|textit{see} {RPCSS} } \index{multiple universal naming convention provider|textit{see} {MUP} } Network starts, then Remote Procedure Call System Service (RPCSS) and multiple universal naming convention provider (MUP) start.


%--- Item
\item 
\index{ADS} \index{GPOs} Where Active Directory is involved, an ordered list of GPOs is downloaded and applied. The list may include GPOs that: 
\begin{itemize}
%--- Item
\item 
Apply to the location of machines in a directory.


%--- Item
\item 
Apply only when settings have changed.


%--- Item
\item 
Depend on configuration of the scope of applicability: local, site, domain, organizational unit, and so on.

\end{itemize}
 No desktop user interface is presented until the above have been processed.


%--- Item
\item 
Execution of startup scripts (hidden and synchronous by default).


%--- Item
\item 
A keyboard action to effect start of logon (Ctrl-Alt-Del).


%--- Item
\item 
User credentials are validated, user profile is loaded (depends on policy settings).


%--- Item
\item 
An ordered list of user GPOs is obtained. The list contents depends on what is configured in respect of: 
\begin{itemize}
%--- Item
\item 
Is the user a domain member, thus subject to particular policies?


%--- Item
\item 
Loopback enablement, and the state of the loopback policy (merge or replace).


%--- Item
\item 
Location of the Active Directory itself.


%--- Item
\item 
Has the list of GPOs changed? No processing is needed if not changed.

\end{itemize}



%--- Item
\item 
User policies are applied from Active Directory. Note: There are several types.


%--- Item
\item 
Logon scripts are run. New to Windows 200x and Active Directory, logon scripts may be obtained based on GPOs (hidden and executed synchronously). NT4-style logon scripts are then run in a normal window.


%--- Item
\item 
The user interface as determined from the GPOs is presented. Note: In a Samba domain (like an NT4 domain), machine (system) policies are applied at startup; user policies are applied at logon.

\end{enumerate}

% ------------------------   
% Section 
\section{Common Errors}
\label{id2573304}\hypertarget{id2573304}{}%

Policy-related problems can be quite difficult to diagnose and even more difficult to rectify. The following collection demonstrates only basic issues.
\subsection{Policy Does Not Work}
\label{id2573316}\hypertarget{id2573316}{}%

{``}We have created the {\texttt{\docbookhyphenatefilename{Config.\dbz{}POL}}} file and put it in the {\em{NETLOGON}} share. It has made no difference to our Win XP Pro machines, they just do not see it. It worked fine with Win 98 but does not work any longer since we upgraded to Win XP Pro. Any hints?{''}

Policy files are not portable between Windows 9x/Me and MS Windows NT4/200x/XP-based platforms. You need to use the NT4 Group Policy Editor to create a file called {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} so it is in the correct format for your MS Windows XP Pro clients.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Desktop Profile Management 
% ------------------------------------------------------------- 	
\chapter{Desktop Profile Management}
\label{ProfileMgmt}\hypertarget{ProfileMgmt}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2531302}\hypertarget{id2531302}{}%

\index{roaming profiles} Roaming profiles are feared by some, hated by a few, loved by many, and a godsend for some administrators.

\index{manage roaming profiles} Roaming profiles allow an administrator to make available a consistent user desktop as the user moves from one machine to another. This chapter provides much information regarding how to configure and manage roaming profiles.

\index{local profiles} While roaming profiles might sound like nirvana to some, they are a real and tangible problem to others. In particular, users of mobile computing tools, where often there may not be a sustained network connection, are often better served by purely local profiles. This chapter provides information to help the Samba administrator deal with those situations.

% ------------------------   
% Section 
\section{Roaming Profiles}
\label{id2574381}\hypertarget{id2574381}{}%

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Roaming profiles support is different for Windows 9x/Me and Windows NT4/200x.
\end{admonition}


Before discussing how to configure roaming profiles, it is useful to see how Windows 9x/Me and Windows NT4/200x clients implement these features.

\index{NetUserGetInfo} Windows 9x/Me clients send a NetUserGetInfo request to the server to get the user's profiles location. However, the response does not have room for a separate profiles location field, only the user's home share. This means that Windows 9x/Me profiles are restricted to being stored in the user's home directory.

\index{NetSAMLogon} \index{RPC} Windows NT4/200x clients send a NetSAMLogon RPC request, which contains many fields including a separate field for the location of the user's profiles.
\subsection{Samba Configuration for Profile Handling}
\label{id2574438}\hypertarget{id2574438}{}%

This section documents how to configure Samba for MS Windows client profile support.
\subsubsection{NT4/200x User Profiles}
\label{id2574449}\hypertarget{id2574449}{}%

For example, to support Windows NT4/200x clients, set the following in the [global] section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	logon path =  \\profileserver\profileshare\profilepath\%U\moreprofilepath
\end{lstlisting}

This is typically implemented like: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	logon path = \\%L\Profiles\%U
\end{lstlisting}
 where {``}\%L{''} translates to the name of the Samba server and {``}\%U{''} translates to the username.

The default for this option is {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\\%N\docbooktolatexgobble\string\\\%U\docbooktolatexgobble\string\\profile}}}, namely, {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\sambaserver\docbooktolatexgobble\string\\username\docbooktolatexgobble\string\\profile}}}. The {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\\%N\docbooktolatexgobble\string\\\%U}}} service is created automatically by the [homes] service. If you are using a Samba server for the profiles, you must make the share that is specified in the logon path browseable. Please refer to the man page for {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} regarding the different semantics of {``}\%L{''} and {``}\%N{''}, as well as {``}\%U{''} and {``}\%u{''}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{logons} \index{disconnect a connection} MS Windows NT/200x clients at times do not disconnect a connection to a server between logons. It is recommended to not use the \smbconfsection{homes} metaservice name as part of the profile share path.
\end{admonition}

\subsubsection{Windows 9x/Me User Profiles}
\label{id2573415}\hypertarget{id2573415}{}%

\index{net use /home} \index{logon home} To support Windows 9x/Me clients, you must use the \smbconfoption{logon home} parameter. Samba has been fixed so {\ttfamily\bfseries{\docbookhyphenatedot{net use /\dbz{}home}}} now works as well and it, too, relies on the {\ttfamily\itshape{\docbookhyphenatedot{logon home}}} parameter.

\index{logon home} \index{\textbackslash \textbackslash \%L\textbackslash \%U\textbackslash .profiles} \index{.profiles} By using the {\ttfamily\itshape{\docbookhyphenatedot{logon home}}} parameter, you are restricted to putting Windows 9x/Me profiles in the user's home directory. But wait! There is a trick you can use. If you set the following in the \smbconfsection{[global]} section of your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	logon home = \\%L\%U\.profiles
\end{lstlisting}
 then your Windows 9x/Me clients will dutifully put their clients in a subdirectory of your home directory called {\texttt{\docbookhyphenatefilename{.\dbz{}profiles}}} (making them hidden).

\index{net use /home} Not only that, but {\ttfamily\bfseries{\docbookhyphenatedot{net use /\dbz{}home}}} will also work because of a feature in Windows 9x/Me. It removes any directory stuff off the end of the home directory area and only uses the server and share portion. That is, it looks like you specified {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\\docbooktolatexgobble\string\\\%L\docbooktolatexgobble\string\\\%U}}} for \smbconfoption{logon home}.
\subsubsection{Mixed Windows Windows 9x/Me and NT4/200x User Profiles}
\label{id2590047}\hypertarget{id2590047}{}%

You can support profiles for Windows 9x and Windows NT clients by setting both the \smbconfoption{logon home} and \smbconfoption{logon path} parameters. For example,


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	logon home = \\%L\%U\.profiles
 	logon path = \\%L\profiles\%U
\end{lstlisting}


\index{mixed profile} Windows 9x/Me and NT4 and later profiles should not be stored in the same location because Windows NT4 and later will experience problems with mixed profile environments.
\subsubsection{Disabling Roaming Profile Support}
\label{id2590100}\hypertarget{id2590100}{}%

\index{disable roaming profiles} The question often asked is, {``}How may I enforce use of local profiles?{''} or {``}How do I disable roaming profiles?{''}

\index{roaming profiles} There are three ways of doing this:
\index{windows registry settings!roaming profiles}
\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{In {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}}]\null{}
Affect the following settings and ALL clients will be forced to use a local profile: \smbconfoption{logon home} =   and \smbconfoption{logon path} =  

The arguments to these parameters must be left blank. It is necessary to include the {\texttt{\docbookhyphenatedot{=}}} sign to specifically assign the empty value.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{MS Windows Registry:}]\null{}
\index{MMC} \index{local profile} Use the Microsoft Management Console (MMC) {\bfseries{gpedit.msc}} to instruct your MS Windows XP machine to use only a local profile. This, of course, modifies registry settings. The full path to the option is: \null{}
\begin{Verbatim}[]

Local Computer Policy\
	Computer Configuration\
		Administrative Templates\
			System\
				User Profiles\

Disable: Only Allow Local User Profiles 
Disable: Prevent Roaming Profile Change from Propagating to the Server

\end{Verbatim}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{Change of Profile Type:}]\null{}
From the start menu right-click on the {\sffamily \bfseries My Computer} icon, select {\sffamily \bfseries Properties}, click on the {\sffamily \bfseries User Profiles} tab, select the profile you wish to change from {\sffamily \bfseries Roaming} type to {\sffamily \bfseries Local}, and click on {\sffamily \bfseries Change Type}.
\end{description}

Consult the MS Windows registry guide for your particular MS Windows version for more information about which registry keys to change to enforce use of only local user profiles.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{Windows Resource Kit} The specifics of how to convert a local profile to a roaming profile, or a roaming profile to a local one, vary according to the version of MS Windows you are running. Consult the Microsoft MS Windows Resource Kit for your version of Windows for specific information.
\end{admonition}

\subsection{Windows Client Profile Configuration Information}
\label{id2594864}\hypertarget{id2594864}{}%
\subsubsection{Windows 9x/Me Profile Setup}
\label{id2594870}\hypertarget{id2594870}{}%

When a user first logs in on Windows 9x, the file user.DAT is created, as are folders {\texttt{\docbookhyphenatefilename{Start Menu}}}, {\texttt{\docbookhyphenatefilename{Desktop}}}, {\texttt{\docbookhyphenatefilename{Programs}}}, and {\texttt{\docbookhyphenatefilename{Nethood}}}. These directories and their contents will be merged with the local versions stored in {\texttt{\docbookhyphenatefilename{c:\docbooktolatexgobble\string\\windows\docbooktolatexgobble\string\\profiles\docbooktolatexgobble\string\\username}}} on subsequent logins, taking the most recent from each. You will need to use the \smbconfsection{[global]} options \smbconfoption{preserve case} = yes, \smbconfoption{short preserve case} = yes, and \smbconfoption{case sensitive} = no in order to maintain capital letters in shortcuts in any of the profile folders.

\index{user.DAT} \index{user.MAN} The {\texttt{\docbookhyphenatefilename{user.\dbz{}DAT}}} file contains all the user's preferences. If you wish to enforce a set of preferences, rename their {\texttt{\docbookhyphenatefilename{user.\dbz{}DAT}}} file to {\texttt{\docbookhyphenatefilename{user.\dbz{}MAN}}}, and deny them write access to this file.

\begin{enumerate}
%--- Item
\item 
On the Windows 9x/Me machine, go to {\sffamily \bfseries Control Panel} -\textgreater{} {\sffamily \bfseries Passwords} and select the {\sffamily \bfseries User Profiles} tab. Select the required level of roaming preferences. Press {\sffamily \bfseries OK}, but do not allow the computer to reboot.


%--- Item
\item 
On the Windows 9x/Me machine, go to {\sffamily \bfseries Control Panel} -\textgreater{} {\sffamily \bfseries Network} -\textgreater{} {\sffamily \bfseries Client for Microsoft Networks} -\textgreater{} {\sffamily \bfseries Preferences}. Select {\sffamily \bfseries Log on to NT Domain}. Then, ensure that the Primary Logon is {\sffamily \bfseries Client for Microsoft Networks}. Press {\sffamily \bfseries OK}, and this time allow the computer to reboot.

\end{enumerate}

\index{Primary Logon} \index{Client for Novell Networks} \index{Novell} \index{Windows Logon} Under Windows 9x/Me, profiles are downloaded from the Primary Logon. If you have the Primary Logon as {``}Client for Novell Networks{''}, then the profiles and logon script will be downloaded from your Novell server. If you have the Primary Logon as {``}Windows Logon{''}, then the profiles will be loaded from the local machine ---  a bit against the concept of roaming profiles, it would seem!

\index{domain logon server} You will now find that the Microsoft Networks Login box contains {\texttt{\docbookhyphenatedot{[user, password, domain]}}} instead of just {\texttt{\docbookhyphenatedot{[user, password]}}}. Type in the Samba server's domain name (or any other domain known to exist, but bear in mind that the user will be authenticated against this domain and profiles downloaded from it if that domain logon server supports it), user name and user's password.

Once the user has been successfully validated, the Windows 9x/Me machine informs you that {\texttt{\docbookhyphenatedot{The user has not logged on before}}} and asks {\texttt{\docbookhyphenatedot{Do you wish to save the user's preferences?}}} Select {\sffamily \bfseries Yes}.

Once the Windows 9x/Me client comes up with the desktop, you should be able to examine the contents of the directory specified in the \smbconfoption{logon path} on the Samba server and verify that the {\texttt{\docbookhyphenatefilename{Desktop}}}, {\texttt{\docbookhyphenatefilename{Start Menu}}}, {\texttt{\docbookhyphenatefilename{Programs}}}, and {\texttt{\docbookhyphenatefilename{Nethood}}} folders have been created.

\index{cached locally} \index{shortcuts} \index{profile directory} These folders will be cached locally on the client and updated when the user logs off (if you haven't made them read-only by then). You will find that if the user creates further folders or shortcuts, the client will merge the profile contents downloaded with the contents of the profile directory already on the local client, taking the newest folders and shortcut from each set.

\index{local profile} \index{remote profile} \index{ownership rights} \index{profile directory} If you have made the folders/files read-only on the Samba server, then you will get errors from the Windows 9x/Me machine on logon and logout as it attempts to merge the local and remote profile. Basically, if you have any errors reported by the Windows 9x/Me machine, check the UNIX file permissions and ownership rights on the profile directory contents, on the Samba server.

\index{windows registry settings} \index{profile path} \index{user profiles} \index{desktop cache} \index{windows registry settings!profile path} If you have problems creating user profiles, you can reset the user's local desktop cache, as shown below. When this user next logs in, the user will be told that he/she is logging in {``}for the first time{''}.

\begin{enumerate}
%--- Item
\item 
Instead of logging in under the [user, password, domain] dialog, press {\sffamily \bfseries escape}.


%--- Item
\item 
Run the {\bfseries{regedit.exe}} program, and look in:

{\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}LOCAL\_\dbz{}MACHINE\docbooktolatexgobble\string\\Windows\docbooktolatexgobble\string\\CurrentVersion\docbooktolatexgobble\string\\ProfileList}}}

You will find an entry for each user of ProfilePath. Note the contents of this key (likely to be {\texttt{\docbookhyphenatefilename{c:\docbooktolatexgobble\string\\windows\docbooktolatexgobble\string\\profiles\docbooktolatexgobble\string\\username}}}), then delete the key {\ttfamily\itshape{\docbookhyphenatedot{ProfilePath}}} for the required user.


%--- Item
\item 
Exit the registry editor.


%--- Item
\item 
Search for the user's .PWL password-caching file in the {\texttt{\docbookhyphenatefilename{c:\docbooktolatexgobble\string\\windows}}} directory, and delete it.


%--- Item
\item 
Log off the Windows 9x/Me client.


%--- Item
\item 
Check the contents of the profile path (see \smbconfoption{logon path} described above) and delete the {\texttt{\docbookhyphenatefilename{user.\dbz{}DAT}}} or {\texttt{\docbookhyphenatefilename{user.\dbz{}MAN}}} file for the user, making a backup if required.

\end{enumerate}

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{ProfilePath} Before deleting the contents of the directory listed in the {\ttfamily\itshape{\docbookhyphenatedot{ProfilePath}}} (this is likely to be {\texttt{\docbookhyphenatefilename{c:\docbooktolatexgobble\string\\windows\docbooktolatexgobble\string\\profiles\docbooktolatexgobble\string\\username)\dbz{}}}}, ask whether the owner has any important files stored on his or her desktop or start menu. Delete the contents of the directory {\ttfamily\itshape{\docbookhyphenatedot{ProfilePath}}} (making a backup if any of the files are needed).

This will have the effect of removing the local (read-only hidden system file) {\texttt{\docbookhyphenatefilename{user.\dbz{}DAT}}} in their profile directory, as well as the local {``}desktop,{''} {``}nethood,{''} {``}start menu,{''} and {``}programs{''} folders.
\end{admonition}


\index{log level} \index{packet sniffer} \index{ethereal} \index{netmon.exe} If all else fails, increase Samba's debug log levels to between 3 and 10, and/or run a packet sniffer program such as ethereal or {\bfseries{netmon.exe}}, and look for error messages.

\index{roaming profiles} \index{packet trace} If you have access to an Windows NT4/200x server, then first set up roaming profiles and/or netlogons on the Windows NT4/200x server. Make a packet trace, or examine the example packet traces provided with Windows NT4/200x server, and see what the differences are with the equivalent Samba trace.
\subsubsection{Windows NT4 Workstation}
\label{id2612606}\hypertarget{id2612606}{}%

When a user first logs in to a Windows NT workstation, the profile NTuser.DAT is created. The profile location can be now specified through the \smbconfoption{logon path} parameter.

There is a parameter that is now available for use with NT Profiles: \smbconfoption{logon drive}. This should be set to {\texttt{\docbookhyphenatefilename{H:}}} or any other drive, and should be used in conjunction with the new \smbconfoption{logon home} parameter.

\index{.PDS extension} \index{profile path} The entry for the NT4 profile is a directory, not a file. The NT help on profiles mentions that a directory is also created with a .PDS extension. The user, while logging in, must have write permission to create the full profile path (and the folder with the .PDS extension for those situations where it might be created).

\index{NTuser.DAT} In the profile directory, Windows NT4 creates more folders than Windows 9x/Me. It creates {\texttt{\docbookhyphenatefilename{Application Data}}} and others, as well as {\texttt{\docbookhyphenatefilename{Desktop}}}, {\texttt{\docbookhyphenatefilename{Nethood}}}, {\texttt{\docbookhyphenatefilename{Start Menu,}}} and {\texttt{\docbookhyphenatefilename{Programs}}}. The profile itself is stored in a file {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}DAT}}}. Nothing appears to be stored in the .PDS directory, and its purpose is currently unknown.

\index{NTuser.DAT} \index{NTuser.MAN} You can use the System Control Panel to copy a local profile onto a Samba server (see NT help on profiles; it is also capable of firing up the correct location in the System Control Panel for you). The NT help file also mentions that renaming {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}DAT}}} to {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}MAN}}} turns a profile into a mandatory one.

The case of the profile is significant. The file must be called {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}DAT}}} or, for a mandatory profile, {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}MAN}}}.
\subsubsection{Windows 2000/XP Professional}
\label{id2612763}\hypertarget{id2612763}{}%

You must first convert the profile from a local profile to a domain profile on the MS Windows workstation as follows:
\begin{enumerate}

\item{Log on as the {\em{local}} workstation administrator.}

\item{Right-click on the {\sffamily \bfseries My Computer} icon, and select {\sffamily \bfseries Properties}.}

\item{Click on the {\sffamily \bfseries User Profiles} tab.}

\item{Select the profile you wish to convert (click it once).}

\item{Click on the {\sffamily \bfseries Copy To} button.}

\item{In the {\sffamily \bfseries Permitted to use} box, click on the {\sffamily \bfseries Change} button.}

\item{Click on the {\sffamily \bfseries Look in} area that lists the machine name. When you click here, it will open up a selection box. Click on the domain to which the profile must be accessible. 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

You will need to log on if a logon box opens up. For example, connect as {\ttfamily\itshape{\docbookhyphenatedot{DOMAIN}}}\textbackslash root, password: {\ttfamily\itshape{\docbookhyphenatedot{mypassword}}}.
\end{admonition}

}

\item{To make the profile capable of being used by anyone, select {``}Everyone{''}.}

\item{Click on {\sffamily \bfseries OK} and the Selection box will close.}

\item{Now click on {\sffamily \bfseries OK} to create the profile in the path you nominated.}
\end{enumerate}

Done. You now have a profile that can be edited using the Samba {\bfseries{profiles}} tool.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Under Windows NT/200x, the use of mandatory profiles forces the use of MS Exchange storage of mail data and keeps it out of the desktop profile. That keeps desktop profiles from becoming unusable.
\end{admonition}

\subparagraph*{Windows XP Service Pack 1}
\label{id2612929}\hypertarget{id2612929}{}%

There is a security check new to Windows XP (or maybe only Windows XP service pack 1). It can be disabled via a group policy in the Active Directory. The policy is called: 
\begin{Verbatim}[]

Computer Configuration\Administrative Templates\System\User Profiles\
          Do not check for user ownership of Roaming Profile Folders

\end{Verbatim}


This should be set to {\texttt{\docbookhyphenatedot{Enabled}}}.

Does the new version of Samba have an Active Directory analogue? If so, then you may be able to set the policy through this.

If you cannot set group policies in Samba, then you may be able to set the policy locally on each machine. If you want to try this, then do the following:
\begin{enumerate}

\item{On the XP workstation, log in with an administrative account.}

\item{Click on {\sffamily \bfseries Start} -\textgreater{} {\sffamily \bfseries Run}.}

\item{Type {\bfseries{mmc}}.}

\item{Click on {\sffamily \bfseries OK}.}

\item{A Microsoft Management Console should appear.}

\item{Click on {\sffamily \bfseries File} -\textgreater{} {\sffamily \bfseries Add/Remove Snap-in} -\textgreater{} {\sffamily \bfseries Add}.}

\item{Double-click on {\sffamily \bfseries Group Policy}.}

\item{Click on {\sffamily \bfseries Finish} -\textgreater{} {\sffamily \bfseries Close}.}

\item{Click on {\sffamily \bfseries OK}.}

\item{In the {``}Console Root{''} window expand {\sffamily \bfseries Local Computer Policy} -\textgreater{} {\sffamily \bfseries Computer Configuration} -\textgreater{} {\sffamily \bfseries Administrative Templates} -\textgreater{} {\sffamily \bfseries System} -\textgreater{} {\sffamily \bfseries User Profiles}.}

\item{Double-click on {\sffamily \bfseries Do not check for user ownership of Roaming Profile Folders}.}

\item{Select {\sffamily \bfseries Enabled}.}

\item{Click on {\sffamily \bfseries OK}.}

\item{Close the whole console. You do not need to save the settings (this refers to the console settings rather than the policies you have changed).}

\item{Reboot.}
\end{enumerate}
\subsection{User Profile Hive Cleanup Service}
\label{id2613175}\hypertarget{id2613175}{}%

There are certain situations that cause a cached local copy of roaming profile not to be deleted on exit, even if the policy to force such deletion is set. To deal with that situation, a special service was created. The application {\bfseries{UPHClean}} (User Profile Hive Cleanup) can be installed as a service on Windows NT4/2000/XP Professional and Windows 2003.

The UPHClean software package can be downloaded from the User Profile Hive Cleanup Service\label{id2613199}\begingroup\catcode`\#=12\footnote{http://www.microsoft.com/downloads/details.aspx?FamilyID=1B286E6D-8912-4E18-B570-42470E2F3582\&displaylang=en}\endgroup\docbooktolatexmakefootnoteref{id2613199} web site.
\subsection{Sharing Profiles between Windows 9x/Me and NT4/200x/XP Workstations}
\label{id2613206}\hypertarget{id2613206}{}%

\index{profile sharing} \index{profile contents} Sharing of desktop profiles between Windows versions is not recommended. Desktop profiles are an evolving phenomenon, and profiles for later versions of MS Windows clients add features that may interfere with earlier versions of MS Windows clients. Probably the more salient reason to not mix profiles is that when logging off an earlier version of MS Windows, the older format of profile contents may overwrite information that belongs to the newer version, resulting in loss of profile information content when that user logs on again with the newer version of MS Windows.

If you then want to share the same Start Menu and Desktop with Windows 9x/Me, you must specify a common location for the profiles. The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameters that need to be common are \smbconfoption{logon path} and \smbconfoption{logon home}.

\index{user.DAT} \index{NTuser.DAT} If you have this set up correctly, you will find separate {\texttt{\docbookhyphenatefilename{user.\dbz{}DAT}}} and {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}DAT}}} files in the same profile directory.
\subsection{Profile Migration from Windows NT4/200x Server to Samba}
\label{id2613252}\hypertarget{id2613252}{}%

\index{encrypted passwords} There is nothing to stop you from specifying any path that you like for the location of users' profiles. Therefore, you could specify that the profile be stored on a Samba server or any other SMB server, as long as that SMB server supports encrypted passwords.
\subsubsection{Windows NT4 Profile Management Tools}
\label{profilemigrn}\hypertarget{profilemigrn}{}%

\index{resource kit} Unfortunately, the resource kit information is specific to the version of MS Windows NT4/200x. The correct resource kit is required for each platform.

Here is a quick guide:
Profile Migration Procedure\begin{enumerate}

\item{On your NT4 domain controller, right-click on {\sffamily \bfseries My Computer}, then select {\sffamily \bfseries Properties}, then the tab labeled {\sffamily \bfseries User Profiles}.}

\item{Select a user profile you want to migrate and click on it. 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

I am using the term {``}migrate{''} loosely. You can copy a profile to create a group profile. You can give the user {\ttfamily\itshape{\docbookhyphenatedot{Everyone}}} rights to the profile you copy this to. That is what you need to do, since your Samba domain is not a member of a trust relationship with your NT4 PDC.
\end{admonition}

}

\item{Click on the {\sffamily \bfseries Copy To} button.}

\item{In the box labeled {\sffamily \bfseries Copy Profile to} add your new path, such as, {\texttt{\docbookhyphenatefilename{c:\docbooktolatexgobble\string\\temp\docbooktolatexgobble\string\\foobar}}}}

\item{Click on {\sffamily \bfseries Change} in the {\sffamily \bfseries Permitted to use} box.}

\item{Click on the group {``}Everyone{''}, click on {\sffamily \bfseries OK}. This closes the {``}choose user{''} box.}

\item{Now click on {\sffamily \bfseries OK}.}
\end{enumerate}

Follow these steps for every profile you need to migrate.
\subsubsection{Side Bar Notes}
\label{id2613427}\hypertarget{id2613427}{}%

\index{SID} \index{net!rpc!info} You should obtain the SID of your NT4 domain. You can use the {\bfseries{net rpc info}} to do this. See \hyperlink{NetCommand}{Chapter {\ref{NetCommand}}, {``}Remote and Local Management: The Net Command{''}}, \hyperlink{netmisc1}{Section {\ref{netmisc1}}} for more information.
\subsubsection{moveuser.exe}
\label{id2613471}\hypertarget{id2613471}{}%

\index{moveuser.exe} The Windows 200x professional resource kit has {\bfseries{moveuser.exe}}. {\bfseries{moveuser.exe}} changes the security of a profile from one user to another. This allows the account domain to change and/or the username to change.

This command is like the Samba {\bfseries{profiles}} tool.
\subsubsection{Get SID}
\label{id2613509}\hypertarget{id2613509}{}%

\index{SID} \index{GetSID.exe} You can identify the SID by using {\bfseries{GetSID.exe}} from the Windows NT Server 4.0 Resource Kit.

Windows NT 4.0 stores the local profile information in the registry under the following key: {\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}LOCAL\_\dbz{}MACHINE\docbooktolatexgobble\string\\SOFTWARE\docbooktolatexgobble\string\\Microsoft\docbooktolatexgobble\string\\Windows NT\docbooktolatexgobble\string\\CurrentVersion\docbooktolatexgobble\string\\ProfileList}}}

Under the ProfileList key, there will be subkeys named with the SIDs of the users who have logged on to this computer. (To find the profile information for the user whose locally cached profile you want to move, find the SID for the user with the {\bfseries{GetSID.exe}} utility.) Inside the appropriate user's subkey, you will see a string value named {\ttfamily\itshape{\docbookhyphenatedot{ProfileImagePath}}}.

% ------------------------   
% Section 
\section{Mandatory Profiles}
\label{id2613571}\hypertarget{id2613571}{}%

\index{mandatory profiles} A mandatory profile is a profile that the user does not have the ability to overwrite. During the user's session, it may be possible to change the desktop environment; however, as the user logs out, all changes made will be lost. If it is desired to not allow the user any ability to change the desktop environment, then this must be done through policy settings. See \hyperlink{PolicyMgmt}{Chapter {\ref{PolicyMgmt}}, {``}System and Account Policies{''}}.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{fake-permissions module} \index{VFS module} \index{fake\_perms} Under NO circumstances should the profile directory (or its contents) be made read-only because this may render the profile unusable. Where it is essential to make a profile read-only within the UNIX file system, this can be done, but then you absolutely must use the {\bfseries{fake-permissions}} VFS module to instruct MS Windows NT/200x/XP clients that the Profile has write permission for the user. See \hyperlink{fakeperms}{Section {\ref{fakeperms}}}.
\end{admonition}


\index{NTUser.MAN} \index{NTUser.DAT} For MS Windows NT4/200x/XP, the procedure shown in \hyperlink{profilemigrn}{Section {\ref{profilemigrn}}} can also be used to create mandatory profiles. To convert a group profile into a mandatory profile, simply locate the {\texttt{\docbookhyphenatefilename{NTUser.\dbz{}DAT}}} file in the copied profile and rename it to {\texttt{\docbookhyphenatefilename{NTUser.\dbz{}MAN}}}.

\index{User.MAN} For MS Windows 9x/Me, it is the {\texttt{\docbookhyphenatefilename{User.\dbz{}DAT}}} file that must be renamed to {\texttt{\docbookhyphenatefilename{User.\dbz{}MAN}}} to effect a mandatory profile.

% ------------------------   
% Section 
\section{Creating and Managing Group Profiles}
\label{id2613697}\hypertarget{id2613697}{}%

\index{group profiles} \index{template} \index{profile migration tool} \index{profile access rights} Most organizations are arranged into departments. There is a nice benefit in this fact, since usually most users in a department require the same desktop applications and the same desktop layout. MS Windows NT4/200x/XP will allow the use of group profiles. A group profile is a profile that is created first using a template (example) user. Then using the profile migration tool (see above), the profile is assigned access rights for the user group that needs to be given access to the group profile.

\index{User Manager} The next step is rather important. Instead of assigning a group profile to users (Using User Manager) on a {``}per-user{''} basis, the group itself is assigned the now modified profile.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Be careful with group profiles. If the user who is a member of a group also has a personal profile, then the result will be a fusion (merge) of the two.
\end{admonition}


% ------------------------   
% Section 
\section{Default Profile for Windows Users}
\label{id2613764}\hypertarget{id2613764}{}%

\index{default profile} \index{registry keys} MS Windows 9x/Me and NT4/200x/XP will use a default profile for any user for whom a profile does not already exist. Armed with a knowledge of where the default profile is located on the Windows workstation, and knowing which registry keys affect the path from which the default profile is created, it is possible to modify the default profile to one that has been optimized for the site. This has significant administrative advantages.
\subsection{MS Windows 9x/Me}
\label{id2613793}\hypertarget{id2613793}{}%

\index{System Policy Editor} \index{registry} To enable default per-use profiles in Windows 9x/Me, you can either use the Windows 98 System Policy Editor or change the registry directly.

To enable default per-user profiles in Windows 9x/Me, launch the System Policy Editor, then select {\sffamily \bfseries File} -\textgreater{} {\sffamily \bfseries Open Registry}. Next click on the {\sffamily \bfseries Local Computer} icon, click on {\sffamily \bfseries Windows 98 System}, select {\sffamily \bfseries User Profiles}, and click on the enable box. Remember to save the registry changes.

\index{regedit.exe} To modify the registry directly, launch the Registry Editor ({\bfseries{regedit.exe}}) and select the hive {\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}LOCAL\_\dbz{}MACHINE\docbooktolatexgobble\string\\Network\docbooktolatexgobble\string\\Logon}}}. Now add a DWORD type key with the name {``}User Profiles.{''} To enable user profiles to set the value to 1; to disable user profiles set it to 0.
\subsubsection{User Profile Handling with Windows 9x/Me}
\label{id2613891}\hypertarget{id2613891}{}%

When a user logs on to a Windows 9x/Me machine, the local profile path, {\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}LOCAL\_\dbz{}MACHINE\docbooktolatexgobble\string\\Software\docbooktolatexgobble\string\\Microsoft\docbooktolatexgobble\string\\Windows\docbooktolatexgobble\string\\CurrentVersion\docbooktolatexgobble\string\\ProfileList}}}, is checked for an existing entry for that user.

If the user has an entry in this registry location, Windows 9x/Me checks for a locally cached version of the user profile. Windows 9x/Me also checks the user's home directory (or other specified directory if the location has been modified) on the server for the user profile. If a profile exists in both locations, the newer of the two is used. If the user profile exists on the server but does not exist on the local machine, the profile on the server is downloaded and used. If the user profile only exists on the local machine, that copy is used.

If a user profile is not found in either location, the default user profile from the Windows 9x/Me machine is used and copied to a newly created folder for the logged on user. At log off, any changes that the user made are written to the user's local profile. If the user has a roaming profile, the changes are written to the user's profile on the server.
\subsection{MS Windows NT4 Workstation}
\label{id2613933}\hypertarget{id2613933}{}%

On MS Windows NT4, the default user profile is obtained from the location {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\Profiles}}}, which in a default installation will translate to {\texttt{\docbookhyphenatefilename{C:\docbooktolatexgobble\string\\Windows NT\docbooktolatexgobble\string\\Profiles}}}. Under this directory on a clean install, there will be three directories: {\texttt{\docbookhyphenatefilename{Administrator}}}, {\texttt{\docbookhyphenatefilename{All Users,}}} and {\texttt{\docbookhyphenatefilename{Default User}}}.

The {\texttt{\docbookhyphenatefilename{All Users}}} directory contains menu settings that are common across all system users. The {\texttt{\docbookhyphenatefilename{Default User}}} directory contains menu entries that are customizable per user depending on the profile settings chosen/created.

When a new user first logs onto an MS Windows NT4 machine, a new profile is created from:

\begin{itemize}
%--- Item
\item 
All Users settings.


%--- Item
\item 
Default User settings (contains the default {\texttt{\docbookhyphenatefilename{NTUser.\dbz{}DAT}}} file).

\end{itemize}

\index{NTConfig.POL} When a user logs on to an MS Windows NT4 machine that is a member of a Microsoft security domain, the following steps are followed for profile handling:
\begin{enumerate}

\item{The user's account information that is obtained during the logon process contains the location of the user's desktop profile. The profile path may be local to the machine or it may be located on a network share. If there exists a profile at the location of the path from the user account, then this profile is copied to the location {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\Profiles\docbooktolatexgobble\string\\\%USERNAME\%}}}. This profile then inherits the settings in the {\texttt{\docbookhyphenatefilename{All Users}}} profile in the {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\Profiles}}} location.}

\item{If the user account has a profile path, but at its location a profile does not exist, then a new profile is created in the {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\Profiles\docbooktolatexgobble\string\\\%USERNAME\%}}} directory from reading the {\texttt{\docbookhyphenatefilename{Default User}}} profile.}

\item{\index{NTConfig.POL} \index{NETLOGON} \index{authenticating server} \index{logon server} \index{HKEY\_CURRENT\_USER} If the NETLOGON share on the authenticating server (logon server) contains a policy file ({\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}}), then its contents are applied to the {\texttt{\docbookhyphenatefilename{NTUser.\dbz{}DAT}}}, which is applied to the {\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}CURRENT\_\dbz{}USER}}} part of the registry.}

\item{When the user logs out, if the profile is set to be a roaming profile, it will be written out to the location of the profile. The {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}DAT}}} file is then re-created from the contents of the {\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}CURRENT\_\dbz{}USER}}} contents. Thus, should there not exist in the NETLOGON share an {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} at the next logon, the effect of the previous {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} will still be held in the profile. The effect of this is known as tattooing.}
\end{enumerate}

MS Windows NT4 profiles may be {\em{local}} or {\em{roaming}}. A local profile is stored in the {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\Profiles\docbooktolatexgobble\string\\\%USERNAME\%}}} location. A roaming profile will also remain stored in the same way, unless the following registry key is created: 
\begin{Verbatim}[]

HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\
winlogon\"DeleteRoamingCache"=dword:0000000

\end{Verbatim}
 In this case, the local copy (in {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\Profiles\docbooktolatexgobble\string\\\%USERNAME\%}}}) will be deleted on logout.

\index{regedt32} Under MS Windows NT4, default locations for common resources like {\texttt{\docbookhyphenatefilename{My Documents}}} may be redirected to a network share by modifying the following registry keys. These changes may be made via use of the System Policy Editor. To do so may require that you create your own template extension for the Policy Editor to allow this to be done through the GUI. Another way to do this is by first creating a default user profile, then while logged in as that user, running {\bfseries{regedt32}} to edit the key settings.

The Registry Hive key that affects the behavior of folders that are part of the default user profile are controlled by entries on Windows NT4 is: 
\begin{Verbatim}[]

HKEY_CURRENT_USER
	\Software
		\Microsoft
			\Windows
				\CurrentVersion
					\Explorer
						\User Shell Folders

\end{Verbatim}
 \index{windows registry settings!default profile locations}

The above hive key contains a list of automatically managed folders. The default entries are shown in \hyperlink{ProfileLocs}{Table {\ref{ProfileLocs}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{ProfileLocs}{}%
\captionswapskip{}{{\caption{User Shell Folder Registry Keys Default Values}\label{ProfileLocs}}}
\captionswapskip{}\begin{tabular}{|l|l|}
\hline 
{{{\bfseries Name}}} & {{{\bfseries Default Value}}} \tabularnewline
 \hline 
{{AppData}} & {{\%USERPROFILE\%\textbackslash Application Data}} \tabularnewline
 \hline 
{{Desktop}} & {{\%USERPROFILE\%\textbackslash Desktop}} \tabularnewline
 \hline 
{{Favorites}} & {{\%USERPROFILE\%\textbackslash Favorites}} \tabularnewline
 \hline 
{{NetHood}} & {{\%USERPROFILE\%\textbackslash NetHood}} \tabularnewline
 \hline 
{{PrintHood}} & {{\%USERPROFILE\%\textbackslash PrintHood}} \tabularnewline
 \hline 
{{Programs}} & {{\%USERPROFILE\%\textbackslash Start Menu\textbackslash Programs}} \tabularnewline
 \hline 
{{Recent}} & {{\%USERPROFILE\%\textbackslash Recent}} \tabularnewline
 \hline 
{{SendTo}} & {{\%USERPROFILE\%\textbackslash SendTo}} \tabularnewline
 \hline 
{{Start Menu}} & {{\%USERPROFILE\%\textbackslash Start Menu}} \tabularnewline
 \hline 
{{Startup}} & {{\%USERPROFILE\%\textbackslash Start Menu\textbackslash Programs\textbackslash Startup}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


The registry key that contains the location of the default profile settings is: 
\begin{Verbatim}[]

HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\
User Shell Folders

\end{Verbatim}


The default entries are shown in \hyperlink{regkeys}{Table {\ref{regkeys}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{regkeys}{}%
\captionswapskip{}{{\caption{Defaults of Profile Settings Registry Keys}\label{regkeys}}}
\captionswapskip{}\begin{tabular}{|l|l|}
\hline 
{{Common Desktop}} & {{\%SystemRoot\%\textbackslash Profiles\textbackslash All Users\textbackslash Desktop}} \tabularnewline
 \hline 
{{Common Programs}} & {{\%SystemRoot\%\textbackslash Profiles\textbackslash All Users\textbackslash Programs}} \tabularnewline
 \hline 
{{Common Start Menu}} & {{\%SystemRoot\%\textbackslash Profiles\textbackslash All Users\textbackslash Start Menu}} \tabularnewline
 \hline 
{{Common Startup}} & {{\%SystemRoot\%\textbackslash Profiles\textbackslash All Users\textbackslash Start Menu\textbackslash Programs\textbackslash Startup}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}

\subsection{MS Windows 200x/XP}
\label{id2614450}\hypertarget{id2614450}{}%

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{GPOs} \index{Windows XP Home Edition} \index{ADS} \index{domain security} MS Windows XP Home Edition does use default per-user profiles, but cannot participate in domain security, cannot log onto an NT/ADS-style domain, and thus can obtain the profile only from itself. While there are benefits in doing this, the beauty of those MS Windows clients that can participate in domain logon processes is that they allow the administrator to create a global default profile and enforce it through the use of Group Policy Objects (GPOs).
\end{admonition}


\index{Default User} When a new user first logs onto an MS Windows 200x/XP machine, the default profile is obtained from {\texttt{\docbookhyphenatefilename{C:\docbooktolatexgobble\string\\Documents and Settings\docbooktolatexgobble\string\\Default User}}}. The administrator can modify or change the contents of this location, and MS Windows 200x/XP will gladly use it. This is far from the optimum arrangement, since it will involve copying a new default profile to every MS Windows 200x/XP client workstation.

\index{NETLOGON} When MS Windows 200x/XP participates in a domain security context, and if the default user profile is not found, then the client will search for a default profile in the NETLOGON share of the authenticating server. In MS Windows parlance, it is {\texttt{\docbookhyphenatefilename{\%LOGONSERVER\%\docbooktolatexgobble\string\\NETLOGON\docbooktolatexgobble\string\\Default User,}}} and if one exists there, it will copy this to the workstation in the {\texttt{\docbookhyphenatefilename{C:\docbooktolatexgobble\string\\Documents and Settings\docbooktolatexgobble\string\\}}} under the Windows login name of the use.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

This path translates, in Samba parlance, to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} \smbconfsection{[NETLOGON]} share. The directory should be created at the root of this share and must be called {\texttt{\docbookhyphenatefilename{Default User}}}.
\end{admonition}


If a default profile does not exist in this location, then MS Windows 200x/XP will use the local default profile.

On logging out, the user's desktop profile is stored to the location specified in the registry settings that pertain to the user. If no specific policies have been created or passed to the client during the login process (as Samba does automatically), then the user's profile is written to the local machine only under the path {\texttt{\docbookhyphenatefilename{C:\docbooktolatexgobble\string\\Documents and Settings\docbooktolatexgobble\string\\\%USERNAME\%}}}.

Those wishing to modify the default behavior can do so through these three methods:

\begin{itemize}
%--- Item
\item 
Modify the registry keys on the local machine manually and place the new default profile in the NETLOGON share root. This is not recommended because it is maintenance intensive.


%--- Item
\item 
Create an NT4-style NTConfig.POL file that specifies this behavior and locate this file in the root of the NETLOGON share along with the new default profile.


%--- Item
\item 
Create a GPO that enforces this through Active Directory, and place the new default profile in the NETLOGON share.

\end{itemize}

The registry hive key that affects the behavior of folders that are part of the default user profile are controlled by entries on Windows 200x/XP is:

{\texttt{\docbookhyphenatefilename{HKEY\_\dbz{}CURRENT\_\dbz{}USER\docbooktolatexgobble\string\\Software\docbooktolatexgobble\string\\Microsoft\docbooktolatexgobble\string\\Windows\docbooktolatexgobble\string\\CurrentVersion\docbooktolatexgobble\string\\Explorer\docbooktolatexgobble\string\\User Shell Folders\docbooktolatexgobble\string\\}}}

This hive key contains a list of automatically managed folders. The default entries are shown in \hyperlink{defregpthkeys}{Table {\ref{defregpthkeys}}} \index{windows registry settings!default profile locations}

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{defregpthkeys}{}%
\captionswapskip{}{{\caption{Defaults of Default User Profile Paths Registry Keys}\label{defregpthkeys}}}
\captionswapskip{}\begin{tabular}{|l|l|}
\hline 
{{{\bfseries Name}}} & {{{\bfseries Default Value}}} \tabularnewline
 \hline 
{{AppData}} & {{\%USERPROFILE\%\textbackslash Application Data}} \tabularnewline
 \hline 
{{Cache}} & {{\%USERPROFILE\%\textbackslash Local Settings\textbackslash Temporary Internet Files}} \tabularnewline
 \hline 
{{Cookies}} & {{\%USERPROFILE\%\textbackslash Cookies}} \tabularnewline
 \hline 
{{Desktop}} & {{\%USERPROFILE\%\textbackslash Desktop}} \tabularnewline
 \hline 
{{Favorites}} & {{\%USERPROFILE\%\textbackslash Favorites}} \tabularnewline
 \hline 
{{History}} & {{\%USERPROFILE\%\textbackslash Local Settings\textbackslash History}} \tabularnewline
 \hline 
{{Local AppData}} & {{\%USERPROFILE\%\textbackslash Local Settings\textbackslash Application Data}} \tabularnewline
 \hline 
{{Local Settings}} & {{\%USERPROFILE\%\textbackslash Local Settings}} \tabularnewline
 \hline 
{{My Pictures}} & {{\%USERPROFILE\%\textbackslash My Documents\textbackslash My Pictures}} \tabularnewline
 \hline 
{{NetHood}} & {{\%USERPROFILE\%\textbackslash NetHood}} \tabularnewline
 \hline 
{{Personal}} & {{\%USERPROFILE\%\textbackslash My Documents}} \tabularnewline
 \hline 
{{PrintHood}} & {{\%USERPROFILE\%\textbackslash PrintHood}} \tabularnewline
 \hline 
{{Programs}} & {{\%USERPROFILE\%\textbackslash Start Menu\textbackslash Programs}} \tabularnewline
 \hline 
{{Recent}} & {{\%USERPROFILE\%\textbackslash Recent}} \tabularnewline
 \hline 
{{SendTo}} & {{\%USERPROFILE\%\textbackslash SendTo}} \tabularnewline
 \hline 
{{Start Menu}} & {{\%USERPROFILE\%\textbackslash Start Menu}} \tabularnewline
 \hline 
{{Startup}} & {{\%USERPROFILE\%\textbackslash Start Menu\textbackslash Programs\textbackslash Startup}} \tabularnewline
 \hline 
{{Templates}} & {{\%USERPROFILE\%\textbackslash Templates}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


There is also an entry called {``}Default{''} that has no value set. The default entry is of type {\texttt{\docbookhyphenatedot{REG\_SZ}}}; all the others are of type {\texttt{\docbookhyphenatedot{REG\_EXPAND\_SZ}}}.

It makes a huge difference to the speed of handling roaming user profiles if all the folders are stored on a dedicated location on a network server. This means that it will not be necessary to write the Outlook PST file over the network for every login and logout.

To set this to a network location, you could use the following examples: 
\begin{Verbatim}[]

%LOGONSERVER%\%USERNAME%\Default Folders

\end{Verbatim}
 This stores the folders in the user's home directory under a directory called {\texttt{\docbookhyphenatefilename{Default Folders}}}. You could also use: 
\begin{Verbatim}[]

\\SambaServer\FolderShare\%USERNAME%

\end{Verbatim}


in which case the default folders are stored in the server named {\ttfamily\itshape{\docbookhyphenatedot{SambaServer}}} in the share called {\ttfamily\itshape{\docbookhyphenatedot{FolderShare}}} under a directory that has the name of the MS Windows user as seen by the Linux/UNIX file system.

Please note that once you have created a default profile share, you {\em{must}} migrate a user's profile (default or custom) to it.

MS Windows 200x/XP profiles may be {\em{local}} or {\em{roaming}}. A roaming profile is cached locally unless the following registry key is created: \index{delete roaming profiles}


\begin{Verbatim}[]
 HKEY_LOCAL_MACHINE\SYSTEM\Software\Microsoft\Windows NT\CurrentVersion\
	winlogon\"DeleteRoamingCache"=dword:00000001
\end{Verbatim}


In this case, the local cache copy is deleted on logout.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2614921}\hypertarget{id2614921}{}%

The following are some typical errors, problems, and questions that have been asked on the Samba mailing lists.
\subsection{Configuring Roaming Profiles for a Few Users or Groups}
\label{id2614932}\hypertarget{id2614932}{}%

With Samba-2.2.x, the choice you have is to enable or disable roaming profiles support. It is a global-only setting. The default is to have roaming profiles, and the default path will locate them in the user's home directory.

If disabled globally, then no one will have roaming profile ability. If enabled and you want it to apply only to certain machines, then on those machines on which roaming profile support is not wanted, it is necessary to disable roaming profile handling in the registry of each such machine.

With Samba-3, you can have a global profile setting in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}, and you can override this by per-user settings using the Domain User Manager (as with MS Windows NT4/200x).

In any case, you can configure only one profile per user. That profile can be either:

\begin{itemize}
%--- Item
\item 
A profile unique to that user.


%--- Item
\item 
A mandatory profile (one the user cannot change).


%--- Item
\item 
A group profile (really should be mandatory ---  that is, unchangable).

\end{itemize}
\subsection{Cannot Use Roaming Profiles}
\label{id2614992}\hypertarget{id2614992}{}%

A user requested the following: {``}I do not want roaming profiles to be implemented. I want to give users a local profile alone. I am totally lost with this error. For the past two days I tried everything, I googled around but found no useful pointers. Please help me.{''}

The choices are:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Local profiles}]\null{}
I know of no registry keys that will allow autodeletion of LOCAL profiles on log out.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Roaming profiles}]\null{}
As a user logs onto the network, a centrally stored profile is copied to the workstation to form a local profile. This local profile will persist (remain on the workstation disk) unless a registry key is changed that will cause this profile to be automatically deleted on logout.
\end{description}

The roaming profile choices are:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Personal roaming profiles}]\null{}
These are typically stored in a profile share on a central (or conveniently located local) server.

Workstations cache (store) a local copy of the profile. This cached copy is used when the profile cannot be downloaded at next logon.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Group profiles}]\null{}
These are loaded from a central profile server.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Mandatory profiles}]\null{}
Mandatory profiles can be created for a user as well as for any group that a user is a member of. Mandatory profiles cannot be changed by ordinary users. Only the administrator can change or reconfigure a mandatory profile.
\end{description}

A Windows NT4/200x/XP profile can vary in size from 130KB to very large. Outlook PST files are most often part of the profile and can be many gigabytes in size. On average (in a well controlled environment), roaming profile size of 2MB is a good rule of thumb to use for planning purposes. In an undisciplined environment, I have seen up to 2GB profiles. Users tend to complain when it takes an hour to log onto a workstation, but they harvest the fruits of folly (and ignorance).

The point of this discussion is to show that roaming profiles and good controls of how they can be changed as well as good discipline make for a problem-free site.

Microsoft's answer to the PST problem is to store all email in an MS Exchange Server backend. This removes the need for a PST file.

Local profiles mean:

\begin{itemize}
%--- Item
\item 
If each machine is used by many users, then much local disk storage is needed for local profiles.


%--- Item
\item 
Every workstation the user logs into has its own profile; these can be very different from machine to machine.

\end{itemize}

On the other hand, use of roaming profiles means:

\begin{itemize}
%--- Item
\item 
The network administrator can control the desktop environment of all users.


%--- Item
\item 
Use of mandatory profiles drastically reduces network management overheads.


%--- Item
\item 
In the long run, users will experience fewer problems.

\end{itemize}
\subsection{Changing the Default Profile}
\label{id2615159}\hypertarget{id2615159}{}%

{``}When the client logs onto the domain controller, it searches for a profile to download. Where do I put this default profile?{''}

\index{default profile} First, the Samba server needs to be configured as a domain controller. This can be done by setting in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	security = user
 	os level = 32 (or more)
 	domain logons = Yes
\end{lstlisting}

There must be a \smbconfsection{[netlogon]} share that is world readable. It is a good idea to add a logon script to preset printer and drive connections. There is also a facility for automatically synchronizing the workstation time clock with that of the logon server (another good thing to do).

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

To invoke autodeletion of roaming profiles from the local workstation cache (disk storage), use the Group Policy Editor to create a file called {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} with the appropriate entries. This file needs to be located in the \smbconfsection{netlogon} share root directory.
\end{admonition}


Windows clients need to be members of the domain. Workgroup machines do not use network logons, so they do not interoperate with domain profiles.

For roaming profiles, add to {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	logon path = \\%N\profiles\%U
 # Default logon drive is Z:
 	logon drive = H:
 # This requires a PROFILES share that is world writable.
\end{lstlisting}
\subsection{Debugging Roaming Profiles and NT4-style Domain Policies}
\label{id2615278}\hypertarget{id2615278}{}%

Roaming profiles and domain policies are implemented via {\bfseries{USERENV.DLL}}. Microsoft Knowledge Base articles 221833\label{id2615294}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;en-us;221833}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2615294} and 154120\label{id2615300}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;en-us;154120}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2615300} describe how to instruct that DLL to debug the login process.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter PAM-Based Distributed Authentication 
% ------------------------------------------------------------- 	
\chapter{PAM-Based Distributed Authentication}
\label{pam}\hypertarget{pam}{}%

\index{PAM-enabled} \index{Winbind} \index{ADS} \index{Winbind-based authentication} This chapter should help you to deploy Winbind-based authentication on any PAM-enabled UNIX/Linux system. Winbind can be used to enable user-level application access authentication from any MS Windows NT domain, MS Windows 200x Active Directory-based domain, or any Samba-based domain environment. It will also help you to configure PAM-based local host access controls that are appropriate to your Samba configuration.

\index{PAM management} \index{pam\_smbpass.so} In addition to knowing how to configure Winbind into PAM, you will learn generic PAM management possibilities and in particular how to deploy tools like {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass.\dbz{}so}}} to your advantage.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The use of Winbind requires more than PAM configuration alone. Please refer to \hyperlink{winbind}{Chapter {\ref{winbind}}, {``}Winbind: Use of Domain Accounts{''}}, for further information regarding Winbind.
\end{admonition}


% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2615705}\hypertarget{id2615705}{}%

\index{Sun Solaris} \index{xxxxBSD} \index{Linux} \index{Pluggable Authentication Modules|textit{see} {PAM} } \index{/etc/passwd} \index{login} \index{passwd} \index{chown} A number of UNIX systems (e.g., Sun Solaris), as well as the xxxxBSD family and Linux, now utilize the Pluggable Authentication Modules (PAM) facility to provide all authentication, authorization, and resource control services. Prior to the introduction of PAM, a decision to use an alternative to the system password database ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}) would require the provision of alternatives for all programs that provide security services. Such a choice would involve provision of alternatives to programs such as {\bfseries{login}}, {\bfseries{passwd}}, {\bfseries{chown}}, and so on.

\index{PAM} \index{/etc/pam.conf} \index{Solaris} \index{/etc/pam.d} PAM provides a mechanism that disconnects these security programs from the underlying authentication/authorization infrastructure. PAM is configured by making appropriate modifications to one file, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}} (Solaris), or by editing individual control files that are located in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d}}}.

\index{PAM-enabled} \index{dynamically loadable library modules} On PAM-enabled UNIX/Linux systems, it is an easy matter to configure the system to use any authentication backend so long as the appropriate dynamically loadable library modules are available for it. The backend may be local to the system or may be centralized on a remote server.

PAM support modules are available for:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}}]\null{}
\index{/etc/passwd} \index{PAM modules} \index{pam\_unix.so} \index{pam\_unix2.so} \index{pam\_pwdb.so} \index{pam\_userdb.so} There are several PAM modules that interact with this standard UNIX user database. The most common are called {\texttt{\docbookhyphenatefilename{pam\_\dbz{}unix.\dbz{}so}}}, {\texttt{\docbookhyphenatefilename{pam\_\dbz{}unix2.\dbz{}so}}}, {\texttt{\docbookhyphenatefilename{pam\_\dbz{}pwdb.\dbz{}so}}} and {\texttt{\docbookhyphenatefilename{pam\_\dbz{}userdb.\dbz{}so}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Kerberos}]\null{}
\index{pam\_krb5.so} \index{Kerberos} \index{Heimdal} \index{MIT Kerberos} \index{ADS} The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}krb5.\dbz{}so}}} module allows the use of any Kerberos-compliant server. This tool is used to access MIT Kerberos, Heimdal Kerberos, and potentially Microsoft Active Directory (if enabled).
% \null and \mbox are tricks to induce different typesetting decisions
\item[{LDAP}]\null{}
\index{LDAP} \index{pam\_ldap.so} \index{OpenLDAP} \index{Sun ONE iDentity server} \index{Novell eDirectory server} \index{Microsoft Active Directory} The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}ldap.\dbz{}so}}} module allows the use of any LDAP v2- or v3-compatible backend server. Commonly used LDAP backend servers include OpenLDAP v2.0 and v2.1, Sun ONE iDentity server, Novell eDirectory server, and Microsoft Active Directory.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{NetWare Bindery}]\null{}
\index{NetWare Bindery} \index{pam\_ncp\_auth.so} \index{bindery-enabled} \index{NetWare Core Protocol-based server} The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}ncp\_\dbz{}auth.\dbz{}so}}} module allows authentication off any bindery-enabled NetWare Core Protocol-based server.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SMB Password}]\null{}
\index{SMB Password} \index{pam\_smbpass.so} \index{passdb backend} This module, called {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass.\dbz{}so}}}, allows user authentication of the passdb backend that is configured in the Samba {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{SMB Server}]\null{}
\index{SMB Server} \index{pam\_smb\_auth.so} The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smb\_\dbz{}auth.\dbz{}so}}} module is the original MS Windows networking authentication tool. This module has been somewhat outdated by the Winbind module.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Winbind}]\null{}
\index{Winbind} \index{pam\_winbind.so} \index{domain controller} \index{authentication} The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}winbind.\dbz{}so}}} module allows Samba to obtain authentication from any MS Windows domain controller. It can just as easily be used to authenticate users for access to any PAM-enabled application.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{RADIUS}]\null{}
\index{Remote Access Dial-In User Service|textit{see} {RADIUS} } There is a PAM RADIUS (Remote Access Dial-In User Service) authentication module. In most cases, administrators need to locate the source code for this tool and compile and install it themselves. RADIUS protocols are used by many routers and terminal servers.
\end{description}

\index{pam\_smbpasswd.so} \index{pam\_winbind.so} Of the modules listed, Samba provides the {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpasswd.\dbz{}so}}} and the {\texttt{\docbookhyphenatefilename{pam\_\dbz{}winbind.\dbz{}so}}} modules alone.

\index{wide-area network bandwidth} \index{efficient authentication} \index{PAM-capable} \index{centrally managed} Once configured, these permit a remarkable level of flexibility in the location and use of distributed Samba domain controllers that can provide wide-area network bandwidth, efficient authentication services for PAM-capable systems. In effect, this allows the deployment of centrally managed and maintained distributed authentication from a single-user account database.

% ------------------------   
% Section 
\section{Technical Discussion}
\label{id2592952}\hypertarget{id2592952}{}%

\index{PAM} \index{privilege-granting applications} \index{/etc/pam.conf} \index{/etc/pam.d/} PAM is designed to provide system administrators with a great deal of flexibility in configuration of the privilege-granting applications of their system. The local configuration of system security controlled by PAM is contained in one of two places: either the single system file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}} or the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}}}} directory.
\subsection{PAM Configuration Syntax}
\label{id2593007}\hypertarget{id2593007}{}%

\index{PAM-specific tokens} \index{case sensitivity} In this section we discuss the correct syntax of and generic options respected by entries to these files. PAM-specific tokens in the configuration file are case insensitive. The module paths, however, are case sensitive, since they indicate a file's name and reflect the case dependence of typical file systems. The case sensitivity of the arguments to any given module is defined for each module in turn.

In addition to the lines described below, there are two special characters provided for the convenience of the system administrator: comments are preceded by a {``}\#{''} and extend to the next end-of-line; also, module specification lines may be extended with a {``}\textbackslash{''}-escaped newline.

\index{PAM authentication module} \index{/lib/security} If the PAM authentication module (loadable link library file) is located in the default location, then it is not necessary to specify the path. In the case of Linux, the default location is {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}security}}}. If the module is located outside the default, then the path must be specified as: 
\begin{Verbatim}[]

auth  required  /other_path/pam_strange_module.so

\end{Verbatim}

\subsubsection{Anatomy of /\dbz{}etc/\dbz{}pam.\dbz{}d Entries}
\label{id2593088}\hypertarget{id2593088}{}%

The remaining information in this subsection was taken from the documentation of the Linux-PAM project. For more information on PAM, see the Official Linux-PAM home page\label{id2593104}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://ftp.kernel.org/pub/linux/libs/pam/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2593104}.

\index{/etc/pam.conf} A general configuration line of the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}} file has the following form: 
\begin{Verbatim}[]

service-name   module-type   control-flag   module-path   args

\end{Verbatim}


We explain the meaning of each of these tokens. The second (and more recently adopted) way of configuring Linux-PAM is via the contents of the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}}}} directory. Once we have explained the meaning of the tokens, we describe this method.

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{service-name}]\null{}
\index{ftpd} \index{rlogind} \index{su} The name of the service associated with this entry. Frequently, the service-name is the conventional name of the given application ---  for example, {\bfseries{ftpd}}, {\bfseries{rlogind}} and {\bfseries{su}}, and so on.

There is a special service-name reserved for defining a default authentication mechanism. It has the name {\ttfamily\itshape{\docbookhyphenatedot{OTHER}}} and may be specified in either lower- or uppercase characters. Note, when there is a module specified for a named service, the {\ttfamily\itshape{\docbookhyphenatedot{OTHER}}} entries are ignored.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{module-type}]\null{}
One of (currently) four types of module. The four types are as follows:

\begin{itemize}
%--- Item
\item 
\index{auth} \index{/etc/groups} {\ttfamily\itshape{\docbookhyphenatedot{auth:}}} This module type provides two aspects of authenticating the user. It establishes that the user is who he or she claims to be by instructing the application to prompt the user for a password or other means of identification. Second, the module can grant group membership (independently of the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}groups}}} file) or other privileges through its credential-granting properties.


%--- Item
\item 
\index{account} \index{non-authentication-based account management} {\ttfamily\itshape{\docbookhyphenatedot{account:}}} This module performs non-authentication-based account management. It is typically used to restrict/permit access to a service based on the time of day, currently available system resources (maximum number of users), or perhaps the location of the user login. For example, the {``}root{''} login may be permitted only on the console.


%--- Item
\item 
\index{session} {\ttfamily\itshape{\docbookhyphenatedot{session:}}} Primarily, this module is associated with doing things that need to be done for the user before and after he or she can be given service. Such things include logging information concerning the opening and closing of some data exchange with a user, mounting directories, and so on.


%--- Item
\item 
\index{password} {\ttfamily\itshape{\docbookhyphenatedot{password:}}} This last module type is required for updating the authentication token associated with the user. Typically, there is one module for each {``}challenge/response{''} authentication {\ttfamily\itshape{\docbookhyphenatedot{(auth)}}} module type.

\end{itemize}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{control-flag}]\null{}
The control-flag is used to indicate how the PAM library will react to the success or failure of the module it is associated with. Since modules can be stacked (modules of the same type execute in series, one after another), the control-flags determine the relative importance of each module. The application is not made aware of the individual success or failure of modules listed in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}} file. Instead, it receives a summary success or fail response from the Linux-PAM library. The order of execution of these modules is that of the entries in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}conf}}} file; earlier entries are executed before later ones. As of Linux-PAM v0.60, this control-flag can be defined with one of two syntaxes.

\index{required} \index{requisite} \index{sufficient} \index{optional} The simpler (and historical) syntax for the control-flag is a single keyword defined to indicate the severity of concern associated with the success or failure of a specific module. There are four such keywords: {\ttfamily\itshape{\docbookhyphenatedot{required}}}, {\ttfamily\itshape{\docbookhyphenatedot{requisite}}}, {\ttfamily\itshape{\docbookhyphenatedot{sufficient}}}, and {\ttfamily\itshape{\docbookhyphenatedot{optional}}}.

The Linux-PAM library interprets these keywords in the following manner:

\begin{itemize}
%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{required:}}} This indicates that the success of the module is required for the module-type facility to succeed. Failure of this module will not be apparent to the user until all of the remaining modules (of the same module-type) have been executed.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{requisite:}}} Like required, except that if such a module returns a failure, control is directly returned to the application. The return value is that associated with the first required or requisite module to fail. This flag can be used to protect against the possibility of a user getting the opportunity to enter a password over an unsafe medium. It is conceivable that such behavior might inform an attacker of valid accounts on a system. This possibility should be weighed against the not insignificant concerns of exposing a sensitive password in a hostile environment.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{sufficient:}}} The success of this module is deemed {\ttfamily\itshape{\docbookhyphenatedot{sufficient}}} to satisfy the Linux-PAM library that this module-type has succeeded in its purpose. In the event that no previous required module has failed, no more {``}stacked{''} modules of this type are invoked. (In this case, subsequent required modules are not invoked). A failure of this module is not deemed as fatal to satisfying the application that this module-type has succeeded.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{optional:}}} As its name suggests, this control-flag marks the module as not being critical to the success or failure of the user's application for service. In general, Linux-PAM ignores such a module when determining if the module stack will succeed or fail. However, in the absence of any definite successes or failures of previous or subsequent stacked modules, this module will determine the nature of the response to the application. One example of this latter case is when the other modules return something like PAM\_IGNORE.

\end{itemize}

The more elaborate (newer) syntax is much more specific and gives the administrator a great deal of control over how the user is authenticated. This form of the control-flag is delimited with square brackets and consists of a series of {\ttfamily\itshape{\docbookhyphenatedot{value=action}}} tokens:

\null{}
\begin{Verbatim}[]

[value1=action1 value2=action2 ...]

\end{Verbatim}


Here, {\ttfamily\itshape{\docbookhyphenatedot{value1}}} is one of the following return values: \null{}
\begin{Verbatim}[]

success; open_err; symbol_err; service_err; system_err; buf_err;
perm_denied; auth_err; cred_insufficient; authinfo_unavail;
user_unknown; maxtries; new_authtok_reqd; acct_expired; session_err;
cred_unavail; cred_expired; cred_err; no_module_data; conv_err;
authtok_err; authtok_recover_err; authtok_lock_busy;
authtok_disable_aging; try_again; ignore; abort; authtok_expired;
module_unknown; bad_item; and default.

\end{Verbatim}


The last of these ({\ttfamily\itshape{\docbookhyphenatedot{default}}}) can be used to set the action for those return values that are not explicitly defined.

The {\ttfamily\itshape{\docbookhyphenatedot{action1}}} can be a positive integer or one of the following tokens: {\ttfamily\itshape{\docbookhyphenatedot{ignore}}}; {\ttfamily\itshape{\docbookhyphenatedot{ok}}}; {\ttfamily\itshape{\docbookhyphenatedot{done}}}; {\ttfamily\itshape{\docbookhyphenatedot{bad}}}; {\ttfamily\itshape{\docbookhyphenatedot{die}}}; and {\ttfamily\itshape{\docbookhyphenatedot{reset}}}. A positive integer, J, when specified as the action, can be used to indicate that the next J modules of the current module-type will be skipped. In this way, the administrator can develop a moderately sophisticated stack of modules with a number of different paths of execution. Which path is taken can be determined by the reactions of individual modules.

\begin{itemize}
%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{ignore:}}} When used with a stack of modules, the module's return status will not contribute to the return code the application obtains.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{bad:}}} This action indicates that the return code should be thought of as indicative of the module failing. If this module is the first in the stack to fail, its status value will be used for that of the whole stack.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{die:}}} Equivalent to bad with the side effect of terminating the module stack and PAM immediately returning to the application.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{ok:}}} This tells PAM that the administrator thinks this return code should contribute directly to the return code of the full stack of modules. In other words, if the former state of the stack would lead to a return of PAM\_SUCCESS, the module's return code will override this value. Note, if the former state of the stack holds some value that is indicative of a module's failure, this {\ttfamily\itshape{\docbookhyphenatedot{ok}}} value will not be used to override that value.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{done:}}} Equivalent to {\ttfamily\itshape{\docbookhyphenatedot{ok}}} with the side effect of terminating the module stack and PAM immediately returning to the application.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{reset:}}} Clears all memory of the state of the module stack and starts again with the next stacked module.

\end{itemize}

Each of the four keywords, {\ttfamily\itshape{\docbookhyphenatedot{required}}}; {\ttfamily\itshape{\docbookhyphenatedot{requisite}}}; {\ttfamily\itshape{\docbookhyphenatedot{sufficient}}}; and {\ttfamily\itshape{\docbookhyphenatedot{optional}}}, have an equivalent expression in terms of the [...] syntax. They are as follows:


\begin{itemize}
%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{required}}} is equivalent to {\ttfamily\itshape{\docbookhyphenatedot{[success=ok new\_authtok\_reqd=ok ignore=ignore default=bad]}}}.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{requisite}}} is equivalent to {\ttfamily\itshape{\docbookhyphenatedot{[success=ok new\_authtok\_reqd=ok ignore=ignore default=die]}}}.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{sufficient}}} is equivalent to {\ttfamily\itshape{\docbookhyphenatedot{[success=done new\_authtok\_reqd=done default=ignore]}}}.


%--- Item
\item 
{\ttfamily\itshape{\docbookhyphenatedot{optional}}} is equivalent to {\ttfamily\itshape{\docbookhyphenatedot{[success=ok new\_authtok\_reqd=ok default=ignore]}}}.

\end{itemize}


Just to get a feel for the power of this new syntax, here is a taste of what you can do with it. With Linux-PAM-0.63, the notion of client plug-in agents was introduced. This makes it possible for PAM to support machine-machine authentication using the transport protocol inherent to the client/server application. With the {\ttfamily\itshape{\docbookhyphenatedot{[ ... value=action ... ]}}} control syntax, it is possible for an application to be configured to support binary prompts with compliant clients, but to gracefully fail over into an alternative authentication mode for legacy applications.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{module-path}]\null{}
The pathname of the dynamically loadable object file; the pluggable module itself. If the first character of the module path is {``}/{''}, it is assumed to be a complete path. If this is not the case, the given module path is appended to the default module path: {\texttt{\docbookhyphenatefilename{/\dbz{}lib/\dbz{}security}}} (but see the previous notes).

The arguments are a list of tokens that are passed to the module when it is invoked, much like arguments to a typical Linux shell command. Generally, valid arguments are optional and are specific to any given module. Invalid arguments are ignored by a module; however, when encountering an invalid argument, the module is required to write an error to syslog(3). For a list of generic options, see the next section.

If you wish to include spaces in an argument, you should surround that argument with square brackets. For example:

\null{}
\begin{Verbatim}[]

squid auth required pam_mysql.so user=passwd_query passwd=mada \
db=eminence [query=select user_name from internet_service where \
user_name=%u and password=PASSWORD(%p) and service=web_proxy]

\end{Verbatim}


When using this convention, you can include {``}[{''} characters inside the string, and if you wish to have a {``}]{''} character inside the string that will survive the argument parsing, you should use {``}\textbackslash [{''}. In other words,

\null{}
\begin{Verbatim}[]

[..[..\]..]    -->   ..[..]..

\end{Verbatim}


Any line in one of the configuration files that is not formatted correctly will generally tend (erring on the side of caution) to make the authentication process fail. A corresponding error is written to the system log files with a call to syslog(3).
\end{description}
\subsection{Example System Configurations}
\label{id2616194}\hypertarget{id2616194}{}%

The following is an example {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}login}}} configuration file. This example had all options uncommented and is probably not usable because it stacks many conditions before allowing successful completion of the login process. Essentially, all conditions can be disabled by commenting them out, except the calls to {\texttt{\docbookhyphenatefilename{pam\_\dbz{}pwdb.\dbz{}so}}}.
\subsubsection{PAM: Original Login Config}
\label{id2616218}\hypertarget{id2616218}{}%


\begin{Verbatim}[]

#%PAM-1.0
# The PAM configuration file for the login service
#
auth         required    pam_securetty.so
auth         required    pam_nologin.so
# auth       required    pam_dialup.so
# auth       optional    pam_mail.so
auth         required    pam_pwdb.so shadow md5
# account    requisite   pam_time.so
account      required    pam_pwdb.so
session      required    pam_pwdb.so
# session    optional    pam_lastlog.so
# password   required    pam_cracklib.so retry=3
password     required    pam_pwdb.so shadow md5

\end{Verbatim}

\subsubsection{PAM: Login Using pam\_\dbz{}smbpass}
\label{id2616244}\hypertarget{id2616244}{}%

PAM allows use of replaceable modules. Those available on a sample system include:

{\texttt{\docbookhyphenatedot{\$}}}{\ttfamily\bfseries{\docbookhyphenatedot{/\dbz{}bin/\dbz{}ls /\dbz{}lib/\dbz{}security}}} 
\begin{Verbatim}[]

pam_access.so    pam_ftp.so          pam_limits.so     
pam_ncp_auth.so  pam_rhosts_auth.so  pam_stress.so     
pam_cracklib.so  pam_group.so        pam_listfile.so   
pam_nologin.so   pam_rootok.so       pam_tally.so      
pam_deny.so      pam_issue.so        pam_mail.so       
pam_permit.so    pam_securetty.so    pam_time.so       
pam_dialup.so    pam_lastlog.so      pam_mkhomedir.so  
pam_pwdb.so      pam_shells.so       pam_unix.so       
pam_env.so       pam_ldap.so         pam_motd.so       
pam_radius.so    pam_smbpass.so      pam_unix_acct.so  
pam_wheel.so     pam_unix_auth.so    pam_unix_passwd.so
pam_userdb.so    pam_warn.so         pam_unix_session.so

\end{Verbatim}


The following example for the login program replaces the use of the {\texttt{\docbookhyphenatefilename{pam\_\dbz{}pwdb.\dbz{}so}}} module that uses the system password database ({\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}shadow}}}, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}}) with the module {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass.\dbz{}so}}}, which uses the Samba database containing the Microsoft MD4 encrypted password hashes. This database is stored either in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}private/\dbz{}smbpasswd}}}, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba/\dbz{}smbpasswd}}} or in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba.\dbz{}d/\dbz{}smbpasswd}}}, depending on the Samba implementation for your UNIX/Linux system. The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass.\dbz{}so}}} module is provided by Samba version 2.2.1 or later. It can be compiled by specifying the {\texttt{\docbookhyphenatedot{--with-pam\_smbpass}}} options when running Samba's {\bfseries{configure}} script. For more information on the {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass}}} module, see the documentation in the {\texttt{\docbookhyphenatefilename{source/\dbz{}pam\_\dbz{}smbpass}}} directory of the Samba source distribution.


\begin{Verbatim}[]

#%PAM-1.0
# The PAM configuration file for the login service
#
auth        required    pam_smbpass.so nodelay
account     required    pam_smbpass.so nodelay
session     required    pam_smbpass.so nodelay
password    required    pam_smbpass.so nodelay

\end{Verbatim}


The following is the PAM configuration file for a particular Linux system. The default condition uses {\texttt{\docbookhyphenatefilename{pam\_\dbz{}pwdb.\dbz{}so}}}.


\begin{Verbatim}[]

#%PAM-1.0
# The PAM configuration file for the samba service
#
auth       required     pam_pwdb.so nullok nodelay shadow audit
account    required     pam_pwdb.so audit nodelay
session    required     pam_pwdb.so nodelay
password   required     pam_pwdb.so shadow md5

\end{Verbatim}


In the following example, the decision has been made to use the {\bfseries{smbpasswd}} database even for basic Samba authentication. Such a decision could also be made for the {\bfseries{passwd}} program and would thus allow the {\bfseries{smbpasswd}} passwords to be changed using the {\bfseries{passwd}} program:


\begin{Verbatim}[]

#%PAM-1.0
# The PAM configuration file for the samba service
#
auth       required     pam_smbpass.so nodelay
account    required     pam_pwdb.so audit nodelay
session    required     pam_pwdb.so nodelay
password   required     pam_smbpass.so nodelay smbconf=/etc/samba.d/smb.conf

\end{Verbatim}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

PAM allows stacking of authentication mechanisms. It is also possible to pass information obtained within one PAM module through to the next module in the PAM stack. Please refer to the documentation for your particular system implementation for details regarding the specific capabilities of PAM in this environment. Some Linux implementations also provide the {\texttt{\docbookhyphenatefilename{pam\_\dbz{}stack.\dbz{}so}}} module that allows all authentication to be configured in a single central file. The {\texttt{\docbookhyphenatefilename{pam\_\dbz{}stack.\dbz{}so}}} method has some devoted followers on the basis that it allows for easier administration. As with all issues in life, though, every decision has trade-offs, so you may want to examine the PAM documentation for further helpful information.
\end{admonition}

\subsection{smb.\dbz{}conf PAM Configuration}
\label{id2616477}\hypertarget{id2616477}{}%

There is an option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} called \smbconfoption{obey pam restrictions}. The following is from the online help for this option in SWAT:
\begin{quote}

When Samba is configured to enable PAM support (i.e., {\texttt{\docbookhyphenatedot{--with-pam}}}), this parameter will control whether or not Samba should obey PAM's account and session management directives. The default behavior is to use PAM for clear-text authentication only and to ignore any account or session management. Samba always ignores PAM for authentication in the case of \smbconfoption{encrypt passwords} = yes. The reason is that PAM modules cannot support the challenge/response authentication mechanism needed in the presence of SMB password encryption.

Default: \smbconfoption{obey pam restrictions} = no
\end{quote}
\subsection{Remote CIFS Authentication Using winbindd.\dbz{}so}
\label{id2616532}\hypertarget{id2616532}{}%

All operating systems depend on the provision of user credentials acceptable to the platform. UNIX requires the provision of a user identifier (UID) as well as a group identifier (GID). These are both simple integer numbers that are obtained from a password backend such as {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd}}}.

Users and groups on a Windows NT server are assigned a relative ID (RID) which is unique for the domain when the user or group is created. To convert the Windows NT user or group into a UNIX user or group, a mapping between RIDs and UNIX user and group IDs is required. This is one of the jobs that winbind performs.

As winbind users and groups are resolved from a server, user and group IDs are allocated from a specified range. This is done on a first come, first served basis, although all existing users and groups will be mapped as soon as a client performs a user or group enumeration command. The allocated UNIX IDs are stored in a database file under the Samba lock directory and will be remembered.

The astute administrator will realize from this that the combination of {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass.\dbz{}so}}}, {\bfseries{winbindd}}, and a distributed \smbconfoption{passdb backend} such as {\ttfamily\itshape{\docbookhyphenatedot{ldap}}} will allow the establishment of a centrally managed, distributed user/password database that can also be used by all PAM-aware (e.g., Linux) programs and applications. This arrangement can have particularly potent advantages compared with the use of Microsoft Active Directory Service (ADS) insofar as the reduction of wide-area network authentication traffic.

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The RID to UNIX ID database is the only location where the user and group mappings are stored by {\bfseries{winbindd}}. If this file is deleted or corrupted, there is no way for {\bfseries{winbindd}} to determine which user and group IDs correspond to Windows NT user and group RIDs.
\end{admonition}

\subsection{Password Synchronization Using pam\_\dbz{}smbpass.\dbz{}so}
\label{id2616624}\hypertarget{id2616624}{}%

{\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass}}} is a PAM module that can be used on conforming systems to keep the {\texttt{\docbookhyphenatefilename{smbpasswd}}} (Samba password) database in sync with the UNIX password file. PAM is an API supported under some UNIX operating systems, such as Solaris, HPUX, and Linux, that provides a generic interface to authentication mechanisms.

This module authenticates a local {\texttt{\docbookhyphenatefilename{smbpasswd}}} user database. If you require support for authenticating against a remote SMB server, or if you are concerned about the presence of SUID root binaries on your system, it is recommended that you use {\texttt{\docbookhyphenatefilename{pam\_\dbz{}winbind}}} instead.

Options recognized by this module are shown in \hyperlink{smbpassoptions}{Table {\ref{smbpassoptions}}}. 
% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{smbpassoptions}{}%
\captionswapskip{}{{\caption{Options recognized by pam\_smbpass}\label{smbpassoptions}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|}
\hline 
{{debug}} & {{Log more debugging info.}} \tabularnewline
 \hline 
{{audit}} & {{Like debug, but also logs unknown usernames.}} \tabularnewline
 \hline 
{{use\_first\_pass}} & {{Do not prompt the user for passwords; take them from PAM\_ items instead.}} \tabularnewline
 \hline 
{{try\_first\_pass}} & {{Try to get the password from a previous PAM module; fall back to prompting the user.}} \tabularnewline
 \hline 
{{use\_authtok}} & {{Like try\_first\_pass, but *fail* if the new PAM\_AUTHTOK has not been previously set (intended for stacking password modules only).}} \tabularnewline
 \hline 
{{not\_set\_pass}} & {{Do not make passwords used by this module available to other modules.}} \tabularnewline
 \hline 
{{nodelay}} & {{dDo not insert \textasciitilde{}1-second delays on authentication failure.}} \tabularnewline
 \hline 
{{nullok}} & {{Null passwords are allowed.}} \tabularnewline
 \hline 
{{nonull}} & {{Null passwords are not allowed. Used to override the Samba configuration.}} \tabularnewline
 \hline 
{{migrate}} & {{Only meaningful in an {``}auth{''} context; used to update smbpasswd file with a password used for successful authentication.}} \tabularnewline
 \hline 
{{smbconf={\ttfamily\itshape{\docbookhyphenatedot{file}}}}} & {{Specify an alternate path to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}



The following are examples of the use of {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass.\dbz{}so}}} in the format of the Linux {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}}}} files structure. Those wishing to implement this tool on other platforms will need to adapt this appropriately.
\subsubsection{Password Synchronization Configuration}
\label{id2616824}\hypertarget{id2616824}{}%

The following is a sample PAM configuration that shows the use of pam\_smbpass to make sure {\texttt{\docbookhyphenatefilename{private/\dbz{}smbpasswd}}} is kept in sync when {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}passwd (\dbz{}/\dbz{}etc/\dbz{}shadow)\dbz{}}}} is changed. It is useful when an expired password might be changed by an application (such as {\bfseries{ssh}}).


\begin{Verbatim}[]

#%PAM-1.0
# password-sync
#
auth       requisite    pam_nologin.so
auth       required     pam_unix.so
account    required     pam_unix.so
password   requisite    pam_cracklib.so retry=3
password   requisite    pam_unix.so shadow md5 use_authtok try_first_pass
password   required     pam_smbpass.so nullok use_authtok try_first_pass
session    required     pam_unix.so

\end{Verbatim}

\subsubsection{Password Migration Configuration}
\label{id2616867}\hypertarget{id2616867}{}%

The following PAM configuration shows the use of {\texttt{\docbookhyphenatefilename{pam\_\dbz{}smbpass}}} to migrate from plaintext to encrypted passwords for Samba. Unlike other methods, this can be used for users who have never connected to Samba shares: password migration takes place when users {\bfseries{ftp}} in, login using {\bfseries{ssh}}, pop their mail, and so on.


\begin{Verbatim}[]

#%PAM-1.0
# password-migration
#
auth       requisite   pam_nologin.so
# pam_smbpass is called IF pam_unix succeeds.
auth       requisite   pam_unix.so
auth       optional    pam_smbpass.so migrate
account    required    pam_unix.so
password   requisite   pam_cracklib.so retry=3
password   requisite   pam_unix.so shadow md5 use_authtok try_first_pass
password   optional    pam_smbpass.so nullok use_authtok try_first_pass
session    required    pam_unix.so

\end{Verbatim}

\subsubsection{Mature Password Configuration}
\label{id2616912}\hypertarget{id2616912}{}%

The following is a sample PAM configuration for a mature {\texttt{\docbookhyphenatefilename{smbpasswd}}} installation. {\texttt{\docbookhyphenatefilename{private/\dbz{}smbpasswd}}} is fully populated, and we consider it an error if the SMB password does not exist or does not match the UNIX password.


\begin{Verbatim}[]

#%PAM-1.0
# password-mature
#
auth       requisite    pam_nologin.so
auth       required     pam_unix.so
account    required     pam_unix.so
password   requisite    pam_cracklib.so retry=3
password   requisite    pam_unix.so shadow md5 use_authtok try_first_pass
password   required     pam_smbpass.so use_authtok use_first_pass
session    required     pam_unix.so

\end{Verbatim}

\subsubsection{Kerberos Password Integration Configuration}
\label{id2616948}\hypertarget{id2616948}{}%

The following is a sample PAM configuration that shows {\ttfamily\itshape{\docbookhyphenatedot{pam\_smbpass}}} used together with {\ttfamily\itshape{\docbookhyphenatedot{pam\_krb5}}}. This could be useful on a Samba PDC that is also a member of a Kerberos realm.


\begin{Verbatim}[]

#%PAM-1.0
# kdc-pdc
#
auth       requisite   pam_nologin.so
auth       requisite   pam_krb5.so
auth       optional    pam_smbpass.so migrate
account    required    pam_krb5.so
password   requisite   pam_cracklib.so retry=3
password   optional    pam_smbpass.so nullok use_authtok try_first_pass
password   required    pam_krb5.so use_authtok try_first_pass
session    required    pam_krb5.so

\end{Verbatim}


% ------------------------   
% Section 
\section{Common Errors}
\label{id2616988}\hypertarget{id2616988}{}%

PAM can be fickle and sensitive to configuration glitches. Here we look at a few cases from the Samba mailing list.
\subsection{pam\_winbind Problem}
\label{id2616998}\hypertarget{id2616998}{}%

A user reported, {\em{I have the following PAM configuration}}:


\begin{Verbatim}[]

auth required /lib/security/pam_securetty.so
auth sufficient /lib/security/pam_winbind.so
auth sufficient /lib/security/pam_unix.so use_first_pass nullok
auth required /lib/security/pam_stack.so service=system-auth
auth required /lib/security/pam_nologin.so
account required /lib/security/pam_stack.so service=system-auth
account required /lib/security/pam_winbind.so
password required /lib/security/pam_stack.so service=system-auth

\end{Verbatim}


{\em{When I open a new console with [ctrl][alt][F1], I can't log in with my user {``}pitie.{''} I have tried with user {``}scienceu\textbackslash pitie{''} also.}}

The problem may lie with the inclusion of {\ttfamily\itshape{\docbookhyphenatedot{pam\_stack.so service=system-auth}}}. That file often contains a lot of stuff that may duplicate what you are already doing. Try commenting out the {\ttfamily\itshape{\docbookhyphenatedot{pam\_stack}}} lines for {\ttfamily\itshape{\docbookhyphenatedot{auth}}} and {\ttfamily\itshape{\docbookhyphenatedot{account}}} and see if things work. If they do, look at {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}system-\dbz{}auth}}} and copy only what you need from it into your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}login}}} file. Alternatively, if you want all services to use Winbind, you can put the Winbind-specific stuff in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}pam.\dbz{}d/\dbz{}system-\dbz{}auth}}}.
\subsection{Winbind Is Not Resolving Users and Groups}
\label{id2617088}\hypertarget{id2617088}{}%

{``}My {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is correctly configured. I have specified \smbconfoption{idmap uid} = 12000 and \smbconfoption{idmap gid} = 3000-3500, and {\bfseries{winbind}} is running. When I do the following it all works fine.{''}


\begin{Verbatim}[]

root# wbinfo -u
MIDEARTH\maryo
MIDEARTH\jackb
MIDEARTH\ameds
...
MIDEARTH\root

root# wbinfo -g
MIDEARTH\Domain Users
MIDEARTH\Domain Admins
MIDEARTH\Domain Guests
...
MIDEARTH\Accounts

root# getent passwd
root:x:0:0:root:/root:/bin/bash
bin:x:1:1:bin:/bin:/bin/bash
...
maryo:x:15000:15003:Mary Orville:/home/MIDEARTH/maryo:/bin/false

\end{Verbatim}


{``}But this command fails:{''} 
\begin{Verbatim}[]

root# chown maryo a_file
chown: 'maryo': invalid user

\end{Verbatim}
 {``}This is driving me nuts! What can be wrong?{''}

Your system is likely running {\bfseries{nscd}}, the name service caching daemon. Shut it down, do not restart it! You will find your problem resolved.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Integrating MS Windows Networks with Samba 
% ------------------------------------------------------------- 	
\chapter{Integrating MS Windows Networks with Samba}
\label{integrate-ms-networks}\hypertarget{integrate-ms-networks}{}%

\index{NetBIOS} This chapter deals with NetBIOS over TCP/IP name to IP address resolution. If your MS Windows clients are not configured to use NetBIOS over TCP/IP, then this section does not apply to your installation. If your installation involves the use of NetBIOS over TCP/IP, then this chapter may help you to resolve networking problems.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{NetBEUI} \index{LLC} NetBIOS over TCP/IP has nothing to do with NetBEUI. NetBEUI is NetBIOS over Logical Link Control (LLC). On modern networks it is highly advised to not run NetBEUI at all. Note also that there is no such thing as NetBEUI over TCP/IP ---  the existence of such a protocol is a complete and utter misapprehension.
\end{admonition}


% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2517515}\hypertarget{id2517515}{}%

Many MS Windows network administrators have never been exposed to basic TCP/IP networking as it is implemented in a UNIX/Linux operating system. Likewise, many UNIX and Linux administrators have not been exposed to the intricacies of MS Windows TCP/IP-based networking (and may have no desire to be, either).

This chapter gives a short introduction to the basics of how a name can be resolved to its IP address for each operating system environment.

% ------------------------   
% Section 
\section{Background Information}
\label{id2589947}\hypertarget{id2589947}{}%

\index{NetBIOS over TCP/IP} \index{UDP port 137} \index{TCP port 139} \index{TCP port 445} \index{UDP port 137} Since the introduction of MS Windows 2000, it is possible to run MS Windows networking without the use of NetBIOS over TCP/IP. NetBIOS over TCP/IP uses UDP port 137 for NetBIOS name resolution and uses TCP port 139 for NetBIOS session services. When NetBIOS over TCP/IP is disabled on MS Windows 2000 and later clients, then only the TCP port 445 is used, and the UDP port 137 and TCP port 139 are not.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

When using Windows 2000 or later clients, if NetBIOS over TCP/IP is not disabled, then the client will use UDP port 137 (NetBIOS Name Service, also known as the Windows Internet Name Service, or WINS), TCP port 139, and TCP port 445 (for actual file and print traffic).
\end{admonition}


\index{DNS} \index{ADS} \index{DDNS} \index{SRV RR} \index{IXFR} \index{DHCP} When NetBIOS over TCP/IP is disabled, the use of DNS is essential. Most installations that disable NetBIOS over TCP/IP today use MS Active Directory Service (ADS). ADS requires \index{DNS!Dynamic} dynamic DNS with Service Resource Records (SRV RR) and with Incremental Zone Transfers (IXFR). \index{DHCP} Use of DHCP with ADS is recommended as a further means of maintaining central control over the client workstation network configuration.

% ------------------------   
% Section 
\section{Name Resolution in a Pure UNIX/Linux World}
\label{id2593254}\hypertarget{id2593254}{}%

The key configuration files covered in this section are:
\index{/etc/hosts}\index{/etc/resolv.conf}\index{/etc/host.conf}\index{/etc/nsswitch.conf}
\begin{itemize}
%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}resolv.\dbz{}conf}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}host.\dbz{}conf}}}


%--- Item
\item 
{\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}}

\end{itemize}
\subsection{/\dbz{}etc/\dbz{}hosts}
\label{id2589775}\hypertarget{id2589775}{}%

This file contains a static list of IP addresses and names. 
\begin{Verbatim}[]

127.0.0.1	localhost localhost.localdomain
192.168.1.1	bigbox.quenya.org	bigbox	alias4box

\end{Verbatim}


\index{/etc/hosts\textgreater{}} \index{name resolution} The purpose of {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} is to provide a name resolution mechanism so users do not need to remember IP addresses.

\index{IP addresses} \index{MAC address} \index{physical network transport layer} Network packets that are sent over the physical network transport layer communicate not via IP addresses but rather using the Media Access Control address, or MAC address. IP addresses are currently 32 bits in length and are typically presented as four decimal numbers that are separated by a dot (or period) ---  for example, 168.192.1.1.

\index{MAC Addresses} MAC addresses use 48 bits (or 6 bytes) and are typically represented as two-digit hexadecimal numbers separated by colons: 40:8e:0a:12:34:56.

Every network interface must have a MAC address. Associated with a MAC address may be one or more IP addresses. There is no relationship between an IP address and a MAC address; all such assignments are arbitrary or discretionary in nature. At the most basic level, all network communications take place using MAC addressing. Since MAC addresses must be globally unique and generally remain fixed for any particular interface, the assignment of an IP address makes sense from a network management perspective. More than one IP address can be assigned per MAC address. One address must be the primary IP address ---  this is the address that will be returned in the Address Resolution Protocol (ARP) reply.

\index{machine name} When a user or a process wants to communicate with another machine, the protocol implementation ensures that the {``}machine name{''} or {``}host name{''} is resolved to an IP address in a manner that is controlled by the TCP/IP configuration control files. The file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} is one such file.

\index{ARP/RARP} When the IP address of the destination interface has been determined, a protocol called ARP/RARP is used to identify the MAC address of the target interface. ARP is a broadcast-oriented method that uses User Datagram Protocol (UDP) to send a request to all interfaces on the local network segment using the all 1s MAC address. Network interfaces are programmed to respond to two MAC addresses only; their own unique address and the address ff:ff:ff:ff:ff:ff. The reply packet from an ARP request will contain the MAC address and the primary IP address for each interface.

\index{/etc/hosts} The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} file is foundational to all UNIX/Linux TCP/IP installations and as a minimum will contain the localhost and local network interface IP addresses and the primary names by which they are known within the local machine. This file helps to prime the pump so a basic level of name resolution can exist before any other method of name resolution becomes available.
\subsection{/\dbz{}etc/\dbz{}resolv.\dbz{}conf}
\label{id2589902}\hypertarget{id2589902}{}%

This file tells the name resolution libraries:

\begin{itemize}
%--- Item
\item 
The name of the domain to which the machine belongs.


%--- Item
\item 
The name(s) of any domains that should be automatically searched when trying to resolve unqualified host names to their IP address.


%--- Item
\item 
The name or IP address of available domain name servers that may be asked to perform name-to-address translation lookups.

\end{itemize}
\subsection{/\dbz{}etc/\dbz{}host.\dbz{}conf}
\label{id2589646}\hypertarget{id2589646}{}%

\index{/etc/host.conf} {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}host.\dbz{}conf}}} is the primary means by which the setting in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}resolv.\dbz{}conf}}} may be effected. It is a critical configuration file. This file controls the order by which name resolution may proceed. The typical structure is: 
\begin{Verbatim}[]

order hosts,bind
multi on

\end{Verbatim}


Both addresses should be returned. Please refer to the man page for {\texttt{\docbookhyphenatefilename{host.\dbz{}conf}}} for further details.
\subsection{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}
\label{id2589696}\hypertarget{id2589696}{}%

\index{/etc/nsswitch.conf} This file controls the actual name resolution targets. The file typically has resolver object specifications as follows: 
\begin{Verbatim}[]

# /etc/nsswitch.conf
#
# Name Service Switch configuration file.
#

passwd:		compat
# Alternative entries for password authentication are:
# passwd:	compat files nis ldap winbind
shadow:		compat
group:		compat

hosts:		files nis dns
# Alternative entries for host name resolution are:
# hosts:	files dns nis nis+ hesiod db compat ldap wins
networks:	nis files dns

ethers:		nis files
protocols:	nis files
rpc:		nis files
services:	nis files

\end{Verbatim}


Of course, each of these mechanisms requires that the appropriate facilities and/or services are correctly configured.

It should be noted that unless a network request/message must be sent, TCP/IP networks are silent. All TCP/IP communications assume a principal of speaking only when necessary.

\index{libnss\_wins.so} \index{NetBIOS names} \index{make} \index{/etc/nsswitch.conf} \index{wins} Starting with version 2.2.0, Samba has Linux support for extensions to the name service switch infrastructure so Linux clients will be able to obtain resolution of MS Windows NetBIOS names to IP addresses. To gain this functionality, Samba needs to be compiled with appropriate arguments to the make command (i.e., {\ttfamily\bfseries{\docbookhyphenatedot{make nsswitch/\dbz{}libnss\_\dbz{}wins.\dbz{}so}}}). The resulting library should then be installed in the {\texttt{\docbookhyphenatefilename{/\dbz{}lib}}} directory, and the {\ttfamily\itshape{\docbookhyphenatedot{wins}}} parameter needs to be added to the {``}hosts:{''} line in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}nsswitch.\dbz{}conf}}} file. At this point, it will be possible to ping any MS Windows machine by its NetBIOS machine name, as long as that machine is within the workgroup to which both the Samba machine and the MS Windows machine belong.

% ------------------------   
% Section 
\section{Name Resolution as Used within MS Windows Networking}
\label{id2612284}\hypertarget{id2612284}{}%

\index{computer name} \index{machine name} \index{NetBIOS name} \index{SMB name} MS Windows networking is predicated on the name each machine is given. This name is known variously (and inconsistently) as the {``}computer name,{''} {``}machine name,{''} {``}networking name,{''} {``}NetBIOS name,{''} or {``}SMB name.{''} All terms mean the same thing with the exception of {``}NetBIOS name,{''} which can also apply to the name of the workgroup or the domain name. The terms {``}workgroup{''} and {``}domain{''} are really just a simple name with which the machine is associated. All NetBIOS names are exactly 16 characters in length. The 16$^\text{th}$ character is reserved. It is used to store a 1-byte value that indicates service level information for the NetBIOS name that is registered. A NetBIOS machine name is therefore registered for each service type that is provided by the client/server.

\hyperlink{uniqnetbiosnames}{Table {\ref{uniqnetbiosnames}}} and \hyperlink{netbiosnamesgrp}{Table {\ref{netbiosnamesgrp}}} tables list typical NetBIOS name/service type registrations.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{uniqnetbiosnames}{}%
\captionswapskip{}{{\caption{Unique NetBIOS Names}\label{uniqnetbiosnames}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|X|}
\hline 
{{MACHINENAME\textless{}00\textgreater{}}} & {{Server Service is running on MACHINENAME}} \tabularnewline
 \hline 
{{MACHINENAME\textless{}03\textgreater{}}} & {{Generic machine name (NetBIOS name)}} \tabularnewline
 \hline 
{{MACHINENAME\textless{}20\textgreater{}}} & {{LanMan server service is running on MACHINENAME}} \tabularnewline
 \hline 
{{WORKGROUP\textless{}1b\textgreater{}}} & {{Domain master browser}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{netbiosnamesgrp}{}%
\captionswapskip{}{{\caption{Group Names}\label{netbiosnamesgrp}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|X|}
\hline 
{{WORKGROUP\textless{}03\textgreater{}}} & {{Generic name registered by all members of WORKGROUP}} \tabularnewline
 \hline 
{{WORKGROUP\textless{}1c\textgreater{}}} & {{Domain cntrollers/netlogon servers}} \tabularnewline
 \hline 
{{WORKGROUP\textless{}1d\textgreater{}}} & {{Local master browsers}} \tabularnewline
 \hline 
{{WORKGROUP\textless{}1e\textgreater{}}} & {{Browser election service}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}


\index{NetBIOS} It should be noted that all NetBIOS machines register their own names as per \hyperlink{uniqnetbiosnames}{Table {\ref{uniqnetbiosnames}}} and \hyperlink{netbiosnamesgrp}{Table {\ref{netbiosnamesgrp}}}. This is in vast contrast to TCP/IP installations where the system administrator traditionally determines in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} or in the DNS database what names are associated with each IP address.

\index{NetBIOS} \index{/etc/hosts} \index{NetBIOS name} One further point of clarification should be noted. The {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} file and the DNS records do not provide the NetBIOS name information that MS Windows clients depend on to locate the type of service that may be needed. An example of this is what happens when an MS Windows client wants to locate a domain logon server. It finds this service and the IP address of a server that provides it by performing a lookup (via a NetBIOS broadcast) for enumeration of all machines that have registered the name type *\textless{}1C\textgreater{}. A logon request is then sent to each IP address that is returned in the enumerated list of IP addresses. Whichever machine first replies, it then ends up providing the logon services.

\index{domain} \index{workgroup} The name {``}workgroup{''} or {``}domain{''} really can be confusing, since these have the added significance of indicating what is the security architecture of the MS Windows network. The term {``}workgroup{''} indicates that the primary nature of the network environment is that of a peer-to-peer design. In a workgroup, all machines are responsible for their own security, and generally such security is limited to the use of just a password (known as share-level security). In most situations with peer-to-peer networking, the users who control their own machines will simply opt to have no security at all. It is possible to have user-level security in a workgroup environment, thus requiring the use of a username and a matching password.

\index{SMB} \index{Network Basic Input/Output System|textit{see} {NetBIOS} } \index{Logical Link Control|textit{see} {LLC} } \index{Network Basic Extended User Interface|textit{see} {NetBEUI} } \index{Internetworking Packet Exchange|textit{see} {IPX} } \index{NetWare} \index{NetBT} \index{NBT} MS Windows networking is thus predetermined to use machine names for all local and remote machine message passing. The protocol used is called Server Message Block (SMB), and this is implemented using the NetBIOS protocol (Network Basic Input/Output System). NetBIOS can be encapsulated using LLC (Logical Link Control) protocol ---  in which case the resulting protocol is called NetBEUI (Network Basic Extended User Interface). NetBIOS can also be run over IPX (Internetworking Packet Exchange) protocol as used by Novell NetWare, and it can be run over TCP/IP protocols ---  in which case the resulting protocol is called NBT or NetBT, the NetBIOS over TCP/IP.

MS Windows machines use a complex array of name resolution mechanisms. Since we are primarily concerned with TCP/IP, this demonstration is limited to this area.
\subsection{The NetBIOS Name Cache}
\label{id2615364}\hypertarget{id2615364}{}%

\index{n-memory buffer} \index{local cache} \index{} All MS Windows machines employ an in-memory buffer in which is stored the NetBIOS names and IP addresses for all external machines that machine has communicated with over the past 10 to 15 minutes. It is more efficient to obtain an IP address for a machine from the local cache than it is to go through all the configured name resolution mechanisms.

\index{name lookup} If a machine whose name is in the local name cache is shut down before the name is expired and flushed from the cache, then an attempt to exchange a message with that machine will be subject to timeout delays. Its name is in the cache, so a name resolution lookup will succeed, but the machine cannot respond. This can be frustrating for users but is a characteristic of the protocol.

\index{nbtstat} \index{nmblookup} \index{NetBIOS} The MS Windows utility that allows examination of the NetBIOS name cache is called {``}nbtstat.{''} The Samba equivalent is called {\bfseries{nmblookup}}.
\subsection{The LMHOSTS File}
\label{id2615453}\hypertarget{id2615453}{}%

\index{LMHOSTS} This file is usually located in MS Windows NT 4.0 or Windows 200x/XP in the directory {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\SYSTEM32\docbooktolatexgobble\string\\DRIVERS\docbooktolatexgobble\string\\ETC}}} and contains the IP address and the machine name in matched pairs. The {\texttt{\docbookhyphenatefilename{LMHOSTS}}} file performs NetBIOS name to IP address mapping.

It typically looks like this:


\begin{Verbatim}[]

# Copyright (c) 1998 Microsoft Corp.
#
# This is a sample LMHOSTS file used by the Microsoft Wins Client (NetBIOS
# over TCP/IP) stack for Windows98
#
# This file contains the mappings of IP addresses to NT computer names
# (NetBIOS) names. Each entry should be kept on an individual line.
# The IP address should be placed in the first column followed by the
# corresponding computer name. The address and the computer name
# should be separated by at least one space or tab. The "#" character
# is generally used to denote the start of a comment (see the exceptions
# below).
#
# This file is compatible with Microsoft LAN Manager 2.x TCP/IP lmhosts
# files and offers the following extensions:
#
#      #PRE
#      #DOM:<domain>
#      #INCLUDE <filename>
#      #BEGIN_ALTERNATE
#      #END_ALTERNATE
#      \0xnn (non-printing character support)
#
# Following any entry in the file with the characters "#PRE" will cause
# the entry to be preloaded into the name cache. By default, entries are
# not preloaded, but are parsed only after dynamic name resolution fails.
#
# Following an entry with the "#DOM:<domain>" tag will associate the
# entry with the domain specified by <domain>. This effects how the
# browser and logon services behave in TCP/IP environments. To preload
# the host name associated with #DOM entry, it is necessary to also add a
# #PRE to the line. The <domain> is always pre-loaded although it will not
# be shown when the name cache is viewed.
#
# Specifying "#INCLUDE <filename>" will force the RFC NetBIOS (NBT)
# software to seek the specified <filename> and parse it as if it were
# local. <filename> is generally a UNC-based name, allowing a
# centralized lmhosts file to be maintained on a server.
# It is ALWAYS necessary to provide a mapping for the IP address of the
# server prior to the #INCLUDE. This mapping must use the #PRE directive.
# In addition the share "public" in the example below must be in the
# LanMan Server list of "NullSessionShares" in order for client machines to
# be able to read the lmhosts file successfully. This key is under
# \machine\system\currentcontrolset\services\lanmanserver\
# parameters\nullsessionshares
# in the registry. Simply add "public" to the list found there.
#
# The #BEGIN_ and #END_ALTERNATE keywords allow multiple #INCLUDE
# statements to be grouped together. Any single successful include
# will cause the group to succeed.
#
# Finally, non-printing characters can be embedded in mappings by
# first surrounding the NetBIOS name in quotations, then using the
# \0xnn notation to specify a hex value for a non-printing character.
#
# The following example illustrates all of these extensions:
#
# 102.54.94.97     rhino     #PRE #DOM:networking  #net group's DC
# 102.54.94.102    "appname  \0x14"       #special app server
# 102.54.94.123    popular   #PRE         #source server
# 102.54.94.117    localsrv  #PRE         #needed for the include
#
# #BEGIN_ALTERNATE
# #INCLUDE \\localsrv\public\lmhosts
# #INCLUDE \\rhino\public\lmhosts
# #END_ALTERNATE
#
# In the above example, the "appname" server contains a special
# character in its name, the "popular" and "localsrv" server names are
# pre-loaded, and the "rhino" server name is specified so it can be used
# to later #INCLUDE a centrally maintained lmhosts file if the "localsrv"
# system is unavailable.
#
# Note that the whole file is parsed including comments on each lookup,
# so keeping the number of comments to a minimum will improve performance.
# Therefore it is not advisable to simply add lmhosts file entries onto the
# end of this file.

\end{Verbatim}

\subsection{HOSTS File}
\label{id2615556}\hypertarget{id2615556}{}%

This file is usually located in MS Windows NT 4.0 or Windows 200x/XP in the directory {\texttt{\docbookhyphenatefilename{\%SystemRoot\%\docbooktolatexgobble\string\\SYSTEM32\docbooktolatexgobble\string\\DRIVERS\docbooktolatexgobble\string\\ETC}}} and contains the IP address and the IP hostname in matched pairs. It can be used by the name resolution infrastructure in MS Windows, depending on how the TCP/IP environment is configured. This file is in every way the equivalent of the UNIX/Linux {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} file.
\subsection{DNS Lookup}
\label{id2577155}\hypertarget{id2577155}{}%

\index{DNS} This capability is configured in the TCP/IP setup area in the network configuration facility. If enabled, an elaborate name resolution sequence is followed, the precise nature of which is dependent on how the NetBIOS Node Type parameter is configured. A Node Type of 0 means that NetBIOS broadcast (over UDP broadcast) is used if the name that is the subject of a name lookup is not found in the NetBIOS name cache. If that fails, then DNS, HOSTS, and LMHOSTS are checked. If set to Node Type 8, then a NetBIOS Unicast (over UDP Unicast) is sent to the WINS server to obtain a lookup before DNS, HOSTS, LMHOSTS, or broadcast lookup is used.
\subsection{WINS Lookup}
\label{id2577184}\hypertarget{id2577184}{}%

\index{WINS} \index{Windows Internet Name Server|textit{see} {WINS} } \index{NetBIOS Name Server|textit{see} {NBNS} } A WINS (Windows Internet Name Server) service is the equivalent of the rfc1001/1002 specified NBNS (NetBIOS Name Server). A WINS server stores the names and IP addresses that are registered by a Windows client if the TCP/IP setup has been given at least one WINS server IP address.

To configure Samba to be a WINS server, the following parameter needs to be added to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	wins support = Yes
\end{lstlisting}


\index{WINS} To configure Samba to use a WINS server, the following parameters are needed in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	wins support = No
 	wins server = xxx.xxx.xxx.xxx
\end{lstlisting}


where {\ttfamily\itshape{\docbookhyphenatedot{xxx.xxx.xxx.xxx}}} is the IP address of the WINS server.

For information about setting up Samba as a WINS server, read \hyperlink{NetworkBrowsing}{Chapter {\ref{NetworkBrowsing}}, {``}Network Browsing{''}}.

% ------------------------   
% Section 
\section{Common Errors}
\label{id2577300}\hypertarget{id2577300}{}%

TCP/IP network configuration problems find every network administrator sooner or later. The cause can be anything from keyboard mishaps to forgetfulness to simple mistakes to carelessness. Of course, no one is ever deliberately careless!
\subsection{Pinging Works Only One Way}
\label{id2577313}\hypertarget{id2577313}{}%

{``}I can ping my Samba server from Windows, but I cannot ping my Windows machine from the Samba server.{''}

The Windows machine was at IP address 192.168.1.2 with netmask 255.255.255.0, the Samba server (Linux) was at IP address 192.168.1.130 with netmask 255.255.255.128. The machines were on a local network with no external connections.

Due to inconsistent netmasks, the Windows machine was on network 192.168.1.0/24, while the Samba server was on network 192.168.1.128/25 ---  logically a different network.
\subsection{Very Slow Network Connections}
\label{id2577346}\hypertarget{id2577346}{}%

A common cause of slow network response includes:

\begin{itemize}
%--- Item
\item 
Client is configured to use DNS and the DNS server is down.


%--- Item
\item 
Client is configured to use remote DNS server, but the remote connection is down.


%--- Item
\item 
Client is configured to use a WINS server, but there is no WINS server.


%--- Item
\item 
Client is not configured to use a WINS server, but there is a WINS server.


%--- Item
\item 
Firewall is filtering out DNS or WINS traffic.

\end{itemize}
\subsection{Samba Server Name-Change Problem}
\label{id2577390}\hypertarget{id2577390}{}%

{``}The name of the Samba server was changed, Samba was restarted, and now the Samba server cannot be pinged by its new name from an MS Windows NT4 workstation, but it does still respond to pinging using the old name. Why?{''}

From this description, three things are obvious:

\begin{itemize}
%--- Item
\item 
WINS is not in use; only broadcast-based name resolution is used.


%--- Item
\item 
The Samba server was renamed and restarted within the last 10 or 15 minutes.


%--- Item
\item 
The old Samba server name is still in the NetBIOS name cache on the MS Windows NT4 workstation.

\end{itemize}

To find what names are present in the NetBIOS name cache on the MS Windows NT4 machine, open a {\bfseries{cmd}} shell and then:


\begin{Verbatim}[]

C:\> nbtstat -n

              NetBIOS Local Name Table

   Name                 Type          Status
------------------------------------------------
FRODO            <03>  UNIQUE      Registered
ADMINISTRATOR     <03>  UNIQUE      Registered
FRODO            <00>  UNIQUE      Registered
SARDON           <00>  GROUP       Registered
FRODO            <20>  UNIQUE      Registered
FRODO            <1F>  UNIQUE      Registered


C:\> nbtstat -c

             NetBIOS Remote Cache Name Table

   Name                 Type       Host Address     Life [sec]
--------------------------------------------------------------
GANDALF	<20>  UNIQUE      192.168.1.1          240

C:\> 

\end{Verbatim}


In this example, GANDALF is the Samba server and FRODO is the MS Windows NT4 workstation. The first listing shows the contents of the Local Name Table (i.e., identity information on the MS Windows workstation), and the second shows the NetBIOS name in the NetBIOS name cache. The name cache contains the remote machines known to this workstation.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Unicode/Charsets 
% ------------------------------------------------------------- 	
\chapter{Unicode/Charsets}
\label{unicode}\hypertarget{unicode}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2579924}\hypertarget{id2579924}{}%

\index{use computer anywhere} Every industry eventually matures. One of the great areas of maturation is in the focus that has been given over the past decade to make it possible for anyone anywhere to use a computer. It has not always been that way. In fact, not so long ago, it was common for software to be written for exclusive use in the country of origin.

Of all the effort that has been brought to bear on providing native language support for all computer users, the efforts of the Openi18n organization\label{id2579949}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.openi18n.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2579949} is deserving of special mention.

\index{codepages} Samba-2.x supported a single locale through a mechanism called {\em{codepages}}. Samba-3 is destined to become a truly transglobal file- and printer-sharing platform.

% ------------------------   
% Section 
\section{What Are Charsets and Unicode?}
\label{id2579974}\hypertarget{id2579974}{}%

\index{character set} Computers communicate in numbers. In texts, each number is translated to a corresponding letter. The meaning that will be assigned to a certain number depends on the {\em{character set (charset)}} that is used.

\index{charset} \index{ASCII} A charset can be seen as a table that is used to translate numbers to letters. Not all computers use the same charset (there are charsets with German umlauts, Japanese characters, and so on). The American Standard Code for Information Interchange (ASCII) encoding system has been the normative character encoding scheme used by computers to date. This employs a charset that contains 256 characters. Using this mode of encoding, each character takes exactly one byte.

\index{multibyte charsets} \index{extended characters} There are also charsets that support extended characters, but those need at least twice as much storage space as does ASCII encoding. Such charsets can contain {\bfseries{256 * 256 = 65536}} characters, which is more than all possible characters one could think of. They are called multibyte charsets because they use more then one byte to store one character.

\index{unicode} One standardized multibyte charset encoding scheme is known as unicode\label{id2589415}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.unicode.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2589415}. A big advantage of using a multibyte charset is that you only need one. There is no need to make sure two computers use the same charset when they are communicating.

\index{single-byte charsets} \index{SMB/CIFS} \index{negotiating the charset} Old Windows clients use single-byte charsets, named {\ttfamily\itshape{\docbookhyphenatedot{codepages}}}, by Microsoft. However, there is no support for negotiating the charset to be used in the SMB/CIFS protocol. Thus, you have to make sure you are using the same charset when talking to an older client. Newer clients (Windows NT, 200x, XP) talk Unicode over the wire.

% ------------------------   
% Section 
\section{Samba and Charsets}
\label{id2589461}\hypertarget{id2589461}{}%

\index{Unicode} \index{character sets} As of Samba-3, Samba can (and will) talk Unicode over the wire. Internally, Samba knows of three kinds of character sets:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{unix charset}}]\null{}
\index{UTF-8} \index{CP850} This is the charset used internally by your operating system. The default is {\texttt{\docbookhyphenatedot{UTF-8}}}, which is fine for most systems and covers all characters in all languages. The default in previous Samba releases was to save filenames in the encoding of the clients ---  for example, CP850 for Western European countries.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{display charset}}]\null{}
This is the charset Samba uses to print messages on your screen. It should generally be the same as the {\ttfamily\itshape{\docbookhyphenatedot{unix charset}}}.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{\smbconfoption{dos charset}}]\null{}
This is the charset Samba uses when communicating with DOS and Windows 9x/Me clients. It will talk Unicode to all newer clients. The default depends on the charsets you have installed on your system. Run {\bfseries{testparm -v \docbooktolatexpipe{} grep "dos charset"}} to see what the default is on your system.
\end{description}

% ------------------------   
% Section 
\section{Conversion from Old Names}
\label{id2580321}\hypertarget{id2580321}{}%

\index{charset conversion} Because previous Samba versions did not do any charset conversion, characters in filenames are usually not correct in the UNIX charset but only for the local charset used by the DOS/Windows clients.

Bjoern Jacke has written a utility named convmv\label{id2580343}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://j3e.de/linux/convmv/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2580343} that can convert whole directory structures to different charsets with one single command.

% ------------------------   
% Section 
\section{Japanese Charsets}
\label{id2580353}\hypertarget{id2580353}{}%

Setting up Japanese charsets is quite difficult. This is mainly because:

\begin{itemize}
%--- Item
\item 
\index{JIS X 0208} The Windows character set is extended from the original legacy Japanese standard (JIS X 0208) and is not standardized. This means that the strictly standardized implementation cannot support the full Windows character set.


%--- Item
\item 
\index{Shift\_JIS} \index{EUC-JP} \index{CAP} \index{HEX} \index{Japanese} Mainly for historical reasons, there are several encoding methods in Japanese, which are not fully compatible with each other. There are two major encoding methods. One is the Shift\_JIS series used in Windows and some UNIXes. The other is the EUC-JP series used in most UNIXes and Linux. Moreover, Samba previously also offered several unique encoding methods, named CAP and HEX, to keep interoperability with CAP/NetAtalk and UNIXes that can't use Japanese filenames. Some implementations of the EUC-JP series can't support the full Windows character set.


%--- Item
\item 
There are some code conversion tables between Unicode and legacy Japanese character sets. One is compatible with Windows, another one is based on the reference of the Unicode consortium, and others are a mixed implementation. The Unicode consortium does not officially define any conversion tables between Unicode and legacy character sets, so there cannot be standard one.


%--- Item
\item 
The character set and conversion tables available in iconv() depend on the iconv library that is available. Next to that, the Japanese locale names may be different on different systems. This means that the value of the charset parameters depends on the implementation of iconv() you are using.

\index{UCS-2} \index{Shift\_JIS} \index{ASCII} \index{English} Though 2-byte fixed UCS-2 encoding is used in Windows internally, Shift\_JIS series encoding is usually used in Japanese environments as ASCII encoding is in English environments.

\end{itemize}
\subsection{Basic Parameter Setting}
\label{id2580468}\hypertarget{id2580468}{}%

\index{CP932} The \smbconfoption{dos charset} and \smbconfoption{display charset} should be set to the locale compatible with the character set and encoding method used on Windows. This is usually CP932 but sometimes has a different name.

\index{Shift\_JIS} \index{UTF-8} \index{EUC-JP} The \smbconfoption{unix charset} can be either Shift\_JIS series, EUC-JP series, or UTF-8. UTF-8 is always available, but the availability of other locales and the name itself depends on the system.

Additionally, you can consider using the Shift\_JIS series as the value of the \smbconfoption{unix charset} parameter by using the vfs\_cap module, which does the same thing as setting {``}coding system = CAP{''} in the Samba 2.2 series.

Where to set \smbconfoption{unix charset} to is a difficult question. Here is a list of details, advantages, and disadvantages of using a certain value.

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Shift\_JIS series}]\null{}
Shift\_JIS series means a locale that is equivalent to {\texttt{\docbookhyphenatedot{Shift\_JIS}}}, used as a standard on Japanese Windows. In the case of {\texttt{\docbookhyphenatedot{Shift\_JIS}}}, for example, if a Japanese filename consists of 0x8ba4 and 0x974c (a 4-bytes Japanese character string meaning {``}share{''}) and {``}.txt{''} is written from Windows on Samba, the filename on UNIX becomes 0x8ba4, 0x974c, {``}.txt{''} (an 8-byte BINARY string), same as Windows.

Since Shift\_JIS series is usually used on some commercial-based UNIXes; hp-ux and AIX as the Japanese locale (however, it is also possible to use the EUC-JP locale series). To use Shift\_JIS series on these platforms, Japanese filenames created from Windows can be referred to also on UNIX.

If your UNIX is already working with Shift\_JIS and there is a user who needs to use Japanese filenames written from Windows, the Shift\_JIS series is the best choice. However, broken filenames may be displayed, and some commands that cannot handle non-ASCII filenames may be aborted during parsing filenames. Especially, there may be {``}\textbackslash \ (0x5c){''} in filenames, which need to be handled carefully. It is best to not touch filenames written from Windows on UNIX.

Note that most Japanized free software actually works with EUC-JP only. It is good practice to verify that the Japanized free software can work with Shift\_JIS.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{EUC-JP series}]\null{}
\index{EUC-JP} \index{Japanese UNIX} EUC-JP series means a locale that is equivalent to the industry standard called EUC-JP, widely used in Japanese UNIX (although EUC contains specifications for languages other than Japanese, such as EUC-KR). In the case of EUC-JP series, for example, if a Japanese filename consists of 0x8ba4 and 0x974c and {``}.txt{''} is written from Windows on Samba, the filename on UNIX becomes 0xb6a6, 0xcdad, {``}.txt{''} (an 8-byte BINARY string).

\index{EUC-JP} \index{UNIX} \index{Linux} \index{FreeBSD} \index{Solaris} \index{IRIX} \index{Tru64 UNIX} \index{Japanese locale} \index{Shift\_JIS} \index{UTF-8} Since EUC-JP is usually used on open source UNIX, Linux, and FreeBSD, and on commercial-based UNIX, Solaris, IRIX, and Tru64 UNIX as Japanese locale (however, it is also possible on Solaris to use Shift\_JIS and UTF-8, and on Tru64 UNIX it is possible to use Shift\_JIS). To use EUC-JP series, most Japanese filenames created from Windows can be referred to also on UNIX. Also, most Japanized free software works mainly with EUC-JP only.

It is recommended to choose EUC-JP series when using Japanese filenames on UNIX.

Although there is no character that needs to be carefully treated like {``}\textbackslash \ (0x5c){''}, broken filenames may be displayed and some commands that cannot handle non-ASCII filenames may be aborted during parsing filenames.

\index{eucJP-ms locale} Moreover, if you built Samba using differently installed libiconv, the eucJP-ms locale included in libiconv and EUC-JP series locale included in the operating system may not be compatible. In this case, you may need to avoid using incompatible characters for filenames.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{UTF-8}]\null{}
UTF-8 means a locale equivalent to UTF-8, the international standard defined by the Unicode consortium. In UTF-8, a {\ttfamily\itshape{\docbookhyphenatedot{character}}} is expressed using 1 to 3 bytes. In case of the Japanese language, most characters are expressed using 3 bytes. Since on Windows Shift\_JIS, where a character is expressed with 1 or 2 bytes is used to express Japanese, basically a byte length of a UTF-8 string the length of the UTF-8 string is 1.5 times that of the original Shift\_JIS string. In the case of UTF-8, for example, if a Japanese filename consists of 0x8ba4 and 0x974c, and {``}.txt{''} is written from Windows on Samba, the filename on UNIX becomes 0xe585, 0xb1e6, 0x9c89, {``}.txt{''} (a 10-byte BINARY string).

For systems where iconv() is not available or where iconv()'s locales are not compatible with Windows, UTF-8 is the only locale available.

There are no systems that use UTF-8 as the default locale for Japanese.

Some broken filenames may be displayed, and some commands that cannot handle non-ASCII filenames may be aborted during parsing filenames. Especially, there may be {``}\textbackslash \ (0x5c){''} in filenames, which must be handled carefully, so you had better not touch filenames written from Windows on UNIX.

\index{Windows} \index{Java} \index{Unicode UTF-8} In addition, although it is not directly concerned with Samba, since there is a delicate difference between the iconv() function, which is generally used on UNIX, and the functions used on other platforms, such as Windows and Java, so far is concerens the conversion between Shift\_JIS and Unicode UTF-8 must be done with care and recognition of the limitations involved in the process.

\index{Mac OS X} Although Mac OS X uses UTF-8 as its encoding method for filenames, it uses an extended UTF-8 specification that Samba cannot handle, so UTF-8 locale is not available for Mac OS X.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Shift\_JIS series + vfs\_cap (CAP encoding)}]\null{}
\index{CAP} \index{NetAtalk} \index{Macintosh} CAP encoding means a specification used in CAP and NetAtalk, file server software for Macintosh. In the case of CAP encoding, for example, if a Japanese filename consists of 0x8ba4 and 0x974c, and {``}.txt{''} is written from Windows on Samba, the filename on UNIX becomes {``}:8b:a4:97L.txt{''} (a 14 bytes ASCII string).

For CAP encoding, a byte that cannot be expressed as an ASCII character (0x80 or above) is encoded in an {``}:xx{''} form. You need to take care of containing a {``}\textbackslash (0x5c){''} in a filename, but filenames are not broken in a system that cannot handle non-ASCII filenames.

The greatest merit of CAP encoding is the compatibility of encoding filenames with CAP or NetAtalk. These are respectively the Columbia Appletalk Protocol, and the NetAtalk Open Source software project. Since these software applications write a file name on UNIX with CAP encoding, if a directory is shared with both Samba and NetAtalk, you need to use CAP encoding to avoid non-ASCII filenames from being broken.

However, recently, NetAtalk has been patched on some systems to write filenames with EUC-JP (e.g., Japanese original Vine Linux). In this case, you need to choose EUC-JP series instead of CAP encoding.

vfs\_cap itself is available for non-Shift\_JIS series locales for systems that cannot handle non-ASCII characters or systems that share files with NetAtalk.

To use CAP encoding on Samba-3, you should use the unix charset parameter and VFS as in \hyperlink{vfscap-intl}{Example {\ref{vfscap-intl}}}.

\begin{example}%
\hypertarget{vfscap-intl}{}%
\captionswapskip{}{{\caption{VFS CAP}\label{vfscap-intl}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 # the locale name "CP932" may be different
 	dos charset = CP932
 	unix charset = CP932
 [cap-share]
 	vfs option = cap
\end{lstlisting}
\end{example}


\index{CP932} \index{libiconv} \index{unix charset} \index{cap-share} You should set CP932 if using GNU libiconv for unix charset. With this setting, filenames in the {``}cap-share{''} share are written with CAP encoding.
\end{description}
\subsection{Individual Implementations}
\label{id2617350}\hypertarget{id2617350}{}%

Here is some additional information regarding individual implementations:

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{GNU libiconv}]\null{}
To handle Japanese correctly, you should apply the patch libiconv-1.8-cp932-patch.diff.gz\label{id2617371}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www2d.biglobe.ne.jp/~msyk/software/libiconv-patch.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2617371} to libiconv-1.8.

Using the patched libiconv-1.8, these settings are available:
\null{}
\begin{Verbatim}[]

dos charset = CP932
unix charset = CP932 / eucJP-ms / UTF-8
		|       |
		|       +-- EUC-JP series
		+-- Shift_JIS series
display charset = CP932

\end{Verbatim}

Other Japanese locales (for example, Shift\_JIS and EUC-JP) should not be used because of the lack of the compatibility with Windows.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{GNU glibc}]\null{}
To handle Japanese correctly, you should apply a patch\label{id2617409}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www2d.biglobe.ne.jp/~msyk/software/glibc/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2617409} to glibc-2.2.5/2.3.1/2.3.2 or should use the patch-merged versions, glibc-2.3.3 or later.

Using the above glibc, these setting are available: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
	dos charset = CP932
 	unix charset = CP932 / eucJP-ms / UTF-8
 	display charset = CP932
\end{lstlisting}


Other Japanese locales (for example, Shift\_JIS and EUC-JP) should not be used because of the lack of the compatibility with Windows.
\end{description}
\subsection{Migration from Samba-2.2 Series}
\label{id2617456}\hypertarget{id2617456}{}%

Prior to Samba-2.2 series, the {``}coding system{''} parameter was used. The default codepage in Samba 2.x was code page 850. In the Samba-3 series this has been replaced with the \smbconfoption{unix charset} parameter. \hyperlink{japancharsets}{Table {\ref{japancharsets}}} shows the mapping table when migrating from the Samba-2.2 series to Samba-3.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{japancharsets}{}%
\captionswapskip{}{{\caption{Japanese Character Sets in Samba-2.2 and Samba-3}\label{japancharsets}}}
\captionswapskip{}\begin{minipage}{\linewidth}
\begin{tabular}{|c|c|}
\hline 
{{{\bfseries Samba-2.2 Coding System}}} & {{{\bfseries Samba-3 unix charset}}} \tabularnewline
 \hline 
{{SJIS}} & {{Shift\_JIS series}} \tabularnewline
 \hline 
{{EUC}} & {{EUC-JP series}} \tabularnewline
 \hline 
{{EUC3\label{id2591498}\begingroup\catcode`\#=12\footnote{
Only exists in Japanese Samba version
}\endgroup\docbooktolatexmakefootnoteref{id2591498}}} & {{EUC-JP series}} \tabularnewline
 \hline 
{{CAP}} & {{Shift\_JIS series + VFS}} \tabularnewline
 \hline 
{{HEX}} & {{currently none}} \tabularnewline
 \hline 
{{UTF8}} & {{UTF-8}} \tabularnewline
 \hline 
{{UTF8-Mac\label{id2591531}\begingroup\catcode`\#=12\footnote{
Only exists in Japanese Samba version
}\endgroup\docbooktolatexmakefootnoteref{id2591531}}} & {{currently none}} \tabularnewline
 \hline 
{{others}} & {{none}} \tabularnewline
\hline 
\end{tabular}
\end{minipage}
\end{center}
\end{table}


% ------------------------   
% Section 
\section{Common Errors}
\label{id2591553}\hypertarget{id2591553}{}%
\subsection{CP850.so Can't Be Found}
\label{id2591559}\hypertarget{id2591559}{}%

{``}Samba is complaining about a missing {\texttt{\docbookhyphenatefilename{CP850.\dbz{}so}}} file.{''}

CP850 is the default \smbconfoption{dos charset}. The \smbconfoption{dos charset} is used to convert data to the codepage used by your DOS clients. If you do not have any DOS clients, you can safely ignore this message.

CP850 should be supported by your local iconv implementation. Make sure you have all the required packages installed. If you compiled Samba from source, make sure that the configure process found iconv. This can be confirmed by checking the {\texttt{\docbookhyphenatefilename{config.\dbz{}log}}} file that is generated when {\bfseries{configure}} is executed.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Backup Techniques 
% ------------------------------------------------------------- 	
\chapter{Backup Techniques}
\label{Backup}\hypertarget{Backup}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2519630}\hypertarget{id2519630}{}%

\index{backup} \index{UNIX system files} \index{system tools} \index{Samba mailing lists} The Samba project is over 10 years old. During the early history of Samba, UNIX administrators were its key implementors. UNIX administrators use UNIX system tools to backup UNIX system files. Over the past 4 years, an increasing number of Microsoft network administrators have taken an interest in Samba. This is reflected in the questions about backup in general on the Samba mailing lists.

% ------------------------   
% Section 
\section{Discussion of Backup Solutions}
\label{id2430540}\hypertarget{id2430540}{}%

\index{Meccano set} \index{training course} During discussions at a Microsoft Windows training course, one of the pro-UNIX delegates stunned the class when he pointed out that Windows NT4 is limiting compared with UNIX. He likened UNIX to a Meccano set that has an unlimited number of tools that are simple, efficient, and, in combination, capable of achieving any desired outcome.

\index{networking advocates} \index{clear purpose preferred} One of the Windows networking advocates retorted that if she wanted a Meccano set, she would buy one. She made it clear that a complex single tool that does more than is needed but does it with a clear purpose and intent is preferred by some like her.

\index{due diligence} \index{research} \index{backup solution} Please note that all information here is provided as is and without recommendation of fitness or suitability. The network administrator is strongly encouraged to perform due diligence research before implementing any backup solution, whether free software or commercial.

A useful Web site I recently stumbled across that you might like to refer to is located at www.allmerchants.com\label{id2563092}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.allmerchants.com/Software/Backup_Software/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2563092}.

The following three free software projects might also merit consideration.
\subsection{BackupPC}
\label{id2563107}\hypertarget{id2563107}{}%

\index{BackupPC} \index{rsync} \index{rsyncd} BackupPC version 2.0.0 has been released on SourceForge\label{id2563138}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://backuppc.sourceforge.net}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2563138}. New features include support for {\bfseries{rsync/rsyncd}} and internationalization of the CGI interface (including English, French, Spanish, and German).

\index{BackupPC} \index{laptops} \index{SMB} \index{smbclient} \index{tar} \index{rsh} \index{ssh} \index{rsync} BackupPC is a high-performance Perl-based package for backing up Linux, UNIX, and Windows PCs and laptops to a server's disk. BackupPC is highly configurable and easy to install and maintain. SMB (via smbclient), {\bfseries{tar}} over {\bfseries{rsh/ssh}}, or {\bfseries{rsync/rsyncd}} are used to extract client data.

\index{RAID} \index{local disk} \index{network storage} Given the ever-decreasing cost of disks and RAID systems, it is now practical and cost effective to backup a large number of machines onto a server's local disk or network storage. This is what BackupPC does.

Key features are pooling of identical files (big savings in server disk space), compression, and a comprehensive CGI interface that allows users to browse backups and restore files.

\index{GNU GPL} BackupPC is free software distributed under a GNU GPL license. BackupPC runs on Linux/UNIX/freenix servers and has been tested on Linux, UNIX, Windows 9x/Me, Windows 98, Windows 200x, Windows XP, and Mac OSX clients.
\subsection{Rsync}
\label{id2577603}\hypertarget{id2577603}{}%

\index{rsync} \index{ftp} \index{http} \index{scp} \index{rcp} \index{checksum-search} {\bfseries{rsync}} is a flexible program for efficiently copying files or directory trees.

{\bfseries{rsync}} has many options to select which files will be copied and how they are to be transferred. It may be used as an alternative to {\bfseries{ftp, http, scp}}, or {\bfseries{rcp}}.

\index{remote-update protocol} \index{transfer differences} \index{differences} The rsync remote-update protocol allows rsync to transfer just the differences between two sets of files across the network link, using an efficient checksum-search algorithm described in the technical report that accompanies the rsync package.

Some of the additional features of rsync are:

\begin{itemize}
%--- Item
\item 
Support for copying links, devices, owners, groups, and permissions.


%--- Item
\item 
Exclude and exclude-from options are similar to GNU tar.


%--- Item
\item 
A CVS exclude mode for ignoring the same files that CVS would ignore.


%--- Item
\item 
Can use any transparent remote shell, including rsh or ssh.


%--- Item
\item 
Does not require root privileges.


%--- Item
\item 
Pipelining of file transfers to minimize latency costs.


%--- Item
\item 
Support for anonymous or authenticated rsync servers (ideal for mirroring).

\end{itemize}
\subsection{Amanda}
\label{id2589214}\hypertarget{id2589214}{}%

\index{Amanda} \index{native dump} \index{GNU tar} Amanda, the Advanced Maryland Automatic Network Disk Archiver, is a backup system that allows the administrator of a LAN to set up a single master backup server to back up multiple hosts to a single large capacity tape drive. Amanda uses native dump and/or GNU tar facilities and can back up a large number of workstations running multiple versions of UNIX. Recent versions can also use Samba to back up Microsoft Windows hosts.

For more information regarding Amanda, please check the www.amanda.org/ site\label{id2589256}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.amanda.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2589256}.
\subsection{BOBS: Browseable Online Backup System}
\label{id2589264}\hypertarget{id2589264}{}%

\index{BOBS} Browseable Online Backup System (BOBS) is a complete online backup system. Uses large disks for storing backups and lets users browse the files using a Web browser. Handles some special files like AppleDouble and icon files.

The home page for BOBS is located at bobs.sourceforge.net\label{id2589287}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://bobs.sourceforge.net/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2589287}.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter High Availability 
% ------------------------------------------------------------- 	
\chapter{High Availability}
\label{SambaHA}\hypertarget{SambaHA}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2509887}\hypertarget{id2509887}{}%

\index{availability} \index{intolerance} \index{vital task} Network administrators are often concerned about the availability of file and print services. Network users are inclined toward intolerance of the services they depend on to perform vital task responsibilities.

A sign in a computer room served to remind staff of their responsibilities. It read:
\begin{quote}

\index{fail} \index{managed by humans} \index{economically wise} \index{anticipate failure} All humans fail, in both great and small ways we fail continually. Machines fail too. Computers are machines that are managed by humans, the fallout from failure can be spectacular. Your responsibility is to deal with failure, to anticipate it and to eliminate it as far as is humanly and economically wise to achieve. Are your actions part of the problem or part of the solution?
\end{quote}

If we are to deal with failure in a planned and productive manner, then first we must understand the problem. That is the purpose of this chapter.

\index{high availability} \index{CIFS/SMB} \index{state of knowledge} Parenthetically, in the following discussion there are seeds of information on how to provision a network infrastructure against failure. Our purpose here is not to provide a lengthy dissertation on the subject of high availability. Additionally, we have made a conscious decision to not provide detailed working examples of high availability solutions; instead we present an overview of the issues in the hope that someone will rise to the challenge of providing a detailed document that is focused purely on presentation of the current state of knowledge and practice in high availability as it applies to the deployment of Samba and other CIFS/SMB technologies.

% ------------------------   
% Section 
\section{Technical Discussion}
\label{id2482172}\hypertarget{id2482172}{}%

\index{SambaXP conference} \index{Germany} \index{inspired structure} The following summary was part of a presentation by Jeremy Allison at the SambaXP 2003 conference that was held at Goettingen, Germany, in April 2003. Material has been added from other sources, but it was Jeremy who inspired the structure that follows.
\subsection{The Ultimate Goal}
\label{id2621045}\hypertarget{id2621045}{}%

\index{clustering technologies} \index{affordable power} \index{unstoppable services} All clustering technologies aim to achieve one or more of the following:

\begin{itemize}
%--- Item
\item 
Obtain the maximum affordable computational power.


%--- Item
\item 
Obtain faster program execution.


%--- Item
\item 
Deliver unstoppable services.


%--- Item
\item 
Avert points of failure.


%--- Item
\item 
Exact most effective utilization of resources.

\end{itemize}

A clustered file server ideally has the following properties: \index{clustered file server} \index{connect transparently} \index{transparently reconnected} \index{distributed file system}

\begin{itemize}
%--- Item
\item 
All clients can connect transparently to any server.


%--- Item
\item 
A server can fail and clients are transparently reconnected to another server.


%--- Item
\item 
All servers serve out the same set of files.


%--- Item
\item 
All file changes are immediately seen on all servers.

\begin{itemize}
%--- Item
\item 
Requires a distributed file system.

\end{itemize}


%--- Item
\item 
Infinite ability to scale by adding more servers or disks.

\end{itemize}
\subsection{Why Is This So Hard?}
\label{id2621175}\hypertarget{id2621175}{}%

In short, the problem is one of {\em{state}}.

\begin{itemize}
%--- Item
\item 
\index{state information} All TCP/IP connections are dependent on state information.

\index{TCP failover} The TCP connection involves a packet sequence number. This sequence number would need to be dynamically updated on all machines in the cluster to effect seamless TCP failover.


%--- Item
\item 
\index{CIFS/SMB} \index{TCP} CIFS/SMB (the Windows networking protocols) uses TCP connections.

This means that from a basic design perspective, failover is not seriously considered. 
\begin{itemize}
%--- Item
\item 
All current SMB clusters are failover solutions ---  they rely on the clients to reconnect. They provide server failover, but clients can lose information due to a server failure. \index{server failure}

\end{itemize}



%--- Item
\item 
Servers keep state information about client connections. \index{state}
\begin{itemize}
%--- Item
\item 
CIFS/SMB involves a lot of state.


%--- Item
\item 
Every file open must be compared with other open files to check share modes.

\end{itemize}


\end{itemize}
\subsubsection{The Front-End Challenge}
\label{id2576015}\hypertarget{id2576015}{}%

\index{cluster servers} \index{single server} \index{TCP data streams} \index{front-end virtual server} \index{virtual server} \index{de-multiplex} \index{SMB} To make it possible for a cluster of file servers to appear as a single server that has one name and one IP address, the incoming TCP data streams from clients must be processed by the front-end virtual server. This server must de-multiplex the incoming packets at the SMB protocol layer level and then feed the SMB packet to different servers in the cluster.

\index{IPC\$ connections} \index{RPC calls} One could split all IPC\$ connections and RPC calls to one server to handle printing and user lookup requirements. RPC printing handles are shared between different IPC4 sessions ---  it is hard to split this across clustered servers!

Conceptually speaking, all other servers would then provide only file services. This is a simpler problem to concentrate on.
\subsubsection{Demultiplexing SMB Requests}
\label{id2576112}\hypertarget{id2576112}{}%

\index{SMB requests} \index{SMB state information} \index{front-end virtual server} \index{complicated problem} De-multiplexing of SMB requests requires knowledge of SMB state information, all of which must be held by the front-end {\em{virtual}} server. This is a perplexing and complicated problem to solve.

\index{vuid} \index{tid} \index{fid} Windows XP and later have changed semantics so state information (vuid, tid, fid) must match for a successful operation. This makes things simpler than before and is a positive step forward.

\index{SMB requests} \index{Terminal Server} SMB requests are sent by vuid to their associated server. No code exists today to effect this solution. This problem is conceptually similar to the problem of correctly handling requests from multiple requests from Windows 2000 Terminal Server in Samba.

\index{de-multiplexing} One possibility is to start by exposing the server pool to clients directly. This could eliminate the de-multiplexing step.
\subsubsection{The Distributed File System Challenge}
\label{id2576221}\hypertarget{id2576221}{}%

\index{Distributed File Systems} There exists many distributed file systems for UNIX and Linux.

\index{backend} \index{SMB semantics} \index{share modes} \index{locking} \index{oplock} \index{distributed file systems} Many could be adopted to backend our cluster, so long as awareness of SMB semantics is kept in mind (share modes, locking, and oplock issues in particular). Common free distributed file systems include: \index{NFS} \index{AFS} \index{OpenGFS} \index{Lustre}

\begin{itemize}
%--- Item
\item 
NFS


%--- Item
\item 
AFS


%--- Item
\item 
OpenGFS


%--- Item
\item 
Lustre

\end{itemize}

\index{server pool} The server pool (cluster) can use any distributed file system backend if all SMB semantics are performed within this pool.
\subsubsection{Restrictive Constraints on Distributed File Systems}
\label{id2591703}\hypertarget{id2591703}{}%

\index{SMB services} \index{oplock handling} \index{server pool} \index{backend file system pool} Where a clustered server provides purely SMB services, oplock handling may be done within the server pool without imposing a need for this to be passed to the backend file system pool.

\index{NFS} \index{interoperability} On the other hand, where the server pool also provides NFS or other file services, it will be essential that the implementation be oplock-aware so it can interoperate with SMB services. This is a significant challenge today. A failure to provide this interoperability will result in a significant loss of performance that will be sorely noted by users of Microsoft Windows clients.

Last, all state information must be shared across the server pool.
\subsubsection{Server Pool Communications}
\label{id2591776}\hypertarget{id2591776}{}%

\index{POSIX semantics} \index{SMB} \index{POSIX locks} \index{SMB locks} Most backend file systems support POSIX file semantics. This makes it difficult to push SMB semantics back into the file system. POSIX locks have different properties and semantics from SMB locks.

\index{smbd} \index{tdb} \index{Clustered smbds} All {\bfseries{smbd}} processes in the server pool must of necessity communicate very quickly. For this, the current {\ttfamily\itshape{\docbookhyphenatedot{tdb}}} file structure that Samba uses is not suitable for use across a network. Clustered {\bfseries{smbd}}s must use something else.
\subsubsection{Server Pool Communications Demands}
\label{id2591864}\hypertarget{id2591864}{}%

High-speed interserver communications in the server pool is a design prerequisite for a fully functional system. Possibilities for this include:
\index{Myrinet}\index{scalable coherent interface|textit{see} {SCI} }
\begin{itemize}
%--- Item
\item 
Proprietary shared memory bus (example: Myrinet or SCI [scalable coherent interface]). These are high-cost items.


%--- Item
\item 
Gigabit Ethernet (now quite affordable).


%--- Item
\item 
Raw Ethernet framing (to bypass TCP and UDP overheads).

\end{itemize}

We have yet to identify metrics for performance demands to enable this to happen effectively.
\subsubsection{Required Modifications to Samba}
\label{id2591921}\hypertarget{id2591921}{}%

Samba needs to be significantly modified to work with a high-speed server interconnect system to permit transparent failover clustering.

Particular functions inside Samba that will be affected include:

\begin{itemize}
%--- Item
\item 
The locking database, oplock notifications, and the share mode database.


%--- Item
\item 
\index{failure semantics} \index{oplock messages} Failure semantics need to be defined. Samba behaves the same way as Windows. When oplock messages fail, a file open request is allowed, but this is potentially dangerous in a clustered environment. So how should interserver pool failure semantics function, and how should such functionality be implemented?


%--- Item
\item 
Should this be implemented using a point-to-point lock manager, or can this be done using multicast techniques?

\end{itemize}
\subsection{A Simple Solution}
\label{id2591981}\hypertarget{id2591981}{}%

\index{failover servers} \index{exported file system} \index{distributed locking protocol} Allowing failover servers to handle different functions within the exported file system removes the problem of requiring a distributed locking protocol.

\index{high-speed server interconnect} \index{complex file name space} If only one server is active in a pair, the need for high-speed server interconnect is avoided. This allows the use of existing high-availability solutions, instead of inventing a new one. This simpler solution comes at a price ---  the cost of which is the need to manage a more complex file name space. Since there is now not a single file system, administrators must remember where all services are located ---  a complexity not easily dealt with.

\index{virtual server} The {\em{virtual server}} is still needed to redirect requests to backend servers. Backend file space integrity is the responsibility of the administrator.
\subsection{High-Availability Server Products}
\label{id2592062}\hypertarget{id2592062}{}%

\index{resource failover} \index{high-availability services} \index{dedicated heartbeat} \index{LAN} \index{failover process} Failover servers must communicate in order to handle resource failover. This is essential for high-availability services. The use of a dedicated heartbeat is a common technique to introduce some intelligence into the failover process. This is often done over a dedicated link (LAN or serial).

\index{SCSI} \index{Red Hat Cluster Manager} \index{Microsoft Wolfpack} \index{Fiber Channel} \index{failover communication} Many failover solutions (like Red Hat Cluster Manager and Microsoft Wolfpack) can use a shared SCSI of Fiber Channel disk storage array for failover communication. Information regarding Red Hat high availability solutions for Samba may be obtained from www.redhat.com\label{id2592153}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.redhat.com/docs/manuals/enterprise/RHEL-AS-2.1-Manual/cluster-manager/s1-service-samba.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2592153}.

\index{Linux High Availability project} The Linux High Availability project is a resource worthy of consultation if your desire is to build a highly available Samba file server solution. Please consult the home page at www.linux-ha.org/\label{id2592174}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.linux-ha.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2592174}.

\index{backend failures} \index{continuity of service} Front-end server complexity remains a challenge for high availability because it must deal gracefully with backend failures, while at the same time providing continuity of service to all network clients.
\subsection{MS-DFS: The Poor Man's Cluster}
\label{id2618256}\hypertarget{id2618256}{}%

\index{MS-DFS} \index{DFS|textit{see} {MS-DFS, Distributed File Systems} } MS-DFS links can be used to redirect clients to disparate backend servers. This pushes complexity back to the network client, something already included by Microsoft. MS-DFS creates the illusion of a simple, continuous file system name space that works even at the file level.

Above all, at the cost of complexity of management, a distributed system (pseudo-cluster) can be created using existing Samba functionality.
\subsection{Conclusions}
\label{id2618294}\hypertarget{id2618294}{}%

\begin{itemize}
%--- Item
\item 
Transparent SMB clustering is hard to do!


%--- Item
\item 
Client failover is the best we can do today.


%--- Item
\item 
Much more work is needed before a practical and manageable high-availability transparent cluster solution will be possible.


%--- Item
\item 
MS-DFS can be used to create the illusion of a single transparent cluster.

\end{itemize}
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Handling Large Directories 
% ------------------------------------------------------------- 	
\chapter{Handling Large Directories}
\label{largefile}\hypertarget{largefile}{}%

\index{performance degradation} \index{large numbers of files} \index{large directory} Samba-3.0.12 and later implements a solution for sites that have experienced performance degradation due to the problem of using Samba-3 with applications that need large numbers of files (100,000 or more) per directory.

\index{read directory into memory} \index{strange delete semantics} The key was fixing the directory handling to read only the current list requested instead of the old (up to samba-3.0.11) behavior of reading the entire directory into memory before doling out names. Normally this would have broken OS/2 applications, which have very strange delete semantics, but by stealing logic from Samba4 (thanks, Tridge), the current code in 3.0.12 handles this correctly.

\index{large directory} \index{performance} To set up an application that needs large numbers of files per directory in a way that does not damage performance unduly, follow these steps:

\index{canonicalize files} First, you need to canonicalize all the files in the directory to have one case, upper or lower ---  take your pick (I chose upper because all my files were already uppercase names). Then set up a new custom share for the application as follows: 
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[bigshare]
 	path = /data/manyfilesdir
 	read only = no
 	case sensitive = True
 	default case = upper
 	preserve case = no
 	short preserve case = no
\end{lstlisting}


\index{case options} \index{match case} \index{uppercase} Of course, use your own path and settings, but set the case options to match the case of all the files in your directory. The path should point at the large directory needed for the application ---  any new files created in there and in any paths under it will be forced by smbd into uppercase, but smbd will no longer have to scan the directory for names: it knows that if a file does not exist in uppercase, then it doesn't exist at all.

\index{case-insensitive} \index{consistent case} \index{smbd} The secret to this is really in the \smbconfoption{case sensitive} = True line. This tells smbd never to scan for case-insensitive versions of names. So if an application asks for a file called {\texttt{\docbookhyphenatefilename{FOO}}}, and it cannot be found by a simple stat call, then smbd will return file not found immediately without scanning the containing directory for a version of a different case. The other {\texttt{\docbookhyphenatefilename{xxx case xxx}}} lines make this work by forcing a consistent case on all files created by smbd.

\index{uppercase} \index{stanza} \index{lowercase filenames} Remember, all files and directories under the {\ttfamily\itshape{\docbookhyphenatedot{path}}} directory must be in uppercase with this {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} stanza because smbd will not be able to find lowercase filenames with these settings. Also note that this is done on a per-share basis, allowing this parameter to be set only for a share servicing an application with this problematic behavior (using large numbers of entries in a directory) ---  the rest of your smbd shares don't need to be affected.

This makes smbd much faster when dealing with large directories. My test case has over 100,000 files, and smbd now deals with this very efficiently.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Advanced Configuration Techniques 
% ------------------------------------------------------------- 	
\chapter{Advanced Configuration Techniques}
\label{cfgsmarts}\hypertarget{cfgsmarts}{}%

\index{configuration techniques} \index{include} Since the release of the first edition of this book there have been repeated requests to better document configuration techniques that may help a network administrator to get more out of Samba. Some users have asked for documentation regarding the use of the \smbconfoption{include} = file-name parameter.

\index{multiple servers} \index{multiple server personalities} Commencing around mid-2004 there has been increasing interest in the ability to host multiple Samba servers on one machine. There has also been an interest in the hosting of multiple Samba server personalities on one server.

\index{technical reviewers} \index{reviewers} Feedback from technical reviewers made the inclusion of this chapter a necessity. So, here is an answer the questions that have to date not been adequately addressed. Additional user input is welcome as it will help this chapter to mature. What is presented here is just a small beginning.

\index{multiple servers} \index{multiple hosting} \index{domain controllers} There are a number of ways in which multiple servers can be hosted on a single Samba server. Multiple server hosting makes it possible to host multiple domain controllers on one machine. Each such machine is independent, and each can be stopped or started without affecting another.

\index{multiple servers} \index{DMS} \index{anonymous server} Sometimes it is desirable to host multiple servers, each with its own security mode. For example, a single UNIX/Linux host may be a domain member server (DMS) as well as a generic anonymous print server. In this case, only domain member machines and domain users can access the DMS, but even guest users can access the generic print server. Another example of a situation where it may be beneficial to host a generic (anonymous) server is to host a CDROM server.

\index{separate servers} \index{} Some environments dictate the need to have separate servers, each with their own resources, each of which are accessible only by certain users or groups. This is one of the simple, but highly effective, ways that Samba can replace many physical Windows servers in one Samba installation.

% ------------------------   
% Section 
\section{Implementation}
\label{id2620690}\hypertarget{id2620690}{}%


\subsection{Multiple Server Hosting}
\label{id2620700}\hypertarget{id2620700}{}%

\index{multiple server hosting} \index{separate instances} \index{nmbd} \index{smbd} \index{winbindd} \index{recompiling} \index{TDB} The use of multiple server hosting involves running multiple separate instances of Samba, each with it's own configuration file. This method is complicated by the fact that each instance of nmbd, smbd and winbindd must have write access to entirely separate TDB files. The ability to keep separate the TDB files used by nmbd, smbd and winbindd can be enabled either by recompiling Samba for each server hosted so each has its own default TDB directories, or by configuring these in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, in which case each instance of nmbd, smbd and winbindd must be told to start up with its own {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} configuration file.

\index{independent} \index{listen own socket} \index{socket} \index{SID} Each instance should operate on its own IP address (that independent IP address can be an IP Alias). Each instance of nmbd, smbd and winbindd should listen only on its own IP socket. This can be secured using the \smbconfoption{socket address} parameter. Each instance of the Samba server will have its own SID also, this means that the servers are discrete and independent of each other.

\index{multiple server hosting} \index{private dir} \index{pid directory} \index{lock directory} \index{interfaces} \index{bind interfaces only} \index{netbios name} \index{workgroup} \index{socket address} The user of multiple server hosting is non-trivial, and requires careful configuration of each aspect of process management and start up. The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameters that must be carefully configured includes: \smbconfoption{private dir}, \smbconfoption{pid directory},\smbconfoption{lock directory}, \smbconfoption{interfaces}, \smbconfoption{bind interfaces only}, \smbconfoption{netbios name}, \smbconfoption{workgroup}, \smbconfoption{socket address}.

\index{multiple servers} \index{contribute} \index{comprehensive documentation} Those who elect to create multiple Samba servers should have the ability to read and follow the Samba source code, and to modify it as needed. This mode of deployment is considered beyond the scope of this book. However, if someone will contribute more comprehensive documentation we will gladly review it, and if it is suitable extend this section of this chapter. Until such documentation becomes available the hosting of multiple samba servers on a single host is considered not supported for Samba-3 by the Samba Team.
\subsection{Multiple Virtual Server Personalities}
\label{id2482588}\hypertarget{id2482588}{}%

\index{multiple virtual servers} \index{netbios alias} \index{meta-services} Samba has the ability to host multiple virtual servers, each of which have their own personality. This is achieved by configuring an {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file that is common to all personalities hosted. Each server personality is hosted using its own \smbconfoption{netbios alias} name, and each has its own distinct \smbconfoption{[global]} section. Each server may have its own stanzas for services and meta-services.

\index{workgroup} \index{security} \index{netbios aliases} When hosting multiple virtual servers, each with their own personality, each can be in a different workgroup. Only the primary server can be a domain member or a domain controller. The personality is defined by the combination of the \smbconfoption{security} mode it is operating in, the \smbconfoption{netbios aliases} it has, and the \smbconfoption{workgroup} that is defined for it.

\index{NetBIOS name} \index{NetBIOS-less SMB} \index{smb ports} \index{TCP port 139} \index{TCP port 445} \index{\%L} This configuration style can be used either with NetBIOS names, or using NetBIOS-less SMB over TCP services. If run using NetBIOS mode (the most common method) it is important that the parameter \smbconfoption{smb ports} = 139 should be specified in the primary {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Failure to do this will result in Samba operating over TCP port 445 and problematic operation at best, and at worst only being able to obtain the functionality that is specified in the primary {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. The use of NetBIOS over TCP/IP using only TCP port 139 means that the use of the {\texttt{\docbookhyphenatedot{\%L}}} macro is fully enabled. If the \smbconfoption{smb ports} = 139 is not specified (the default is {\ttfamily\itshape{\docbookhyphenatedot{445 139}}}, or if the value of this parameter is set at {\ttfamily\itshape{\docbookhyphenatedot{139 445}}} then the {\texttt{\docbookhyphenatedot{\%L}}} macro is not serviceable.

\index{host multiple servers} \index{multiple personality} \index{NetBIOS-less} \index{\%i macro} It is possible to host multiple servers, each with their own personality, using port 445 (the NetBIOS-less SMB port), in which case the {\texttt{\docbookhyphenatedot{\%i}}} macro can be used to provide separate server identities (by IP Address). Each can have its own \smbconfoption{security} mode. It will be necessary to use the \smbconfoption{interfaces}, \smbconfoption{bind interfaces only} and IP aliases in addition to the \smbconfoption{netbios name} parameters to create the virtual servers. This method is considerably more complex than that using NetBIOS names only using TCP port 139.

\index{anonymous file server} Consider an example environment that consists of a standalone, user-mode security Samba server and a read-only Windows 95 file server that has to be replaced. Instead of replacing the Windows 95 machine with a new PC, it is possible to add this server as a read-only anonymous file server that is hosted on the Samba server. Here are some parameters:

The Samba server is called {\texttt{\docbookhyphenatedot{ELASTIC}}}, its workgroup name is {\texttt{\docbookhyphenatedot{ROBINSNEST}}}. The CDROM server is called {\texttt{\docbookhyphenatedot{CDSERVER}}} and its workgroup is {\texttt{\docbookhyphenatedot{ARTSDEPT}}}. A possible implementation is shown here:

\index{/etc/samba} \index{nmbd} \index{smbd} \index{smb.conf} The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file for the master server is shown in \hyperlink{elastic}{Example {\ref{elastic}}}. This file is placed in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba}}} directory. Only the nmbd and the smbd daemons are needed. When started the server will appear in Windows Network Neighborhood as the machine {\texttt{\docbookhyphenatedot{ELASTIC}}} under the workgroup {\texttt{\docbookhyphenatedot{ROBINSNEST}}}. It is helpful if the Windows clients that must access this server are also in the workgroup {\texttt{\docbookhyphenatedot{ROBINSNEST}}} as this will make browsing much more reliable.

\begin{example}%
\hypertarget{elastic}{}%
\captionswapskip{}{{\caption{Elastic smb.conf File}\label{elastic}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = ROBINSNEST
 	netbios name = ELASTIC
 	netbios aliases = CDSERVER
 	smb ports = 139
 	printcap name = cups
 	disable spoolss = Yes
 	show add printer wizard = No
 	printing = cups
 	include = /etc/samba/smb-%L.conf
 [homes]
 	comment = Home Directories
 	valid users = %S
 	read only = No
 	browseable = No
 [office]
 	comment = Data
 	path = /data
 	read only = No
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	create mask = 0600
 	guest ok = Yes
 	printable = Yes
 	use client driver = Yes
 	browseable = No
\end{lstlisting}
\end{example}


\index{smb-cdserver.conf} The configuration file for the CDROM server is listed in \hyperlink{cdserver}{Example {\ref{cdserver}}}. This file is called {\texttt{\docbookhyphenatefilename{smb-\dbz{}cdserver.\dbz{}conf}}} and it should be located in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba}}} directory. Machines that are in the workgroup {\texttt{\docbookhyphenatedot{ARTSDEPT}}} will be able to browse this server freely.

\begin{example}%
\hypertarget{cdserver}{}%
\captionswapskip{}{{\caption{CDROM Server smb-cdserver.conf file}\label{cdserver}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = ARTSDEPT
 	netbios name = CDSERVER
 	map to guest = Bad User
 	guest ok = Yes
 [carousel]
 	comment = CDROM Share
 	path = /export/cddata
 	read only = Yes
 	guest ok = Yes
\end{lstlisting}
\end{example}


\index{different resources} \index{separate workgroups} \index{read-only access} \index{nobody account} The two servers have different resources and are in separate workgroups. The server {\texttt{\docbookhyphenatedot{ELASTIC}}} can only be accessed by uses who have an appropriate account on the host server. All users will be able to access the CDROM data that is stored in the {\texttt{\docbookhyphenatefilename{/\dbz{}export/\dbz{}cddata}}} directory. File system permissions should set so that the {\texttt{\docbookhyphenatedot{others}}} user has read-only access to the directory and its contents. The files can be owned by root (any user other than the nobody account).
\subsection{Multiple Virtual Server Hosting}
\label{id2621658}\hypertarget{id2621658}{}%

\index{primary domain controller} \index{extra machine} \index{same domain/workgroup} In this example, the requirement is for a primary domain controller for the domain called {\texttt{\docbookhyphenatedot{MIDEARTH}}}. The PDC will be called {\texttt{\docbookhyphenatedot{MERLIN}}}. An extra machine called {\texttt{\docbookhyphenatedot{SAURON}}} is required. Each machine will have only its own shares. Both machines belong to the same domain/workgroup.

\index{master smb.conf} \index{/etc/samba} \index{} The master {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file is shown in \hyperlink{mastersmbc}{Example {\ref{mastersmbc}}}. The two files that specify the share information for each server are shown in \hyperlink{merlinsmbc}{Example {\ref{merlinsmbc}}}, and \hyperlink{sauronsmbc}{Example {\ref{sauronsmbc}}}. All three files are locate in the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba}}} directory.

\begin{example}%
\hypertarget{mastersmbc}{}%
\captionswapskip{}{{\caption{Master smb.conf File Global Section}\label{mastersmbc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = MERLIN
 	netbios aliases = SAURON
 	passdb backend = tdbsam
 	smb ports = 139
 	syslog = 0
 	printcap name = CUPS
 	show add printer wizard = No
 	add user script = /usr/sbin/useradd -m '%u'
 	delete user script = /usr/sbin/userdel -r '%u'
 	add group script = /usr/sbin/groupadd '%g'
 	delete group script = /usr/sbin/groupdel '%g'
 	add user to group script = /usr/sbin/usermod -G '%g' '%u'
 	add machine script = /usr/sbin/useradd -s /bin/false -d /var/lib/nobody '%u'
 	logon script = scripts\login.bat
 	logon path =  
 	logon drive = X:
 	domain logons = Yes
 	preferred master = Yes
 	wins support = Yes
 	printing = CUPS
 	include = /etc/samba/smb-%L.conf
\end{lstlisting}
\end{example}


\begin{example}%
\hypertarget{merlinsmbc}{}%
\captionswapskip{}{{\caption{MERLIN smb-merlin.conf File Share Section}\label{merlinsmbc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = MERLIN
 [homes]
 	comment = Home Directories
 	valid users = %S
 	read only = No
 	browseable = No
 [office]
 	comment = Data
 	path = /data
 	read only = No
 [netlogon]
 	comment = NETLOGON
 	path = /var/lib/samba/netlogon
 	read only = Yes
 	browseable = No
 [printers]
 	comment = All Printers
 	path = /var/spool/samba
 	printable = Yes
 	use client driver = Yes
 	browseable = No
\end{lstlisting}
\end{example}


\begin{example}%
\hypertarget{sauronsmbc}{}%
\captionswapskip{}{{\caption{SAURON smb-sauron.conf File Share Section}\label{sauronsmbc}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
# Global parameters
 [global]
 	workgroup = MIDEARTH
 	netbios name = SAURON
 [www]
 	comment = Web Pages
 	path = /srv/www/htdocs
 	read only = No
\end{lstlisting}
\end{example}

\cleardoublepage % ------------------------------------------------------------- 
% 
% PART Migration and Updating
% 
% ------------------------------------------------------------- 
\part{Migration and Updating}
\label{migration}\hypertarget{migration}{}%
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Updating and Upgrading Samba 
% ------------------------------------------------------------- 	
\chapter{Updating and Upgrading Samba}
\label{upgrading-to-3.0}\hypertarget{upgrading-to-3.0}{}%

This chapter provides a detailed record of changes made during the 3.x series releases. At this time this series consists of the 3.0.x series that is under the GNU GPL version 2 license, and the Samba 3.2.x series that is being released under the terms of the GNU GPL version 3 license.

% ------------------------   
% Section 
\section{Key Update Requirements}
\label{id2624384}\hypertarget{id2624384}{}%

Samba is a fluid product in which there may be significant changes between releases. Some of these changes are brought about as a result of changes in the protocols that are used by Microsoft Windows network clients as a result of security or functionality updates through official Microsoft patches and updates. Samba must track such changes, particularly where they affect the internal operation of Samba itself.

Please refer to any notes below that make explicit mention of the version of Samba you are using. In general, all changes that apply to a new release will apply to follow-on releases also. For example, changes to Samba 3.0.23 affect all releases up to an including 3.0.25 and later. Samba 3.2.x was originaly cut from Samba 3.0.25 before 3.2.0-specific changes were applied. Unless a 3.0.x series feature is specifically revoked, the behavior of the 3.2.x series can be expected to follow the earlier pattern.
\subsection{Upgrading from Samba-3.0.x to Samba-3.2.0}
\label{id2535202}\hypertarget{id2535202}{}%


\subsection{Upgrading from Samba-2.x to Samba-3.0.25}
\label{oldupdatenotes}\hypertarget{oldupdatenotes}{}%

\index{Samba differences} \index{changed parameters} \index{simple guide} This chapter deals exclusively with the differences between Samba-3.0.25 and Samba-2.2.8a. It points out where configuration parameters have changed, and provides a simple guide for the move from 2.2.x to 3.0.25.
\subsection{Quick Migration Guide}
\label{id2624418}\hypertarget{id2624418}{}%

Samba-3.0.25 default behavior should be approximately the same as Samba-2.2.x. The default behavior when the new parameter \smbconfoption{passdb backend} is not defined in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file provides the same default behavior as Samba-2.2.x with \smbconfoption{encrypt passwords} = Yes and will use the {\texttt{\docbookhyphenatefilename{smbpasswd}}} database.

\index{behavior approximately same} \index{differing protocol} So why say that {\em{behavior should be approximately the same as Samba-2.2.x}}? Because Samba-3.0.25 can negotiate new protocols, such as support for native Unicode, that may result in differing protocol code paths being taken. The new behavior under such circumstances is not exactly the same as the old one. The good news is that the domain and machine SIDs will be preserved across the upgrade.

\index{LDAP backend} \index{database} \index{pdbedit} \index{Samba-3-compatible LDAP backend} If the Samba-2.2.x system is using an LDAP backend, and there is no time to update the LDAP database, then make sure that \smbconfoption{passdb backend} = ldapsam\_compat is specified in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. For the rest, behavior should remain more or less the same. At a later date, when there is time to implement a new Samba-3-compatible LDAP backend, it is possible to migrate the old LDAP database to the new one through use of the {\bfseries{pdbedit}}. See \hyperlink{pdbeditthing}{Section {\ref{pdbeditthing}}}.

% ------------------------   
% Section 
\section{New Featuers in Samba-3.x Series}
\label{id2624547}\hypertarget{id2624547}{}%


\subsection{New Features in Samba-3.2.x Series}
\label{id2624556}\hypertarget{id2624556}{}%


\subsection{New Features in Samba-3.0.x}
\label{id2624567}\hypertarget{id2624567}{}%

The major new features are:

\begin{enumerate}[1]
%--- Item
\item 
\index{ADS} \index{LDAP/Kerberos} Active Directory support. This release is able to join an ADS realm as a member server and authenticate users using LDAP/Kerberos.


%--- Item
\item 
\index{Unicode} \index{multibyte character sets} Unicode support. Samba will now negotiate Unicode on the wire, and internally there is a much better infrastructure for multibyte and Unicode character sets.


%--- Item
\item 
\index{authentication system} New authentication system. The internal authentication system has been almost completely rewritten. Most of the changes are internal, but the new authoring system is also very configurable.


%--- Item
\item 
\index{filename mangling} New filename mangling system. The filename mangling system has been completely rewritten. An internal database now stores mangling maps persistently.


%--- Item
\item 
\index{net command} New {``}net{''} command. A new {``}net{''} command has been added. It is somewhat similar to the {``}net{''} command in Windows. Eventually, we plan to replace a bunch of other utilities (such as smbpasswd) with subcommands in {``}net{''}.


%--- Item
\item 
\index{status32 codes} Samba now negotiates NT-style status32 codes on the wire. This considerably improves error handling.


%--- Item
\item 
\index{printer attributes publishing} Better Windows 200x/XP printing support, including publishing printer attributes in Active Directory.


%--- Item
\item 
\index{RPC modules} \index{passdb backends} \index{character sets} New loadable RPC modules for passdb backends and character sets.


%--- Item
\item 
\index{dual-daemon winbindd} New default dual-daemon winbindd support for better performance.


%--- Item
\item 
\index{migrating} \index{maintaining ids} \index{SID} Support for migrating from a Windows NT 4.0 domain to a Samba domain and maintaining user, group, and domain SIDs.


%--- Item
\item 
\index{trust relationships} \index{domain controllers} Support for establishing trust relationships with Windows NT 4.0 domain controllers.


%--- Item
\item 
\index{Winbind architecture} \index{LDAP directory} \index{ID mapping} Initial support for a distributed Winbind architecture using an LDAP directory for storing SID to UID/GID mappings.


%--- Item
\item 
Major updates to the Samba documentation tree.


%--- Item
\item 
\index{SMB signing} \index{security settings} Full support for client and server SMB signing to ensure compatibility with default Windows 2003 security settings.

\end{enumerate}

Plus lots of other improvements!
\subsubsection{Configuration Parameter Changes}
\label{id2621907}\hypertarget{id2621907}{}%

This section contains a brief listing of changes to {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} options since the Samba-2.2.x series up to and including Samba-3.0.25.

Please refer to the smb.conf(5) man page for complete descriptions of new or modified parameters.

Whenever a Samba update or upgrade is performed it is highly recommended to read the file called {\em{WHATSNEW.txt}} that is part of the Samba distribution tarball. This file may also be obtain on-line from the Samba web site\label{id2621939}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2621939}, in the right column, under Current Stable Release, by clicking on {\em{Release Notes}}.
\subsubsection{Removed Parameters}
\label{id2619728}\hypertarget{id2619728}{}%
\index{deleted parameters}
In alphabetical order, these are the parameters eliminated from Samba-2.2.x through 3.0.25.

\begin{itemize}
%--- Item
\item 
admin log


%--- Item
\item 
alternate permissions


%--- Item
\item 
character set


%--- Item
\item 
client codepage


%--- Item
\item 
code page directory


%--- Item
\item 
coding system


%--- Item
\item 
domain admin group


%--- Item
\item 
domain guest group


%--- Item
\item 
enable rid algorithm


%--- Item
\item 
enable svcctl


%--- Item
\item 
force unknown acl user


%--- Item
\item 
hosts equiv


%--- Item
\item 
ldap filter


%--- Item
\item 
min password length


%--- Item
\item 
nt smb support


%--- Item
\item 
post script


%--- Item
\item 
printer admin


%--- Item
\item 
printer driver


%--- Item
\item 
printer driver file


%--- Item
\item 
printer driver location


%--- Item
\item 
read size


%--- Item
\item 
source environment


%--- Item
\item 
status


%--- Item
\item 
strip dot


%--- Item
\item 
total print jobs


%--- Item
\item 
unicode


%--- Item
\item 
use rhosts


%--- Item
\item 
valid chars


%--- Item
\item 
vfs options


%--- Item
\item 
winbind enable local accounts


%--- Item
\item 
winbind max idle children


%--- Item
\item 
wins partners

\end{itemize}
\subsubsection{New Parameters}
\label{id2619905}\hypertarget{id2619905}{}%

The following new parameters have been released up to and including Samba 3.0.25 (grouped by function:)

Remote Management
\index{new parameters}
\begin{itemize}
%--- Item
\item 
abort shutdown script


%--- Item
\item 
shutdown script

\end{itemize}

User and Group Account Management

\begin{itemize}
%--- Item
\item 
add group script


%--- Item
\item 
add machine script


%--- Item
\item 
add user to group script


%--- Item
\item 
algorithmic rid base


%--- Item
\item 
delete group script


%--- Item
\item 
delete user from group script


%--- Item
\item 
passdb backend


%--- Item
\item 
rename user script


%--- Item
\item 
set primary group script


%--- Item
\item 
username map script

\end{itemize}

Authentication

\begin{itemize}
%--- Item
\item 
auth methods


%--- Item
\item 
ldap password sync


%--- Item
\item 
passdb expand explicit


%--- Item
\item 
realm

\end{itemize}

Protocol Options

\begin{itemize}
%--- Item
\item 
add port command


%--- Item
\item 
afs token lifetime


%--- Item
\item 
client lanman auth


%--- Item
\item 
client NTLMv2 auth


%--- Item
\item 
client schannel


%--- Item
\item 
client signing


%--- Item
\item 
client use spnego


%--- Item
\item 
defer sharing violations


%--- Item
\item 
disable netbios


%--- Item
\item 
dmapi support


%--- Item
\item 
enable privileges


%--- Item
\item 
use kerberos keytab


%--- Item
\item 
log nt token command


%--- Item
\item 
ntlm auth


%--- Item
\item 
paranoid server security


%--- Item
\item 
sendfile


%--- Item
\item 
server schannel


%--- Item
\item 
server signing


%--- Item
\item 
smb ports


%--- Item
\item 
svcctl list


%--- Item
\item 
use spnego

\end{itemize}

File Service

\begin{itemize}
%--- Item
\item 
allocation roundup size


%--- Item
\item 
acl check permissions


%--- Item
\item 
acl group control


%--- Item
\item 
acl map full control


%--- Item
\item 
aio read size


%--- Item
\item 
aio write size


%--- Item
\item 
dfree cache time


%--- Item
\item 
dfree command


%--- Item
\item 
ea support


%--- Item
\item 
enable asu support


%--- Item
\item 
fam change notify


%--- Item
\item 
force unknown acl user


%--- Item
\item 
get quota command


%--- Item
\item 
hide special files


%--- Item
\item 
hide unwriteable files


%--- Item
\item 
inherit owner


%--- Item
\item 
hostname lookups


%--- Item
\item 
kernel change notify


%--- Item
\item 
mangle prefix


%--- Item
\item 
map acl inherit


%--- Item
\item 
map read only


%--- Item
\item 
max stat cache size


%--- Item
\item 
msdfs proxy


%--- Item
\item 
open files database hash size


%--- Item
\item 
set quota command


%--- Item
\item 
store dos attributes


%--- Item
\item 
use sendfile


%--- Item
\item 
usershare allow guests


%--- Item
\item 
usershare max shares


%--- Item
\item 
usershare owner only


%--- Item
\item 
usershare path


%--- Item
\item 
usershare prefix allow list


%--- Item
\item 
usershare prefix deny list


%--- Item
\item 
usershare template share


%--- Item
\item 
vfs objects

\end{itemize}

Printing

\begin{itemize}
%--- Item
\item 
cups options


%--- Item
\item 
cups server


%--- Item
\item 
force printername


%--- Item
\item 
iprint server


%--- Item
\item 
max reported print jobs


%--- Item
\item 
printcap cache time

\end{itemize}

Unicode and Character Sets

\begin{itemize}
%--- Item
\item 
display charset


%--- Item
\item 
dos charset


%--- Item
\item 
UNIX charset

\end{itemize}

SID to UID/GID Mappings

\begin{itemize}
%--- Item
\item 
idmap backend


%--- Item
\item 
idmap gid


%--- Item
\item 
idmap uid


%--- Item
\item 
username map script


%--- Item
\item 
winbind nss info


%--- Item
\item 
winbind offline logon


%--- Item
\item 
winbind refresh tickets


%--- Item
\item 
winbind trusted domains only


%--- Item
\item 
template primary group

\end{itemize}

LDAP

\begin{itemize}
%--- Item
\item 
ldap delete dn


%--- Item
\item 
ldap group suffix


%--- Item
\item 
ldap idmap suffix


%--- Item
\item 
ldap machine suffix


%--- Item
\item 
ldap passwd sync


%--- Item
\item 
ldap replication sleep


%--- Item
\item 
ldap timeout


%--- Item
\item 
ldap user suffix

\end{itemize}

General Configuration

\begin{itemize}
%--- Item
\item 
eventlog list


%--- Item
\item 
preload modules


%--- Item
\item 
reset on zero vc


%--- Item
\item 
privatedir

\end{itemize}
\subsubsection{Modified Parameters (Changes in Behavior)}
\label{id2626131}\hypertarget{id2626131}{}%

\begin{itemize}
%--- Item
\item 
acl group control (new default is No, deprecated parameter)


%--- Item
\item 
change notify timeout (scope changed)


%--- Item
\item 
dos filemode (disabled by default)


%--- Item
\item 
dos filetimes (enabled by default)


%--- Item
\item 
enable asu support (disabled by default)


%--- Item
\item 
enable privileges (enabled by default)


%--- Item
\item 
encrypt passwords (enabled by default)


%--- Item
\item 
host msdfs (enabled by default)


%--- Item
\item 
mangling method (set to hash2 by default)


%--- Item
\item 
map to guest


%--- Item
\item 
only user (deprecated)


%--- Item
\item 
passwd chat


%--- Item
\item 
passwd program


%--- Item
\item 
password server


%--- Item
\item 
restrict anonymous (integer value)


%--- Item
\item 
security (new ads value)


%--- Item
\item 
strict locking (auto by default)


%--- Item
\item 
winbind cache time (increased to 5 minutes)


%--- Item
\item 
winbind enum groups (disabled by default)


%--- Item
\item 
winbind enum users (disabled by default)


%--- Item
\item 
winbind nested groups (enabled by default)


%--- Item
\item 
winbind uid (deprecated in favor of idmap uid)


%--- Item
\item 
winbind gid (deprecated in favor of idmap gid)


%--- Item
\item 
winbindd nss info


%--- Item
\item 
write cache (deprecated)

\end{itemize}
\subsection{New Functionality}
\label{id2626256}\hypertarget{id2626256}{}%

\index{major changes} The major changes in behavior since that Samba-2.2.x series are documented in this section. Please refer to the {\texttt{\docbookhyphenatefilename{WHATSNEW.\dbz{}txt}}} file that ships with every release of Samba to obtain detailed information regarding the changes that have been made during the life of the current Samba release.
\subsubsection{TDB Data Files}
\label{id2626281}\hypertarget{id2626281}{}%
\index{tdb data files}
Refer to \hyperlink{install}{Chapter {\ref{install}}, {``}How to Install and Test SAMBA{''}}, \hyperlink{tdbdocs}{Section {\ref{tdbdocs}}} for information pertaining to the Samba-3 data files, their location and the information that must be preserved across server migrations, updates and upgrades.

\index{tdb file backup} Please remember to back up your existing \$\{lock directory\}/*tdb before upgrading to Samba-3. If necessary, Samba will upgrade databases as they are opened. Downgrading from Samba-3 to 2.2, or reversion to an earlier version of Samba-3 from a later release, is an unsupported path.

\index{tdb file descriptions} The old Samba-2.2.x tdb files are described in \hyperlink{oldtdbfiledesc}{Table {\ref{oldtdbfiledesc}}}.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{oldtdbfiledesc}{}%
\captionswapskip{}{{\caption{Samba-2.2.x TDB File Descriptions}\label{oldtdbfiledesc}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|>{\hsize=1\hsize}X|l|}
\hline 
\docbooktolatexalignll {{{\bfseries Name}}} & {{{\bfseries Description}}} & \docbooktolatexaligncl {{{\bfseries Backup?}}} \tabularnewline
 \hline 
{{account\_policy}} & {{User policy settings}} & {{yes}} \tabularnewline
 \hline 
{{brlock}} & {{Byte-range file locking information.}} & {{no}} \tabularnewline
 \hline 
{{connections}} & {{Client connection information}} & {{no}} \tabularnewline
 \hline 
{{locking}} & {{Temporary file locking data.}} & {{no}} \tabularnewline
 \hline 
{{messages}} & {{Temporary storage of messages being processed by smbd.}} & {{no}} \tabularnewline
 \hline 
{{ntdrivers}} & {{Stores per-printer driver information.}} & {{yes}} \tabularnewline
 \hline 
{{ntforms}} & {{Stores per-printer forms information.}} & {{yes}} \tabularnewline
 \hline 
{{ntprinters}} & {{Stores the per-printer devmode configuration settings.}} & {{yes}} \tabularnewline
 \hline 
{{printing/*.tdb}} & {{Cached output from lpq command created on a per-print-service basis.}} & {{no}} \tabularnewline
 \hline 
{{registry}} & {{Read-only Samba registry skeleton that provides support for exporting various database tables via the winreg RPCs.}} & {{no}} \tabularnewline
 \hline 
{{sessionid}} & {{Temporary cache for miscellaneous session information.}} & {{no}} \tabularnewline
 \hline 
{{share\_info}} & {{Share ACL settings.}} & {{yes}} \tabularnewline
 \hline 
{{unexpected}} & {{Packets received for which no process was listening.}} & {{no}} \tabularnewline
 \hline 
{{winbindd\_cache}} & {{Cache of identity information received from an NT4 or an ADS domain.}} & {{yes}} \tabularnewline
 \hline 
{{winbindd\_idmap}} & {{New ID map table from SIDS to UNIX UIDs/GIDs.}} & {{yes}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsubsection{Changes in Behavior}
\label{id2626611}\hypertarget{id2626611}{}%

The following issues are known changes in behavior between Samba-2.2 and Samba-3 that may affect certain installations of Samba.

\begin{enumerate}
%--- Item
\item 
\index{Windows domain} \index{getpwnam() call} \index{NT\_STATUS\_LOGON\_FAILURE} When operating as a member of a Windows domain, Samba-2.2 would map any users authenticated by the remote DC to the {``}guest account{''} if a UID could not be obtained via the getpwnam() call. Samba-3 rejects the connection with the error message {``}NT\_STATUS\_LOGON\_FAILURE.{''} There is no current workaround to re-establish the Samba-2.2 behavior.


%--- Item
\item 
\index{add user script} \index{add machine script} When adding machines to a Samba-2.2 controlled domain, the {``}add user script{''} was used to create the UNIX identity of the machine trust account. Samba-3 introduces a new {``}add machine script{''} that must be specified for this purpose. Samba-3 will not fall back to using the {``}add user script{''} in the absence of an {``}add machine script{''}.

\end{enumerate}
\subsubsection{Passdb Backends and Authentication}
\label{id2626699}\hypertarget{id2626699}{}%

There have been a few new changes that Samba administrators should be aware of when moving to Samba-3.

\begin{enumerate}
%--- Item
\item 
\index{encrypted passwords} Encrypted passwords have been enabled by default in order to interoperate better with out-of-the-box Windows client installations. This does mean that either (a) a Samba account must be created for each user, or (b) {``}encrypt passwords = no{''} must be explicitly defined in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}.


%--- Item
\item 
\index{ADS} \index{Kerberos} \index{LDAP} Inclusion of new \smbconfoption{security} = ads option for integration with an Active Directory domain using the native Windows Kerberos 5 and LDAP protocols.

\end{enumerate}

\index{account storage backends} Samba-3 also includes the possibility of setting up chains of authentication methods (\smbconfoption{auth methods}) and account storage backends (\smbconfoption{passdb backend}). Please refer to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page and \hyperlink{passdb}{Chapter {\ref{passdb}}, {``}Account Information Databases{''}}, for details. While both parameters assume sane default values, it is likely that you will need to understand what the values actually mean in order to ensure Samba operates correctly.

\index{pdbedit} \index{smbpasswd} \index{net tool} Certain functions of the {\bfseries{smbpasswd}} tool have been split between the new {\bfseries{smbpasswd}} utility, the {\bfseries{net}} tool, and the new {\bfseries{pdbedit}} utility. See the respective man pages for details.
\subsubsection{LDAP}
\label{id2626849}\hypertarget{id2626849}{}%

This section outlines the new features effecting Samba/LDAP integration.
\subparagraph*{New Schema}
\label{id2626859}\hypertarget{id2626859}{}%

\index{object class} \index{sambaSamAccount} \index{LDIF} \index{attributes} A new object class (sambaSamAccount) has been introduced to replace the old sambaAccount. This change aids in the renaming of attributes to prevent clashes with attributes from other vendors. There is a conversion script (examples/LDAP/convertSambaAccount) to modify an LDIF file to the new schema.

Example: \index{ldapsearch}


\begin{Verbatim}[]

		$ ldapsearch .... -LLL -b "ou=people,dc=..." > old.ldif
		$ convertSambaAccount --sid <DOM SID> --input old.ldif --output new.ldif
		
\end{Verbatim}


\index{net!getlocalsid} The \textless{}DOM SID\textgreater{} can be obtained by running 
\begin{Verbatim}[]

$ net getlocalsid <DOMAINNAME>

\end{Verbatim}
 \index{PDC} on the Samba PDC as root.

Under Samba-2.x the domain SID can be obtained by executing: \index{smbpasswd} 
\begin{Verbatim}[]

$ smbpasswd -S <DOMAINNAME>

\end{Verbatim}


\index{old sambaAccount} \index{ldapsam\_compat} \index{object class declaration} \index{samba.schema} The old {\texttt{\docbookhyphenatedot{sambaAccount}}} schema may still be used by specifying the {\ttfamily\itshape{\docbookhyphenatedot{ldapsam\_compat}}} passdb backend. However, the sambaAccount and associated attributes have been moved to the historical section of the schema file and must be uncommented before use if needed. The Samba-2.2 object class declaration for a {\texttt{\docbookhyphenatedot{sambaAccount}}} has not changed in the Samba-3 {\texttt{\docbookhyphenatefilename{samba.\dbz{}schema}}} file.

Other new object classes and their uses include:

\begin{itemize}
%--- Item
\item 
\index{sambaDomain} \index{domain information} \index{RID} \index{ldap suffix} \index{ldapsam} \index{idmap} {\texttt{\docbookhyphenatedot{sambaDomain}}} ---  domain information used to allocate RIDs for users and groups as necessary. The attributes are added in {``}ldap suffix{''} directory entry automatically if an idmap UID/GID range has been set and the {``}ldapsam{''} passdb backend has been selected.


%--- Item
\item 
\index{sambaGroupMapping} \index{ldap group suffix} \index{net groupmap} sambaGroupMapping ---  an object representing the relationship between a posixGroup and a Windows group/SID. These entries are stored in the {``}ldap group suffix{''} and managed by the {``}net groupmap{''} command.


%--- Item
\item 
\index{sambaUNIXIdPool} \index{ldap idmap suffix} \index{idmap UID} \index{idmap GID} {\texttt{\docbookhyphenatedot{sambaUNIXIdPool}}} ---  created in the {``}ldap idmap suffix{''} entry automatically and contains the next available {``}idmap UID{''} and {``}idmap GID{''}.


%--- Item
\item 
\index{sambaIdmapEntry} \index{idmap\_ldap module} {\texttt{\docbookhyphenatedot{sambaIdmapEntry}}} ---  object storing a mapping between a SID and a UNIX UID/GID. These objects are created by the idmap\_ldap module as needed.

\end{itemize}
\subparagraph*{New Suffix for Searching}
\label{id2627215}\hypertarget{id2627215}{}%

\index{LDAP queries} \index{passdb backend} \index{ldap suffix} \index{ldap user suffix} \index{ldap machine suffix} \index{ldap group suffix} \index{ldap idmap suffix} The following new {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameters have been added to aid in directing certain LDAP queries when {\ttfamily\itshape{\docbookhyphenatedot{passdb backend = ldapsam://...}}} has been specified.

\begin{itemize}
%--- Item
\item 
ldap suffix ---  used to search for user and computer accounts.


%--- Item
\item 
ldap user suffix ---  used to store user accounts.


%--- Item
\item 
ldap machine suffix ---  used to store machine trust accounts.


%--- Item
\item 
ldap group suffix ---  location of posixGroup/sambaGroupMapping entries.


%--- Item
\item 
ldap idmap suffix ---  location of sambaIdmapEntry objects.

\end{itemize}

\index{ldap suffix} \index{subsuffix parameters} If an {\ttfamily\itshape{\docbookhyphenatedot{ldap suffix}}} is defined, it will be appended to all of the remaining subsuffix parameters. In this case, the order of the suffix listings in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} is important. Always place the {\ttfamily\itshape{\docbookhyphenatedot{ldap suffix}}} first in the list.

Due to a limitation in Samba's {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parsing, you should not surround the domain names with quotation marks.
\subparagraph*{IdMap LDAP Support}
\label{id2627362}\hypertarget{id2627362}{}%

\index{idmap backend} Samba-3 supports an LDAP backend for the idmap subsystem. The following options inform Samba that the idmap table should be stored on the directory server {\em{onterose}} in the ou=Idmap,dc=quenya,dc=org partition.

\begin{lstlisting}[language=smbconf,style=smbconfblock]
[global]
 ... 	idmap backend = ldap:ldap://onterose/
 	ldap idmap suffix = ou=Idmap
 	idmap uid = 40000-50000
 	idmap gid = 40000-50000
\end{lstlisting}

\index{NFS} This configuration allows Winbind installations on multiple servers to share a UID/GID number space, thus avoiding the interoperability problems with NFS that were present in Samba-2.2.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Migration from NT4 PDC to Samba-3 PDC 
% ------------------------------------------------------------- 	
\chapter{Migration from NT4 PDC to Samba-3 PDC}
\label{NT4Migration}\hypertarget{NT4Migration}{}%

\index{migrate} \index{domain control} This is a rough guide to assist those wishing to migrate from NT4 domain control to Samba-3-based domain control.

% ------------------------   
% Section 
\section{Planning and Getting Started}
\label{id2460638}\hypertarget{id2460638}{}%

\index{show-stopper-type} In the IT world there is often a saying that all problems are encountered because of poor planning. The corollary to this saying is that not all problems can be anticipated and planned for. Then again, good planning will anticipate most show-stopper-type situations.

\index{migration plan} Those wishing to migrate from MS Windows NT4 domain control to a Samba-3 domain control environment would do well to develop a detailed migration plan. So here are a few pointers to help migration get underway.
\subsection{Objectives}
\label{id2625666}\hypertarget{id2625666}{}%

\index{migration process} The key objective for most organizations is to make the migration from MS Windows NT4 to Samba-3 domain control as painless as possible. One of the challenges you may experience in your migration process may well be convincing management that the new environment should remain in place. Many who have introduced open source technologies have experienced pressure to return to a Microsoft-based platform solution at the first sign of trouble.

\index{change motivations} Before attempting a migration to a Samba-3-controlled network, make every possible effort to gain all-round commitment to the change. Know precisely {\em{why}} the change is important for the organization. Possible motivations to make a change include:
\index{manageability}\index{functionality}\index{operating costs}\index{support exposure}\index{licensing}
\begin{itemize}
%--- Item
\item 
Improve network manageability.


%--- Item
\item 
Obtain better user-level functionality.


%--- Item
\item 
Reduce network operating costs.


%--- Item
\item 
Reduce exposure caused by Microsoft withdrawal of NT4 support.


%--- Item
\item 
Avoid MS License 6 implications.


%--- Item
\item 
Reduce organization's dependency on Microsoft.

\end{itemize}

\index{alternative solution} \index{advantages} \index{core values} \index{migration} \index{ADS} \index{without ADS} Make sure everyone knows that Samba-3 is not MS Windows NT4. Samba-3 offers an alternative solution that is both different from MS Windows NT4 and offers advantages compared with it. Gain recognition that Samba-3 lacks many of the features that Microsoft has promoted as core values in migration from MS Windows NT4 to MS Windows 2000 and beyond (with or without Active Directory services).

What are the features that Samba-3 cannot provide?
\index{Active Directory Server}\index{Group Policy Objects}\index{Machine Policy Objects}\index{Logon Scripts}\index{Access Controls}
\begin{itemize}
%--- Item
\item 
Active Directory Server.


%--- Item
\item 
Group Policy Objects (in Active Directory).


%--- Item
\item 
Machine Policy Objects.


%--- Item
\item 
Logon Scripts in Active Directory.


%--- Item
\item 
Software Application and Access Controls in Active Directory.

\end{itemize}

The features that Samba-3 does provide and that may be of compelling interest to your site include:
\index{ownership cost}\index{Global support}\index{Dynamic SMB servers}\index{on-the-fly logon scripts}\index{on-the-fly policy files}\index{stability}\index{reliability}\index{performance}\index{availability}\index{Manageability}\index{backend authentication}\index{tdbsam}\index{ldapsam}\index{single-sign-on}\index{distribute authentication systems}
\begin{itemize}
%--- Item
\item 
Lower cost of ownership.


%--- Item
\item 
Global availability of support with no strings attached.


%--- Item
\item 
Dynamic SMB servers (can run more than one SMB/CIFS server per UNIX/Linux system).


%--- Item
\item 
Creation of on-the-fly logon scripts.


%--- Item
\item 
Creation of on-the-fly policy files.


%--- Item
\item 
Greater stability, reliability, performance, and availability.


%--- Item
\item 
Manageability via an SSH connection.


%--- Item
\item 
Flexible choices of backend authentication technologies (tdbsam, ldapsam).


%--- Item
\item 
Ability to implement a full single-sign-on architecture.


%--- Item
\item 
Ability to distribute authentication systems for absolute minimum wide-area network bandwidth demand.

\end{itemize}

\index{successful migration} Before migrating a network from MS Windows NT4 to Samba-3, consider all necessary factors. Users should be educated about changes they may experience so the change will be a welcome one and not become an obstacle to the work they need to do. The following sections explain factors that will help ensure a successful migration.
\subsubsection{Domain Layout}
\label{id2624168}\hypertarget{id2624168}{}%

\index{domain controller} \index{backup domain controller} \index{secondary controller} \index{domain member} \index{standalone server} \index{network security} \index{domain context} \index{PDC} \index{BDCs} \index{LDAP} \index{authentication backend} \index{complex organization} \index{LDAP database} \index{master server} \index{slave servers} \index{multiple domains} Samba-3 can be configured as a domain controller, a backup domain controller (probably best called a secondary controller), a domain member, or a standalone server. The Windows network security domain context should be sized and scoped before implementation. Particular attention needs to be paid to the location of the Primary Domain Controller (PDC) as well as backup controllers (BDCs). One way in which Samba-3 differs from Microsoft technology is that if one chooses to use an LDAP authentication backend, then the same database can be used by several different domains. In a complex organization, there can be a single LDAP database, which itself can be distributed (have a master server and multiple slave servers) that can simultaneously serve multiple domains.

\index{network bandwidth} From a design perspective, the number of users per server as well as the number of servers per domain should be scaled taking into consideration server capacity and network bandwidth.

\index{network segment} \index{multiple network segments} \index{domain controller} \index{ping} \index{BDC} \index{remote segment} A physical network segment may house several domains. Each may span multiple network segments. Where domains span routed network segments, consider and test the performance implications of the design and layout of a network. A centrally located domain controller that is designed to serve multiple routed network segments may result in severe performance problems. Check the response time (ping timing) between the remote segment and the PDC. If it's long (more than 100 ms), locate a BDC on the remote segment to serve as the local authentication and access control server.
\subsubsection{Server Share and Directory Layout}
\label{id2530653}\hypertarget{id2530653}{}%

\index{Simplicity is king} \index{well-controlled network} There are cardinal rules to effective network design that cannot be broken with impunity. The most important rule: Simplicity is king in every well-controlled network. Every part of the infrastructure must be managed; the more complex it is, the greater will be the demand of keeping systems secure and functional.

\index{disk space} \index{backed up} \index{tape} \index{backup} \index{validate every backup} \index{disaster recovery} Keep in mind the nature of how data must be shared. Physical disk space layout should be considered carefully. Some data must be backed up. The simpler the disk layout, the easier it will be to keep track of backup needs. Identify what backup media will meet your needs; consider backup to tape, CD-ROM or DVD-ROM, or other offline storage medium. Plan and implement for minimum maintenance. Leave nothing to chance in your design; above all, do not leave backups to chance: backup, test, and validate every backup; create a disaster recovery plan and prove that it works.

\index{access control needs} \index{group permissions} \index{sticky bit} Users should be grouped according to data access control needs. File and directory access is best controlled via group permissions, and the use of the {``}sticky bit{''} on group-controlled directories may substantially avoid file access complaints from Samba share users.

\index{network administrators} \index{document design} \index{simple access controls} \index{obtuse complexity} \index{document design} Inexperienced network administrators often attempt elaborate techniques to set access controls on files, directories, shares, as well as in share definitions. Keep your design and implementation simple and document your design extensively. Have others audit your documentation. Do not create a complex mess that your successor will not understand. Remember, job security through complex design and implementation may cause loss of operations and downtime to users as the new administrator learns to untangle your knots. Keep access controls simple and effective, and make sure that users will never be interrupted by obtuse complexity.
\subsubsection{Logon Scripts}
\label{id2618838}\hypertarget{id2618838}{}%

\index{Logon scripts} Logon scripts can help to ensure that all users gain the share and printer connections they need.

Logon scripts can be created on the fly so all commands executed are specific to the rights and privileges granted to the user. The preferred controls should be effected through group membership so group information can be used to create a custom logon script using the \smbconfoption{root preexec} parameters to the \smbconfsection{NETLOGON} share.

\index{kixstart} Some sites prefer to use a tool such as {\bfseries{kixstart}} to establish a controlled user environment. In any case, you may wish to do a Google search for logon script process controls. In particular, you may wish to explore the use of the Microsoft Knowledge Base article KB189105 that deals with how to add printers without user intervention via the logon script process.
\subsubsection{Profile Migration/Creation}
\label{id2618899}\hypertarget{id2618899}{}%

User and group profiles may be migrated using the tools described in the section titled Desktop Profile Management.

\index{SID} \index{NTuser.DAT} Profiles may also be managed using the Samba-3 tool {\bfseries{profiles}}. This tool allows the MS Windows NT-style security identifiers (SIDs) that are stored inside the profile {\texttt{\docbookhyphenatefilename{NTuser.\dbz{}DAT}}} file to be changed to the SID of the Samba-3 domain.
\subsubsection{User and Group Accounts}
\label{id2624629}\hypertarget{id2624629}{}%

\index{migrate account settings} \index{migrate user} \index{migrate group} \index{map} It is possible to migrate all account settings from an MS Windows NT4 domain to Samba-3. Before attempting to migrate user and group accounts, you are STRONGLY advised to create in Samba-3 the groups that are present on the MS Windows NT4 domain {\em{AND}} to map them to suitable UNIX/Linux groups. By following this simple advice, all user and group attributes should migrate painlessly.
\subsection{Steps in Migration Process}
\label{id2624679}\hypertarget{id2624679}{}%

The approximate migration process is described below.

\begin{itemize}
%--- Item
\item 
You have an NT4 PDC that has the users, groups, policies, and profiles to be migrated.


%--- Item
\item 
\index{domain controller} \index{netlogon share} \index{BDC} Samba-3 is set up as a domain controller with netlogon share, profile share, and so on. Configure the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to function as a BDC: {\ttfamily\itshape{\docbookhyphenatedot{domain master = No}}}.

\end{itemize}
The Account Migration Process\index{pdbedit}\begin{enumerate}

\item{\index{pdbedit} Create a BDC account in the old NT4 domain for the Samba server using NT Server Manager. {\em{Samba must not be running.}}}

\item{\index{net!rpc!join} {\ttfamily\bfseries{\docbookhyphenatedot{net rpc join -\dbz{}S {\ttfamily\itshape{\docbookhyphenatedot{NT4PDC}}} -\dbz{}w {\ttfamily\itshape{\docbookhyphenatedot{DOMNAME}}} -\dbz{}U Administrator\%{\ttfamily\itshape{\docbookhyphenatedot{passwd}}}}}}}

\item{\index{net!rpc!vampire} {\ttfamily\bfseries{\docbookhyphenatedot{net rpc vampire -\dbz{}S {\ttfamily\itshape{\docbookhyphenatedot{NT4PDC}}} -\dbz{}U administrator\%{\ttfamily\itshape{\docbookhyphenatedot{passwd}}}}}}}

\item{{\ttfamily\bfseries{\docbookhyphenatedot{pdbedit -\dbz{}L}}}  Note: Did the users migrate?}

\item{\index{net!groupmap} \index{initGroups.sh} Now assign each of the UNIX groups to NT groups: (It may be useful to copy this text to a script called {\texttt{\docbookhyphenatefilename{initGroups.\dbz{}sh}}}) 
\begin{Verbatim}[]

#!/bin/bash
#### Keep this as a shell script for future re-use
			
# First assign well known domain global groups
net groupmap add ntgroup="Domain Admins" unixgroup=root rid=512 type=d
net groupmap add ntgroup="Domain Users"  unixgroup=users rid=513 type=d
net groupmap add ntgroup="Domain Guests" unixgroup=nobody rid=514 type=d

# Now for our added domain global groups
net groupmap add ntgroup="Designers" unixgroup=designers type=d
net groupmap add ntgroup="Engineers" unixgroup=engineers type=d
net groupmap add ntgroup="QA Team"   unixgroup=qateam    type=d

\end{Verbatim}
}

\item{{\ttfamily\bfseries{\docbookhyphenatedot{net groupmap list}}}  Check that all groups are recognized.}
\end{enumerate}

Migrate all the profiles, then migrate all policy files.

% ------------------------   
% Section 
\section{Migration Options}
\label{id2624922}\hypertarget{id2624922}{}%

Sites that wish to migrate from MS Windows NT4 domain control to a Samba-based solution generally fit into three basic categories. \hyperlink{majtypes}{Table {\ref{majtypes}}} shows the possibilities.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{majtypes}{}%
\captionswapskip{}{{\caption{The Three Major Site Types}\label{majtypes}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|l|X|}
\hline 
{{{\bfseries Number of Users}}} & {{{\bfseries Description}}} \tabularnewline
 \hline 
{{\textless{} 50}} & {{Want simple conversion with no pain.}} \tabularnewline
 \hline 
{{50 - 250}} & {{Want new features; can manage some inhouse complexity.}} \tabularnewline
 \hline 
{{\textgreater{} 250}} & {{Solution/implementation must scale well; complex needs. Cross-departmental decision process. Local expertise in most areas.}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsection{Planning for Success}
\label{id2628297}\hypertarget{id2628297}{}%

There are three basic choices for sites that intend to migrate from MS Windows NT4 to Samba-3:

\begin{itemize}
%--- Item
\item 
Simple conversion (total replacement).


%--- Item
\item 
Upgraded conversion (could be one of integration).


%--- Item
\item 
Complete redesign (completely new solution).

\end{itemize}

Minimize downstream problems by:

\begin{itemize}
%--- Item
\item 
Taking sufficient time.


%--- Item
\item 
Avoiding panic.


%--- Item
\item 
Testing all assumptions.


%--- Item
\item 
Testing the full roll-out program, including workstation deployment.

\end{itemize}

\hyperlink{natconchoices}{Table {\ref{natconchoices}}} lists the conversion choices given the type of migration being contemplated.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{natconchoices}{}%
\captionswapskip{}{{\caption{Nature of the Conversion Choices}\label{natconchoices}}}
\captionswapskip{}\begin{tabularx}{\linewidth}{|>{\hsize=1\hsize}X|>{\hsize=1\hsize}X|>{\hsize=1\hsize}X|}
\hline 
{{{\bfseries Simple Install}}} & {{{\bfseries Upgrade Decisions}}} & {{{\bfseries Redesign Decisions}}} \tabularnewline
 \hline 
{{Make use of minimal OS-specific features}} & {{Translate NT4 features to new host OS features}} & {{Improve on NT4 functionality, enhance management capabilities}} \tabularnewline
 \hline 
{{Move all accounts from NT4 into Samba-3}} & {{Copy and improve}} & {{Authentication regime (database location and access)}} \tabularnewline
 \hline 
{{Make least number of operational changes}} & {{Make progressive improvements}} & {{Desktop management methods}} \tabularnewline
 \hline 
{{Take least amount of time to migrate}} & {{Minimize user impact}} & {{Better control of Desktops/Users}} \tabularnewline
 \hline 
{{Live versus isolated conversion}} & {{Maximize functionality}} & {{Identify Needs for: {\em{Manageability, Scalability, Security, Availability}}}} \tabularnewline
 \hline 
{{Integrate Samba-3, then migrate while users are active, then change of control (swap out)}} & {{Take advantage of lower maintenance opportunity}} & {{}} \tabularnewline
\hline 
\end{tabularx}
\end{center}
\end{table}

\subsection{Samba-3 Implementation Choices}
\label{id2628516}\hypertarget{id2628516}{}%

\begin{description}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Authentication Database/Backend}]\null{}
Samba-3 can use an external authentication backend:


\begin{itemize}
%--- Item
\item 
Winbind (external Samba or NT4/200x server).


%--- Item
\item 
External server could use Active Directory or NT4 domain.


%--- Item
\item 
Can use pam\_mkhomedir.so to autocreate home directories.


%--- Item
\item 
Samba-3 can use a local authentication backend: {\ttfamily\itshape{\docbookhyphenatedot{smbpasswd}}}, {\ttfamily\itshape{\docbookhyphenatedot{tdbsam}}}, {\ttfamily\itshape{\docbookhyphenatedot{ldapsam}}}

\end{itemize}

% \null and \mbox are tricks to induce different typesetting decisions
\item[{Access Control Points}]\null{}
Samba permits Access Control points to be set:
\index{share ACLs}\index{UNIX permissions}\index{POSIX ACLS}\index{share stanza controls}
\begin{itemize}
%--- Item
\item 
On the share itself ---  using share ACLs.


%--- Item
\item 
On the file system ---  using UNIX permissions on files and directories.

Note: Can enable Posix ACLs in file system also.


%--- Item
\item 
Through Samba share parameters ---  not recommended except as last resort.

\end{itemize}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Policies (migrate or create new ones)}]\null{}
\index{policies} \index{NTConfig.POL} Exercise great caution when making registry changes; use the right tool and be aware that changes made through NT4-style {\texttt{\docbookhyphenatefilename{NTConfig.\dbz{}POL}}} files can leave permanent changes. \index{Group Policy Editor} \index{tattoo effect} \index{permanent changes}

\begin{itemize}
%--- Item
\item 
Using Group Policy Editor (NT4).


%--- Item
\item 
Watch out for tattoo effect.

\end{itemize}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{User and Group Profiles}]\null{}
\index{NTUser.DAT} \index{SIDs} Platform-specific, so use platform tool to change from a local to a roaming profile. Can use new profiles tool to change SIDs ({\texttt{\docbookhyphenatefilename{NTUser.\dbz{}DAT}}}).
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Logon Scripts}]\null{}
Know how they work.
% \null and \mbox are tricks to induce different typesetting decisions
\item[{User and Group Mapping to UNIX/Linux}]\null{}
\index{pdbedit} User and group mapping code is new. Many problems have been experienced as network administrators who are familiar with Samba-2.2.x migrate to Samba-3. Carefully study the chapters that document the new password backend behavior and the new group mapping functionality.

\begin{itemize}
%--- Item
\item 
The {\ttfamily\itshape{\docbookhyphenatedot{username map}}} facility may be needed.


%--- Item
\item 
Use {\bfseries{net groupmap}} to connect NT4 groups to UNIX groups.


%--- Item
\item 
Use {\bfseries{pdbedit}} to set/change user configuration.

When migrating to LDAP backend, it may be easier to dump the initial LDAP database to LDIF, edit, then reload into LDAP.

\end{itemize}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{OS-Specific Scripts/Programs May be Needed}]\null{}
Every operating system has its peculiarities. These are the result of engineering decisions that were based on the experience of the designer and may have side effects that were not anticipated. Limitations that may bite the Windows network administrator include:

\begin{itemize}
%--- Item
\item 
Add/Delete Users: Note OS limits on size of name (Linux 8 chars, NT4 up to 254 chars).


%--- Item
\item 
Add/Delete Machines: Applied only to domain members (Note: machine names may be limited to 16 characters).


%--- Item
\item 
Use {\bfseries{net groupmap}} to connect NT4 groups to UNIX groups.


%--- Item
\item 
Add/Delete Groups: Note OS limits on size and nature. Linux limit is 16 char, no spaces, and no uppercase chars ({\bfseries{groupadd}}).

\end{itemize}
% \null and \mbox are tricks to induce different typesetting decisions
\item[{Migration Tools}]\null{}
\index{pdbedit} Domain Control (NT4-Style) Profiles, Policies, Access Controls, Security 
\begin{itemize}
%--- Item
\item 
Samba: {\bfseries{net, rpcclient, smbpasswd, pdbedit, profiles}}


%--- Item
\item 
Windows: {\bfseries{NT4 Domain User Manager, Server Manager (NEXUS)}}

\end{itemize}

\end{description}
\cleardoublepage 
% -------------------------------------------------------------
% Chapter SWAT: The Samba Web Administration Tool 
% ------------------------------------------------------------- 	
\chapter{SWAT: The Samba Web Administration Tool}
\label{SWAT}\hypertarget{SWAT}{}%

\index{configuration tool} \index{SWAT} \index{Web-based configuration} There are many and varied opinions regarding the usefulness of SWAT. No matter how hard one tries to produce the perfect configuration tool, it remains an object of personal taste. SWAT is a tool that allows Web-based configuration of Samba. It has a wizard that may help to get Samba configured quickly, it has context-sensitive help on each {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} parameter, it provides for monitoring of current state of connection information, and it allows networkwide MS Windows network password management.

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2518353}\hypertarget{id2518353}{}%

\index{internetworking super daemon} SWAT is a facility that is part of the Samba suite. The main executable is called {\bfseries{swat}} and is invoked by the internetworking super daemon. See \hyperlink{xinetd}{Section {\ref{xinetd}}} for details.

\index{man} SWAT uses integral Samba components to locate parameters supported by the particular version of Samba. Unlike tools and utilities that are external to Samba, SWAT is always up to date as known Samba parameters change. SWAT provides context-sensitive help for each configuration parameter, directly from {\bfseries{man}} page entries.

\index{documentation} \index{configuration files} \index{internal ordering} Some network administrators believe that it is a good idea to write systems documentation inside configuration files, and for them SWAT will always be a nasty tool. SWAT does not store the configuration file in any intermediate form; rather, it stores only the parameter settings, so when SWAT writes the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file to disk, it writes only those parameters that are at other than the default settings. The result is that all comments, as well as parameters that are no longer supported, will be lost from the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Additionally, the parameters will be written back in internal ordering.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{stripped of comments} Before using SWAT, please be warned ---  SWAT will completely replace your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} with a fully optimized file that has been stripped of all comments you might have placed there and only nondefault settings will be written to the file.
\end{admonition}


% ------------------------   
% Section 
\section{Guidelines and Technical Tips}
\label{id2625461}\hypertarget{id2625461}{}%

\index{internationalization support} This section aims to unlock the dark secrets behind how SWAT may be made to work, how it can be made more secure, and how to solve internationalization support problems.
\subsection{Validate SWAT Installation}
\label{id2625480}\hypertarget{id2625480}{}%

\index{SWAT binary support} The very first step that should be taken before attempting to configure a host system for SWAT operation is to check that it is installed. This may seem a trivial point to some, but several Linux distributions do not install SWAT by default, even though they do ship an installable binary support package containing SWAT on the distribution media.

\index{swat} When you have confirmed that SWAT is installed, it is necessary to validate that the installation includes the binary {\bfseries{swat}} file as well as all the supporting text and Web files. A number of operating system distributions in the past have failed to include the necessary support files, even though the {\bfseries{swat}} binary executable file was installed.

\index{inetd} \index{xinetd} Finally, when you are sure that SWAT has been fully installed, please check that SWAT is enabled in the control file for the internetworking super-daemon (inetd or xinetd) that is used on your operating system platform.
\subsubsection{Locating the SWAT File}
\label{id2625551}\hypertarget{id2625551}{}%

\index{/usr/local/samba/bin} \index{/usr/sbin} \index{/opt/samba/bin} To validate that SWAT is installed, first locate the {\bfseries{swat}} binary file on the system. It may be found under the following directories:


\begin{tabular}{l}

{\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}bin}}} ---  the default Samba location  \\
{\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}sbin}}} ---  the default location on most Linux systems  \\
{\texttt{\docbookhyphenatefilename{/\dbz{}opt/\dbz{}samba/\dbz{}bin}}}  \\
\end{tabular}


The actual location is much dependent on the choice of the operating system vendor or as determined by the administrator who compiled and installed Samba.

There are a number of methods that may be used to locate the {\bfseries{swat}} binary file. The following methods may be helpful.

\index{swat} \index{operating system search path} \index{swat command-line options} If {\bfseries{swat}} is in your current operating system search path, it will be easy to find it. You can ask what are the command-line options for {\bfseries{swat}} as shown here: 
\begin{Verbatim}[]

frodo:~ # swat -?
Usage: swat [OPTION...]
  -a, --disable-authentication         Disable authentication (demo mode)

Help options:
  -?, --help                           Show this help message
  --usage                              Display brief usage message

Common samba options:
  -d, --debuglevel=DEBUGLEVEL          Set debug level
  -s, --configfile=CONFIGFILE          Use alternative configuration file
  -l, --log-basename=LOGFILEBASE       Basename for log/debug files
  -V, --version                        Print version

\end{Verbatim}

\subsubsection{Locating the SWAT Support Files}
\label{id2468140}\hypertarget{id2468140}{}%

Now that you have found that {\bfseries{swat}} is in the search path, it is easy to identify where the file is located. Here is another simple way this may be done: 
\begin{Verbatim}[]

frodo:~ # whereis swat
swat: /usr/sbin/swat /usr/share/man/man8/swat.8.gz

\end{Verbatim}


If the above measures fail to locate the {\bfseries{swat}} binary, another approach is needed. The following may be used: 
\begin{Verbatim}[]

frodo:/ # find / -name swat -print
/etc/xinetd.d/swat
/usr/sbin/swat
/usr/share/samba/swat
frodo:/ #

\end{Verbatim}


This list shows that there is a control file for {\bfseries{xinetd}}, the internetwork super-daemon that is installed on this server. The location of the SWAT binary file is {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}sbin/\dbz{}swat}}}, and the support files for it are located under the directory {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}samba/\dbz{}swat}}}.

We must now check where {\bfseries{swat}} expects to find its support files. This can be done as follows: 
\begin{Verbatim}[]

frodo:/ # strings /usr/sbin/swat | grep "/swat"
/swat/
...
/usr/share/samba/swat
frodo:/ #

\end{Verbatim}


The {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}samba/\dbz{}swat/\dbz{}}}} entry shown in this listing is the location of the support files. You should verify that the support files exist under this directory. A sample list is as shown: 
\begin{Verbatim}[]

jht@frodo:/> find /usr/share/samba/swat -print
/usr/share/samba/swat
/usr/share/samba/swat/help
/usr/share/samba/swat/lang
/usr/share/samba/swat/lang/ja
/usr/share/samba/swat/lang/ja/help
/usr/share/samba/swat/lang/ja/help/welcome.html
/usr/share/samba/swat/lang/ja/images
/usr/share/samba/swat/lang/ja/images/home.gif
...
/usr/share/samba/swat/lang/ja/include
/usr/share/samba/swat/lang/ja/include/header.nocss.html
...
/usr/share/samba/swat/lang/tr
/usr/share/samba/swat/lang/tr/help
/usr/share/samba/swat/lang/tr/help/welcome.html
/usr/share/samba/swat/lang/tr/images
/usr/share/samba/swat/lang/tr/images/home.gif
...
/usr/share/samba/swat/lang/tr/include
/usr/share/samba/swat/lang/tr/include/header.html
/usr/share/samba/swat/using_samba
...
/usr/share/samba/swat/images
/usr/share/samba/swat/images/home.gif
...
/usr/share/samba/swat/include
/usr/share/samba/swat/include/footer.html
/usr/share/samba/swat/include/header.html
jht@frodo:/>

\end{Verbatim}


If the files needed are not available, it is necessary to obtain and install them before SWAT can be used.
\subsection{Enabling SWAT for Use}
\label{xinetd}\hypertarget{xinetd}{}%

SWAT should be installed to run via the network super-daemon. Depending on which system your UNIX/Linux system has, you will have either an {\bfseries{inetd}}- or {\bfseries{xinetd}}-based system.

The nature and location of the network super-daemon varies with the operating system implementation. The control file (or files) can be located in the file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}inetd.\dbz{}conf}}} or in the directory {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}[x]inet[d].\dbz{}d}}} or in a similar location.

The control entry for the older style file might be: \index{swat!enable}


\begin{Verbatim}[]

	# swat is the Samba Web Administration Tool
	swat stream tcp nowait.400 root /usr/sbin/swat swat

\end{Verbatim}


A control file for the newer style xinetd could be:


\begin{Verbatim}[]

# default: off
# description: SWAT is the Samba Web Admin Tool. Use swat \
#              to configure your Samba server. To use SWAT, \
#              connect to port 901 with your favorite web browser.
service swat
{
	port    = 901
	socket_type     = stream
	wait    = no
	only_from = localhost
	user    = root
	server  = /usr/sbin/swat
	log_on_failure  += USERID
	disable = no
}

\end{Verbatim}
 In the above, the default setting for {\ttfamily\itshape{\docbookhyphenatedot{disable}}} is {\texttt{\docbookhyphenatedot{yes}}}. This means that SWAT is disabled. To enable use of SWAT, set this parameter to {\texttt{\docbookhyphenatedot{no}}} as shown.

\index{swat} \index{/usr/sbin} \index{/usr/share/samba/swat} \index{/usr/local/samba/swat} Both of the previous examples assume that the {\bfseries{swat}} binary has been located in the {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}sbin}}} directory. In addition to the above, SWAT will use a directory access point from which it will load its Help files as well as other control information. The default location for this on most Linux systems is in the directory {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}share/\dbz{}samba/\dbz{}swat}}}. The default location using Samba defaults will be {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}swat}}}.

\index{SWAT permission allowed} \index{password change facility} Access to SWAT will prompt for a logon. If you log onto SWAT as any non-root user, the only permission allowed is to view certain aspects of configuration as well as access to the password change facility. The buttons that will be exposed to the non-root user are {\sffamily \bfseries HOME}, {\sffamily \bfseries STATUS}, {\sffamily \bfseries VIEW}, and {\sffamily \bfseries PASSWORD}. The only page that allows change capability in this case is {\sffamily \bfseries PASSWORD}.

As long as you log onto SWAT as the user {\em{root}}, you should obtain full change and commit ability. The buttons that will be exposed include {\sffamily \bfseries HOME}, {\sffamily \bfseries GLOBALS}, {\sffamily \bfseries SHARES}, {\sffamily \bfseries PRINTERS}, {\sffamily \bfseries WIZARD}, {\sffamily \bfseries STATUS}, {\sffamily \bfseries VIEW}, and {\sffamily \bfseries PASSWORD}.
\subsection{Securing SWAT through SSL}
\label{id2619001}\hypertarget{id2619001}{}%

\index{SSL} \index{swat!security} Many people have asked about how to set up SWAT with SSL to allow for secure remote administration of Samba. Here is a method that works, courtesy of Markus Krieger.

Modifications to the SWAT setup are as follows:
\begin{enumerate}

\item{\index{OpenSSL} Install OpenSSL.}

\item{\index{certificate} \index{private key} Generate certificate and private key. \index{/usr/bin/openssl} 
\begin{Verbatim}[]

root# /usr/bin/openssl req -new -x509 -days 365 -nodes -config \
	/usr/share/doc/packages/stunnel/stunnel.cnf \
	-out /etc/stunnel/stunnel.pem -keyout /etc/stunnel/stunnel.pem

\end{Verbatim}
}

\item{Remove SWAT entry from [x]inetd.}

\item{\index{stunnel} Start {\bfseries{stunnel}}. 
\begin{Verbatim}[]

root# stunnel -p /etc/stunnel/stunnel.pem -d 901 \
	 -l /usr/local/samba/bin/swat swat 

\end{Verbatim}
}
\end{enumerate}

Afterward, simply connect to SWAT by using the URL {\textless}\url{https://myhost:901}{\textgreater}, accept the certificate, and the SSL connection is up.
\subsection{Enabling SWAT Internationalization Support}
\label{id2619158}\hypertarget{id2619158}{}%

SWAT can be configured to display its messages to match the settings of the language configurations of your Web browser. It will be passed to SWAT in the Accept-Language header of the HTTP request.

To enable this feature:

\begin{itemize}
%--- Item
\item 
Install the proper {\bfseries{msg}} files from the Samba {\texttt{\docbookhyphenatefilename{source/\dbz{}po}}} directory into \$LIBDIR.


%--- Item
\item 
Set your browsers language setting.

\end{itemize}

\index{msg file} \index{Japanese} \index{French} \index{English} The name of the {\bfseries{msg}} file is the same as the language ID sent by the browser. For example, {\em{en}} means English, {\em{ja}} means Japanese, {\em{fr}} means French.

\index{locale} If you do not like some of messages, or there are no {\bfseries{msg}} files for your locale, you can create them simply by copying the {\bfseries{en.msg}} files to the directory for {``}your language ID.msg{''} and filling in proper strings to each {``}msgstr{''}. For example, in {\texttt{\docbookhyphenatefilename{it.\dbz{}msg}}}, the {\bfseries{msg}} file for the Italian locale, just set: 
\begin{Verbatim}[]

msgid "Set Default"
msgstr "Imposta Default"

\end{Verbatim}
 \index{msg} and so on. If you find a mistake or create a new {\bfseries{msg}} file, please email it to us so we will consider it in the next release of Samba. The {\bfseries{msg}} file should be encoded in UTF-8.

\index{UTF-8 encoding} Note that if you enable this feature and the \smbconfoption{display charset} is not matched to your browser's setting, the SWAT display may be corrupted. In a future version of Samba, SWAT will always display messages with UTF-8 encoding. You will then not need to set this {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file parameter.

% ------------------------   
% Section 
\section{Overview and Quick Tour}
\label{id2625097}\hypertarget{id2625097}{}%

SWAT is a tool that may be used to configure Samba or just to obtain useful links to important reference materials such as the contents of this book as well as other documents that have been found useful for solving Windows networking problems.
\subsection{The SWAT Home Page}
\label{id2625111}\hypertarget{id2625111}{}%

The SWAT title page provides access to the latest Samba documentation. The manual page for each Samba component is accessible from this page, as are the Samba3-HOWTO (this document) as well as the O'Reilly book {``}Using Samba.{''}

Administrators who wish to validate their Samba configuration may obtain useful information from the man pages for the diagnostic utilities. These are available from the SWAT home page also. One diagnostic tool that is not mentioned on this page but that is particularly useful is {\bfseries{ethereal}}\label{id2625135}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.ethereal.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2625135}.

\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

SWAT can be configured to run in {\em{demo}} mode. This is not recommended because it runs SWAT without authentication and with full administrative ability. It allows changes to {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} as well as general operation with root privileges. The option that creates this ability is the {\texttt{\docbookhyphenatedot{-a}}} flag to SWAT. {\em{Do not use this in a production environment.}}
\end{admonition}

\subsection{Global Settings}
\label{id2625173}\hypertarget{id2625173}{}%

The {\sffamily \bfseries GLOBALS} button exposes a page that allows configuration of the global parameters in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. There are two levels of exposure of the parameters:

\begin{itemize}
%--- Item
\item 
{\sffamily \bfseries Basic} ---  exposes common configuration options.


%--- Item
\item 
{\sffamily \bfseries Advanced} ---  exposes configuration options needed in more complex environments.

\end{itemize}

To switch to other than {\sffamily \bfseries Basic} editing ability, click on {\sffamily \bfseries Advanced}. You may also do this by clicking on the radio button, then click on the {\sffamily \bfseries Commit Changes} button.

After making any changes to configuration parameters, make sure that you click on the {\sffamily \bfseries Commit Changes} button before moving to another area; otherwise, your changes will be lost.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

SWAT has context-sensitive help. To find out what each parameter is for, simply click on the {\sffamily \bfseries Help} link to the left of the configuration parameter.
\end{admonition}

\subsection{Share Settings}
\label{id2625278}\hypertarget{id2625278}{}%

To affect a currently configured share, simply click on the pull-down button between the {\sffamily \bfseries Choose Share} and the {\sffamily \bfseries Delete Share} buttons and select the share you wish to operate on. To edit the settings, click on the {\sffamily \bfseries Choose Share} button. To delete the share, simply press the {\sffamily \bfseries Delete Share} button.

To create a new share, next to the button labeled {\sffamily \bfseries Create Share}, enter into the text field the name of the share to be created, then click on the {\sffamily \bfseries Create Share} button.
\subsection{Printers Settings}
\label{id2622331}\hypertarget{id2622331}{}%

To affect a currently configured printer, simply click on the pull-down button between the {\sffamily \bfseries Choose Printer} and the {\sffamily \bfseries Delete Printer} buttons and select the printer you wish to operate on. To edit the settings, click on the {\sffamily \bfseries Choose Printer} button. To delete the share, simply press the {\sffamily \bfseries Delete Printer} button.

To create a new printer, next to the button labeled {\sffamily \bfseries Create Printer}, enter into the text field the name of the share to be created, then click on the {\sffamily \bfseries Create Printer} button.
\subsection{The SWAT Wizard}
\label{id2622388}\hypertarget{id2622388}{}%

The purpose of the SWAT Wizard is to help the Microsoft-knowledgeable network administrator to configure Samba with a minimum of effort.

The Wizard page provides a tool for rewriting the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file in fully optimized format. This will also happen if you press the {\sffamily \bfseries Commit} button. The two differ because the {\sffamily \bfseries Rewrite} button ignores any changes that may have been made, while the {\sffamily \bfseries Commit} button causes all changes to be affected.

The {\sffamily \bfseries Edit} button permits the editing (setting) of the minimal set of options that may be necessary to create a working Samba server.

Finally, there are a limited set of options that determine what type of server Samba will be configured for, whether it will be a WINS server, participate as a WINS client, or operate with no WINS support. By clicking one button, you can elect to expose (or not) user home directories.
\subsection{The Status Page}
\label{id2622453}\hypertarget{id2622453}{}%

The status page serves a limited purpose. First, it allows control of the Samba daemons. The key daemons that create the Samba server environment are smbd, nmbd, and winbindd.

The daemons may be controlled individually or as a total group. Additionally, you may set an automatic screen refresh timing. As MS Windows clients interact with Samba, new smbd processes are continually spawned. The auto-refresh facility allows you to track the changing conditions with minimal effort.

Finally, the status page may be used to terminate specific smbd client connections in order to free files that may be locked.
\subsection{The View Page}
\label{id2622499}\hypertarget{id2622499}{}%

The view page allows you to view the optimized {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file and, if you are particularly masochistic, permits you also to see all possible global configuration parameters and their settings.
\subsection{The Password Change Page}
\label{id2622520}\hypertarget{id2622520}{}%

The password change page is a popular tool that allows the creation, deletion, deactivation, and reactivation of MS Windows networking users on the local machine. You can also use this tool to change a local password for a user account.

When logged in as a non-root account, the user must provide the old password as well as the new password (twice). When logged in as {\em{root}}, only the new password is required.

One popular use for this tool is to change user passwords across a range of remote MS Windows servers.
\cleardoublepage % ------------------------------------------------------------- 
% 
% PART Troubleshooting
% 
% ------------------------------------------------------------- 
\part{Troubleshooting}
\label{troubleshooting}\hypertarget{troubleshooting}{}%
\cleardoublepage 
% -------------------------------------------------------------
% Chapter The Samba Checklist 
% ------------------------------------------------------------- 	
\chapter{The Samba Checklist}
\label{diagnosis}\hypertarget{diagnosis}{}%

% ------------------------   
% Section 
\section{Introduction}
\label{id2627440}\hypertarget{id2627440}{}%

\index{validate} This file contains a list of tests you can perform to validate your Samba server. It also tells you what the likely cause of the problem is if it fails any one of these steps. If it passes all these tests, then it is probably working fine.

You should do all the tests in the order shown. We have tried to carefully choose them so later tests only use capabilities verified in the earlier tests. However, do not stop at the first error: there have been some instances when continuing with the tests has helped to solve a problem.

If you send one of the Samba mailing lists an email saying, {``}It does not work,{''} and you have not followed this test procedure, you should not be surprised if your email is ignored.

% ------------------------   
% Section 
\section{Assumptions}
\label{id2627480}\hypertarget{id2627480}{}%

In all of the tests, it is assumed you have a Samba server called BIGSERVER and a PC called ACLIENT, both in workgroup TESTGROUP.

The procedure is similar for other types of clients.

It is also assumed you know the name of an available share in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. I for our examples this share is called \smbconfsection{tmp}. You can add a \smbconfsection{tmp} share like this by adding the lines shown in \hyperlink{tmpshare}{Example {\ref{tmpshare}}}.

\begin{example}%
\hypertarget{tmpshare}{}%
\captionswapskip{}{{\caption{smb.conf with [tmp] Share}\label{tmpshare}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[tmp]
 	comment = temporary files 
 	path = /tmp
 	read only = yes
\end{lstlisting}
\end{example}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

These tests assume version 3.0.0 or later of the Samba suite. Some commands shown did not exist in earlier versions.
\end{admonition}


\index{error messages} \index{name resolution} \index{/etc/resolv.conf} Please pay attention to the error messages you receive. If any error message reports that your server is being unfriendly, you should first check that your IP name resolution is correctly set up. Make sure your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}resolv.\dbz{}conf}}} file points to name servers that really do exist.

\index{DNS server access} \index{name resolution} \index{dns proxy} \index{testparm} Also, if you do not have DNS server access for name resolution, please check that the settings for your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file results in {\ttfamily\itshape{\docbookhyphenatedot{dns proxy = no}}}. The best way to check this is with {\bfseries{testparm smb.conf}}.

\index{log files} \index{tail} \index{/usr/local/samba/var} \index{/var/log/samba} \index{log files!monitoring} It is helpful to monitor the log files during testing by using the {\bfseries{tail -F log\_file\_name}} in a separate terminal console (use ctrl-alt-F1 through F6 or multiple terminals in X). Relevant log files can be found (for default installations) in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}var}}}. Also, connection logs from machines can be found here or possibly in {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}log/\dbz{}samba}}}, depending on how or if you specified logging in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

If you make changes to your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file while going through these test, remember to restart smbd and nmbd.

% ------------------------   
% Section 
\section{The Tests}
\label{id2629055}\hypertarget{id2629055}{}%
Diagnosing Your Samba Server\begin{enumerate}

\item{\index{testparm} In the directory in which you store your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, run the command {\bfseries{testparm smb.conf}}. If it reports any errors, then your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} configuration file is faulty. 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{/etc/samba} \index{/usr/local/samba/lib} Your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file may be located in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}samba}}} or in {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}lib}}}.
\end{admonition}

}

\item{\index{ping} Run the command {\bfseries{ping BIGSERVER}} from the PC and {\bfseries{ping ACLIENT}} from the UNIX box. If you do not get a valid response, then your TCP/IP software is not correctly installed.  You will need to start a {``}DOS prompt{''} window on the PC to run ping.  \index{/etc/hosts} \index{DNS} \index{/etc/resolv.conf} If you get a message saying {``}host not found{''} or a similar message, then your DNS software or {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} file is not correctly set up. If using DNS, check that the {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}resolv.\dbz{}conf}}} has correct, current, entries in it. It is possible to run Samba without DNS entries for the server and client, but it is assumed you do have correct entries for the remainder of these tests.  \index{firewall} \index{iptables} \index{ipchains} Another reason why ping might fail is if your host is running firewall software. You will need to relax the rules to let in the workstation in question, perhaps by allowing access from another subnet (on Linux this is done via the appropriate firewall maintenance commands {\bfseries{ipchains}} or {\bfseries{iptables}}). 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Modern Linux distributions install ipchains/iptables by default. This is a common problem that is often overlooked.
\end{admonition}

 \index{iptables} \index{ipchains} If you wish to check what firewall rules may be present in a system under test, simply run {\bfseries{iptables -L -v}}, or if {\ttfamily\itshape{\docbookhyphenatedot{ipchains}}}-based firewall rules are in use, {\bfseries{ipchains -L -v}}.  Here is a sample listing from a system that has an external Ethernet interface (eth1) on which Samba is not active and an internal (private network) interface (eth0) on which Samba is active: 
\begin{Verbatim}[]

frodo:~ # iptables -L -v
Chain INPUT (policy DROP 98496 packets, 12M bytes)
 pkts bytes target     prot opt in     out     source     destination
 187K  109M ACCEPT     all  --  lo     any     anywhere   anywhere
 892K  125M ACCEPT     all  --  eth0   any     anywhere   anywhere
1399K 1380M ACCEPT     all  --  eth1   any     anywhere   anywhere  \
					state RELATED,ESTABLISHED

Chain FORWARD (policy DROP 0 packets, 0 bytes)
 pkts bytes target     prot opt in     out     source     destination
 978K 1177M ACCEPT     all  --  eth1   eth0    anywhere   anywhere \
					state RELATED,ESTABLISHED
 658K   40M ACCEPT     all  --  eth0   eth1    anywhere   anywhere
    0     0 LOG        all  --  any    any     anywhere   anywhere \
					LOG level warning

Chain OUTPUT (policy ACCEPT 2875K packets, 1508M bytes)
 pkts bytes target     prot opt in     out     source     destination

Chain reject_func (0 references)
 pkts bytes target     prot opt in     out     source     destination

\end{Verbatim}
}

\item{Run the command {\bfseries{smbclient -L BIGSERVER}} on the UNIX box. You should get back a list of available shares.  \index{bad password} \index{hosts allow} \index{hosts deny} \index{valid users} \index{guest account} \index{invalid users} If you get an error message containing the string {``}bad password{''}, then you probably have either an incorrect {\ttfamily\itshape{\docbookhyphenatedot{hosts allow}}}, {\ttfamily\itshape{\docbookhyphenatedot{hosts deny}}}, or {\ttfamily\itshape{\docbookhyphenatedot{valid users}}} line in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}, or your guest account is not valid. Check what your guest account is using testparm and temporarily remove any {\ttfamily\itshape{\docbookhyphenatedot{hosts allow}}}, {\ttfamily\itshape{\docbookhyphenatedot{hosts deny}}}, {\ttfamily\itshape{\docbookhyphenatedot{valid users}}}, or {\ttfamily\itshape{\docbookhyphenatedot{invalid users}}} lines.  \index{inetd.conf} If you get a message {\texttt{\docbookhyphenatedot{connection refused}}} response, then the {\bfseries{smbd}} server may not be running. If you installed it in {\texttt{\docbookhyphenatefilename{inetd.\dbz{}conf}}}, then you probably edited that file incorrectly. If you installed it as a daemon, then check that it is running and check that the netbios-ssn port is in a LISTEN state using {\bfseries{netstat -a}}. 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{inetd} \index{xinetd|textit{see} {inetd} } Some UNIX/Linux systems use {\bfseries{xinetd}} in place of {\bfseries{inetd}}. Check your system documentation for the location of the control files for your particular system implementation of the network super daemon.
\end{admonition}

 If you get a message saying {\texttt{\docbookhyphenatedot{session request failed,}}} the server refused the connection. If it says {``}Your server software is being unfriendly,{''} then it's probably because you have invalid command line parameters to smbd, or a similar fatal problem with the initial startup of smbd. Also check your config file ({\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}) for syntax errors with testparm and that the various directories where Samba keeps its log and lock files exist.  There are a number of reasons for which smbd may refuse or decline a session request. The most common of these involve one or more of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file entries as shown in \hyperlink{modif1}{Example {\ref{modif1}}}. 
\begin{example}%
\hypertarget{modif1}{}%
\captionswapskip{}{{\caption{Configuration for Allowing Connections Only from a Certain Subnet}\label{modif1}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[globals]
 	hosts deny = ALL
 	hosts allow = xxx.xxx.xxx.xxx/yy
 	interfaces = eth0
 	bind interfaces only = Yes
\end{lstlisting}
\end{example}

 \index{loopback adapter} In \hyperlink{modif1}{Example {\ref{modif1}}}, no allowance has been made for any session requests that will automatically translate to the loopback adapter address 127.0.0.1. To solve this problem, change these lines as shown in \hyperlink{modif2}{Example {\ref{modif2}}}. 
\begin{example}%
\hypertarget{modif2}{}%
\captionswapskip{}{{\caption{Configuration for Allowing Connections from a Certain Subnet and localhost}\label{modif2}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[globals]
 	hosts deny = ALL
 	hosts allow = xxx.xxx.xxx.xxx/yy 127.
 	interfaces = eth0 lo
\end{lstlisting}
\end{example}

 \index{inetd} \index{smbclient} Another common cause of these two errors is having something already running on port {\texttt{\docbookhyphenatedot{139}}}, such as Samba (smbd is running from inetd already) or Digital's Pathworks. Check your {\texttt{\docbookhyphenatefilename{inetd.\dbz{}conf}}} file before trying to start smbd as a daemon ---  it can avoid a lot of frustration!  \index{subnet mask} \index{broadcast address} \index{log.nmbd} \index{network interface} \index{IP address} And yet another possible cause for failure of this test is when the subnet mask and/or broadcast address settings are incorrect. Please check that the network interface IP address/broadcast address/subnet mask settings are correct and that Samba has correctly noted these in the {\texttt{\docbookhyphenatefilename{log.\dbz{}nmbd}}} file.}

\item{\index{nmblookup} Run the command {\bfseries{nmblookup -B BIGSERVER \_\_SAMBA\_\_}}. You should get back the IP address of your Samba server.  \index{inetd.conf} \index{nmbd} \index{port 137} If you do not, then nmbd is incorrectly installed. Check your {\texttt{\docbookhyphenatefilename{inetd.\dbz{}conf}}} if you run it from there, or that the daemon is running and listening to UDP port 137.  One common problem is that many inetd implementations can't take many parameters on the command line. If this is the case, then create a one-line script that contains the right parameters and run that from inetd.}

\item{\index{nmblookup} Run the command {\bfseries{nmblookup -B ACLIENT `*'}}.  You should get the PC's IP address back. If you do not, then the client software on the PC isn't installed correctly, or isn't started, or you got the name of the PC wrong.  If ACLIENT does not resolve via DNS, then use the IP address of the client in the above test.}

\item{Run the command {\bfseries{nmblookup -d 2 `*'}}.  This time we are trying the same as the previous test but are trying it via a broadcast to the default broadcast address. A number of NetBIOS/TCP/IP hosts on the network should respond, although Samba may not catch all of the responses in the short time it listens. You should see the {\texttt{\docbookhyphenatedot{got a positive name query response}}} messages from several hosts.  \index{nmblookup} If this does not give a result similar to the previous test, then nmblookup isn't correctly getting your broadcast address through its automatic mechanism. In this case you should experiment with the \smbconfoption{interfaces} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to manually configure your IP address, broadcast, and netmask.  If your PC and server aren't on the same subnet, then you will need to use the {\texttt{\docbookhyphenatedot{-B}}} option to set the broadcast address to that of the PC's subnet.  This test will probably fail if your subnet mask and broadcast address are not correct. (Refer to test 3 notes above).}

\item{\index{smbclient} Run the command {\bfseries{smbclient //BIGSERVER/TMP}}. You should then be prompted for a password. You should use the password of the account with which you are logged into the UNIX box. If you want to test with another account, then add the {\texttt{\docbookhyphenatedot{-U accountname}}} option to the end of the command line ---  for example, {\bfseries{smbclient //bigserver/tmp -Ujohndoe}}. 
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

It is possible to specify the password along with the username as follows: {\bfseries{smbclient //bigserver/tmp -Ujohndoe\%secret}}.
\end{admonition}

 Once you enter the password, you should get the {\texttt{\docbookhyphenatedot{smb>}}} prompt. If you do not, then look at the error message. If it says {``}invalid network name,{''} then the service \smbconfsection{tmp} is not correctly set up in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}.  If it says {``}bad password,{''} then the likely causes are: 
\begin{enumerate}
%--- Item
\item 
You have shadow passwords (or some other password system) but didn't compile in support for them in smbd.


%--- Item
\item 
Your \smbconfoption{valid users} configuration is incorrect.


%--- Item
\item 
You have a mixed-case password and you haven't enabled the \smbconfoption{password level} option at a high enough level.


%--- Item
\item 
The \smbconfoption{path} line in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} is incorrect. Check it with testparm.


%--- Item
\item 
You enabled password encryption but didn't map UNIX to Samba users. Run {\bfseries{smbpasswd -a username}}

\end{enumerate}
 \index{dir} \index{get} \index{put} \index{help command} Once connected, you should be able to use the commands {\bfseries{dir}}, {\bfseries{get}}, {\bfseries{put}}, and so on. Type {\bfseries{help command}} for instructions. You should especially check that the amount of free disk space shown is correct when you type {\bfseries{dir}}.}

\item{\index{net view} On the PC, type the command {\bfseries{net view \textbackslash \textbackslash BIGSERVER}}. You will need to do this from within a DOS prompt window. You should get back a list of shares available on the server.  \index{nmbd} If you get a message {\texttt{\docbookhyphenatedot{network name not found}}} or similar error, then NetBIOS name resolution is not working. This is usually caused by a problem in {\bfseries{nmbd}}. To overcome it, you could do one of the following (you only need to choose one of them): 
\begin{enumerate}
%--- Item
\item 
Fix the nmbd installation.


%--- Item
\item 
Add the IP address of BIGSERVER to the {\bfseries{wins server}} box in the advanced TCP/IP setup on the PC.


%--- Item
\item 
Enable Windows name resolution via DNS in the advanced section of the TCP/IP setup.


%--- Item
\item 
Add BIGSERVER to your lmhosts file on the PC.

\end{enumerate}
 If you get a message {``}invalid network name{''} or {``}bad password error,{''} then apply the same fixes as for the {\bfseries{smbclient -L}} test. In particular, make sure your {\bfseries{hosts allow}} line is correct (see the man pages).  Also, do not overlook that fact that when the workstation requests the connection to the Samba server, it will attempt to connect using the name with which you logged onto your Windows machine. You need to make sure that an account exists on your Samba server with that exact same name and password.  If you get a message {``}specified computer is not receiving requests{''} or similar error, it probably means that the host is not contactable via TCP services. Check to see if the host is running TCP wrappers, and if so, add an entry in the {\texttt{\docbookhyphenatefilename{hosts.\dbz{}allow}}} file for your client (or subnet, and so on.)}

\item{Run the command {\bfseries{net use x: \textbackslash \textbackslash BIGSERVER\textbackslash TMP}}. You should be prompted for a password, then you should get a {\texttt{\docbookhyphenatedot{command completed successfully}}} message. If not, then your PC software is incorrectly installed or your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} is incorrect. Make sure your {\ttfamily\itshape{\docbookhyphenatedot{hosts allow}}} and other config lines in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} are correct.  It's also possible that the server can't work out what username to connect you as. To see if this is the problem, add the line \smbconfoption{user} = username to the \smbconfsection{[tmp]} section of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} where {\ttfamily\itshape{\docbookhyphenatedot{username}}} is the username corresponding to the password you typed. If you find this fixes things, you may need the username mapping option.  It might also be the case that your client only sends encrypted passwords and you have \smbconfoption{encrypt passwords} = no in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. Change this setting to `yes' to fix this.}

\item{Run the command {\bfseries{nmblookup -M {\ttfamily\itshape{\docbookhyphenatedot{testgroup}}}}} where {\ttfamily\itshape{\docbookhyphenatedot{testgroup}}} is the name of the workgroup that your Samba server and Windows PCs belong to. You should get back the IP address of the master browser for that workgroup.  If you do not, then the election process has failed. Wait a minute to see if it is just being slow, then try again. If it still fails after that, then look at the browsing options you have set in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. Make sure you have \smbconfoption{preferred master} = yes to ensure that an election is held at startup.}

\item{From file manager, try to browse the server. Your Samba server should appear in the browse list of your local workgroup (or the one you specified in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}). You should be able to double-click on the name of the server and get a list of shares. If you get the error message {``}invalid password,{''} you are probably running Windows NT and it is refusing to browse a server that has no encrypted password capability and is in user-level security mode. In this case, either set \smbconfoption{security} = server and \smbconfoption{password server} = Windows\_NT\_Machine in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file or make sure \smbconfoption{encrypt passwords} is set to {``}yes{''}.}
\end{enumerate}
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Analyzing and Solving Samba Problems 
% ------------------------------------------------------------- 	
\chapter{Analyzing and Solving Samba Problems}
\label{problems}\hypertarget{problems}{}%

\index{RFCs} \index{SMB} \index{documentation} There are many sources of information available in the form of mailing lists, RFCs, and documentation. The documentation that comes with the Samba distribution contains good explanations of general SMB topics such as browsing.

% ------------------------   
% Section 
\section{Diagnostics Tools}
\label{id2633405}\hypertarget{id2633405}{}%

\index{sniffer} \index{LAN} \index{analyzes data} \index{SMB networking} \index{network analyzer} With SMB networking, it is often not immediately clear what the cause is of a certain problem. Samba itself provides rather useful information, but in some cases you might have to fall back to using a {\em{sniffer}}. A sniffer is a program that listens on your LAN, analyzes the data sent on it, and displays it on the screen.
\subsection{Debugging with Samba Itself}
\label{id2633458}\hypertarget{id2633458}{}%

\index{diagnostic tools} \index{debugging problems} \index{smbd} \index{nmbd} \index{debugging passwords} \index{debug level} \index{log level} One of the best diagnostic tools for debugging problems is Samba itself. You can use the {\texttt{\docbookhyphenatedot{-d option}}} for both smbd and nmbd to specify the \smbconfoption{debug level} at which to run. See the man pages for {\bfseries{smbd, nmbd}}, and {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} for more information regarding debugging options. The debug level (log level) can range from 1 (the default) to 10 (100 for debugging passwords).

\index{debugging} \index{gcc} \index{gdb} \index{smbd} \index{nmbd} \index{LsaEnumTrustedDomains} \index{attach gdb} Another helpful method of debugging is to compile Samba using the {\bfseries{gcc -g}} flag. This will include debug information in the binaries and allow you to attach {\bfseries{gdb}} to the running {\bfseries{smbd/nmbd}} process. To attach {\bfseries{gdb}} to an {\bfseries{smbd}} process for an NT workstation, first get the workstation to make the connection. Pressing ctrl-alt-delete and going down to the domain box is sufficient (at least, the first time you join the domain) to generate a {\ttfamily\itshape{\docbookhyphenatedot{LsaEnumTrustedDomains}}}. Thereafter, the workstation maintains an open connection and there will be an smbd process running (assuming that you haven't set a really short smbd idle timeout). So, in between pressing {\bfseries{ctrl-alt-delete}} and actually typing in your password, you can attach {\bfseries{gdb}} and continue.

Some useful Samba commands worth investigating are: \index{testparm} \index{smbclient} 
\begin{Verbatim}[]

$ testparm | more
$ smbclient -L //{netbios name of server}

\end{Verbatim}

\subsection{Tcpdump}
\label{id2629339}\hypertarget{id2629339}{}%

\index{tcpdump} \index{tethereal} \index{ethereal} Tcpdump\label{id2629369}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.tcpdump.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2629369} was the first UNIX sniffer with SMB support. It is a command-line utility and now, its SMB support is somewhat lagging that of {\bfseries{ethereal}} and {\bfseries{tethereal}}.
\subsection{Ethereal}
\label{id2629391}\hypertarget{id2629391}{}%

\index{ethereal} Ethereal\label{id2629407}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.ethereal.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2629407} is a graphical sniffer, available for both UNIX (Gtk) and Windows. Ethereal's SMB support is quite good. For details on the use of {\bfseries{ethereal}}, read the well-written Ethereal User Guide.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{ethereal1}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/ethereal1}
{{\caption[{Starting a Capture.}]{{{Starting a Capture.}}}\label{ethereal1}}}
\end{center}
\end{figure}


\index{ports} Listen for data on ports 137, 138, 139, and 445. For example, use the filter {\ttfamily\bfseries{\docbookhyphenatedot{port 137, port 138, port 139, or port 445}}} as seen in \hyperlink{ethereal1}{Figure {\ref{ethereal1}}} snapshot.

A console version of ethereal is available as well and is called {\bfseries{tethereal}}.

% figure ------------------------------------------------------
\begin{figure}[hbt]
\begin{center}%
\hypertarget{ethereal2}{}%
\includegraphics[scale=.50]{Samba3-HOWTO/images/ethereal2}
{{\caption[{Main Ethereal Data Window.}]{{{Main Ethereal Data Window.}}}\label{ethereal2}}}
\end{center}
\end{figure}

\subsection{The Windows Network Monitor}
\label{id2629481}\hypertarget{id2629481}{}%

\index{Network Monitor} \index{Netmon} \index{Microsoft Developer Network CDs} \index{SMS} \index{promiscuous mode} \index{ethereal} For tracing things on Microsoft Windows NT, Network Monitor (aka Netmon) is available on Microsoft Developer Network CDs, the Windows NT Server install CD, and the SMS CDs. The version of Netmon that ships with SMS allows for dumping packets between any two computers (i.e., placing the network interface in promiscuous mode). The version on the NT Server install CD will only allow monitoring of network traffic directed to the local NT box and broadcasts on the local subnet. Be aware that Ethereal can read and write Netmon formatted files.
\subsubsection{Installing Network Monitor on an NT Workstation}
\label{id2465299}\hypertarget{id2465299}{}%

\index{Netmon.} Installing Netmon on an NT workstation requires a couple of steps. The following are instructions for installing Netmon V4.00.349, which comes with Microsoft Windows NT Server 4.0, on Microsoft Windows NT Workstation 4.0. The process should be similar for other versions of Windows NT version of Netmon. You will need both the Microsoft Windows NT Server 4.0 Install CD and the Workstation 4.0 Install CD.

\index{Network Monitor Tools and Agent} Initially you will need to install Network Monitor Tools and Agent on the NT Server to do this:

\begin{itemize}
%--- Item
\item 
Go to {\sffamily \bfseries Start} -\textgreater{} {\sffamily \bfseries Settings} -\textgreater{} {\sffamily \bfseries Control Panel} -\textgreater{} {\sffamily \bfseries Network} -\textgreater{} {\sffamily \bfseries Services} -\textgreater{} {\sffamily \bfseries Add}.


%--- Item
\item 
Select the {\sffamily \bfseries Network Monitor Tools and Agent} and click on {\sffamily \bfseries OK}.


%--- Item
\item 
Click on {\sffamily \bfseries OK} on the Network Control Panel.


%--- Item
\item 
Insert the Windows NT Server 4.0 install CD when prompted.

\end{itemize}

At this point, the Netmon files should exist in {\texttt{\docbookhyphenatefilename{\%SYSTEMROOT\%\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\netmon\docbooktolatexgobble\string\\*.\dbz{}*}}}. Two subdirectories exist as well: {\texttt{\docbookhyphenatefilename{parsers\docbooktolatexgobble\string\\}}}, which contains the necessary DLLs for parsing the Netmon packet dump, and {\texttt{\docbookhyphenatefilename{captures\docbooktolatexgobble\string\\}}}.

To install the Netmon tools on an NT Workstation, you will first need to install the Network Monitor Agent from the Workstation install CD.

\begin{itemize}
%--- Item
\item 
Go to {\sffamily \bfseries Start} -\textgreater{} {\sffamily \bfseries Settings} -\textgreater{} {\sffamily \bfseries Control Panel} -\textgreater{} {\sffamily \bfseries Network} -\textgreater{} {\sffamily \bfseries Services} -\textgreater{} {\sffamily \bfseries Add}.


%--- Item
\item 
Select the {\sffamily \bfseries Network Monitor Agent}, click on {\sffamily \bfseries OK}.


%--- Item
\item 
Click on {\sffamily \bfseries OK} in the Network Control Panel.


%--- Item
\item 
Insert the Windows NT Workstation 4.0 install CD when prompted.

\end{itemize}

Now copy the files from the NT Server in {\texttt{\docbookhyphenatefilename{\%SYSTEMROOT\%\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\netmon}}} to {\texttt{\docbookhyphenatefilename{\%SYSTEMROOT\%\docbooktolatexgobble\string\\System32\docbooktolatexgobble\string\\netmon}}} on the workstation and set permissions as you deem appropriate for your site. You will need administrative rights on the NT box to run Netmon.
\subsubsection{Installing Network Monitor on Windows 9x/Me}
\label{id2622650}\hypertarget{id2622650}{}%

To install Netmon on Windows 9x/Me, install the Network Monitor Agent from the Windows 9x/Me CD ({\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\admin\docbooktolatexgobble\string\\nettools\docbooktolatexgobble\string\\netmon}}}). There is a readme file included with the Netmon driver files on the CD if you need information on how to do this. Copy the files from a working Netmon installation.

% ------------------------   
% Section 
\section{Useful URLs}
\label{id2622672}\hypertarget{id2622672}{}%
.
\begin{itemize}
%--- Item
\item 
See how Scott Merrill simulates a BDC behavior at http://www.skippy.net/linux/smb-howto.html\label{id2622685}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.skippy.net/linux/smb-howto.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2622685}.


%--- Item
\item 
FTP site for older SMB specs, ftp://ftp.microsoft.com/developr/drg/CIFS/\label{id2622700}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://ftp.microsoft.com/developr/drg/CIFS/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2622700}

\end{itemize}

% ------------------------   
% Section 
\section{Getting Mailing List Help}
\label{id2622712}\hypertarget{id2622712}{}%

There are a number of Samba-related mailing lists. Go to {\textless}\url{http://samba.org}{\textgreater}, click on your nearest mirror, and then click on {\bfseries{Support}}. Next, click on {\bfseries{Samba-related mailing lists}}.

For questions relating to Samba TNG, go to {\textless}\url{http://www.samba-tng.org/}{\textgreater}. It has been requested that you do not post questions about Samba-TNG to the mainstream Samba lists.

If you do post a message to one of the lists, please observe the following guidelines:

\begin{itemize}
%--- Item
\item 
\index{volunteers} Always remember that the developers are volunteers; they are not paid and they never guarantee to produce a particular feature at a particular time. Any timelines are {``}best guess,{''} and nothing more.


%--- Item
\item 
\index{PDC} Always mention what version of Samba you are using and what operating system it's running under. You should list the relevant sections of your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, at least the options in \smbconfsection{[global]} that affect PDC support.


%--- Item
\item 
In addition to the version, if you obtained Samba via CVS, mention the date when you last checked it out.


%--- Item
\item 
Try to make your questions clear and brief. Lots of long, convoluted questions get deleted before they are completely read! Do not post HTML-encoded messages. Most people on mailing lists simply delete them.


%--- Item
\item 
If you run one of those nifty {``}I'm on holiday{''} things when you are away, make sure its configured to not answer mailing list traffic. Autoresponses to mailing lists really irritate the thousands of people who end up having to deal with such bad netiquet bahavior.


%--- Item
\item 
\index{cross post} Don't cross post. Work out which is the best list to post to and see what happens. Do not post to both samba-ntdom and samba-technical. Many people active on the lists subscribe to more than one list and get annoyed to see the same message two or more times. Often someone who thinks a message would be better dealt with on another list will forward it on for you.


%--- Item
\item 
You might include {\em{partial}} log files written at a log level set to as much as 20. Please do not send the entire log but just enough to give the context of the error messages.


%--- Item
\item 
If you have a complete Netmon trace (from the opening of the pipe to the error), you can send the *.CAP file as well.


%--- Item
\item 
Please think carefully before attaching a document to an email. Consider pasting the relevant parts into the body of the message. The Samba mailing lists go to a huge number of people. Do they all need a copy of your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} in their attach directory?

\end{itemize}

% ------------------------   
% Section 
\section{How to Get Off the Mailing Lists}
\label{id2622881}\hypertarget{id2622881}{}%

To have your name removed from a Samba mailing list, go to the same place where you went to subscribe to it, go to http://lists.samba.org\label{id2622891}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://lists.samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2622891}, click on your nearest mirror, click on {\bfseries{Support}}, and then click on {\bfseries{Samba-related mailing lists}}.

Please do not post messages to the list asking to be removed. You will only be referred to the above address (unless that process failed in some way).
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Reporting Bugs 
% ------------------------------------------------------------- 	
\chapter{Reporting Bugs}
\label{bugreport}\hypertarget{bugreport}{}%

% ------------------------   
% Section 
\section{Introduction}
\label{id2631617}\hypertarget{id2631617}{}%

\index{Bugzilla} \index{bug reports} Please report bugs using Samba's Bugzilla\label{id2622923}\begingroup\catcode`\#=12\footnote{ {\textless}\url{https://bugzilla.samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2622923} facilities and take the time to read this file before you submit a bug report. Also, check to see if it has changed between releases, as we may be changing the bug reporting mechanism at some point.

Please do as much as you can yourself to help track down the bug. Samba is maintained by a dedicated group of people who volunteer their time, skills, and efforts. We receive far more mail than we can possibly answer, so you have a much higher chance of a response and a fix if you send us a {``}developer-friendly{''} bug report that lets us fix it fast.

\index{comp.protocols.smb} \index{newsgroup} \index{configuration problem} If you post the bug to the comp.protocols.smb newsgroup or the mailing list, do not assume that we will read it. If you suspect that your problem is not a bug but a configuration problem, it is better to send it to the Samba mailing list, as there are thousands of other users on that list who may be able to help you.

You may also like to look though the recent mailing list archives, which are conveniently accessible on the Samba Web pages at {\textless}\url{http://samba.org/samba/}{\textgreater}.

% ------------------------   
% Section 
\section{General Information}
\label{id2622989}\hypertarget{id2622989}{}%

Before submitting a bug report, check your config for silly errors. Look in your log files for obvious messages that tell you've misconfigured something. Run testparm to check your config file for correct syntax.

Have you looked through \hyperlink{diagnosis}{Chapter {\ref{diagnosis}}, {``}The Samba Checklist{''}}? This is extremely important.

If you include part of a log file with your bug report, then be sure to annotate it with exactly what you were doing on the client at the time and exactly what the results were.

% ------------------------   
% Section 
\section{Debug Levels}
\label{dbglvl}\hypertarget{dbglvl}{}%

If the bug has anything to do with Samba behaving incorrectly as a server (like refusing to open a file), then the log files will probably be quite useful. Depending on the problem, a log level of between 3 and 10 showing the problem may be appropriate. A higher level gives more detail but may use too much disk space.

\index{debug level} \index{log level} To set the debug level, use the \smbconfoption{log level} in your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. You may also find it useful to set the log level higher for just one machine and keep separate logs for each machine. To do this, add the following lines to your main {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file:

\begin{lstlisting}[language=smbconf,style=smbconfblock]
	log level = 10
 	log file = /usr/local/samba/lib/log.%m
 	include = /usr/local/samba/lib/smb.conf.%m
\end{lstlisting}

and create a file {\texttt{\docbookhyphenatefilename{/\dbz{}usr/\dbz{}local/\dbz{}samba/\dbz{}lib/\dbz{}smb.\dbz{}conf.\dbz{}{\ttfamily\itshape{\docbookhyphenatedot{machine}}}}}} where {\ttfamily\itshape{\docbookhyphenatedot{machine}}} is the name of the client you wish to debug. In that file put any {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} commands you want; for example, \smbconfoption{log level} may be useful. This also allows you to experiment with different security systems, protocol levels, and so on, on just one machine.

The {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} entry \smbconfoption{log level} is synonymous with the parameter \smbconfoption{debuglevel} that has been used in older versions of Samba and is being retained for backward compatibility of {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} files.

As the \smbconfoption{log level} value is increased, you will record a significantly greater level of debugging information. For most debugging operations, you may not need a setting higher than {\texttt{\docbookhyphenatedot{3}}}. Nearly all bugs can be tracked at a setting of {\texttt{\docbookhyphenatedot{10}}}, but be prepared for a large volume of log data.
\subsection{Debugging-Specific Operations}
\label{id2631770}\hypertarget{id2631770}{}%

\index{debugging} \index{logging} \index{functional components} \index{cluttering} Samba-3.x permits debugging (logging) of specific functional components without unnecessarily cluttering the log files with detailed logs for all operations. An example configuration to achieve this is shown in:


\begin{lstlisting}[language=smbconf,style=smbconfblock]
	log level = 0 tdb:3 passdb:5 auth:4 vfs:2
 	max log size = 0
 	log file = /var/log/samba/%U.%m.log
\end{lstlisting}


This will cause the level of detail to be expanded to the debug class (log level) passed to each functional area per the value shown above. The first value passed to the {\ttfamily\itshape{\docbookhyphenatedot{log level}}} of {\texttt{\docbookhyphenatedot{0}}} means turn off all unnecessary debugging except the debug classes set for the functional areas as specified. The table shown in \hyperlink{dbgclass}{Table {\ref{dbgclass}}} may be used to attain very precise analysis of each SMB operation Samba is conducting.

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{dbgclass}{}%
\captionswapskip{}{{\caption{Debuggable Functions}\label{dbgclass}}}
\captionswapskip{}\begin{tabular}{|c|c|}
\hline 
{{{\bfseries Function Name}}} & {{{\bfseries Function Name}}} \tabularnewline
 \hline 
{{all}} & {{passdb}} \tabularnewline
 \hline 
{{tdb}} & {{sam}} \tabularnewline
 \hline 
{{printdrivers}} & {{auth}} \tabularnewline
 \hline 
{{lanman}} & {{winbind}} \tabularnewline
 \hline 
{{smb}} & {{vfs}} \tabularnewline
 \hline 
{{rpc\_parse}} & {{idmap}} \tabularnewline
 \hline 
{{rpc\_srv}} & {{quota}} \tabularnewline
 \hline 
{{rpc\_cli}} & {{acls}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


% ------------------------   
% Section 
\section{Internal Errors}
\label{id2631955}\hypertarget{id2631955}{}%

If you get the message {``}INTERNAL ERROR{''} in your log files, it means that Samba got an unexpected signal while running. It is probably a segmentation fault and almost certainly means a bug in Samba (unless you have faulty hardware or system software).

If the message came from smbd, it will probably be accompanied by a message that details the last SMB message received by smbd. This information is often useful in tracking down the problem, so please include it in your bug report.

You should also detail how to reproduce the problem, if possible. Please make this reasonably detailed.

\index{core files} You may also find that a core file appeared in a {\texttt{\docbookhyphenatefilename{corefiles}}} subdirectory of the directory where you keep your Samba log files. This file is the most useful tool for tracking down the bug. To use it, you do this: \index{gdb} \index{debug} 
\begin{Verbatim}[]

$ gdb smbd core

\end{Verbatim}


\index{dbx} \index{stack trace} adding appropriate paths to smbd and core so gdb can find them. If you do not have gdb, try {\ttfamily\bfseries{\docbookhyphenatedot{dbx}}}. Then within the debugger, use the command {\bfseries{where}} to give a stack trace of where the problem occurred. Include this in your report.

\index{disass} If you know any assembly language, do a {\bfseries{disass}} of the routine where the problem occurred (if it's in a library routine, then disassemble the routine that called it) and try to work out exactly where the problem is by looking at the surrounding code. Even if you do not know assembly, including this information in the bug report can be useful.

% ------------------------   
% Section 
\section{Attaching to a Running Process}
\label{id2632092}\hypertarget{id2632092}{}%

\index{PID} \index{gdb} \index{smbstatus} Unfortunately, some UNIXes (in particular some recent Linux kernels) refuse to dump a core file if the task has changed UID (which smbd does often). To debug with this sort of system, you could try to attach to the running process using {\ttfamily\bfseries{\docbookhyphenatedot{gdb smbd {\ttfamily\itshape{\docbookhyphenatedot{PID}}}}}}, where you get {\ttfamily\itshape{\docbookhyphenatedot{PID}}} from smbstatus. Then use {\bfseries{c}} to continue and try to cause the core dump using the client. The debugger should catch the fault and tell you where it occurred.

Sometimes it is necessary to build Samba binary files that have debugging symbols so as to make it possible to capture enough information from a crashed operation to permit the Samba Team to fix the problem.

Compile with {\texttt{\docbookhyphenatedot{-g}}} to ensure you have symbols in place. Add the following line to the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file global section: 
\begin{Verbatim}[]

panic action = "/bin/sleep 90000"

\end{Verbatim}
 to catch any panics. If {\bfseries{smbd}} seems to be frozen, look for any sleep processes. If it is not, and appears to be spinning, find the PID of the spinning process and type: 
\begin{Verbatim}[]

root#  gdb /usr/local/samba/sbin/smbd

\end{Verbatim}
 \index{spinning process} then {``}attach `pid'{''} (of the spinning process), then type {``}bt{''} to get a backtrace to see where the smbd is in the call path.

% ------------------------   
% Section 
\section{Patches}
\label{id2632214}\hypertarget{id2632214}{}%

\index{diff} \index{patch} The best sort of bug report is one that includes a fix! If you send us patches, please use {\ttfamily\bfseries{\docbookhyphenatedot{diff -\dbz{}u}}} format if your version of diff supports it; otherwise, use {\ttfamily\bfseries{\docbookhyphenatedot{diff -\dbz{}c4}}}. Make sure you do the diff against a clean version of the source and let me know exactly what version you used.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Managing TDB Files 
% ------------------------------------------------------------- 	
\chapter{Managing TDB Files}
\label{tdb}\hypertarget{tdb}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2456616}\hypertarget{id2456616}{}%

\index{tdb} \index{Trivial Database} Samba uses a lightweight database called Trivial Database (tdb) in which it stores persistent and transient data. Some tdb files can be disposed of before restarting Samba, but others are used to store information that is vital to Samba configuration and behavior. The following information is provided to help administrators who are seeking to better manage their Samba installations.

\index{tdb} \index{currupted} \index{backup} \index{restore} Those who package Samba for commercial distribution with operating systems and appliances would do well to take note that tdb files can get corrupted, and for this reason ought to be backed up regularly. An appropriate time is at system shutdown (backup) and startup (restore from backup).

% table ------------------------------------------------------
\begin{table}[htb]
\begin{center}%
\hypertarget{TOSH-TDB}{}%
\captionswapskip{}{{\caption{Samba's Trivial Database Files}\label{TOSH-TDB}}}
\captionswapskip{}\begin{tabular}{|c|c|}
\hline 
{{{\bfseries File name}}} & {{{\bfseries Preserve}}} & {{{\bfseries Description}}} \tabularnewline
 \hline 
{{account\_policy.tdb}} & {{Y}} & {{NT account policy settings such as pw expiration, etc...}} \tabularnewline
 \hline 
{{brlock.tdb}} & {{N}} & {{Byte range locks.}} \tabularnewline
 \hline 
{{browse.dat}} & {{N}} & {{Browse lists - gets rebuilt automatically.}} \tabularnewline
 \hline 
{{connections.tdb}} & {{N}} & {{Share connections. Used to enforce max connections, etc.}} \tabularnewline
 \hline 
{{gencache.tdb}} & {{N}} & {{Generic caching database.}} \tabularnewline
 \hline 
{{group\_mapping.tdb}} & {{Y}} & {{Stores group mapping information. Not used when using LDAP backend.}} \tabularnewline
 \hline 
{{lang\_en.tdb}} & {{Y}} & {{Stores language encoding information.}} \tabularnewline
 \hline 
{{locking.tdb}} & {{N}} & {{Stores share mode and oplock information.}} \tabularnewline
 \hline 
{{login\_cache.tdb}} & {{N}} & {{Keeps a log of bad pw attempts.}} \tabularnewline
 \hline 
{{messages.tdb}} & {{N}} & {{Used to keep track of Samba internal messaging.}} \tabularnewline
 \hline 
{{netsamlogon\_cache.tdb}} & {{Y}} & {{Cache of user net\_info\_3 struct from {\em{net\_samlogon()}} requests from domain member machines.}} \tabularnewline
 \hline 
{{ntdrivers.tdb}} & {{Y}} & {{Stores installed printer driver information.}} \tabularnewline
 \hline 
{{ntforms.tdb}} & {{Y}} & {{Stores installed printer forms information.}} \tabularnewline
 \hline 
{{ntprinters.tdb}} & {{Y}} & {{Stores installed printers information.}} \tabularnewline
 \hline 
{{printing directory}} & {{Y}} & {{Directory containing tdb per print queue of cached lpq output.}} \tabularnewline
 \hline 
{{registry.tdb}} & {{Y}} & {{Windows registry skeleton (connect via regedit.exe).}} \tabularnewline
 \hline 
{{sessionid.tdb}} & {{N}} & {{Session information to support {\texttt{\docbookhyphenatedot{utmp = yes}}} capabilities.}} \tabularnewline
 \hline 
{{share\_info.tdb}} & {{Y}} & {{Stores share-level ACL configuration settings. Default ACL is {\em{Everyone - Full Control}}.}} \tabularnewline
 \hline 
{{unexpected.tdb}} & {{N}} & {{Unexpected packet queue needed to support windows clients that respond on a different port that the originating reques.}} \tabularnewline
 \hline 
{{winbindd\_cache.tdb}} & {{N}} & {{Winbind's cache of user lists.}} \tabularnewline
 \hline 
{{winbindd\_idmap.tdb}} & {{Y}} & {{Winbind's local IDMAP database.}} \tabularnewline
 \hline 
{{wins.dat}} & {{N}} & {{WINS database iused only when {\ttfamily\itshape{\docbookhyphenatedot{wins support = yes}}} has been set. This gets rebuilt or updated at every restart.}} \tabularnewline
 \hline 
{{wins.tdb}} & {{Y}} & {{The working permanent storage for all WINS data. This database is used only when {\ttfamily\itshape{\docbookhyphenatedot{wins support = yes}}} has been set in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file. Note: This retains all manually configured WINS entries. Manual setting can be done use the net utility.}} \tabularnewline
 \hline 
{{secrets.tdb}} & {{Y}} & {{This tdb file stores internal settings such as the machine and the domain SID, secret passwords that are used with LDAP, the machine secret token, etc. This is an essential file that is stored in a secure area. Vendors locate this in various folders. Check {\bfseries{smbd -b}} to find its location on your system.}} \tabularnewline
 \hline 
{{schannel\_store.tdb}} & {{Y}} & {{This stores secure channel access token information used with SMB signing.}} \tabularnewline
 \hline 
{{passdb.tdb}} & {{Y}} & {{This stores the Samba SAM account information when using a tdbsam password backend.}} \tabularnewline
\hline 
\end{tabular}
\end{center}
\end{table}


% ------------------------   
% Section 
\section{Managing TDB Files}
\label{id2632384}\hypertarget{id2632384}{}%

The {\bfseries{tdbbackup}} utility is a tool that may be used to backup samba tdb files. This tool may also be used to verify the integrity of the tdb files prior to Samba startup or during normal operation. If it finds file damage it will search for a prior backup the backup file from which the damaged tdb file will be restored. The {\bfseries{tdbbackup}} utility can safely be run at any time. It was designed so that it can be used at any time to validate the integrity of tdb files, even during Samba operation.

It is recommended to backup all tdb files as part of the Samba start-up scripts on a Samba server. The following command syntax can be used:

\begin{Verbatim}[]

myserver# > cd /var/lib/samba
myserver@ > tdbbackup *.tdb

\end{Verbatim}

The default extension is {\texttt{\docbookhyphenatefilename{.\dbz{}bak}}}. Any alternate extension can be specified by executing {\texttt{\docbookhyphenatedot{tdbbackup -\dbz{}s 'new\_\dbz{}extension' *.\dbz{}tdb}}} as part of your startup script.
\cleardoublepage % ------------------------------------------------------------- 
% 
% PART Reference Section
% 
% ------------------------------------------------------------- 
\part{Reference Section}
\label{Appendix}\hypertarget{Appendix}{}%
\cleardoublepage 
% -------------------------------------------------------------
% Chapter How to Compile Samba 
% ------------------------------------------------------------- 	
\chapter{How to Compile Samba}
\label{compiling}\hypertarget{compiling}{}%

You can obtain the Samba source file from the Samba Web site\label{id2634871}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2634871}. To obtain a development version, you can download Samba from Subversion or using {\bfseries{rsync}}.

% ------------------------   
% Section 
\section{Access Samba Source Code via Subversion}
\label{id2634885}\hypertarget{id2634885}{}%
\subsection{Introduction}
\label{id2634890}\hypertarget{id2634890}{}%

\index{Subversion} Samba is developed in an open environment. Developers use a Subversion to {``}checkin{''} (also known as {``}commit{''}) new source code. Samba's various Subversion branches can be accessed via anonymous Subversion using the instructions detailed in this chapter.

This chapter is a modified version of the instructions found at the Samba\label{id2634922}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://samba.org/samba/subversion.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2634922} Web site.
\subsection{Subversion Access to samba.org}
\label{id2634933}\hypertarget{id2634933}{}%

The machine samba.org runs a publicly accessible Subversion repository for access to the source code of several packages, including Samba, rsync, distcc, ccache, and jitterbug. There are two main ways of accessing the Subversion server on this host.
\subsubsection{Access via ViewCVS}
\label{id2634946}\hypertarget{id2634946}{}%

\index{SVN!web} You can access the source code via your favorite WWW browser. This allows you to access the contents of individual files in the repository and also to look at the revision history and commit logs of individual files. You can also ask for a diff listing between any two versions on the repository.

Use the URL {\textless}\url{http://viewcvs.samba.org/}{\textgreater}.
\subsubsection{Access via Subversion}
\label{id2634984}\hypertarget{id2634984}{}%

\index{Subversion} You can also access the source code via a normal Subversion client. This gives you much more control over what you can do with the repository and allows you to check out whole source trees and keep them up to date via normal Subversion commands. This is the preferred method of access if you are a developer and not just a casual browser.

In order to be able to download the Samba sources off Subversion, you need a Subversion client. Your distribution might include one, or you can download the sources from {\textless}\url{http://subversion.tigris.org/}{\textgreater}.

To gain access via anonymous Subversion, use the following steps.
Retrieving Samba using Subversion\begin{enumerate}

\item{Install a recent copy of Subversion. All you really need is a copy of the Subversion client binary.}

\item{Run the command 
\begin{Verbatim}[]

	svn co svn://svnanon.samba.org/samba/trunk samba.
	
\end{Verbatim}
  This will create a directory called {\texttt{\docbookhyphenatefilename{samba}}} containing the latest Samba source code (usually the branch that is going to be the next major release). This currently corresponds to the 3.1 development tree.  Subversion branches other then trunk can be obtained by adding branches/BRANCH\_NAME to the URL you check out. A list of branch names can be found on the {``}Development{''} page of the Samba Web site. A common request is to obtain the latest 3.0 release code. This could be done by using the following command: 
\begin{Verbatim}[]

	svn co svn://svnanon.samba.org/samba/branches/SAMBA_3_0 samba_3.
	
\end{Verbatim}
}

\item{Whenever you want to merge in the latest code changes, use the following command from within the Samba directory: 
\begin{Verbatim}[]

	svn update
	
\end{Verbatim}
}
\end{enumerate}

% ------------------------   
% Section 
\section{Accessing the Samba Sources via rsync and ftp}
\label{id2629996}\hypertarget{id2629996}{}%

\index{rsync} \index{ftp} {\ttfamily\itshape{\docbookhyphenatedot{pserver.samba.org}}} also exports unpacked copies of most parts of the Subversion tree at the Samba pserver\label{id2630027}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://pserver.samba.org/pub/unpacked}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2630027} location and also via anonymous rsync at the Samba rsync\label{id2630036}\begingroup\catcode`\#=12\footnote{ {\textless}\url{rsync://pserver.samba.org/ftp/unpacked/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2630036} server location. I recommend using rsync rather than ftp, because rsync is capable of compressing data streams, but it is also more useful than FTP because during a partial update it will transfer only the data that is missing plus a small overhead. See the rsync home page\label{id2630048}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://rsync.samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2630048} for more info on rsync.

The disadvantage of the unpacked trees is that they do not support automatic merging of local changes as Subversion does. {\bfseries{rsync}} access is most convenient for an initial install.

% ------------------------   
% Section 
\section{Verifying Samba's PGP Signature}
\label{id2630071}\hypertarget{id2630071}{}%

\index{GPG} \index{PGP} It is strongly recommended that you verify the PGP signature for any source file before installing it. Even if you're not downloading from a mirror site, verifying PGP signatures should be a standard reflex. Many people today use the GNU GPG tool set in place of PGP. GPG can substitute for PGP.

With that said, go ahead and download the following files:


\begin{Verbatim}[]

$ wget http://us1.samba.org/samba/ftp/samba-3.0.20.tar.asc
$ wget http://us1.samba.org/samba/ftp/samba-pubkey.asc

\end{Verbatim}


\index{PGP} The first file is the PGP signature for the Samba source file; the other is the Samba public PGP key itself. Import the public PGP key with: 
\begin{Verbatim}[]

$ gpg --import samba-pubkey.asc

\end{Verbatim}
 and verify the Samba source code integrity with: 
\begin{Verbatim}[]

$ gzip -d samba-3.0.20.tar.gz
$ gpg --verify samba-3.0.20.tar.asc

\end{Verbatim}


If you receive a message like, {``}Good signature from Samba Distribution Verification Key...,{''} then all is well. The warnings about trust relationships can be ignored. An example of what you would not want to see would be: 
\begin{Verbatim}[]

gpg: BAD signature from Samba Distribution Verification Key

\end{Verbatim}


% ------------------------   
% Section 
\section{Building the Binaries}
\label{id2630213}\hypertarget{id2630213}{}%

\index{autogen.sh} \index{configure} After the source tarball has been unpacked, the next step involves configuration to match Samba to your operating system platform. If your source directory does not contain the {\bfseries{configure}} script, it is necessary to build it before you can continue. Building of the configure script requires the correct version of the autoconf tool kit. Where the necessary version of autoconf is present, the configure script can be generated by executing the following: 
\begin{Verbatim}[]

root#  cd samba-3.0.20/source
root#  ./autogen.sh

\end{Verbatim}


\index{configure} To build the binaries, run the program {\ttfamily\bfseries{\docbookhyphenatedot{.\dbz{}/\dbz{}configure}}} in the source directory. This should automatically configure Samba for your operating system. If you have unusual needs, then you may wish to first run: 
\begin{Verbatim}[]

root# ./configure --help

\end{Verbatim}


This will help you to see what special options can be enabled. Now execute {\ttfamily\bfseries{\docbookhyphenatedot{.\dbz{}/\dbz{}configure}}} with any arguments it might need: 
\begin{Verbatim}[]

root# ./configure [... arguments ...]

\end{Verbatim}


\index{make} Execute the following create the binaries: 
\begin{Verbatim}[]

root#  make

\end{Verbatim}
 Once it is successfully compiled, you can execute the command shown here to install the binaries and manual pages: 
\begin{Verbatim}[]

root#  make install

\end{Verbatim}


Some people prefer to install binary files and man pages separately. If this is your wish, the binary files can be installed by executing: 
\begin{Verbatim}[]

root#  make installbin

\end{Verbatim}
 The man pages can be installed using this command: 
\begin{Verbatim}[]

root#  make installman

\end{Verbatim}


Note that if you are upgrading from a previous version of Samba the old versions of the binaries will be renamed with an {``}.old{''} extension. You can go back to the previous version by executing: 
\begin{Verbatim}[]

root#  make revert

\end{Verbatim}
 As you can see from this, building and installing Samba does not need to result in disaster!
\subsection{Compiling Samba with Active Directory Support}
\label{id2632676}\hypertarget{id2632676}{}%

In order to compile Samba with ADS support, you need to have installed on your system:

\begin{itemize}
%--- Item
\item 
The MIT or Heimdal Kerberos development libraries (either install from the sources or use a package).


%--- Item
\item 
The OpenLDAP development libraries.

\end{itemize}

If your Kerberos libraries are in a nonstandard location, then remember to add the configure option {\texttt{\docbookhyphenatedot{--with-krb5={\ttfamily\itshape{\docbookhyphenatedot{DIR}}}}}}.

After you run configure, make sure that the {\texttt{\docbookhyphenatefilename{include/\dbz{}config.\dbz{}h}}} it generates contain lines like this: 
\begin{Verbatim}[]

#define HAVE_KRB5 1
#define HAVE_LDAP 1

\end{Verbatim}


If it does not, configure did not find your KRB5 libraries or your LDAP libraries. Look in {\texttt{\docbookhyphenatefilename{config.\dbz{}log}}} to figure out why and fix it.
\subsubsection{Installing the Required Packages for Debian}
\label{id2632743}\hypertarget{id2632743}{}%

On Debian, you need to install the following packages:


\begin{itemize}
%--- Item
\item 
libkrb5-dev


%--- Item
\item 
krb5-user

\end{itemize}

\subsubsection{Installing the Required Packages for Red Hat Linux}
\label{id2632773}\hypertarget{id2632773}{}%

On Red Hat Linux, this means you should have at least:


\begin{itemize}
%--- Item
\item 
krb5-workstation (for kinit)


%--- Item
\item 
krb5-libs (for linking with)


%--- Item
\item 
krb5-devel (because you are compiling from source)

\end{itemize}


in addition to the standard development environment.

If these files are not installed on your system, you should check the installation CDs to find which has them and install the files using your tool of choice. If in doubt about what tool to use, refer to the Red Hat Linux documentation.
\subsubsection{SuSE Linux Package Requirements}
\label{id2632820}\hypertarget{id2632820}{}%

SuSE Linux installs Heimdal packages that may be required to allow you to build binary packages. You should verify that the development libraries have been installed on your system.

SuSE Linux Samba RPMs support Kerberos. Please refer to the documentation for your SuSE Linux system for information regarding SuSE Linux specific configuration. Additionally, SuSE is very active in the maintenance of Samba packages that provide the maximum capabilities that are available. You should consider using SuSE-provided packages where they are available.

% ------------------------   
% Section 
\section{Starting the smbd nmbd and winbindd}
\label{startingSamba}\hypertarget{startingSamba}{}%

\index{inetd} You must choose to start smbd, winbindd and nmbd either as daemons or from inetd. Don't try to do both! Either you can put them in {\texttt{\docbookhyphenatefilename{inetd.\dbz{}conf}}} and have them started on demand by inetd or xinetd, or you can start them as daemons either from the command-line or in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}rc.\dbz{}local}}}. See the man pages for details on the command line options. Take particular care to read the bit about what user you need to have to start Samba. In many cases, you must be root.

The main advantage of starting smbd and nmbd using the recommended daemon method is that they will respond slightly more quickly to an initial connection request.
\subsection{Starting from inetd.conf}
\label{id2632953}\hypertarget{id2632953}{}%
\index{inetd}
\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The following will be different if you use NIS, NIS+, or LDAP to distribute services maps.
\end{admonition}


Look at your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}services}}}. What is defined at port 139/tcp? If nothing is defined, then add a line like this:


\begin{Verbatim}[]
netbios-ssn     139/tcp
\end{Verbatim}


Similarly for 137/udp, you should have an entry like:


\begin{Verbatim}[]
netbios-ns	137/udp
\end{Verbatim}


Next, edit your {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}inetd.\dbz{}conf}}} and add two lines like this: 
\begin{Verbatim}[]

netbios-ssn stream tcp nowait root /usr/local/samba/sbin/smbd smbd 
netbios-ns dgram udp wait root /usr/local/samba/sbin/nmbd nmbd 

\end{Verbatim}

\index{/etc/inetd.conf}
The exact syntax of {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}inetd.\dbz{}conf}}} varies between UNIXes. Look at the other entries in inetd.conf for a guide.

\index{xinetd} Some distributions use xinetd instead of inetd. Consult the xinetd manual for configuration information.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Some UNIXes already have entries like netbios\_ns (note the underscore) in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}services}}}. You must edit {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}services}}} or {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}inetd.\dbz{}conf}}} to make them consistent.
\end{admonition}


\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{ifconfig} On many systems you may need to use the \smbconfoption{interfaces} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} to specify the IP address and netmask of your interfaces. Run ifconfig as root if you do not know what the broadcast is for your net. nmbd tries to determine it at runtime, but fails on some UNIXes.
\end{admonition}


\begin{admonition}{xslt/figures/warning}{Warning}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

Many UNIXes only accept around five parameters on the command line in {\texttt{\docbookhyphenatefilename{inetd.\dbz{}conf}}}. This means you shouldn't use spaces between the options and arguments, or you should use a script and start the script from {\bfseries{inetd}}.
\end{admonition}


Restart inetd, perhaps just send it a HUP, like this: \index{killall} 
\begin{Verbatim}[]

root# killall -HUP inetd

\end{Verbatim}

\subsection{Alternative: Starting smbd as a Daemon}
\label{id2630827}\hypertarget{id2630827}{}%

\index{daemon} \index{startsmb} To start the server as a daemon, you should create a script something like this one, perhaps calling it {\texttt{\docbookhyphenatefilename{startsmb}}}.


\begin{Verbatim}[]

#!/bin/sh
/usr/local/samba/sbin/smbd -D 
/usr/local/samba/sbin/winbindd -B
/usr/local/samba/sbin/nmbd -D 

\end{Verbatim}


Make it executable with {\bfseries{chmod +x startsmb}}.

You can then run {\bfseries{startsmb}} by hand or execute it from {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}rc.\dbz{}local}}}.

To kill it, send a kill signal to the processes nmbd and smbd.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

If you use the SVR4-style init system, you may like to look at the {\texttt{\docbookhyphenatefilename{examples/\dbz{}svr4-\dbz{}startup}}} script to make Samba fit into that system.
\end{admonition}

\subsubsection{Starting Samba for Red Hat Linux}
\label{id2630927}\hypertarget{id2630927}{}%

Red Hat Linux has not always included all Samba components in the standard installation. So versions of Red Hat Linux do not install the winbind utility, even though it is present on the installation CDROM media. Check to see if the {\bfseries{winbindd}} is present on the system: 
\begin{Verbatim}[]

root#  ls /usr/sbin/winbindd
/usr/sbin/winbindd

\end{Verbatim}
 This means that the appropriate RPM package was installed. The following response means that it is not installed: 
\begin{Verbatim}[]

/bin/ls: /usr/sbin/winbind: No such file or directory

\end{Verbatim}
 In this case, it should be installed if you intend to use {\bfseries{winbindd}}. Search the CDROM installation media for the samba-winbind RPM and install it following Red Hat guidelines.

The process for starting Samba will now be outlined. Be sure to configure Samba's {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file before starting Samba. When configured, start Samba by executing: 
\begin{Verbatim}[]

root#  service smb start
root#  service winbind start

\end{Verbatim}
 These steps will start nmbd, smbd and winbindd.

To ensure that these services will be automatically restarted when the system is rebooted execute: 
\begin{Verbatim}[]

root#  chkconfig smb on
root#  chkconfig winbind on

\end{Verbatim}
 Samba will be started automatically at every system reboot.
\subsubsection{Starting Samba for Novell SUSE Linux}
\label{id2631050}\hypertarget{id2631050}{}%

Novell SUSE Linux products automatically install all essential Samba components in a default installation. Configure your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file, then execute the following to start Samba: 
\begin{Verbatim}[]

root#  rcnmb start
root#  rcsmb start
root#  rcwinbind start

\end{Verbatim}
 Now execute these commands so that Samba will be started automatically following a system reboot: 
\begin{Verbatim}[]

root#  chkconfig nmb on
root#  chkconfig smb on
root#  chkconfig winbind on

\end{Verbatim}
 The Samba services will now be started automatically following a system reboot.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Portability 
% ------------------------------------------------------------- 	
\chapter{Portability}
\label{Portability}\hypertarget{Portability}{}%

\index{platforms} \index{compatible} Samba works on a wide range of platforms, but the interface all the platforms provide is not always compatible. This chapter contains platform-specific information about compiling and using Samba.

% ------------------------   
% Section 
\section{HPUX}
\label{id2630309}\hypertarget{id2630309}{}%

\index{/etc/logingroup} \index{/etc/group} Hewlett-Packard's implementation of supplementary groups is nonstandard (for historical reasons). There are two group files, {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} and {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}logingroup}}}; the system maps UIDs to numbers using the former, but initgroups() reads the latter. Most system admins who know the ropes symlink {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}group}}} to {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}logingroup}}} (hard-link does not work for reasons too obtuse to go into here). initgroups() will complain if one of the groups you're in, in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}logingroup}}}, has what it considers to be an invalid ID, which means outside the range {\texttt{\docbookhyphenatedot{[0..UID\_MAX]}}}, where {\texttt{\docbookhyphenatedot{UID\_MAX}}} is 60000 currently on HP-UX. This precludes -2 and 65534, the usual {\texttt{\docbookhyphenatedot{nobody}}} GIDs.

If you encounter this problem, make sure the programs that are failing to initgroups() are run as users, not in any groups with GIDs outside the allowed range.

This is documented in the HP manual pages under setgroups(2) and passwd(4).

\index{gcc} \index{ANSI compiler} On HP-UX you must use gcc or the HP ANSI compiler. The free compiler that comes with HP-UX is not ANSI compliant and cannot compile Samba.

% ------------------------   
% Section 
\section{SCO UNIX}
\label{id2630414}\hypertarget{id2630414}{}%

If you run an old version of SCO UNIX, you may need to get important TCP/IP patches for Samba to work correctly. Without the patch, you may encounter corrupt data transfers using Samba.

The patch you need is UOD385 Connection Drivers SLS. It is available from SCO ftp.sco.com\label{id2630430}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://ftp.sco.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2630430}, directory SLS, files uod385a.Z and uod385a.ltr.Z).

The information provided here refers to an old version of SCO UNIX. If you require binaries for more recent SCO UNIX products, please contact SCO to obtain packages that are ready to install. You should also verify with SCO that your platform is up to date for the binary packages you will install. This is important if you wish to avoid data corruption problems with your installation. To build Samba for SCO UNIX products may require significant patching of Samba source code. It is much easier to obtain binary packages directly from SCO.

% ------------------------   
% Section 
\section{DNIX}
\label{id2482563}\hypertarget{id2482563}{}%

DNIX has a problem with seteuid() and setegid(). These routines are needed for Samba to work correctly, but they were left out of the DNIX C library for some reason.

For this reason Samba by default defines the macro NO\_EID in the DNIX section of includes.h. This works around the problem in a limited way, but it is far from ideal, and some things still will not work right.

To fix the problem properly, you need to assemble the following two functions and then either add them to your C library or link them into Samba. Put the following in the file {\texttt{\docbookhyphenatefilename{setegid.\dbz{}s}}}:


\begin{Verbatim}[]

        .globl  _setegid
_setegid:
        moveq   #47,d0
        movl    #100,a0
        moveq   #1,d1
        movl    4(sp),a1
        trap    #9
        bccs    1$
        jmp     cerror
1$:
        clrl    d0
        rts

\end{Verbatim}


Put this in the file {\texttt{\docbookhyphenatefilename{seteuid.\dbz{}s}}}:


\begin{Verbatim}[]

        .globl  _seteuid
_seteuid:
        moveq   #47,d0
        movl    #100,a0
        moveq   #0,d1
        movl    4(sp),a1
        trap    #9
        bccs    1$
        jmp     cerror
1$:
        clrl    d0
        rts

\end{Verbatim}


After creating the files, you then assemble them using

\begin{Verbatim}[]

$ as seteuid.s
$ as setegid.s

\end{Verbatim}

which should produce the files {\texttt{\docbookhyphenatefilename{seteuid.\dbz{}o}}} and {\texttt{\docbookhyphenatefilename{setegid.\dbz{}o}}}.

Next you need to add these to the LIBSM line in the DNIX section of the Samba Makefile. Your LIBSM line will look something like this:


\begin{Verbatim}[]

LIBSM = setegid.o seteuid.o -ln

\end{Verbatim}


You should then remove the line:


\begin{Verbatim}[]

#define NO_EID

\end{Verbatim}


from the DNIX section of {\texttt{\docbookhyphenatefilename{includes.\dbz{}h}}}.

% ------------------------   
% Section 
\section{Red Hat Linux}
\label{id2633866}\hypertarget{id2633866}{}%

By default during installation, some versions of Red Hat Linux add an entry to {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}hosts}}} as follows: 
\begin{Verbatim}[]

127.0.0.1 loopback "hostname"."domainname"

\end{Verbatim}


\index{loopback interface} This causes Samba to loop back onto the loopback interface. The result is that Samba fails to communicate correctly with the world and therefore may fail to correctly negotiate who is the master browse list holder and who is the master browser.

Corrective action: Delete the entry after the word "loopback" in the line starting 127.0.0.1.

% ------------------------   
% Section 
\section{AIX: Sequential Read Ahead}
\label{id2637759}\hypertarget{id2637759}{}%

Disabling sequential read ahead can improve Samba performance significantly when there is a relatively high level of multiprogramming (many smbd processes or mixed with another workload), not an abundance of physical memory or slower disk technology. These can cause AIX to have a higher WAIT values. Disabling sequential read-ahead can also have an adverse affect on other workloads in the system so you will need to evaluate other applications for impact.

It is recommended to use the defaults provided by IBM, but if you experience a high amount of wait time, try disabling read-ahead with the following commands:

For AIX 5.1 and earlier: {\ttfamily\bfseries{\docbookhyphenatedot{vmtune -\dbz{}r 0}}}

For AIX 5.2 and later jfs filesystems: {\ttfamily\bfseries{\docbookhyphenatedot{ioo -\dbz{}o minpgahead=0}}}

For AIX 5.2 and later jfs2 filesystems: {\ttfamily\bfseries{\docbookhyphenatedot{ioo -\dbz{}o j2\_\dbz{}minPageReadAhead=0}}}

If you have a mix of jfs and jfs2 filesystems on the same host, simply use both ioo commands.

% ------------------------   
% Section 
\section{Solaris}
\label{id2637820}\hypertarget{id2637820}{}%
\subsection{Locking Improvements}
\label{id2637826}\hypertarget{id2637826}{}%

Some people have been experiencing problems with F\_SETLKW64/fcntl when running Samba on Solaris. The built-in file-locking mechanism was not scalable. Performance would degrade to the point where processes would get into loops of trying to lock a file. It would try a lock, then fail, then try again. The lock attempt was failing before the grant was occurring. The visible manifestation of this was a handful of processes stealing all of the CPU, and when they were trussed, they would be stuck in F\_SETLKW64 loops.

Please check with Sun support for current patches needed to fix this bug. The patch revision for 2.6 is 105181-34, for 8 is 108528-19, and for 9 is 112233-04. After the installation of these patches, it is recommended to reconfigure and rebuild Samba.

Thanks to Joe Meslovich for reporting this.
\subsection{Winbind on Solaris 9}
\label{winbind-solaris9}\hypertarget{winbind-solaris9}{}%

Nsswitch on Solaris 9 refuses to use the Winbind NSS module. This behavior is fixed by Sun in patch 112960-14\label{id2637865}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://sunsolve.sun.com/search/advsearch.do?collection=PATCH\string&type=collections\string&max=50\string&language=en\string&queryKey5=112960;rev=14\string&toDocument=yes}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2637865}.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Samba and Other CIFS Clients 
% ------------------------------------------------------------- 	
\chapter{Samba and Other CIFS Clients}
\label{Other-Clients}\hypertarget{Other-Clients}{}%

This chapter contains client-specific information.

% ------------------------   
% Section 
\section{Macintosh Clients}
\label{id2635144}\hypertarget{id2635144}{}%

\index{DAVE} Yes. Thursby\label{id2635160}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.thursby.com/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635160} has a CIFS client/server called DAVE\label{id2635165}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.thursby.com/products/dave.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635165}. They test it against Windows 95, Windows NT/200x/XP, and Samba for compatibility issues. At the time of this writing, DAVE was at version 5.1. Please refer to Thursby's Web site for more information regarding this product.

\index{Netatalk} \index{CAP} Alternatives include two free implementations of AppleTalk for several kinds of UNIX machines and several more commercial ones. These products allow you to run file services and print services natively to Macintosh users, with no additional support required on the Macintosh. The two free implementations are Netatalk\label{id2635198}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.umich.edu/~rsug/netatalk/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635198} and CAP\label{id2635203}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.cs.mu.oz.au/appletalk/atalk.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635203}. What Samba offers MS Windows users, these packages offer to Macs. For more info on these packages, Samba, and Linux (and other UNIX-based systems), see http://www.eats.com/linux\_mac\_win.html.\label{id2635212}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.eats.com/linux_mac_win.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635212}

Newer versions of the Macintosh (Mac OS X) include Samba.

% ------------------------   
% Section 
\section{OS2 Client}
\label{id2635226}\hypertarget{id2635226}{}%
\subsection{Configuring OS/2 Warp Connect or OS/2 Warp 4}
\label{id2635233}\hypertarget{id2635233}{}%

Basically, you need three components:

\begin{itemize}
%--- Item
\item 
The File and Print Client (IBM peer)


%--- Item
\item 
TCP/IP (Internet support)


%--- Item
\item 
The {``}NetBIOS over TCP/IP{''} driver (TCPBEUI)

\end{itemize}

Installing the first two together with the base operating system on a blank system is explained in the Warp manual. If Warp has already been installed, but you now want to install the networking support, use the {``}Selective Install for Networking{''} object in the {``}System Setup{''} folder.

Adding the {``}NetBIOS over TCP/IP{''} driver is not described in the manual and just barely in the online documentation. Start {\bfseries{MPTS.EXE}}, click on {\sffamily \bfseries OK}, click on {\sffamily \bfseries Configure LAPS}, and click on {\sffamily \bfseries IBM OS/2 NETBIOS OVER TCP/IP} in {\sffamily \bfseries Protocols}. This line is then moved to {\sffamily \bfseries Current Configuration}. Select that line, click on {\sffamily \bfseries Change number}, and increase it from 0 to 1. Save this configuration.

If the Samba server is not on your local subnet, you can optionally add IP names and addresses of these servers to the {\sffamily \bfseries Names List} or specify a WINS server (NetBIOS Nameserver in IBM and RFC terminology). For Warp Connect, you may need to download an update for {\texttt{\docbookhyphenatedot{IBM Peer}}} to bring it on the same level as Warp 4. See the IBM OS/2 Warp Web page
\subsection{Configuring Other Versions of OS/2}
\label{id2637169}\hypertarget{id2637169}{}%

This sections deals with configuring OS/2 Warp 3 (not Connect), OS/2 1.2, 1.3 or 2.x.

You can use the free Microsoft LAN Manager 2.2c Client for OS/2 that is available from ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/\label{id2637184}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2637184}. In a nutshell, edit the file {\texttt{\docbookhyphenatefilename{\docbooktolatexgobble\string\\OS2VER}}} in the root directory of the OS/2 boot partition and add the lines:


\begin{Verbatim}[]

		20=setup.exe
		20=netwksta.sys
		20=netvdd.sys
		
\end{Verbatim}


before you install the client. Also, do not use the included NE2000 driver because it is buggy. Try the NE2000 or NS2000 driver from ftp://ftp.cdrom.com/pub/os2/network/ndis/\label{id2637214}\begingroup\catcode`\#=12\footnote{ {\textless}\url{ftp://ftp.cdrom.com/pub/os2/network/ndis/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2637214} instead.
\subsection{Printer Driver Download for OS/2 Clients}
\label{id2637226}\hypertarget{id2637226}{}%

Create a share called \smbconfsection{[PRINTDRV]} that is world-readable. Copy your OS/2 driver files there. The {\texttt{\docbookhyphenatefilename{.\dbz{}EA\_\dbz{}}}} files must still be separate, so you will need to use the original install files and not copy an installed driver from an OS/2 system.

Install the NT driver first for that printer. Then, add to your {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} a parameter, \smbconfoption{os2 driver map}. Next, in the file specified by {\ttfamily\itshape{\docbookhyphenatedot{filename}}}, map the name of the NT driver name to the OS/2 driver name as follows:

{\ttfamily\itshape{\docbookhyphenatedot{{\ttfamily\itshape{\docbookhyphenatedot{nt driver name}}} = {\ttfamily\itshape{\docbookhyphenatedot{os2 driver name}}}.{\ttfamily\itshape{\docbookhyphenatedot{device name}}}}}}, e.g.,

{\ttfamily\itshape{\docbookhyphenatedot{HP LaserJet 5L = LASERJET.HP LaserJet 5L}}}

You can have multiple drivers mapped in this file.

If you only specify the OS/2 driver name, and not the device name, the first attempt to download the driver will actually download the files, but the OS/2 client will tell you the driver is not available. On the second attempt, it will work. This is fixed simply by adding the device name to the mapping, after which it will work on the first attempt.

% ------------------------   
% Section 
\section{Windows for Workgroups}
\label{id2637313}\hypertarget{id2637313}{}%
\subsection{Latest TCP/IP Stack from Microsoft}
\label{id2637319}\hypertarget{id2637319}{}%

Use the latest TCP/IP stack from Microsoft if you use Windows for Workgroups. The early TCP/IP stacks had lots of bugs.

Microsoft has released an incremental upgrade to its TCP/IP 32-bit VxD drivers. The latest release can be found at ftp.microsoft.com, located in {\texttt{\docbookhyphenatefilename{/\dbz{}Softlib/\dbz{}MSLFILES/\dbz{}TCP32B.\dbz{}EXE}}}. There is an update.txt file there that describes the problems that were fixed. New files include {\texttt{\docbookhyphenatefilename{WINSOCK.\dbz{}DLL}}}, {\texttt{\docbookhyphenatefilename{TELNET.\dbz{}EXE}}}, {\texttt{\docbookhyphenatefilename{WSOCK.\dbz{}386}}}, {\texttt{\docbookhyphenatefilename{VNBT.\dbz{}386}}}, {\texttt{\docbookhyphenatefilename{WSTCP.\dbz{}386}}}, {\texttt{\docbookhyphenatefilename{TRACERT.\dbz{}EXE}}}, {\texttt{\docbookhyphenatefilename{NETSTAT.\dbz{}EXE}}}, and {\texttt{\docbookhyphenatefilename{NBTSTAT.\dbz{}EXE}}}.

More information about this patch is available in Knowledge Base article 99891\label{id2630491}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/kb/q99891/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2630491}.
\subsection{Delete .pwl Files After Password Change}
\label{id2630500}\hypertarget{id2630500}{}%

Windows for Workgroups does a lousy job with passwords. When you change passwords on either the UNIX box or the PC, the safest thing to do is delete the .pwl files in the Windows directory. The PC will complain about not finding the files, but will soon get over it, allowing you to enter the new password.

If you do not do this, you may find that Windows for Workgroups remembers and uses the old password, even if you told it a new one.

Often Windows for Workgroups will totally ignore a password you give it in a dialog box.
\subsection{Configuring Windows for Workgroups Password Handling}
\label{id2630527}\hypertarget{id2630527}{}%

\index{admincfg.exe} There is a program call {\texttt{\docbookhyphenatefilename{admincfg.\dbz{}exe}}} on the last disk (disk 8) of the WFW 3.11 disk set. To install it, type {\ttfamily\bfseries{\docbookhyphenatedot{EXPAND A:\docbooktolatexgobble\string\\ADMINCFG.\dbz{}EX\_\dbz{} C:\docbooktolatexgobble\string\\WINDOWS\docbooktolatexgobble\string\\ADMINCFG.\dbz{}EXE}}}. Then add an icon for it via the Program Manager {\sffamily \bfseries New} menu. This program allows you to control how WFW handles passwords, Disable Password Caching and so on, for use with \smbconfoption{security} = user.
\subsection{Password Case Sensitivity}
\label{id2630579}\hypertarget{id2630579}{}%

Windows for Workgroups uppercases the password before sending it to the server. UNIX passwords can be case-sensitive though. Check the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} information on \smbconfoption{password level} to specify what characters Samba should try to uppercase when checking.
\subsection{Use TCP/IP as Default Protocol}
\label{id2630603}\hypertarget{id2630603}{}%

To support print queue reporting, you may find that you have to use TCP/IP as the default protocol under Windows for Workgroups. For some reason, if you leave NetBEUI as the default, it may break the print queue reporting on some systems. It is presumably a Windows for Workgroups bug.
\subsection{Speed Improvement}
\label{speedimpr}\hypertarget{speedimpr}{}%

Note that some people have found that setting {\ttfamily\itshape{\docbookhyphenatedot{DefaultRcvWindow}}} in the \smbconfsection{[MSTCP]} section of the {\texttt{\docbookhyphenatefilename{SYSTEM.\dbz{}INI}}} file under Windows for Workgroups to 3072 gives a big improvement.

My own experience with DefaultRcvWindow is that I get a much better performance with a large value (16384 or larger). Other people have reported that anything over 3072 slows things down enormously. One person even reported a speed drop of a factor of 30 when he went from 3072 to 8192.

% ------------------------   
% Section 
\section{Windows 95/98}
\label{id2630660}\hypertarget{id2630660}{}%

When using Windows 95 OEM SR2, the following updates are recommended where Samba is being used. Please note that the changes documented in \hyperlink{speedimpr}{Section {\ref{speedimpr}}} will affect you once these updates have been installed.

There are more updates than the ones mentioned here. Refer to the Microsoft Web site for all currently available updates to your specific version of Windows 95.

\begin{tabular}{l}

Kernel Update: KRNLUPD.EXE  \\
Ping Fix: PINGUPD.EXE  \\
RPC Update: RPCRTUPD.EXE  \\
TCP/IP Update: VIPUPD.EXE  \\
Redirector Update: VRDRUPD.EXE  \\
\end{tabular}

Also, if using MS Outlook, it is desirable to install the {\bfseries{OLEUPD.EXE}} fix. This fix may stop your machine from hanging for an extended period when exiting Outlook, and you may notice a significant speedup when accessing network neighborhood services.
\subsection{Speed Improvement}
\label{id2631138}\hypertarget{id2631138}{}%

Configure the Windows 95 TCP/IP registry settings to give better performance. I use a program called {\bfseries{MTUSPEED.exe}} that I got off the Internet. There are various other utilities of this type freely available.

% ------------------------   
% Section 
\section{Windows 2000 Service Pack 2}
\label{id2631159}\hypertarget{id2631159}{}%

There are several annoyances with Windows 2000 SP2, one of which only appears when using a Samba server to host user profiles to Windows 2000 SP2 clients in a Windows domain. This assumes that Samba is a member of the domain, but the problem will most likely occur if it is not.

In order to serve profiles successfully to Windows 2000 SP2 clients (when not operating as a PDC), Samba must have \smbconfoption{nt acl support} = no added to the file share that houses the roaming profiles. If this is not done, then the Windows 2000 SP2 client will complain about not being able to access the profile (Access Denied) and create multiple copies of it on disk (DOMAIN.user.001, DOMAIN.user.002, and so on). See the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} man page for more details on this option. Also note that the \smbconfoption{nt acl support} parameter was formally a global parameter in releases prior to Samba 2.2.2.

\hyperlink{minimalprofile}{Example {\ref{minimalprofile}}} provides a minimal profile share.

\begin{example}%
\hypertarget{minimalprofile}{}%
\captionswapskip{}{{\caption{Minimal Profile Share}\label{minimalprofile}}}
\captionswapskip{}
\begin{lstlisting}[language=smbconf,style=smbconfblock]
[profile]
 	path = /export/profile
 	create mask = 0600
 	directory mask = 0700
 	nt acl support = no
 	read only = no
\end{lstlisting}
\end{example}


The reason for this bug is that the Windows 200x SP2 client copies the security descriptor for the profile that contains the Samba server's SID, and not the domain SID. The client compares the SID for SAMBA\textbackslash user and realizes it is different from the one assigned to DOMAIN\textbackslash user; hence, access denied message.

When the \smbconfoption{nt acl support} parameter is disabled, Samba will send the Windows 200x client a response to the QuerySecurityDescriptor trans2 call, which causes the client to set a default ACL for the profile. This default ACL includes:

{\em{DOMAIN\textbackslash user {``}Full Control{''}}}\textgreater{}

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

This bug does not occur when using Winbind to create accounts on the Samba host for Domain users.
\end{admonition}


% ------------------------   
% Section 
\section{Windows NT 3.1}
\label{id2631301}\hypertarget{id2631301}{}%

If you have problems communicating across routers with Windows NT 3.1 workstations, read this Microsoft Knowledge Base article:\label{id2631311}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://support.microsoft.com/default.aspx?scid=kb;Q103765}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2631311}.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Samba Performance Tuning 
% ------------------------------------------------------------- 	
\chapter{Samba Performance Tuning}
\label{speed}\hypertarget{speed}{}%

% ------------------------   
% Section 
\section{Comparisons}
\label{id2510653}\hypertarget{id2510653}{}%

The Samba server uses TCP to talk to the client, so if you are trying to see if it performs well, you should really compare it to programs that use the same protocol. The most readily available programs for file transfer that use TCP are ftp or another TCP-based SMB server.

If you want to test against something like an NT or Windows for Workgroups server, then you will have to disable all but TCP on either the client or server. Otherwise, you may well be using a totally different protocol (such as NetBEUI) and comparisons may not be valid.

Generally, you should find that Samba performs similarly to ftp at raw transfer speed. It should perform quite a bit faster than NFS, although this depends on your system.

Several people have done comparisons between Samba and Novell, NFS, or Windows NT. In some cases Samba performed the best, in others the worst. I suspect the biggest factor is not Samba versus some other system, but the hardware and drivers used on the various systems. Given similar hardware, Samba should certainly be competitive in speed with other systems.

% ------------------------   
% Section 
\section{Socket Options}
\label{id2631329}\hypertarget{id2631329}{}%

There are a number of socket options that can greatly affect the performance of a TCP-based server like Samba.

The socket options that Samba uses are settable both on the command line with the {\texttt{\docbookhyphenatedot{-O}}} option and in the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} file.

The \smbconfoption{socket options} section of the {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}} manual page describes how to set these and gives recommendations.

Getting the socket options correct can make a big difference to your performance, but getting them wrong can degrade it by just as much. The correct settings are very dependent on your local network.

The socket option TCP\_NODELAY is the one that seems to make the biggest single difference for most networks. Many people report that adding \smbconfoption{socket options} = TCP\_NODELAY doubles the read performance of a Samba drive. The best explanation I have seen for this is that the Microsoft TCP/IP stack is slow in sending TCP ACKs.

There have been reports that setting {\ttfamily\itshape{\docbookhyphenatedot{socket options = SO\_RCVBUF=8192}}} in smb.conf can seriously degrade Samba performance on the loopback adaptor (IP Address 127.0.0.1). It is strongly recommended that before specifying any settings for {\ttfamily\itshape{\docbookhyphenatedot{socket options}}}, the effect first be quantitatively measured on the server being configured.

% ------------------------   
% Section 
\section{Read Size}
\label{id2631407}\hypertarget{id2631407}{}%

The option \smbconfoption{read size} affects the overlap of disk reads/writes with network reads/writes. If the amount of data being transferred in several of the SMB commands (currently SMBwrite, SMBwriteX, and SMBreadbraw) is larger than this value, then the server begins writing the data before it has received the whole packet from the network, or in the case of SMBreadbraw, it begins writing to the network before all the data has been read from disk.

This overlapping works best when the speeds of disk and network access are similar, having little effect when the speed of one is much greater than the other.

The default value is 16384, but little experimentation has been done as yet to determine the optimal value, and it is likely that the best value will vary greatly between systems anyway. A value over 65536 is pointless and will cause you to allocate memory unnecessarily.

% ------------------------   
% Section 
\section{Max Xmit}
\label{id2631441}\hypertarget{id2631441}{}%

At startup the client and server negotiate a {\ttfamily\itshape{\docbookhyphenatedot{maximum transmit}}} size, which limits the size of nearly all SMB commands. You can set the maximum size that Samba will negotiate using the \smbconfoption{max xmit} option in {\texttt{\docbookhyphenatefilename{smb.\dbz{}conf}}}. Note that this is the maximum size of SMB requests that Samba will accept, but not the maximum size that the client will accept. The client maximum receive size is sent to Samba by the client, and Samba honors this limit.

It defaults to 65536 bytes (the maximum), but it is possible that some clients may perform better with a smaller transmit unit. Trying values of less than 2048 is likely to cause severe problems. In most cases the default is the best option.

% ------------------------   
% Section 
\section{Log Level}
\label{id2631482}\hypertarget{id2631482}{}%

If you set the log level (also known as \smbconfoption{debug level}) higher than 2, then you may suffer a large drop in performance. This is because the server flushes the log file after each operation, which can be quite expensive.

% ------------------------   
% Section 
\section{Read Raw}
\label{id2631500}\hypertarget{id2631500}{}%

The \smbconfoption{read raw} operation is designed to be an optimized, low-latency file read operation. A server may choose to not support it, however, and Samba makes support for \smbconfoption{read raw} optional, with it being enabled by default.

In some cases clients do not handle \smbconfoption{read raw} very well and actually get lower performance using it than they get using the conventional read operations, so you might like to try \smbconfoption{read raw} = no and see what happens on your network. It might lower, raise, or not affect your performance. Only testing can really tell.

% ------------------------   
% Section 
\section{Write Raw}
\label{id2631540}\hypertarget{id2631540}{}%

The \smbconfoption{write raw} operation is designed to be an optimized, low-latency file write operation. A server may choose to not support it, however, and Samba makes support for \smbconfoption{write raw} optional, with it being enabled by default.

Some machines may find \smbconfoption{write raw} slower than normal write, in which case you may wish to change this option.

% ------------------------   
% Section 
\section{Slow Logins}
\label{id2631570}\hypertarget{id2631570}{}%

Slow logins are almost always due to the password checking time. Using the lowest practical \smbconfoption{password level} will improve things.

% ------------------------   
% Section 
\section{Client Tuning}
\label{id2631587}\hypertarget{id2631587}{}%

Often a speed problem can be traced to the client. The client (for example Windows for Workgroups) can often be tuned for better TCP performance. Check the sections on the various clients in \hyperlink{Other-Clients}{Chapter {\ref{Other-Clients}}, {``}Samba and Other CIFS Clients{''}}.

% ------------------------   
% Section 
\section{Samba Performance Problem Due to Changing Linux Kernel}
\label{id2637356}\hypertarget{id2637356}{}%

A user wrote the following to the mailing list:
\begin{quote}

\index{Gentoo} \index{slow network} I am running Gentoo on my server and Samba 2.2.8a. Recently I changed kernel versions from {\texttt{\docbookhyphenatefilename{linux-\dbz{}2.\dbz{}4.\dbz{}19-\dbz{}gentoo-\dbz{}r10}}} to {\texttt{\docbookhyphenatefilename{linux-\dbz{}2.\dbz{}4.\dbz{}20-\dbz{}wolk4.\dbz{}0s}}}. Now I have a performance issue with Samba. Many of you will probably say, {``}Move to vanilla sources!{''} Well, I tried that and it didn't work. I have a 100MB LAN and two computers (Linux and Windows 2000). The Linux server shares directories with DivX files, the client (Windows 2000) plays them via LAN. Before, when I was running the 2.4.19 kernel, everything was fine, but now movies freeze and stop. I tried moving files between the server and Windows, and it is terribly slow.
\end{quote}

The answer he was given is:
\begin{quote}

\index{ifconfig} \index{framing error} \index{collisions} Grab the mii-tool and check the duplex settings on the NIC. My guess is that it is a link layer issue, not an application layer problem. Also run ifconfig and verify that the framing error, collisions, and so on, look normal for ethernet.
\end{quote}

% ------------------------   
% Section 
\section{Corrupt tdb Files}
\label{id2637449}\hypertarget{id2637449}{}%

\index{PDC} \index{mbd kept spawning} \index{/var/locks/*.tdb} Our Samba PDC server has been hosting three TB of data to our 500+ users [Windows NT/XP] for the last three years using Samba without a problem. Today all shares went very slow. Also, the main smbd kept spawning new processes, so we had 1600+ running SMDB's (normally we average 250). It crashed the SUN E3500 cluster twice. After a lot of searching, I decided to {\bfseries{rm /var/locks/*.tdb}}. Happy again.

{\em{Question:}} Is there any method of keeping the *.tdb files in top condition, or how can I detect early corruption?

\index{tdbbackup} \index{nmbd} {\em{Answer:}} Yes, run {\bfseries{tdbbackup}} each time after stopping nmbd and before starting nmbd.

{\em{Question:}} What I also would like to mention is that the service latency seems a lot lower than before the locks cleanup. Any ideas on keeping it top notch?

{\em{Answer:}} Yes. Same answer as for previous question!

% ------------------------   
% Section 
\section{Samba Performance is Very Slow}
\label{id2637547}\hypertarget{id2637547}{}%

\index{slow performance} A site reported experiencing very baffling symptoms with MYOB Premier opening and accessing its data files. Some operations on the file would take between 40 and 45 seconds.

\index{printer monitor} \index{pauses} It turned out that the printer monitor program running on the Windows clients was causing the problems. From the logs, we saw activity coming through with pauses of about 1 second.

\index{networks access} \index{printing now} Stopping the monitor software resulted in the networks access at normal (quick) speed. Restarting the program caused the speed to slow down again. The printer was a Canon LBP-810 and the relevant task was something like CAPON (not sure on spelling). The monitor software displayed a "printing now" dialog on the client during printing.

We discovered this by starting with a clean install of Windows and trying the application at every step of the installation of other software process (we had to do this many times).

Moral of the story: Check everything (other software included)!
\cleardoublepage 
% -------------------------------------------------------------
% Chapter LDAP and Transport Layer Security 
% ------------------------------------------------------------- 	
\chapter{LDAP and Transport Layer Security}
\label{ch-ldap-tls}\hypertarget{ch-ldap-tls}{}%

% ------------------------   
% Section 
\section{Introduction}
\label{s1-intro-ldap-tls}\hypertarget{s1-intro-ldap-tls}{}%

\index{Transport Layer Seccurity, TLS!Introduction} \index{ACL} Up until now, we have discussed the straightforward configuration of OpenLDAP\texttrademark{}, with some advanced features such as ACLs. This does not however, deal with the fact that the network transmissions are still in plain text. This is where {\em{Transport Layer Security (TLS)}} comes in.

\index{RFC 2830} OpenLDAP\texttrademark{} clients and servers are capable of using the Transport Layer Security (TLS) framework to provide integrity and confidentiality protections in accordance with RFC 2830\label{id2639668}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://rfc.net/rfc2830.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2639668}; {\em{Lightweight Directory Access Protocol (v3): Extension for Transport Layer Security.}}

\index{X.509 certificates} TLS uses X.509 certificates. All servers are required to have valid certificates, whereas client certificates are optional. We will only be discussing server certificates.

\begin{admonition}{xslt/figures/tip}{Tip}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

\index{DN} \index{CN} \index{FQDN} The DN of a server certificate must use the CN attribute to name the server, and the CN must carry the server's fully qualified domain name (FQDN). Additional alias names and wildcards may be present in the {\texttt{\docbookhyphenatedot{subjectAltName}}} certificate extension. More details on server certificate names are in RFC2830\label{id2639726}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://rfc.net/rfc2830.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2639726}.
\end{admonition}


We will discuss this more in the next sections.

% ------------------------   
% Section 
\section{Configuring}
\label{s1-config-ldap-tls}\hypertarget{s1-config-ldap-tls}{}%

\index{Transport Layer Seccurity, TLS!Configuring} Now on to the good bit.
\subsection{Generating the Certificate Authority}
\label{s1-config-ldap-tls-certs}\hypertarget{s1-config-ldap-tls-certs}{}%

\index{Certificate Authority|textit{see} {CA} } In order to create the relevant certificates, we need to become our own Certificate Authority (CA). \label{id2639781}\begingroup\catcode`\#=12\footnote{
We could however, get our generated server certificate signed by proper CAs, like Thawte {\textless}\url{http://www.thawte.com/}{\textgreater} and VeriSign {\textless}\url{http://www.verisign.com/}{\textgreater}, which you pay for, or the free ones, via CAcert {\textless}\url{http://www.cacert.org/}{\textgreater}
}\endgroup\docbooktolatexmakefootnoteref{id2639781} This is necessary, so we can sign the server certificate.

\index{OpenSSL} We will be using the OpenSSL\label{id2639816}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.openssl.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2639816} \label{id2639822}\begingroup\catcode`\#=12\footnote{
The downside to making our own CA, is that the certificate is not automatically recognized by clients, like the commercial ones are.
}\endgroup\docbooktolatexmakefootnoteref{id2639822} software for this, which is included with every great Linux\texttrademark{} distribution.

TLS is used for many types of servers, but the instructions\label{id2639840}\begingroup\catcode`\#=12\footnote{
For information straight from the horse's mouth, please visit {\textless}\url{http://www.openssl.org/docs/HOWTO/}{\textgreater}; the main OpenSSL site.
}\endgroup\docbooktolatexmakefootnoteref{id2639840} presented here, are tailored for OpenLDAP.

\begin{admonition}{xslt/figures/note}{Note}% NOTICE: see the db2latex FAQ w.r.t db2latex variable $latex.admonition.path

The {\em{Common Name (CN)}}, in the following example, {\em{MUST}} be the fully qualified domain name (FQDN) of your ldap server.
\end{admonition}


First we need to generate the CA: 
\begin{Verbatim}[]


root#  mkdir myCA


\end{Verbatim}
 Move into that directory: 
\begin{Verbatim}[]


root#  cd myCA


\end{Verbatim}
 Now generate the CA:\label{id2635408}\begingroup\catcode`\#=12\footnote{
Your {\texttt{\docbookhyphenatefilename{CA.\dbz{}pl}}} or {\texttt{\docbookhyphenatefilename{CA.\dbz{}sh}}} might not be in the same location as mine is, you can find it by using the {\bfseries{locate}} command, i.e., {\bfseries{locate CA.pl}}. If the command complains about the database being too old, run {\bfseries{updatedb}} as {\em{root}} to update it.
}\endgroup\docbooktolatexmakefootnoteref{id2635408} 
\begin{Verbatim}[]


root#  /usr/share/ssl/misc/CA.pl -newca
CA certificate filename (or enter to create)
  
Making CA certificate ...
Generating a 1024 bit RSA private key
.......................++++++
.............................++++++
writing new private key to './demoCA/private/cakey.pem'
Enter PEM pass phrase:
Verifying - Enter PEM pass phrase:
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:AU
State or Province Name (full name) [Some-State]:NSW
Locality Name (eg, city) []:Sydney
Organization Name (eg, company) [Internet Widgits Pty Ltd]:Abmas
Organizational Unit Name (eg, section) []:IT
Common Name (eg, YOUR name) []:ldap.abmas.biz
Email Address []:support@abmas.biz


\end{Verbatim}


There are some things to note here.

\begin{enumerate}
%--- Item
\item 
You {\em{MUST}} remember the password, as we will need it to sign the server certificate..


%--- Item
\item 
The {\em{Common Name (CN)}}, {\em{MUST}} be the fully qualified domain name (FQDN) of your ldap server.

\end{enumerate}
\subsection{Generating the Server Certificate}
\label{s1-config-ldap-tls-server}\hypertarget{s1-config-ldap-tls-server}{}%

Now we need to generate the server certificate: 
\begin{Verbatim}[]


root#  openssl req -new -nodes -keyout newreq.pem -out newreq.pem
Generating a 1024 bit RSA private key
.............++++++
........................................................++++++
writing new private key to 'newreq.pem'
-----
You are about to be asked to enter information that will be incorporated
into your certificate request.
What you are about to enter is what is called a Distinguished Name or a DN.
There are quite a few fields but you can leave some blank
For some fields there will be a default value,
If you enter '.', the field will be left blank.
-----
Country Name (2 letter code) [AU]:AU
State or Province Name (full name) [Some-State]:NSW
Locality Name (eg, city) []:Sydney
Organization Name (eg, company) [Internet Widgits Pty Ltd]:Abmas
Organizational Unit Name (eg, section) []:IT
Common Name (eg, YOUR name) []:ldap.abmas.biz
Email Address []:support@abmas.biz
  
Please enter the following 'extra' attributes
to be sent with your certificate request
A challenge password []:
An optional company name []:


\end{Verbatim}


Again, there are some things to note here.

\begin{enumerate}
%--- Item
\item 
You should {\em{NOT}} enter a password.


%--- Item
\item 
The {\em{Common Name (CN)}}, {\em{MUST}} be the fully qualified domain name (FQDN) of your ldap server.

\end{enumerate}

Now we sign the certificate with the new CA: 
\begin{Verbatim}[]


root#  /usr/share/ssl/misc/CA.pl -sign
Using configuration from /etc/ssl/openssl.cnf
Enter pass phrase for ./demoCA/private/cakey.pem:
Check that the request matches the signature
Signature ok
Certificate Details:
Serial Number: 1 (0x1)
Validity
	Not Before: Mar  6 18:22:26 2005 EDT
	Not After : Mar  6 18:22:26 2006 EDT
Subject:
	countryName               = AU
	stateOrProvinceName       = NSW
	localityName              = Sydney
	organizationName          = Abmas
	organizationalUnitName    = IT
	commonName                = ldap.abmas.biz
	emailAddress              = support@abmas.biz
X509v3 extensions:
	X509v3 Basic Constraints:
	    CA:FALSE
	Netscape Comment:
	    OpenSSL Generated Certificate
	X509v3 Subject Key Identifier:
	    F7:84:87:25:C4:E8:46:6D:0F:47:27:91:F0:16:E0:86:6A:EE:A3:CE
	X509v3 Authority Key Identifier:
	    keyid:27:44:63:3A:CB:09:DC:B1:FF:32:CC:93:23:A4:F1:B4:D5:F0:7E:CC
	    DirName:/C=AU/ST=NSW/L=Sydney/O=Abmas/OU=IT/
						CN=ldap.abmas.biz/emailAddress=support@abmas.biz
	    serial:00

Certificate is to be certified until Mar  6 18:22:26 2006 EDT (365 days)
Sign the certificate? [y/n]:y


1 out of 1 certificate requests certified, commit? [y/n]y
Write out database with 1 new entries
Data Base Updated
Signed certificate is in newcert.pem


\end{Verbatim}


That completes the server certificate generation.
\subsection{Installing the Certificates}
\label{s1-config-ldap-tls-install}\hypertarget{s1-config-ldap-tls-install}{}%

Now we need to copy the certificates to the right configuration directories, rename them at the same time (for convenience), change the ownership and finally the permissions: 
\begin{Verbatim}[]


root#  cp demoCA/cacert.pem /etc/openldap/
root#  cp newcert.pem /etc/openldap/servercrt.pem
root#  cp newreq.pem /etc/openldap/serverkey.pem
root#  chown ldap.ldap /etc/openldap/*.pem
root#  chmod 640 /etc/openldap/cacert.pem;
root#  chmod 600 /etc/openldap/serverkey.pem


\end{Verbatim}


Now we just need to add these locations to {\texttt{\docbookhyphenatefilename{slapd.\dbz{}conf}}}, anywhere before the {\texttt{\docbookhyphenatedot{database}}} declaration as shown here: 
\begin{Verbatim}[]


TLSCertificateFile /etc/openldap/servercrt.pem
TLSCertificateKeyFile /etc/openldap/serverkey.pem
TLSCACertificateFile /etc/openldap/cacert.pem


\end{Verbatim}


Here is the declaration and {\texttt{\docbookhyphenatefilename{ldap.\dbz{}conf}}}: {\texttt{\docbookhyphenatefilename{ldap.\dbz{}conf}}} 
\begin{Verbatim}[]


TLS_CACERT /etc/openldap/cacert.pem


\end{Verbatim}


That's all there is to it. Now on to \hyperlink{s1-test-ldap-tls}{Section {\ref{s1-test-ldap-tls}}}

% ------------------------   
% Section 
\section{Testing}
\label{s1-test-ldap-tls}\hypertarget{s1-test-ldap-tls}{}%

\index{Transport Layer Security, TLS!Testing} This is the easy part. Restart the server: 
\begin{Verbatim}[]


root#  /etc/init.d/ldap restart
Stopping slapd:                                            [  OK  ]
Checking configuration files for slapd: config file testing succeeded
Starting slapd:                                            [  OK  ]


\end{Verbatim}
 Then, using {\bfseries{ldapsearch}}, test an anonymous search with the {\texttt{\docbookhyphenatedot{-ZZ}}}\label{id2633988}\begingroup\catcode`\#=12\footnote{
See {\bfseries{man ldapsearch}}
}\endgroup\docbooktolatexmakefootnoteref{id2633988} option: 
\begin{Verbatim}[]


root#  ldapsearch -x -b "dc=ldap,dc=abmas,dc=biz" \
        -H 'ldap://ldap.abmas.biz:389' -ZZ


\end{Verbatim}
 Your results should be the same as before you restarted the server, for example: 
\begin{Verbatim}[]


root#  ldapsearch -x -b "dc=ldap,dc=abmas,dc=biz" \
    -H 'ldap://ldap.abmas.biz:389' -ZZ

# extended LDIF
#
# LDAPv3
# base <> with scope sub
# filter: (objectclass=*)
# requesting: ALL
#

# abmas.biz
dn: dc=ldap,dc=abmas,dc=biz
objectClass: dcObject
objectClass: organization
o: Abmas
dc: abmas

# Manager, ldap.abmas.biz
dn: cn=Manager,dc=ldap,dc=abmas,dc=biz
objectClass: organizationalRole
cn: Manager

# ABMAS, abmas.biz
dn: sambaDomainName=ABMAS,dc=ldap,dc=abmas,dc=biz
sambaDomainName: ABMAS
sambaSID: S-1-5-21-238355452-1056757430-1592208922
sambaAlgorithmicRidBase: 1000
objectClass: sambaDomain
sambaNextUserRid: 67109862
sambaNextGroupRid: 67109863


\end{Verbatim}
 If you have any problems, please read \hyperlink{s1-int-ldap-tls}{Section {\ref{s1-int-ldap-tls}}}

% ------------------------   
% Section 
\section{Troubleshooting}
\label{s1-int-ldap-tls}\hypertarget{s1-int-ldap-tls}{}%

\index{Transport Layer Security, TLS!Troubleshooting} The most common error when configuring TLS, as I have already mentioned numerous times, is that the {\em{Common Name (CN)}} you entered in \hyperlink{s1-config-ldap-tls-server}{Section {\ref{s1-config-ldap-tls-server}}} is {\em{NOT}} the Fully Qualified Domain Name (FQDN) of your ldap server.

Other errors could be that you have a typo somewhere in your {\bfseries{ldapsearch}} command, or that your have the wrong permissions on the {\texttt{\docbookhyphenatefilename{servercrt.\dbz{}pem}}} and {\texttt{\docbookhyphenatefilename{cacert.\dbz{}pem}}} files. They should be set with {\bfseries{chmod 640}}, as per \hyperlink{s1-config-ldap-tls-install}{Section {\ref{s1-config-ldap-tls-install}}}.

For anything else, it's best to read through your ldap logfile or join the OpenLDAP mailing list.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter Samba Support 
% ------------------------------------------------------------- 	
\chapter{Samba Support}
\label{id2469957}\hypertarget{id2469957}{}%

\index{support} One of the most difficult to answer questions in the information technology industry is, {``}What is support?{''}. That question irritates some folks, as much as common answers may annoy others.

\index{customers} The most aggravating situation pertaining to support is typified when, as a Linux user, a call is made to an Internet service provider who, instead of listening to the problem to find a solution, blandly replies: {``}Oh, Linux? We do not support Linux!{''}. It has happened to me, and similar situations happen through-out the IT industry. Answers like that are designed to inform us that there are some customers that a business just does not want to deal with, and well may we feel the anguish of the rejection that is dished out.

One way to consider support is to view it as consisting of the right answer, in the right place, at the right time, no matter the situation. Support is all that it takes to take away pain, disruption, inconvenience, loss of productivity, disorientation, uncertainty, and real or perceived risk.

\index{provided services} \index{services provided} \index{customer expected} One of the forces that has become a driving force for the adoption of open source software is the fact that many IT businesses have provided services that have perhaps failed to deliver what the customer expected, or that have been found wanting for other reasons.

\index{consumer expects} \index{problem resolution} In recognition of the need for needs satisfaction as the primary experience an information technology user or consumer expects, the information provided in this chapter may help someone to avoid an unpleasant experience in respect of problem resolution.

\index{free support} \index{paid-for support} \index{commercial support} In the open source software arena there are two support options: free support and paid-for (commercial) support.

% ------------------------   
% Section 
\section{Free Support}
\label{id2639527}\hypertarget{id2639527}{}%

\index{user groups} \index{mailing lists} \index{interactive help} \index{help} \index{mutual assistance} \index{assistance} Free support may be obtained from friends, colleagues, user groups, mailing lists, and interactive help facilities. An example of an interactive dacility is the Internet relay chat (IRC) channels that host user supported mutual assistance.

\index{mailing list} \index{deployment} \index{subscription} \index{IRC} \index{project} The Samba project maintains a mailing list that is commonly used to discuss solutions to Samba deployments. Information regarding subscription to the Samba mailing list can be found on the Samba web\label{id2640769}\begingroup\catcode`\#=12\footnote{ {\textless}\url{https://lists.samba.org/mailman/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2640769} site. The public mailing list that can be used to obtain free, user contributed, support is called the {\texttt{\docbookhyphenatedot{samba}}} list. The email address for this list is at {\texttt{\docbookhyphenatedot{mail:samba@samba.\dbz{}org}}}. Information regarding the Samba IRC channels may be found on the Samba IRC\label{id2640789}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba.irc.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2640789} web page.

\index{free support} \index{qualified problem} \index{requesting payment} \index{professional support} As a general rule, it is considered poor net behavior to contact a Samba Team member directly for free support. Most active members of the Samba Team work exceptionally long hours to assist users who have demonstrated a qualified problem. Some team members may respond to direct email or telephone contact, with requests for assistance, by requesting payment. A few of the Samba Team members actually provide professional paid-for Samba support and it is therefore wise to show appropriate discretion and reservation in all direct contact.

\index{bug report} \index{problem report} \index{code maintainer} When you stumble across a Samba bug, often the quickest way to get it resolved is by posting a bug report\label{id2617997}\begingroup\catcode`\#=12\footnote{ {\textless}\url{https://bugzilla.samba.org/}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2617997}. All such reports are mailed to the responsible code maintainer for action. The better the report, and the more serious it is, the sooner it will be dealt with. On the other hand, if the responsible person can not duplicate the reported bug it is likely to be rejected. It is up to you to provide sufficient information that will permit the problem to be reproduced.

\index{purchase support} We all recognize that sometimes free support does not provide the answer that is sought within the time-frame required. At other times the problem is elusive and you may lack the experience necessary to isolate the problem and thus to resolve it. This is a situation where is may be prudent to purchase paid-for support.

% ------------------------   
% Section 
\section{Commercial Support}
\label{id2640860}\hypertarget{id2640860}{}%

There are six basic support oriented services that are most commonly sought by Samba sites:

\begin{itemize}
%--- Item
\item 
Assistance with network design


%--- Item
\item 
Staff Training


%--- Item
\item 
Assistance with Samba network deployment and installation


%--- Item
\item 
Priority telephone or email Samba configuration assistance


%--- Item
\item 
Trouble-shooting and diagnostic assistance


%--- Item
\item 
Provision of quality assured ready-to-install Samba binary packages

\end{itemize}

\index{commercial support} \index{country of origin} Information regarding companies that provide professional Samba support can be obtained by performing a Google search, as well as by reference to the Samba Support\label{id2640922}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.samba.org/samba/support.html}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2640922} web page. Companies who notify the Samba Team that they provide commercial support are given a free listing that is sorted by the country of origin. Multiple listings are permitted, however no guarantee is offered. It is left to you to qualify a support provider and to satisfy yourself that both the company and its staff are able to deliver what is required of them.

\index{commercial support} The policy within the Samba Team is to treat all commercial support providers equally and to show no preference. As a result, Samba Team members who provide commercial support are lumped in with everyone else. You are encouraged to obtain the services needed from a company in your local area. The open source movement is pro-community; so do what you can to help a local business to prosper.

\index{unsupported software} Open source software support can be found in any quality, at any price and in any place you can to obtain it. Over 180 companies around the world provide Samba support, there is no excuse for suffering in the mistaken belief that Samba is unsupported software ---  it is supported.
\cleardoublepage 
% -------------------------------------------------------------
% Chapter DNS and DHCP Configuration Guide 
% ------------------------------------------------------------- 	
\chapter{DNS and DHCP Configuration Guide}
\label{DNSDHCP}\hypertarget{DNSDHCP}{}%

% ------------------------   
% Section 
\section{Features and Benefits}
\label{id2475712}\hypertarget{id2475712}{}%

\index{Dynamic Host Configuration Protocol|textit{see} {DHCP} } \index{Domain Name System|textit{see} {DNS} } There are few subjects in the UNIX world that might raise as much contention as Domain Name System (DNS) and Dynamic Host Configuration Protocol (DHCP). Not all opinions held for or against particular implementations of DNS and DHCP are valid.

We live in a modern age where many information technology users demand mobility and freedom. Microsoft Windows users in particular expect to be able to plug their notebook computer into a network port and have things {``}just work.{''}

\index{ADS} UNIX administrators have a point. Many of the normative practices in the Microsoft Windows world at best border on bad practice from a security perspective. Microsoft Windows networking protocols allow workstations to arbitrarily register themselves on a network. Windows 2000 Active Directory registers entries in the DNS namespace that are equally perplexing to UNIX administrators. Welcome to the new world!

\index{ISC!DNS} \index{ISC!DHCP} \index{Dynamic DNS|textit{see} {DDNS} } The purpose of this chapter is to demonstrate the configuration of the Internet Software Consortium (ISC) DNS and DHCP servers to provide dynamic services that are compatible with their equivalents in the Microsoft Windows 2000 Server products.

This chapter provides no more than a working example of configuration files for both DNS and DHCP servers. The examples used match configuration examples used elsewhere in this document.

\index{DNS} \index{DHCP} \index{BIND9.NET} This chapter explicitly does not provide a tutorial, nor does it pretend to be a reference guide on DNS and DHCP, as this is well beyond the scope and intent of this document as a whole. Anyone who wants more detailed reference materials on DNS or DHCP should visit the ISC Web site at http://www.isc.org\label{id2635837}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.isc.org}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635837}. Those wanting a written text might also be interested in the O'Reilly publications on DNS, see the O'Reilly\label{id2635847}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.oreilly.com/catalog/dns/index.htm}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635847} web site, and the BIND9.NET\label{id2635853}\begingroup\catcode`\#=12\footnote{ {\textless}\url{http://www.bind9.net/books-dhcp}{\textgreater}}\endgroup\docbooktolatexmakefootnoteref{id2635853} web site for details. The books are:

\begin{enumerate}
%--- Item
\item 
DNS and BIND, By Cricket Liu, Paul Albitz, ISBN: 1-56592-010-4


%--- Item
\item 
DNS \& Bind Cookbook, By Cricket Liu, ISBN: 0-596-00410-9


%--- Item
\item 
The DHCP Handbook (2nd Edition), By: Ralph Droms, Ted Lemon, ISBN 0-672-32327-3

\end{enumerate}

% ------------------------   
% Section 
\section{Example Configuration}
\label{id2635887}\hypertarget{id2635887}{}%

\index{WINS} \index{DNS} The DNS is to the Internet what water is to life. Nearly all information resources (host names) are resolved to their Internet protocol (IP) addresses through DNS. Windows networking tried hard to avoid the complexities of DNS, but alas, DNS won. \index{WINS} The alternative to DNS, the Windows Internet Name Service (WINS) ---  an artifact of NetBIOS networking over the TCP/IP protocols ---  has demonstrated scalability problems as well as a flat, nonhierarchical namespace that became unmanageable as the size and complexity of information technology networks grew.

\index{RFC 1001} \index{RFC 1002} WINS is a Microsoft implementation of the RFC1001/1002 NetBIOS Name Service (NBNS). It allows NetBIOS clients (like Microsoft Windows machines) to register an arbitrary machine name that the administrator or user has chosen together with the IP address that the machine has been given. Through the use of WINS, network client machines could resolve machine names to their IP address.

The demand for an alternative to the limitations of NetBIOS networking finally drove Microsoft to use DNS and Active Directory. Microsoft's new implementation attempts to use DNS in a manner similar to the way that WINS is used for NetBIOS networking. Both WINS and Microsoft DNS rely on dynamic name registration.

Microsoft Windows clients can perform dynamic name registration to the DNS server on startup. Alternatively, where DHCP is used to assign workstation IP addresses, it is possible to register hostnames and their IP address by the DHCP server as soon as a client acknowledges an IP address lease. Finally, Microsoft DNS can resolve hostnames via Microsoft WINS.

The following configurations demonstrate a simple, insecure dynamic DNS server and a simple DHCP server that matches the DNS configuration.
\subsection{Dynamic DNS}
\label{id2635980}\hypertarget{id2635980}{}%

\index{DNS!Dynamic} The example DNS configuration is for a private network in the IP address space for network 192.168.1.0/24. The private class network address space is set forth in RFC1918.

\index{BIND} It is assumed that this network will be situated behind a secure firewall. The files that follow work with ISC BIND version 9. BIND is the Berkeley Internet Name Daemon.

The master configuration file {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}named.\dbz{}conf}}} determines the location of all further configuration files used. The location and name of this file is specified in the startup script that is part of the operating system. 
\begin{Verbatim}[]

# Quenya.Org configuration file

acl mynet {
	192.168.1.0/24;
	127.0.0.1;
};

options {

	directory "/var/named";
	listen-on-v6 { any; };
	notify no;
	forward first;
	forwarders {
		192.168.1.1;
		};
	auth-nxdomain yes;
	multiple-cnames yes;
	listen-on {
		mynet;
		};
};

# The following three zone definitions do not need any modification.
# The first one defines localhost while the second defines the
# reverse lookup for localhost. The last zone "." is the
# definition of the root name servers.

zone "localhost" in {
	type master;
	file "localhost.zone";
};

zone "0.0.127.in-addr.arpa" in {
	type master;
	file "127.0.0.zone";
};

zone "." in {
	type hint;
	file "root.hint";
};

# You can insert further zone records for your own domains below.

zone "quenya.org" {
	type master;
	file "/var/named/quenya.org.hosts";
	allow-query {
		mynet;
		};
	allow-transfer {
		mynet;
		};
	allow-update {
		mynet;
		};
	};

zone "1.168.192.in-addr.arpa" {
	type master;
	file "/var/named/192.168.1.0.rev";
	allow-query {
		mynet;
	};
	allow-transfer {
		mynet;
	};
	allow-update {
		mynet;
	};
};

\end{Verbatim}


The following files are all located in the directory {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}named}}}. This is the {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}named/\dbz{}localhost.\dbz{}zone}}} file: 
\begin{Verbatim}[]

$TTL 1W
@               IN SOA  @   root (
				42              ; serial (d. adams)
				2D              ; refresh
				4H              ; retry
				6W              ; expiry
				1W )            ; minimum

		IN NS           @
		IN A            127.0.0.1
	
\end{Verbatim}


The {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}named/\dbz{}127.\dbz{}0.\dbz{}0.\dbz{}zone}}} file: 
\begin{Verbatim}[]

$TTL 1W
@               IN SOA          localhost.  root.localhost. (
				42              ; serial (d. adams)
				2D              ; refresh
				4H              ; retry
				6W              ; expiry
				1W )            ; minimum

				IN NS           localhost.
1               IN PTR          localhost.

\end{Verbatim}


The {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}named/\dbz{}quenya.\dbz{}org.\dbz{}host}}} file: 
\begin{Verbatim}[]

$ORIGIN .
$TTL 38400      ; 10 hours 40 minutes
quenya.org      IN SOA  marvel.quenya.org. root.quenya.org. (
				2003021832 ; serial
				10800      ; refresh (3 hours)
				3600       ; retry (1 hour)
				604800     ; expire (1 week)
				38400      ; minimum (10 hours 40 minutes)
				)
			NS      marvel.quenya.org.
			MX      10 mail.quenya.org.
$ORIGIN quenya.org.
frodo                   A       192.168.1.1
marvel                  A       192.168.1.2
;
mail                    CNAME   marvel
www                     CNAME   marvel

\end{Verbatim}


The {\texttt{\docbookhyphenatefilename{/\dbz{}var/\dbz{}named/\dbz{}192.\dbz{}168.\dbz{}1.\dbz{}0.\dbz{}rev}}} file: 
\begin{Verbatim}[]

$ORIGIN .
$TTL 38400      ; 10 hours 40 minutes
1.168.192.in-addr.arpa  IN SOA  marvel.quenya.org. root.quenya.org. (
				2003021824 ; serial
				10800      ; refresh (3 hours)
				3600       ; retry (1 hour)
				604800     ; expire (1 week)
				38400      ; minimum (10 hours 40 minutes)
				)
			NS      marvel.quenya.org.
$ORIGIN 1.168.192.in-addr.arpa.
1                       PTR     frodo.quenya.org.
2                       PTR     marvel.quenya.org.

\end{Verbatim}


\index{BIND} \index{dynamic registration files} The configuration files shown here were copied from a fully working system. All dynamically registered entries have been removed. In addition to these files, BIND version 9 will create for each of the dynamic registration files a file that has a {\texttt{\docbookhyphenatefilename{.\dbz{}jnl}}} extension. Do not edit or tamper with the configuration files or with the {\texttt{\docbookhyphenatefilename{.\dbz{}jnl}}} files that are created.
\subsection{DHCP Server}
\label{DHCP}\hypertarget{DHCP}{}%

The following file is used with the ISC DHCP Server version 3. The file is located in {\texttt{\docbookhyphenatefilename{/\dbz{}etc/\dbz{}dhcpd.\dbz{}conf}}}:


\begin{Verbatim}[]

ddns-updates on;
ddns-domainname "quenya.org";
option ntp-servers 192.168.1.2;
ddns-update-style ad-hoc;
allow unknown-clients;
default-lease-time 86400;
max-lease-time 172800;

option domain-name "quenya.org";
option domain-name-servers 192.168.1.2;
option netbios-name-servers 192.168.1.2;
option netbios-dd-server 192.168.1.2;
option netbios-node-type 8;

subnet 192.168.1.0 netmask 255.255.255.0 {
	range dynamic-bootp 192.168.1.60 192.168.1.254;
	option subnet-mask 255.255.255.0;
	option routers 192.168.1.2;
	allow unknown-clients;
}

\end{Verbatim}


In this example, IP addresses between 192.168.1.1 and 192.168.1.59 are reserved for fixed-address (commonly called {\texttt{\docbookhyphenatedot{hard-wired}}}) IP addresses. The addresses between 192.168.1.60 and 192.168.1.254 are allocated for dynamic use.
\cleardoublepage \cleardoublepage 
\newcommand{\dbappendix}[1]{\chapter{#1}}%
% ------------------------------------------------------------- 
% Appendices start here
% -------------------------------------------------------------
\appendix

% -------------------------------------------------------------
% appendix:  GNU General Public License version 3 
% ------------------------------------------------------------- 	
\dbappendix{GNU General Public License version 3}
\label{id2475986}\hypertarget{id2475986}{}%

Version 3, 29 June 2007

Copyright © 2007 Free Software Foundation, Inc. {\textless}\url{http://fsf.org/}{\textgreater}

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

\section*{Preamble}\label{id2506652}

The GNU General Public License is a free, copyleft license for software and other kinds of works.

The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

The precise terms and conditions for copying, distribution and modification follow.

\paragraph*{TERMS AND CONDITIONS}\label{id2642815}

\noindent

\section*{0. Definitions.}\label{id2458799}

“This License” refers to version 3 of the GNU General Public License.

“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

A “covered work” means either the unmodified Program or a work based on the Program.

To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.

\section*{1. Source Code.}\label{id2642514}

The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

The Corresponding Source for a work in source code form is that same work.

\section*{2. Basic Permissions.}\label{id2573672}

All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.

\section*{3. Protecting Users’ Legal Rights From Anti-Circumvention Law.}\label{id2465368}

No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.

\section*{4. Conveying Verbatim Copies.}\label{id2573806}

You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.

\section*{5. Conveying Modified Source Versions.}\label{id2493767}

You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

\begin{enumerate}[a]
%--- Item
\item 
The work must carry prominent notices stating that you modified it, and giving a relevant date.


%--- Item
\item 
The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.


%--- Item
\item 
You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.


%--- Item
\item 
If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.

\end{enumerate}

A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.

\section*{6. Conveying Non-Source Forms.}\label{id2468100}

You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

\begin{enumerate}[a]
%--- Item
\item 
Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.


%--- Item
\item 
Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.


%--- Item
\item 
Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.


%--- Item
\item 
Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.


%--- Item
\item 
Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.

\end{enumerate}

A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.

\section*{7. Additional Terms.}\label{id2642923}

“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

\begin{enumerate}[a]
%--- Item
\item 
Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or


%--- Item
\item 
Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or


%--- Item
\item 
Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or


%--- Item
\item 
Limiting the use for publicity purposes of names of licensors or authors of the material; or


%--- Item
\item 
Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or


%--- Item
\item 
Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.

\end{enumerate}

All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.

\section*{8. Termination.}\label{id2494270}

You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.

\section*{9. Acceptance Not Required for Having Copies.}\label{id2644864}

You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.

\section*{10. Automatic Licensing of Downstream Recipients.}\label{id2471274}

Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.

\section*{11. Patents.}\label{id2500727}

A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.

A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.

\section*{12. No Surrender of Others’ Freedom.}\label{id2571497}

If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.

\section*{13. Use with the GNU Affero General Public License.}\label{id2642655}

Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.

\section*{14. Revised Versions of this License.}\label{id2456609}

The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.

\section*{15. Disclaimer of Warranty.}\label{id2502983}

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

\section*{16. Limitation of Liability.}\label{id2466637}

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

\section*{17. Interpretation of Sections 15 and 16.}\label{id2646203}

If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

\paragraph*{END OF TERMS AND CONDITIONS}\label{id2646219}

\noindent

\section*{How to Apply These Terms to Your New Programs}\label{id2646222}

If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

\begin{Verbatim}[]

one line to give the program’s name and a brief idea of what it does.
Copyright (C) year name of author

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see http://www.gnu.org/licenses/.
  
\end{Verbatim}

Also add information on how to contact you by electronic and paper mail.

If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

\begin{Verbatim}[]

program Copyright (C) year name of author
This program comes with ABSOLUTELY NO WARRANTY; for details type ‘{\verb show w}’.
This is free software, and you are welcome to redistribute it
under certain conditions; type ‘{\verb show c}’ for details.
  
\end{Verbatim}

The hypothetical commands ‘{\texttt{\docbookhyphenatedot{show w}}}’ and ‘{\texttt{\docbookhyphenatedot{show c}}}’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.

You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see {\textless}\url{http://www.gnu.org/licenses/}{\textgreater}.

The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read {\textless}\url{http://www.gnu.org/philosophy/why-not-lgpl.html}{\textgreater}.


\cleardoublepage % ------------------------------------------------------------- 
% 
% GLOSSARY Glossary
% 
% ------------------------------------------------------------- 
\dbglossary{Glossary}
\label{id2460612}\hypertarget{id2460612}{}%
\noindent%
\begin{description}
\item[{Access Control List}]  ( {\texttt{\docbookhyphenatedot{ACL}}} ) 

A detailed list of permissions granted to users or groups with respect to file and network resource access. See \hyperlink{AccessControls}{Chapter {\ref{AccessControls}}, {``}File, Directory, and Share Access Controls{''}}, for details.


\item[{Active Directory Service}]  ( {\texttt{\docbookhyphenatedot{ADS}}} ) 

A service unique to Microsoft Windows 200x servers that provides a centrally managed directory for management of user identities and computer objects, as well as the permissions each user or computer may be granted to access distributed network resources. ADS uses Kerberos-based authentication and LDAP over Kerberos for directory access.


\item[{Common Internet File System}]  ( {\texttt{\docbookhyphenatedot{CIFS}}} ) 

The new name for SMB. Microsoft renamed the SMB protocol to CIFS during the Internet hype in the nineties. At about the time that the SMB protocol was renamed to CIFS, an additional dialect of the SMB protocol was in development. The need for the deployment of the NetBIOS layer was also removed, thus paving the way for use of the SMB protocol natively over TCP/IP (known as NetBIOS-less SMB or {``}naked{''} TCP transport).


\item[{Common UNIX Printing System}]  ( {\texttt{\docbookhyphenatedot{CUPS}}} ) 

A recent implementation of a high capability printing system for UNIX developed by {\textless}\url{http://www.easysw.com/}{\textgreater}. The design objective of CUPS was to provide a rich print processing system that has built-in intelligence capable of correctly rendering (processing) a file that is submitted for printing even if it was formatted for an entirely different printer.


\item[{Domain Master Browser}]  ( {\texttt{\docbookhyphenatedot{DMB}}} ) 

The domain master browser maintains a list of all the servers that have announced their services within a given workgroup or NT domain. See \hyperlink{DMB}{Section {\ref{DMB}}} for details.


\item[{Domain Name Service}]  ( {\texttt{\docbookhyphenatedot{DNS}}} ) 

A protocol by which computer hostnames may be resolved to the matching IP address/es. DNS is implemented by the Berkeley Internet Name Daemon. There exists a recent version of DNS that allows dynamic name registration by network clients or by a DHCP server. This recent protocol is known as dynamic DNS (DDNS).


\item[{Dynamic Host Configuration Protocol}]  ( {\texttt{\docbookhyphenatedot{DHCP}}} ) 

A protocol that was based on the BOOTP protocol that may be used to dynamically assign an IP address, from a reserved pool of addresses, to a network client or device. Additionally, DHCP may assign all network configuration settings and may be used to register a computer name and its address with a dynamic DNS server.


\item[{Extended Meta-file Format}]  ( {\texttt{\docbookhyphenatedot{EMF}}} ) 

An intermediate file format used by Microsoft Windows-based servers and clients. EMF files may be rendered into a page description language by a print processor.


\item[{Graphical Device Interface}]  ( {\texttt{\docbookhyphenatedot{GDI}}} ) 

Device-independent format for printing used by Microsoft Windows. It is quite similar to what PostScript is for UNIX. Printing jobs are first generated in GDI and then converted to a device-specific format. See \hyperlink{gdipost}{Section {\ref{gdipost}}} for details.


\item[{Group IDentifier}]  ( {\texttt{\docbookhyphenatedot{GID}}} ) 

The UNIX system group identifier; on older systems, a 32-bit unsigned integer, and on newer systems an unsigned 64-bit integer. The GID is used in UNIX-like operating systems for all group-level access control.


\item[{Internet Print Protocol}]  ( {\texttt{\docbookhyphenatedot{IPP}}} ) 

An IETF standard for network printing. CUPS implements IPP.


\item[{Key Distribution Center}]  ( {\texttt{\docbookhyphenatedot{KDC}}} ) 

The Kerberos authentication protocol makes use of security keys (also called a ticket) by which access to network resources is controlled. The issuing of Kerberos tickets is effected by a KDC.


\item[{NetBIOS Extended User Interface}]  ( {\texttt{\docbookhyphenatedot{NetBEUI}}} ) 

Very simple network protocol invented by IBM and Microsoft. It is used to do NetBIOS over Ethernet with low overhead. NetBEUI is a nonroutable protocol.


\item[{Network Basic Input/Output System}]  ( {\texttt{\docbookhyphenatedot{NetBIOS}}} ) 

NetBIOS is a simple application programming interface (API) invented in the 1980s that allows programs to send data to certain network names. NetBIOS is always run over another network protocol such as IPX/SPX, TCP/IP, or Logical Link Control (LLC). NetBIOS run over LLC is best known as NetBEUI (NetBIOS Extended User Interface ---  a complete misnomer!).


\item[{NetBT}]  ( {\texttt{\docbookhyphenatedot{NBT}}} ) 

Protocol for transporting NetBIOS frames over TCP/IP. Uses ports 137, 138, and 139. NetBT is a fully routable protocol.


\item[{Local Master Browser}]  ( {\texttt{\docbookhyphenatedot{LMB}}} ) 

The local master browser maintains a list of all servers that have announced themselves within a given workgroup or NT domain on a particular broadcast-isolated subnet. See \hyperlink{DMB}{Section {\ref{DMB}}} for details.


\item[{Printer Command Language}]  ( {\texttt{\docbookhyphenatedot{PCL}}} ) 

A printer page description language that was developed by Hewlett-Packard and is in common use today.


\item[{Portable Document Format}]  ( {\texttt{\docbookhyphenatedot{PDF}}} ) 

A highly compressed document format, based on PostScript, used as a document distribution format that is supported by Web browsers as well as many applications. Adobe also distributes an application called {``}Acrobat,{''} which is a PDF reader.


\item[{Page Description Language}]  ( {\texttt{\docbookhyphenatedot{PDL}}} ) 

A language for describing the layout and contents of a printed page. The best-known PDLs are Adobe PostScript and Hewlett-Packard PCL (Printer Control Language), both of which are used to control laser printers.


\item[{PostScript Printer Description}]  ( {\texttt{\docbookhyphenatedot{PPD}}} ) 

PPDs specify and control options supported by PostScript printers, such as duplexing, stapling, and DPI. See also \hyperlink{post-and-ghost}{Section {\ref{post-and-ghost}}}. PPD files can be read by printing applications to enable correct PostScript page layout for a particular PostScript printer.


\item[{Remote Procedure Call}]  ( {\texttt{\docbookhyphenatedot{RPC}}} ) 

RPCs are a means for executing network operations. The RPC protocol is independent of transport protocols. RPC does not try to implement any kind of reliability and the application that uses RPCs must be aware of the type of transport protocol underneath RPC. An RPC is like a programmatic jump subroutine over a network. RPCs used in the UNIX environment are specified in RFC 1050. RPC is a powerful technique for constructing distributed, client-server based applications. It is based on extending the notion of conventional, or local procedure calling, so that the called procedure need not exist in the same address space as the calling procedure. The two processes may be on the same system, or they may be on different systems with a network connecting them. By using RPC, programmers of distributed applications avoid the details of the interface with the network. The transport independence of RPC isolates the application from the physical and logical elements of the data communications mechanism and allows the application to use a variety of transports.


\item[{Server Message Block}]  ( {\texttt{\docbookhyphenatedot{SMB}}} ) 

SMB was the original name of the protocol `spoken' by Samba. It was invented in the 1980s by IBM and adopted and extended further by Microsoft. Microsoft renamed the protocol to CIFS during the Internet hype in the 1990s.


\item[{User IDentifier}]  ( {\texttt{\docbookhyphenatedot{UID}}} ) 

The UNIX system user identifier; on older systems a 32-bit unsigned integer, and on newer systems, an unsigned 64-bit integer. The UID is used in UNIX-like operating systems for all user-level access control.


\item[{Universal Naming Convention}]  ( {\texttt{\docbookhyphenatedot{UNC}}} ) 

A syntax for specifying the location of network resources (such as file shares). The UNC syntax was developed in the early days of MS DOS 3.x and is used internally by the SMB protocol.


\end{description}
\cleardoublepage \chaptermark{Subject index} \setlength\saveparskip\parskip
\setlength\saveparindent\parindent
\begin{dbtolatexindex}{id2407324}
\setlength\tempparskip\parskip \setlength\tempparindent\parindent
\parskip\saveparskip \parindent\saveparindent
\noindent \indexspace
\parskip\tempparskip
\parindent\tempparindent
\makeatletter\@input@{\jobname.ind}\makeatother
\end{dbtolatexindex}

\end{document}