sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-03-02 08:58:33 +03:00
Code

This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to be commit a1ffe2a29c0e6be54af09d6647b7f54369d75a1e)

Browse Source
This commit is contained in:
cvs2svn Import User 2003-05-01 11:47:49 +00:00
commit 67ce764d69
262 changed files with 62759 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

237
docs/docbook/devdoc/CodingSuggestions.xml Normal file
View File

@ -0,0 +1,237 @@
<chapter id="CodingSuggestions">
<chapterinfo>
<author>
<firstname>Steve</firstname><surname>French</surname>
</author>
<author>
<firstname>Simo</firstname><surname>Sorce</surname>
</author>
<author>
<firstname>Andrew</firstname><surname>Bartlett</surname>
</author>
<author>
<firstname>Tim</firstname><surname>Potter</surname>
</author>
<author>
<firstname>Martin</firstname><surname>Pool</surname>
</author>
</chapterinfo>
<title>Coding Suggestions</title>
<para>
So you want to add code to Samba ...
</para>
<para>
One of the daunting tasks facing a programmer attempting to write code for
Samba is understanding the various coding conventions used by those most
active in the project. These conventions were mostly unwritten and helped
improve either the portability, stability or consistency of the code. This
document will attempt to document a few of the more important coding
practices used at this time on the Samba project. The coding practices are
expected to change slightly over time, and even to grow as more is learned
about obscure portability considerations. Two existing documents
<filename>samba/source/internals.doc</filename> and
<filename>samba/source/architecture.doc</filename> provide
additional information.
</para>
<para>
The loosely related question of coding style is very personal and this
document does not attempt to address that subject, except to say that I
have observed that eight character tabs seem to be preferred in Samba
source. If you are interested in the topic of coding style, two oft-quoted
documents are:
</para>
<para>
<ulink url="http://lxr.linux.no/source/Documentation/CodingStyle">http://lxr.linux.no/source/Documentation/CodingStyle</ulink>
</para>
<para>
<ulink url="http://www.fsf.org/prep/standards_toc.html">http://www.fsf.org/prep/standards_toc.html</ulink>
</para>
<para>
But note that coding style in Samba varies due to the many different
programmers who have contributed.
</para>
<para>
Following are some considerations you should use when adding new code to
Samba. First and foremost remember that:
</para>
<para>
Portability is a primary consideration in adding function, as is network
compatability with de facto, existing, real world CIFS/SMB implementations.
There are lots of platforms that Samba builds on so use caution when adding
a call to a library function that is not invoked in existing Samba code.
Also note that there are many quite different SMB/CIFS clients that Samba
tries to support, not all of which follow the SNIA CIFS Technical Reference
(or the earlier Microsoft reference documents or the X/Open book on the SMB
Standard) perfectly.
</para>
<para>
Here are some other suggestions:
</para>
<orderedlist>
<listitem><para>
use d_printf instead of printf for display text
reason: enable auto-substitution of translated language text
</para></listitem>
<listitem><para>
use SAFE_FREE instead of free
reason: reduce traps due to null pointers
</para></listitem>
<listitem><para>
don't use bzero use memset, or ZERO_STRUCT and ZERO_STRUCTP macros
reason: not POSIX
</para></listitem>
<listitem><para>
don't use strcpy and strlen (use safe_* equivalents)
reason: to avoid traps due to buffer overruns
</para></listitem>
<listitem><para>
don't use getopt_long, use popt functions instead
reason: portability
</para></listitem>
<listitem><para>
explicitly add const qualifiers on parm passing in functions where parm
is input only (somewhat controversial but const can be #defined away)
</para></listitem>
<listitem><para>
when passing a va_list as an arg, or assigning one to another
please use the VA_COPY() macro
reason: on some platforms, va_list is a struct that must be
initialized in each function...can SEGV if you don't.
</para></listitem>
<listitem><para>
discourage use of threads
reason: portability (also see architecture.doc)
</para></listitem>
<listitem><para>
don't explicitly include new header files in C files - new h files
should be included by adding them once to includes.h
reason: consistency
</para></listitem>
<listitem><para>
don't explicitly extern functions (they are autogenerated by
"make proto" into proto.h)
reason: consistency
</para></listitem>
<listitem><para>
use endian safe macros when unpacking SMBs (see byteorder.h and
internals.doc)
reason: not everyone uses Intel
</para></listitem>
<listitem><para>
Note Unicode implications of charset handling (see internals.doc). See
pull_* and push_* and convert_string functions.
reason: Internationalization
</para></listitem>
<listitem><para>
Don't assume English only
reason: See above
</para></listitem>
<listitem><para>
Try to avoid using in/out parameters (functions that return data which
overwrites input parameters)
reason: Can cause stability problems
</para></listitem>
<listitem><para>
Ensure copyright notices are correct, don't append Tridge's name to code
that he didn't write. If you did not write the code, make sure that it
can coexist with the rest of the Samba GPLed code.
</para></listitem>
<listitem><para>
Consider usage of DATA_BLOBs for length specified byte-data.
reason: stability
</para></listitem>
<listitem><para>
Take advantage of tdbs for database like function
reason: consistency
</para></listitem>
<listitem><para>
Don't access the SAM_ACCOUNT structure directly, they should be accessed
via pdb_get...() and pdb_set...() functions.
reason: stability, consistency
</para></listitem>
<listitem><para>
Don't check a password directly against the passdb, always use the
check_password() interface.
reason: long term pluggability
</para></listitem>
<listitem><para>
Try to use asprintf rather than pstrings and fstrings where possible
</para></listitem>
<listitem><para>
Use normal C comments / * instead of C++ comments // like
this. Although the C++ comment format is part of the C99
standard, some older vendor C compilers do not accept it.
</para></listitem>
<listitem><para>
Try to write documentation for API functions and structures
explaining the point of the code, the way it should be used, and
any special conditions or results. Mark these with a double-star
comment start / ** so that they can be picked up by Doxygen, as in
this file.
</para></listitem>
<listitem><para>
Keep the scope narrow. This means making functions/variables
static whenever possible. We don't want our namespace
polluted. Each module should have a minimal number of externally
visible functions or variables.
</para></listitem>
<listitem><para>
Use function pointers to keep knowledge about particular pieces of
code isolated in one place. We don't want a particular piece of
functionality to be spread out across lots of places - that makes
for fragile, hand to maintain code. Instead, design an interface
and use tables containing function pointers to implement specific
functionality. This is particularly important for command
interpreters.
</para></listitem>
<listitem><para>
Think carefully about what it will be like for someone else to add
to and maintain your code. If it would be hard for someone else to
maintain then do it another way.
</para></listitem>
</orderedlist>
<para>
The suggestions above are simply that, suggestions, but the information may
help in reducing the routine rework done on new code. The preceeding list
is expected to change routinely as new support routines and macros are
added.
</para>
</chapter>

154
docs/docbook/devdoc/NetBIOS.xml Normal file
View File

@ -0,0 +1,154 @@
<chapter id="netbios">
<chapterinfo>
<author>
<firstname>Luke</firstname><surname>Leighton</surname>
</author>
<pubdate>12 June 1997</pubdate>
</chapterinfo>
<title>Definition of NetBIOS Protocol and Name Resolution Modes</title>
<sect1>
<title>NETBIOS</title>
<para>
NetBIOS runs over the following tranports: TCP/IP; NetBEUI and IPX/SPX.
Samba only uses NetBIOS over TCP/IP. For details on the TCP/IP NetBIOS
Session Service NetBIOS Datagram Service, and NetBIOS Names, see
rfc1001.txt and rfc1002.txt.
</para>
<para>
NetBEUI is a raw NetBIOS frame protocol implementation that allows NetBIOS
datagrams to be sent out over the 'wire' embedded within LLC frames.
NetBEUI is not required when using NetBIOS over TCP/IP protocols and it
is preferable NOT to install NetBEUI if it can be avoided.
</para>
<para>
IPX/SPX is also not required when using NetBIOS over TCP/IP, and it is
preferable NOT to install the IPX/SPX transport unless you are using Novell
servers. At the very least, it is recommended that you do not install
'NetBIOS over IPX/SPX'.
</para>
<para>
[When installing Windows 95, you will find that NetBEUI and IPX/SPX are
installed as the default protocols. This is because they are the simplest
to manage: no Windows 95 user-configuration is required].
</para>
<para>
NetBIOS applications (such as samba) offer their services (for example,
SMB file and print sharing) on a NetBIOS name. They must claim this name
on the network before doing so. The NetBIOS session service will then
accept connections on the application's behalf (on the NetBIOS name
claimed by the application). A NetBIOS session between the application
and the client can then commence.
</para>
<para>
NetBIOS names consist of 15 characters plus a 'type' character. This is
similar, in concept, to an IP address and a TCP port number, respectively.
A NetBIOS-aware application on a host will offer different services under
different NetBIOS name types, just as a host will offer different TCP/IP
services on different port numbers.
</para>
<para>
NetBIOS names must be claimed on a network, and must be defended. The use
of NetBIOS names is most suitable on a single subnet; a Local Area Network
or a Wide Area Network.
</para>
<para>
NetBIOS names are either UNIQUE or GROUP. Only one application can claim a
UNIQUE NetBIOS name on a network.
</para>
<para>
There are two kinds of NetBIOS Name resolution: Broadcast and Point-to-Point.
</para>
</sect1>
<sect1>
<title>BROADCAST NetBIOS</title>
<para>
Clients can claim names, and therefore offer services on successfully claimed
names, on their broadcast-isolated subnet. One way to get NetBIOS services
(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and
SMB file/print sharing: see cifs4.txt) working on a LAN or WAN is to make
your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139.
</para>
<para>
This, however, is not recommended. If you have a large LAN or WAN, you will
find that some of your hosts spend 95 percent of their time dealing with
broadcast traffic. [If you have IPX/SPX on your LAN or WAN, you will find
that this is already happening: a packet analyzer will show, roughly
every twelve minutes, great swathes of broadcast traffic!].
</para>
</sect1>
<sect1>
<title>NBNS NetBIOS</title>
<para>
rfc1001.txt describes, amongst other things, the implementation and use
of, a 'NetBIOS Name Service'. NT/AS offers 'Windows Internet Name Service'
which is fully rfc1001/2 compliant, but has had to take specific action
with certain NetBIOS names in order to make it useful. (for example, it
deals with the registration of &lt;1c&gt; &lt;1d&gt; &lt;1e&gt; names all in different ways.
I recommend the reading of the Microsoft WINS Server Help files for full
details).
</para>
<para>
The use of a WINS server cuts down on broadcast network traffic for
NetBIOS name resolution. It has the effect of pulling all the broadcast
isolated subnets together into a single NetBIOS scope, across your LAN
or WAN, while avoiding the use of TCP/IP broadcast packets.
</para>
<para>
When you have a WINS server on your LAN, WINS clients will be able to
contact the WINS server to resolve NetBIOS names. Note that only those
WINS clients that have registered with the same WINS server will be
visible. The WINS server _can_ have static NetBIOS entries added to its
database (usually for security reasons you might want to consider putting
your domain controllers or other important servers as static entries,
but you should not rely on this as your sole means of security), but for
the most part, NetBIOS names are registered dynamically.
</para>
<para>
This provides some confusion for lots of people, and is worth mentioning
here: a Browse Server is NOT a WINS Server, even if these services are
implemented in the same application. A Browse Server _needs_ a WINS server
because a Browse Server is a WINS client, which is _not_ the same thing].
</para>
<para>
Clients can claim names, and therefore offer services on successfully claimed
names, on their broadcast-isolated subnet. One way to get NetBIOS services
(such as browsing: see ftp.microsoft.com/drg/developr/CIFS/browdiff.txt; and
SMB file/print sharing: see cifs6.txt) working on a LAN or WAN is to make
your routers forward all broadcast packets from TCP/IP ports 137, 138 and 139.
You will find, however, if you do this on a large LAN or a WAN, that your
network is completely swamped by NetBIOS and browsing packets, which is why
WINS was developed to minimise the necessity of broadcast traffic.
</para>
<para>
WINS Clients therefore claim names from the WINS server. If the WINS
server allows them to register a name, the client's NetBIOS session service
can then offer services on this name. Other WINS clients will then
contact the WINS server to resolve a NetBIOS name.
</para>
</sect1>
</chapter>

129
docs/docbook/devdoc/Tracing.xml Normal file
View File

@ -0,0 +1,129 @@
<chapter id="tracing">
<chapterinfo>
<author>
<firstname>Andrew</firstname><surname>Tridgell</surname>
<affiliation>
<orgname>Samba Team</orgname>
</affiliation>
</author>
</chapterinfo>
<title>Tracing samba system calls</title>
<para>
This file describes how to do a system call trace on Samba to work out
what its doing wrong. This is not for the faint of heart, but if you
are reading this then you are probably desperate.
</para>
<para>
Actually its not as bad as the the above makes it sound, just don't
expect the output to be very pretty :-)
</para>
<para>
Ok, down to business. One of the big advantages of unix systems is
that they nearly all come with a system trace utility that allows you
to monitor all system calls that a program is making. This is
extremely using for debugging and also helps when trying to work out
why something is slower than you expect. You can use system tracing
without any special compilation options.
</para>
<para>
The system trace utility is called different things on different
systems. On Linux systems its called strace. Under SunOS 4 its called
trace. Under SVR4 style systems (including solaris) its called
truss. Under many BSD systems its called ktrace.
</para>
<para>
The first thing you should do is read the man page for your native
system call tracer. In the discussion below I'll assume its called
strace as strace is the only portable system tracer (its available for
free for many unix types) and its also got some of the nicest
features.
</para>
<para>
Next, try using strace on some simple commands. For example, <command>strace
ls</command> or <command>strace echo hello</command>.
</para>
<para>
You'll notice that it produces a LOT of output. It is showing you the
arguments to every system call that the program makes and the
result. Very little happens in a program without a system call so you
get lots of output. You'll also find that it produces a lot of
"preamble" stuff showing the loading of shared libraries etc. Ignore
this (unless its going wrong!)
</para>
<para>
For example, the only line that really matters in the <command>strace echo
hello</command> output is:
</para>
<para><programlisting>
write(1, "hello\n", 6) = 6
</programlisting></para>
<para>all the rest is just setting up to run the program.</para>
<para>
Ok, now you're familiar with strace. To use it on Samba you need to
strace the running smbd daemon. The way I tend ot use it is to first
login from my Windows PC to the Samba server, then use smbstatus to
find which process ID that client is attached to, then as root I do
<command>strace -p PID</command> to attach to that process. I normally redirect the
stderr output from this command to a file for later perusal. For
example, if I'm using a csh style shell:
</para>
<para><command>strace -f -p 3872 &gt;&amp; strace.out</command></para>
<para>or with a sh style shell:</para>
<para><command>strace -f -p 3872 > strace.out 2&gt;&amp;1</command></para>
<para>
Note the "-f" option. This is only available on some systems, and
allows you to trace not just the current process, but any children it
forks. This is great for finding printing problems caused by the
"print command" being wrong.
</para>
<para>
Once you are attached you then can do whatever it is on the client
that is causing problems and you will capture all the system calls
that smbd makes.
</para>
<para>
So how do you interpret the results? Generally I search through the
output for strings that I know will appear when the problem
happens. For example, if I am having touble with permissions on a file
I would search for that files name in the strace output and look at
the surrounding lines. Another trick is to match up file descriptor
numbers and "follow" what happens to an open file until it is closed.
</para>
<para>
Beyond this you will have to use your initiative. To give you an idea
of what you are looking for here is a piece of strace output that
shows that <filename>/dev/null</filename> is not world writeable, which
causes printing to fail with Samba:
</para>
<para><programlisting>
[pid 28268] open("/dev/null", O_RDWR) = -1 EACCES (Permission denied)
[pid 28268] open("/dev/null", O_WRONLY) = -1 EACCES (Permission denied)
</programlisting></para>
<para>
The process is trying to first open <filename>/dev/null</filename> read-write
then read-only. Both fail. This means <filename>/dev/null</filename> has
incorrect permissions.
</para>
</chapter>

184
docs/docbook/devdoc/architecture.xml Normal file
View File

@ -0,0 +1,184 @@
<chapter id="architecture">
<chapterinfo>
<author>
<firstname>Dan</firstname><surname>Shearer</surname>
</author>
<pubdate> November 1997</pubdate>
</chapterinfo>
<title>Samba Architecture</title>
<sect1>
<title>Introduction</title>
<para>
This document gives a general overview of how Samba works
internally. The Samba Team has tried to come up with a model which is
the best possible compromise between elegance, portability, security
and the constraints imposed by the very messy SMB and CIFS
protocol.
</para>
<para>
It also tries to answer some of the frequently asked questions such as:
</para>
<orderedlist>
<listitem><para>
Is Samba secure when running on Unix? The xyz platform?
What about the root priveliges issue?
</para></listitem>
<listitem><para>Pros and cons of multithreading in various parts of Samba</para></listitem>
<listitem><para>Why not have a separate process for name resolution, WINS, and browsing?</para></listitem>
</orderedlist>
</sect1>
<sect1>
<title>Multithreading and Samba</title>
<para>
People sometimes tout threads as a uniformly good thing. They are very
nice in their place but are quite inappropriate for smbd. nmbd is
another matter, and multi-threading it would be very nice.
</para>
<para>
The short version is that smbd is not multithreaded, and alternative
servers that take this approach under Unix (such as Syntax, at the
time of writing) suffer tremendous performance penalties and are less
robust. nmbd is not threaded either, but this is because it is not
possible to do it while keeping code consistent and portable across 35
or more platforms. (This drawback also applies to threading smbd.)
</para>
<para>
The longer versions is that there are very good reasons for not making
smbd multi-threaded. Multi-threading would actually make Samba much
slower, less scalable, less portable and much less robust. The fact
that we use a separate process for each connection is one of Samba's
biggest advantages.
</para>
</sect1>
<sect1>
<title>Threading smbd</title>
<para>
A few problems that would arise from a threaded smbd are:
</para>
<orderedlist>
<listitem><para>
It's not only to create threads instead of processes, but you
must care about all variables if they have to be thread specific
(currently they would be global).
</para></listitem>
<listitem><para>
if one thread dies (eg. a seg fault) then all threads die. We can
immediately throw robustness out the window.
</para></listitem>
<listitem><para>
many of the system calls we make are blocking. Non-blocking
equivalents of many calls are either not available or are awkward (and
slow) to use. So while we block in one thread all clients are
waiting. Imagine if one share is a slow NFS filesystem and the others
are fast, we will end up slowing all clients to the speed of NFS.
</para></listitem>
<listitem><para>
you can't run as a different uid in different threads. This means
we would have to switch uid/gid on _every_ SMB packet. It would be
horrendously slow.
</para></listitem>
<listitem><para>
the per process file descriptor limit would mean that we could only
support a limited number of clients.
</para></listitem>
<listitem><para>
we couldn't use the system locking calls as the locking context of
fcntl() is a process, not a thread.
</para></listitem>
</orderedlist>
</sect1>
<sect1>
<title>Threading nmbd</title>
<para>
This would be ideal, but gets sunk by portability requirements.
</para>
<para>
Andrew tried to write a test threads library for nmbd that used only
ansi-C constructs (using setjmp and longjmp). Unfortunately some OSes
defeat this by restricting longjmp to calling addresses that are
shallower than the current address on the stack (apparently AIX does
this). This makes a truly portable threads library impossible. So to
support all our current platforms we would have to code nmbd both with
and without threads, and as the real aim of threads is to make the
code clearer we would not have gained anything. (it is a myth that
threads make things faster. threading is like recursion, it can make
things clear but the same thing can always be done faster by some
other method)
</para>
<para>
Chris tried to spec out a general design that would abstract threading
vs separate processes (vs other methods?) and make them accessible
through some general API. This doesn't work because of the data
sharing requirements of the protocol (packets in the future depending
on packets now, etc.) At least, the code would work but would be very
clumsy, and besides the fork() type model would never work on Unix. (Is there an OS that it would work on, for nmbd?)
</para>
<para>
A fork() is cheap, but not nearly cheap enough to do on every UDP
packet that arrives. Having a pool of processes is possible but is
nasty to program cleanly due to the enormous amount of shared data (in
complex structures) between the processes. We can't rely on each
platform having a shared memory system.
</para>
</sect1>
<sect1>
<title>nbmd Design</title>
<para>
Originally Andrew used recursion to simulate a multi-threaded
environment, which use the stack enormously and made for really
confusing debugging sessions. Luke Leighton rewrote it to use a
queuing system that keeps state information on each packet. The
first version used a single structure which was used by all the
pending states. As the initialisation of this structure was
done by adding arguments, as the functionality developed, it got
pretty messy. So, it was replaced with a higher-order function
and a pointer to a user-defined memory block. This suddenly
made things much simpler: large numbers of functions could be
made static, and modularised. This is the same principle as used
in NT's kernel, and achieves the same effect as threads, but in
a single process.
</para>
<para>
Then Jeremy rewrote nmbd. The packet data in nmbd isn't what's on the
wire. It's a nice format that is very amenable to processing but still
keeps the idea of a distinct packet. See "struct packet_struct" in
nameserv.h. It has all the detail but none of the on-the-wire
mess. This makes it ideal for using in disk or memory-based databases
for browsing and WINS support.
</para>
</sect1>
</chapter>

2932
docs/docbook/devdoc/cifsntdomain.xml Normal file
View File

File diff suppressed because it is too large Load Diff

321
docs/docbook/devdoc/debug.xml Normal file
View File

@ -0,0 +1,321 @@
<chapter id="debug">
<chapterinfo>
<author>
<firstname>Chris</firstname><surname>Hertel</surname>
</author>
<pubdate>July 1998</pubdate>
</chapterinfo>
<title>The samba DEBUG system</title>
<sect1>
<title>New Output Syntax</title>
<para>
The syntax of a debugging log file is represented as:
</para>
<para><programlisting>
&gt;debugfile&lt; :== { &gt;debugmsg&lt; }
&gt;debugmsg&lt; :== &gt;debughdr&lt; '\n' &gt;debugtext&lt;
&gt;debughdr&lt; :== '[' TIME ',' LEVEL ']' FILE ':' [FUNCTION] '(' LINE ')'
&gt;debugtext&lt; :== { &gt;debugline&lt; }
&gt;debugline&lt; :== TEXT '\n'
</programlisting></para>
<para>
TEXT is a string of characters excluding the newline character.
</para>
<para>
LEVEL is the DEBUG level of the message (an integer in the range
0..10).
</para>
<para>
TIME is a timestamp.
</para>
<para>
FILE is the name of the file from which the debug message was
generated.
</para>
<para>
FUNCTION is the function from which the debug message was generated.
</para>
<para>
LINE is the line number of the debug statement that generated the
message.
</para>
<para>Basically, what that all means is:</para>
<orderedlist>
<listitem><para>
A debugging log file is made up of debug messages.
</para></listitem>
<listitem><para>
Each debug message is made up of a header and text. The header is
separated from the text by a newline.
</para></listitem>
<listitem><para>
The header begins with the timestamp and debug level of the
message enclosed in brackets. The filename, function, and line
number at which the message was generated follow. The filename is
terminated by a colon, and the function name is terminated by the
parenthesis which contain the line number. Depending upon the
compiler, the function name may be missing (it is generated by the
__FUNCTION__ macro, which is not universally implemented, dangit).
</para></listitem>
<listitem><para>
The message text is made up of zero or more lines, each terminated
by a newline.
</para></listitem>
</orderedlist>
<para>Here's some example output:</para>
<para><programlisting>
[1998/08/03 12:55:25, 1] nmbd.c:(659)
Netbios nameserver version 1.9.19-prealpha started.
Copyright Andrew Tridgell 1994-1997
[1998/08/03 12:55:25, 3] loadparm.c:(763)
Initializing global parameters
</programlisting></para>
<para>
Note that in the above example the function names are not listed on
the header line. That's because the example above was generated on an
SGI Indy, and the SGI compiler doesn't support the __FUNCTION__ macro.
</para>
</sect1>
<sect1>
<title>The DEBUG() Macro</title>
<para>
Use of the DEBUG() macro is unchanged. DEBUG() takes two parameters.
The first is the message level, the second is the body of a function
call to the Debug1() function.
</para>
<para>That's confusing.</para>
<para>Here's an example which may help a bit. If you would write</para>
<para><programlisting>
printf( "This is a %s message.\n", "debug" );
</programlisting></para>
<para>
to send the output to stdout, then you would write
</para>
<para><programlisting>
DEBUG( 0, ( "This is a %s message.\n", "debug" ) );
</programlisting></para>
<para>
to send the output to the debug file. All of the normal printf()
formatting escapes work.
</para>
<para>
Note that in the above example the DEBUG message level is set to 0.
Messages at level 0 always print. Basically, if the message level is
less than or equal to the global value DEBUGLEVEL, then the DEBUG
statement is processed.
</para>
<para>
The output of the above example would be something like:
</para>
<para><programlisting>
[1998/07/30 16:00:51, 0] file.c:function(128)
This is a debug message.
</programlisting></para>
<para>
Each call to DEBUG() creates a new header *unless* the output produced
by the previous call to DEBUG() did not end with a '\n'. Output to the
debug file is passed through a formatting buffer which is flushed
every time a newline is encountered. If the buffer is not empty when
DEBUG() is called, the new input is simply appended.
</para>
<para>
...but that's really just a Kludge. It was put in place because
DEBUG() has been used to write partial lines. Here's a simple (dumb)
example of the kind of thing I'm talking about:
</para>
<para><programlisting>
DEBUG( 0, ("The test returned " ) );
if( test() )
DEBUG(0, ("True") );
else
DEBUG(0, ("False") );
DEBUG(0, (".\n") );
</programlisting></para>
<para>
Without the format buffer, the output (assuming test() returned true)
would look like this:
</para>
<para><programlisting>
[1998/07/30 16:00:51, 0] file.c:function(256)
The test returned
[1998/07/30 16:00:51, 0] file.c:function(258)
True
[1998/07/30 16:00:51, 0] file.c:function(261)
.
</programlisting></para>
<para>Which isn't much use. The format buffer kludge fixes this problem.
</para>
</sect1>
<sect1>
<title>The DEBUGADD() Macro</title>
<para>
In addition to the kludgey solution to the broken line problem
described above, there is a clean solution. The DEBUGADD() macro never
generates a header. It will append new text to the current debug
message even if the format buffer is empty. The syntax of the
DEBUGADD() macro is the same as that of the DEBUG() macro.
</para>
<para><programlisting>
DEBUG( 0, ("This is the first line.\n" ) );
DEBUGADD( 0, ("This is the second line.\nThis is the third line.\n" ) );
</programlisting></para>
<para>Produces</para>
<para><programlisting>
[1998/07/30 16:00:51, 0] file.c:function(512)
This is the first line.
This is the second line.
This is the third line.
</programlisting></para>
</sect1>
<sect1>
<title>The DEBUGLVL() Macro</title>
<para>
One of the problems with the DEBUG() macro was that DEBUG() lines
tended to get a bit long. Consider this example from
nmbd_sendannounce.c:
</para>
<para><programlisting>
DEBUG(3,("send_local_master_announcement: type %x for name %s on subnet %s for workgroup %s\n",
type, global_myname, subrec->subnet_name, work->work_group));
</programlisting></para>
<para>
One solution to this is to break it down using DEBUG() and DEBUGADD(),
as follows:
</para>
<para><programlisting>
DEBUG( 3, ( "send_local_master_announcement: " ) );
DEBUGADD( 3, ( "type %x for name %s ", type, global_myname ) );
DEBUGADD( 3, ( "on subnet %s ", subrec->subnet_name ) );
DEBUGADD( 3, ( "for workgroup %s\n", work->work_group ) );
</programlisting></para>
<para>
A similar, but arguably nicer approach is to use the DEBUGLVL() macro.
This macro returns True if the message level is less than or equal to
the global DEBUGLEVEL value, so:
</para>
<para><programlisting>
if( DEBUGLVL( 3 ) )
{
dbgtext( "send_local_master_announcement: " );
dbgtext( "type %x for name %s ", type, global_myname );
dbgtext( "on subnet %s ", subrec->subnet_name );
dbgtext( "for workgroup %s\n", work->work_group );
}
</programlisting></para>
<para>(The dbgtext() function is explained below.)</para>
<para>There are a few advantages to this scheme:</para>
<orderedlist>
<listitem><para>
The test is performed only once.
</para></listitem>
<listitem><para>
You can allocate variables off of the stack that will only be used
within the DEBUGLVL() block.
</para></listitem>
<listitem><para>
Processing that is only relevant to debug output can be contained
within the DEBUGLVL() block.
</para></listitem>
</orderedlist>
</sect1>
<sect1>
<title>New Functions</title>
<sect2>
<title>dbgtext()</title>
<para>
This function prints debug message text to the debug file (and
possibly to syslog) via the format buffer. The function uses a
variable argument list just like printf() or Debug1(). The
input is printed into a buffer using the vslprintf() function,
and then passed to format_debug_text().
If you use DEBUGLVL() you will probably print the body of the
message using dbgtext().
</para>
</sect2>
<sect2>
<title>dbghdr()</title>
<para>
This is the function that writes a debug message header.
Headers are not processed via the format buffer. Also note that
if the format buffer is not empty, a call to dbghdr() will not
produce any output. See the comments in dbghdr() for more info.
</para>
<para>
It is not likely that this function will be called directly. It
is used by DEBUG() and DEBUGADD().
</para>
</sect2>
<sect2>
<title>format_debug_text()</title>
<para>
This is a static function in debug.c. It stores the output text
for the body of the message in a buffer until it encounters a
newline. When the newline character is found, the buffer is
written to the debug file via the Debug1() function, and the
buffer is reset. This allows us to add the indentation at the
beginning of each line of the message body, and also ensures
that the output is written a line at a time (which cleans up
syslog output).
</para>
</sect2>
</sect1>
</chapter>

80
docs/docbook/devdoc/dev-doc.xml Normal file
View File

@ -0,0 +1,80 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY NetBIOS SYSTEM "NetBIOS.xml">
<!ENTITY Architecture SYSTEM "architecture.xml">
<!ENTITY debug SYSTEM "debug.xml">
<!ENTITY internals SYSTEM "internals.xml">
<!ENTITY parsing SYSTEM "parsing.xml">
<!ENTITY unix-smb SYSTEM "unix-smb.xml">
<!ENTITY CodingSuggestions SYSTEM "CodingSuggestions.xml">
<!ENTITY Tracing SYSTEM "Tracing.xml">
<!ENTITY cifsntdomain SYSTEM "cifsntdomain.xml">
<!ENTITY printing SYSTEM "printing.xml">
<!ENTITY wins SYSTEM "wins.xml">
<!ENTITY sam SYSTEM "sam.xml">
<!ENTITY encryption SYSTEM "encryption.xml">
<!ENTITY rpc-plugin SYSTEM "rpc_plugin.xml">
<!ENTITY modules SYSTEM "modules.xml">
<!ENTITY packagers SYSTEM "packagers.xml">
]>
<book id="Samba-Developers-Guide">
<title>SAMBA Developers Guide</title>
<bookinfo>
<author>
<surname>SAMBA Team</surname>
</author>
<address><email>samba@samba.org</email></address>
</bookinfo>
<dedication>
<title>Abstract</title>
<para>
<emphasis>Last Update</emphasis> : Mon Sep 30 15:23:53 CDT 2002
</para>
<para>
This book is a collection of documents that might be useful for
people developing samba or those interested in doing so.
It's nothing more than a collection of documents written by samba developers about
the internals of various parts of samba and the SMB protocol. It's still incomplete.
The most recent version of this document
can be found at <ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>.
Please send updates to <ulink
url="mailto:jelmer@samba.org">Jelmer Veenrooij</ulink>.
</para>
<para>
This documentation is distributed under the GNU General Public License (GPL)
version 2. A copy of the license is included with the Samba source
distribution. A copy can be found on-line at <ulink
url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</ulink>
</para>
</dedication>
<!-- Contents -->
<toc/>
<!-- Chapters -->
&NetBIOS;
&Architecture;
&debug;
&CodingSuggestions;
&internals;
&parsing;
&unix-smb;
&Tracing;
&cifsntdomain;
&printing;
&wins;
&sam;
&encryption;
&modules;
&rpc-plugin;
&packagers;
</book>

197
docs/docbook/devdoc/encryption.xml Normal file
View File

@ -0,0 +1,197 @@
<chapter id="pwencrypt">
<chapterinfo>
<author>
<firstname>Jeremy</firstname><surname>Allison</surname>
<affiliation>
<orgname>Samba Team</orgname>
<address>
<email>samba@samba.org</email>
</address>
</affiliation>
</author>
<pubdate>19 Apr 1999</pubdate>
</chapterinfo>
<title>LanMan and NT Password Encryption</title>
<sect1>
<title>Introduction</title>
<para>With the development of LanManager and Windows NT
compatible password encryption for Samba, it is now able
to validate user connections in exactly the same way as
a LanManager or Windows NT server.</para>
<para>This document describes how the SMB password encryption
algorithm works and what issues there are in choosing whether
you want to use it. You should read it carefully, especially
the part about security and the "PROS and CONS" section.</para>
</sect1>
<sect1>
<title>How does it work?</title>
<para>LanManager encryption is somewhat similar to UNIX
password encryption. The server uses a file containing a
hashed value of a user's password. This is created by taking
the user's plaintext password, capitalising it, and either
truncating to 14 bytes or padding to 14 bytes with null bytes.
This 14 byte value is used as two 56 bit DES keys to encrypt
a 'magic' eight byte value, forming a 16 byte value which is
stored by the server and client. Let this value be known as
the "hashed password".</para>
<para>Windows NT encryption is a higher quality mechanism,
consisting of doing an MD4 hash on a Unicode version of the user's
password. This also produces a 16 byte hash value that is
non-reversible.</para>
<para>When a client (LanManager, Windows for WorkGroups, Windows
95 or Windows NT) wishes to mount a Samba drive (or use a Samba
resource), it first requests a connection and negotiates the
protocol that the client and server will use. In the reply to this
request the Samba server generates and appends an 8 byte, random
value - this is stored in the Samba server after the reply is sent
and is known as the "challenge". The challenge is different for
every client connection.</para>
<para>The client then uses the hashed password (16 byte values
described above), appended with 5 null bytes, as three 56 bit
DES keys, each of which is used to encrypt the challenge 8 byte
value, forming a 24 byte value known as the "response".</para>
<para>In the SMB call SMBsessionsetupX (when user level security
is selected) or the call SMBtconX (when share level security is
selected), the 24 byte response is returned by the client to the
Samba server. For Windows NT protocol levels the above calculation
is done on both hashes of the user's password and both responses are
returned in the SMB call, giving two 24 byte values.</para>
<para>The Samba server then reproduces the above calculation, using
its own stored value of the 16 byte hashed password (read from the
<filename>smbpasswd</filename> file - described later) and the challenge
value that it kept from the negotiate protocol reply. It then checks
to see if the 24 byte value it calculates matches the 24 byte value
returned to it from the client.</para>
<para>If these values match exactly, then the client knew the
correct password (or the 16 byte hashed value - see security note
below) and is thus allowed access. If not, then the client did not
know the correct password and is denied access.</para>
<para>Note that the Samba server never knows or stores the cleartext
of the user's password - just the 16 byte hashed values derived from
it. Also note that the cleartext password or 16 byte hashed values
are never transmitted over the network - thus increasing security.</para>
</sect1>
<sect1>
<title>The smbpasswd file</title>
<anchor id="SMBPASSWDFILEFORMAT"/>
<para>In order for Samba to participate in the above protocol
it must be able to look up the 16 byte hashed values given a user name.
Unfortunately, as the UNIX password value is also a one way hash
function (ie. it is impossible to retrieve the cleartext of the user's
password given the UNIX hash of it), a separate password file
containing this 16 byte value must be kept. To minimise problems with
these two password files, getting out of sync, the UNIX <filename>
/etc/passwd</filename> and the <filename>smbpasswd</filename> file,
a utility, <command>mksmbpasswd.sh</command>, is provided to generate
a smbpasswd file from a UNIX <filename>/etc/passwd</filename> file.
</para>
<para>To generate the smbpasswd file from your <filename>/etc/passwd
</filename> file use the following command:</para>
<para><prompt>$ </prompt><userinput>cat /etc/passwd | mksmbpasswd.sh
&gt; /usr/local/samba/private/smbpasswd</userinput></para>
<para>If you are running on a system that uses NIS, use</para>
<para><prompt>$ </prompt><userinput>ypcat passwd | mksmbpasswd.sh
&gt; /usr/local/samba/private/smbpasswd</userinput></para>
<para>The <command>mksmbpasswd.sh</command> program is found in
the Samba source directory. By default, the smbpasswd file is
stored in :</para>
<para><filename>/usr/local/samba/private/smbpasswd</filename></para>
<para>The owner of the <filename>/usr/local/samba/private/</filename>
directory should be set to root, and the permissions on it should
be set to 0500 (<command>chmod 500 /usr/local/samba/private</command>).
</para>
<para>Likewise, the smbpasswd file inside the private directory should
be owned by root and the permissions on is should be set to 0600
(<command>chmod 600 smbpasswd</command>).</para>
<para>The format of the smbpasswd file is (The line has been
wrapped here. It should appear as one entry per line in
your smbpasswd file.)</para>
<para><programlisting>
username:uid:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
[Account type]:LCT-&lt;last-change-time&gt;:Long name
</programlisting></para>
<para>Although only the <replaceable>username</replaceable>,
<replaceable>uid</replaceable>, <replaceable>
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</replaceable>,
[<replaceable>Account type</replaceable>] and <replaceable>
last-change-time</replaceable> sections are significant
and are looked at in the Samba code.</para>
<para>It is <emphasis>VITALLY</emphasis> important that there by 32
'X' characters between the two ':' characters in the XXX sections -
the smbpasswd and Samba code will fail to validate any entries that
do not have 32 characters between ':' characters. The first XXX
section is for the Lanman password hash, the second is for the
Windows NT version.</para>
<para>When the password file is created all users have password entries
consisting of 32 'X' characters. By default this disallows any access
as this user. When a user has a password set, the 'X' characters change
to 32 ascii hexadecimal digits (0-9, A-F). These are an ascii
representation of the 16 byte hashed value of a user's password.</para>
<para>To set a user to have no password (not recommended), edit the file
using vi, and replace the first 11 characters with the ascii text
<constant>"NO PASSWORD"</constant> (minus the quotes).</para>
<para>For example, to clear the password for user bob, his smbpasswd file
entry would look like :</para>
<para><programlisting>
bob:100:NO PASSWORDXXXXXXXXXXXXXXXXXXXXX:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX:
[U ]:LCT-00000000:Bob's full name:/bobhome:/bobshell
</programlisting></para>
<para>If you are allowing users to use the smbpasswd command to set
their own passwords, you may want to give users NO PASSWORD initially
so they do not have to enter a previous password when changing to their
new password (not recommended). In order for you to allow this the
<command>smbpasswd</command> program must be able to connect to the
<command>smbd</command> daemon as that user with no password. Enable this
by adding the line :</para>
<para><command>null passwords = yes</command></para>
<para>to the [global] section of the smb.conf file (this is why
the above scenario is not recommended). Preferably, allocate your
users a default password to begin with, so you do not have
to enable this on your server.</para>
<para><emphasis>Note : </emphasis>This file should be protected very
carefully. Anyone with access to this file can (with enough knowledge of
the protocols) gain access to your SMB server. The file is thus more
sensitive than a normal unix <filename>/etc/passwd</filename> file.</para>
</sect1>
</chapter>

119
docs/docbook/devdoc/gencache.xml Normal file
View File

@ -0,0 +1,119 @@
<chapter id="gencache">
<chapterinfo>
<author>
<firstname>Rafal</firstname><surname>Szczesniak</surname>
</author>
<pubdate>April 2003</pubdate>
</chapterinfo>
<title>General cache mechanism and API</title>
<sect1>
<title>Abstract</title>
<para>
General cache (gencache) was designed to combine various kinds of caching
mechanisms into one, defined by a simple API. This way, anyone can use it
to create their own caching layer on top of gencache. An example of
such approach is the netbios name cache.
</para>
</sect1>
<sect1>
<title>The mechanism</title>
<para>
Gencache utilises <emphasise>tdb</emphasise> database, like many other
parts of Samba. As its origins are in Berkeley DB implementation, it
uses key/value pairs stored in binary file. The values gencache
operates on are string-based, however. This makes very easy to use it
in command line environment eg. to quickly take a look at what's in
the cache or set some value.
</para>
<para>
All the data is stored in <filename>gencache.tdb</filename>
file. Records put there are in key/value format as mentioned below,
but as it's a cache, the timeout plays also important role and has a
special place in the key/value pair, as well as API.
</para>
</sect1>
<sect1>
<title>The data structure</title>
<para>
The record stored in <filename>gencache.tdb</filename> file consists
of the key, the value and the expiration timeout. While the first part
is stored completely independent from the others, the last two are
kept together. The form the record has is:
</para>
<para><programlisting>
key: &lt;string&bt;
value: &lt;12-digit timeout&bt;/&lt;string&gt;
</programlisting></para>
<para>The timeout part is the ASCII representation of
<emphasis>time_t</emphasis> value of the time when the cache entry
expires. Obviously the API, the programmer is provided with, hides this detail,
so that you don't have to care about checking it. Simply watch
carefully the return status of the function.
</para>
</sect1>
<sect1>
<title>The API</title>
<para><programlisting>
BOOL gencache_init()
</programlisting></para>
<para>This is used to initialise to whole caching mechanism. It means
opening the file or creating it if non-existing. If it's already been
opened earlier, then the routine just does nothing and returns
<constant>true</constant>. If something goes wrong, say the user
doesn't have necessary rights, the function returns
<constant>false</constant>.</para>
<para><programlisting>
BOOL gencache_shutdown()
</programlisting></para>
<para>This is the proper way to close the cache file. It simply
returns <constant>true</constant> after successful closing file and
<constant>false</constant> upon a failure.</para>
<para><programlisting>
BOOL gencache_set(const char* keystr, const char* value, time_t timeout)
</programlisting></para>
<para>This is one of the most basic functions. What it allows you to
do is to set some particular cache entry. If the entry haven't
existed yet, the function will act just as it was "gencache_add"
function. If it's already been in the cache, the entry will be set to
the new value. In either case, the cache entry will be set with given
key, value and timeout. Thus it is comfortable way to just set the
entry and not care about the details.</para>
<para><programlisting>
BOOL gencache_set_only(const char* keystr, const char* value, time_t timeout)
</programlisting></para>
<para><programlisting>
BOOL gencache_del(const char* keystr)
</programlisting></para>
<para><programlisting>
BOOL gencache_get(const char* keystr, char** valstr, time_t* timeout)
</programlisting></para>
<para><programlisting>
void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout, void* dptr),
void* data, const char* keystr_pattern)
</programlisting></para>
<sect1>
<title>Writing your own caching layer</title>
</sect1>
</chapter>

440
docs/docbook/devdoc/internals.xml Normal file
View File

@ -0,0 +1,440 @@
<chapter id="internals">
<chapterinfo>
<author>
<firstname>David</firstname><surname>Chappell</surname>
<affiliation>
<address><email>David.Chappell@mail.trincoll.edu</email></address>
</affiliation>
</author>
<pubdate>8 May 1996</pubdate>
</chapterinfo>
<title>Samba Internals</title>
<sect1>
<title>Character Handling</title>
<para>
This section describes character set handling in Samba, as implemented in
Samba 3.0 and above
</para>
<para>
In the past Samba had very ad-hoc character set handling. Scattered
throughout the code were numerous calls which converted particular
strings to/from DOS codepages. The problem is that there was no way of
telling if a particular char* is in dos codepage or unix
codepage. This led to a nightmare of code that tried to cope with
particular cases without handlingt the general case.
</para>
</sect1>
<sect1>
<title>The new functions</title>
<para>
The new system works like this:
</para>
<orderedlist>
<listitem><para>
all char* strings inside Samba are "unix" strings. These are
multi-byte strings that are in the charset defined by the "unix
charset" option in smb.conf.
</para></listitem>
<listitem><para>
there is no single fixed character set for unix strings, but any
character set that is used does need the following properties:
</para>
<orderedlist>
<listitem><para>
must not contain NULLs except for termination
</para></listitem>
<listitem><para>
must be 7-bit compatible with C strings, so that a constant
string or character in C will be byte-for-byte identical to the
equivalent string in the chosen character set.
</para></listitem>
<listitem><para>
when you uppercase or lowercase a string it does not become
longer than the original string
</para></listitem>
<listitem><para>
must be able to correctly hold all characters that your client
will throw at it
</para></listitem>
</orderedlist>
<para>
For example, UTF-8 is fine, and most multi-byte asian character sets
are fine, but UCS2 could not be used for unix strings as they
contain nulls.
</para>
</listitem>
<listitem><para>
when you need to put a string into a buffer that will be sent on the
wire, or you need a string in a character set format that is
compatible with the clients character set then you need to use a
pull_ or push_ function. The pull_ functions pull a string from a
wire buffer into a (multi-byte) unix string. The push_ functions
push a string out to a wire buffer.
</para></listitem>
<listitem><para>
the two main pull_ and push_ functions you need to understand are
pull_string and push_string. These functions take a base pointer
that should point at the start of the SMB packet that the string is
in. The functions will check the flags field in this packet to
automatically determine if the packet is marked as a unicode packet,
and they will choose whether to use unicode for this string based on
that flag. You may also force this decision using the STR_UNICODE or
STR_ASCII flags. For use in smbd/ and libsmb/ there are wrapper
functions clistr_ and srvstr_ that call the pull_/push_ functions
with the appropriate first argument.
</para>
<para>
You may also call the pull_ascii/pull_ucs2 or push_ascii/push_ucs2
functions if you know that a particular string is ascii or
unicode. There are also a number of other convenience functions in
charcnv.c that call the pull_/push_ functions with particularly
common arguments, such as pull_ascii_pstring()
</para>
</listitem>
<listitem><para>
The biggest thing to remember is that internal (unix) strings in Samba
may now contain multi-byte characters. This means you cannot assume
that characters are always 1 byte long. Often this means that you will
have to convert strings to ucs2 and back again in order to do some
(seemingly) simple task. For examples of how to do this see functions
like strchr_m(). I know this is very slow, and we will eventually
speed it up but right now we want this stuff correct not fast.
</para></listitem>
<listitem><para>
all lp_ functions now return unix strings. The magic "DOS" flag on
parameters is gone.
</para></listitem>
<listitem><para>
all vfs functions take unix strings. Don't convert when passing to them
</para></listitem>
</orderedlist>
</sect1>
<sect1>
<title>Macros in byteorder.h</title>
<para>
This section describes the macros defined in byteorder.h. These macros
are used extensively in the Samba code.
</para>
<sect2>
<title>CVAL(buf,pos)</title>
<para>
returns the byte at offset pos within buffer buf as an unsigned character.
</para>
</sect2>
<sect2>
<title>PVAL(buf,pos)</title>
<para>returns the value of CVAL(buf,pos) cast to type unsigned integer.</para>
</sect2>
<sect2>
<title>SCVAL(buf,pos,val)</title>
<para>sets the byte at offset pos within buffer buf to value val.</para>
</sect2>
<sect2>
<title>SVAL(buf,pos)</title>
<para>
returns the value of the unsigned short (16 bit) little-endian integer at
offset pos within buffer buf. An integer of this type is sometimes
refered to as "USHORT".
</para>
</sect2>
<sect2>
<title>IVAL(buf,pos)</title>
<para>returns the value of the unsigned 32 bit little-endian integer at offset
pos within buffer buf.</para>
</sect2>
<sect2>
<title>SVALS(buf,pos)</title>
<para>returns the value of the signed short (16 bit) little-endian integer at
offset pos within buffer buf.</para>
</sect2>
<sect2>
<title>IVALS(buf,pos)</title>
<para>returns the value of the signed 32 bit little-endian integer at offset pos
within buffer buf.</para>
</sect2>
<sect2>
<title>SSVAL(buf,pos,val)</title>
<para>sets the unsigned short (16 bit) little-endian integer at offset pos within
buffer buf to value val.</para>
</sect2>
<sect2>
<title>SIVAL(buf,pos,val)</title>
<para>sets the unsigned 32 bit little-endian integer at offset pos within buffer
buf to the value val.</para>
</sect2>
<sect2>
<title>SSVALS(buf,pos,val)</title>
<para>sets the short (16 bit) signed little-endian integer at offset pos within
buffer buf to the value val.</para>
</sect2>
<sect2>
<title>SIVALS(buf,pos,val)</title>
<para>sets the signed 32 bit little-endian integer at offset pos withing buffer
buf to the value val.</para>
</sect2>
<sect2>
<title>RSVAL(buf,pos)</title>
<para>returns the value of the unsigned short (16 bit) big-endian integer at
offset pos within buffer buf.</para>
</sect2>
<sect2>
<title>RIVAL(buf,pos)</title>
<para>returns the value of the unsigned 32 bit big-endian integer at offset
pos within buffer buf.</para>
</sect2>
<sect2>
<title>RSSVAL(buf,pos,val)</title>
<para>sets the value of the unsigned short (16 bit) big-endian integer at
offset pos within buffer buf to value val.
refered to as "USHORT".</para>
</sect2>
<sect2>
<title>RSIVAL(buf,pos,val)</title>
<para>sets the value of the unsigned 32 bit big-endian integer at offset
pos within buffer buf to value val.</para>
</sect2>
</sect1>
<sect1>
<title>LAN Manager Samba API</title>
<para>
This section describes the functions need to make a LAN Manager RPC call.
This information had been obtained by examining the Samba code and the LAN
Manager 2.0 API documentation. It should not be considered entirely
reliable.
</para>
<para>
<programlisting>
call_api(int prcnt, int drcnt, int mprcnt, int mdrcnt,
char *param, char *data, char **rparam, char **rdata);
</programlisting>
</para>
<para>
This function is defined in client.c. It uses an SMB transaction to call a
remote api.
</para>
<sect2>
<title>Parameters</title>
<para>The parameters are as follows:</para>
<orderedlist>
<listitem><para>
prcnt: the number of bytes of parameters begin sent.
</para></listitem>
<listitem><para>
drcnt: the number of bytes of data begin sent.
</para></listitem>
<listitem><para>
mprcnt: the maximum number of bytes of parameters which should be returned
</para></listitem>
<listitem><para>
mdrcnt: the maximum number of bytes of data which should be returned
</para></listitem>
<listitem><para>
param: a pointer to the parameters to be sent.
</para></listitem>
<listitem><para>
data: a pointer to the data to be sent.
</para></listitem>
<listitem><para>
rparam: a pointer to a pointer which will be set to point to the returned
paramters. The caller of call_api() must deallocate this memory.
</para></listitem>
<listitem><para>
rdata: a pointer to a pointer which will be set to point to the returned
data. The caller of call_api() must deallocate this memory.
</para></listitem>
</orderedlist>
<para>
These are the parameters which you ought to send, in the order of their
appearance in the parameter block:
</para>
<orderedlist>
<listitem><para>
An unsigned 16 bit integer API number. You should set this value with
SSVAL(). I do not know where these numbers are described.
</para></listitem>
<listitem><para>
An ASCIIZ string describing the parameters to the API function as defined
in the LAN Manager documentation. The first parameter, which is the server
name, is ommited. This string is based uppon the API function as described
in the manual, not the data which is actually passed.
</para></listitem>
<listitem><para>
An ASCIIZ string describing the data structure which ought to be returned.
</para></listitem>
<listitem><para>
Any parameters which appear in the function call, as defined in the LAN
Manager API documentation, after the "Server" and up to and including the
"uLevel" parameters.
</para></listitem>
<listitem><para>
An unsigned 16 bit integer which gives the size in bytes of the buffer we
will use to receive the returned array of data structures. Presumably this
should be the same as mdrcnt. This value should be set with SSVAL().
</para></listitem>
<listitem><para>
An ASCIIZ string describing substructures which should be returned. If no
substructures apply, this string is of zero length.
</para></listitem>
</orderedlist>
<para>
The code in client.c always calls call_api() with no data. It is unclear
when a non-zero length data buffer would be sent.
</para>
</sect2>
<sect2>
<title>Return value</title>
<para>
The returned parameters (pointed to by rparam), in their order of appearance
are:</para>
<orderedlist>
<listitem><para>
An unsigned 16 bit integer which contains the API function's return code.
This value should be read with SVAL().
</para></listitem>
<listitem><para>
An adjustment which tells the amount by which pointers in the returned
data should be adjusted. This value should be read with SVAL(). Basically,
the address of the start of the returned data buffer should have the returned
pointer value added to it and then have this value subtracted from it in
order to obtain the currect offset into the returned data buffer.
</para></listitem>
<listitem><para>
A count of the number of elements in the array of structures returned.
It is also possible that this may sometimes be the number of bytes returned.
</para></listitem>
</orderedlist>
<para>
When call_api() returns, rparam points to the returned parameters. The
first if these is the result code. It will be zero if the API call
suceeded. This value by be read with "SVAL(rparam,0)".
</para>
<para>
The second parameter may be read as "SVAL(rparam,2)". It is a 16 bit offset
which indicates what the base address of the returned data buffer was when
it was built on the server. It should be used to correct pointer before
use.
</para>
<para>
The returned data buffer contains the array of returned data structures.
Note that all pointers must be adjusted before use. The function
fix_char_ptr() in client.c can be used for this purpose.
</para>
<para>
The third parameter (which may be read as "SVAL(rparam,4)") has something to
do with indicating the amount of data returned or possibly the amount of
data which can be returned if enough buffer space is allowed.
</para>
</sect2>
</sect1>
<sect1>
<title>Code character table</title>
<para>
Certain data structures are described by means of ASCIIz strings containing
code characters. These are the code characters:
</para>
<orderedlist>
<listitem><para>
W a type byte little-endian unsigned integer
</para></listitem>
<listitem><para>
N a count of substructures which follow
</para></listitem>
<listitem><para>
D a four byte little-endian unsigned integer
</para></listitem>
<listitem><para>
B a byte (with optional count expressed as trailing ASCII digits)
</para></listitem>
<listitem><para>
z a four byte offset to a NULL terminated string
</para></listitem>
<listitem><para>
l a four byte offset to non-string user data
</para></listitem>
<listitem><para>
b an offset to data (with count expressed as trailing ASCII digits)
</para></listitem>
<listitem><para>
r pointer to returned data buffer???
</para></listitem>
<listitem><para>
L length in bytes of returned data buffer???
</para></listitem>
<listitem><para>
h number of bytes of information available???
</para></listitem>
</orderedlist>
</sect1>
</chapter>

156
docs/docbook/devdoc/modules.xml Normal file
View File

@ -0,0 +1,156 @@
<chapter id="modules">
<chapterinfo>
<author>
<firstname>Jelmer</firstname><surname>Vernooij</surname>
<affiliation>
<orgname>Samba Team</orgname>
<address><email>jelmer@samba.org</email></address>
</affiliation>
</author>
<pubdate> 19 March 2003 </pubdate>
</chapterinfo>
<title>Modules</title>
<sect1>
<title>Advantages</title>
<para>
The new modules system has the following advantages:
</para>
<simplelist>
<member>Transparent loading of static and shared modules (no need
for a subsystem to know about modules)</member>
<member>Simple selection between shared and static modules at configure time</member>
<member>"preload modules" option for increasing performance for stable modules</member>
<member>No nasty #define stuff anymore</member>
<member>All backends are available as plugin now (including pdb_ldap and pdb_tdb)</member>
</simplelist>
</sect1>
<sect1>
<title>Loading modules</title>
<para>
Some subsystems in samba use different backends. These backends can be
either statically linked in to samba or available as a plugin. A subsystem
should have a function that allows a module to register itself. For example,
the passdb subsystem has:
</para>
<para><programlisting>
BOOL smb_register_passdb(const char *name, pdb_init_function init, int version);
</programlisting></para>
<para>
This function will be called by the initialisation function of the module to
register itself.
</para>
<sect2>
<title>Static modules</title>
<para>
The modules system compiles a list of initialisation functions for the
static modules of each subsystem. This is a define. For example,
it is here currently (from <filename>include/config.h</filename>):
</para>
<para><programlisting>
/* Static init functions */
#define static_init_pdb { pdb_mysql_init(); pdb_ldap_init(); pdb_smbpasswd_init(); pdb_tdbsam_init(); pdb_guest_init();}
</programlisting></para>
<para>
These functions should be called before the subsystem is used. That
should be done when the subsystem is initialised or first used.
</para>
</sect2>
<sect2>
<title>Shared modules</title>
<para>
If a subsystem needs a certain backend, it should check if it has
already been registered. If the backend hasn't been registered already,
the subsystem should call smb_probe_module(char *subsystem, char *backend).
This function tries to load the correct module from a certain path
($LIBDIR/subsystem/backend.so). If the first character in 'backend'
is a slash, smb_probe_module() tries to load the module from the
absolute path specified in 'backend'.
</para>
<para>After smb_probe_module() has been executed, the subsystem
should check again if the module has been registered.
</para>
</sect2>
</sect1>
<sect1>
<title>Writing modules</title>
<para>
Each module has an initialisation function. For modules that are
included with samba this name is '<replaceable>subsystem</replaceable>_<replaceable>backend</replaceable>_init'. For external modules (that will never be built-in, but only available as a module) this name is always 'init_module'. (In the case of modules included with samba, the configure system will add a #define subsystem_backend_init() init_module()).
The prototype for these functions is:
</para>
<para><programlisting>
int init_module(void);
</programlisting></para>
<para>This function should call one or more
registration functions. The function should return non-zero on success and zero on
failure.</para>
<para>For example, pdb_ldap_init() contains: </para>
<para><programlisting>
int pdb_ldap_init(void)
{
smb_register_passdb("ldapsam", pdb_init_ldapsam, PASSDB_INTERFACE_VERSION);
smb_register_passdb("ldapsam_nua", pdb_init_ldapsam_nua, PASSDB_INTERFACE_VERSION);
return TRUE;
}
</programlisting></para>
<sect2>
<title>Static/Shared selection in configure.in</title>
<para>
Some macros in configure.in generate the various defines and substs that
are necessary for the system to work correct. All modules that should
be built by default have to be added to the variable 'default_modules'.
For example, if ldap is found, pdb_ldap is added to this variable.
</para>
<para>
On the bottom of configure.in, SMB_MODULE() should be called
for each module and SMB_SUBSYSTEM() for each subsystem.
</para>
<para>Syntax:</para>
<para><programlisting>
SMB_MODULE(<replaceable>subsystem</replaceable>_<replaceable>backend</replaceable>, <replaceable>object files</replaceable>, <replaceable>plugin name</replaceable>, <replaceable>subsystem name</replaceable>, <replaceable>static_action</replaceable>, <replaceable>shared_action</replaceable>)
SMB_SUBSYSTEM(<replaceable>subsystem</replaceable>)
</programlisting></para>
<para>Also, make sure to add the correct directives to
<filename>Makefile.in</filename>. <replaceable>@SUBSYSTEM_STATIC@</replaceable>
will be replaced with a list of objects files of the modules that need to
be linked in statically. <replaceable>@SUBSYSTEM_MODULES@</replaceable> will
be replaced with the names of the plugins to build.
</para>
<para>You must make sure all .c files that contain defines that can
be changed by ./configure are rebuilded in the 'modules_clean' make target.
Practically, this means all c files that contain <command>static_init_subsystem;</command> calls need to be rebuilded.
</para>
</sect2>
</sect1>
</chapter>

40
docs/docbook/devdoc/packagers.xml Normal file
View File

@ -0,0 +1,40 @@
<chapter id="Packaging">
<chapterinfo>
<author>
<firstname>Jelmer</firstname><surname>Vernooij</surname>
</author>
</chapterinfo>
<title>Notes to packagers</title>
<sect1>
<title>Versioning</title>
<para>Please, please update the version number in
<filename>source/include/version.h</filename> to include the versioning of your package. This makes it easier to distinguish standard samba builds
from custom-build samba builds (distributions often patch packages). For
example, a good version would be: </para>
<para><programlisting>
Version 2.999+3.0.alpha21-5 for Debian
</programlisting></para>
</sect1>
<sect1>
<title>Modules</title>
<para>Samba now has support for building parts of samba as plugins. This
makes it possible to, for example, put ldap or mysql support in a seperate
package, thus making it possible to have a normal samba package not
depending on ldap or mysql. To build as much parts of samba
as a plugin, run: </para>
<para><programlisting>
./configure --with-shared-modules=rpc,vfs,auth,pdb,charset
</programlisting></para>
</sect1>
</chapter>

239
docs/docbook/devdoc/parsing.xml Normal file
View File

@ -0,0 +1,239 @@
<chapter id="parsing">
<chapterinfo>
<author>
<firstname>Chris</firstname><surname>Hertel</surname>
</author>
<pubdate>November 1997</pubdate>
</chapterinfo>
<title>The smb.conf file</title>
<sect1>
<title>Lexical Analysis</title>
<para>
Basically, the file is processed on a line by line basis. There are
four types of lines that are recognized by the lexical analyzer
(params.c):
</para>
<orderedlist>
<listitem><para>
Blank lines - Lines containing only whitespace.
</para></listitem>
<listitem><para>
Comment lines - Lines beginning with either a semi-colon or a
pound sign (';' or '#').
</para></listitem>
<listitem><para>
Section header lines - Lines beginning with an open square bracket ('[').
</para></listitem>
<listitem><para>
Parameter lines - Lines beginning with any other character.
(The default line type.)
</para></listitem>
</orderedlist>
<para>
The first two are handled exclusively by the lexical analyzer, which
ignores them. The latter two line types are scanned for
</para>
<orderedlist>
<listitem><para>
- Section names
</para></listitem>
<listitem><para>
- Parameter names
</para></listitem>
<listitem><para>
- Parameter values
</para></listitem>
</orderedlist>
<para>
These are the only tokens passed to the parameter loader
(loadparm.c). Parameter names and values are divided from one
another by an equal sign: '='.
</para>
<sect2>
<title>Handling of Whitespace</title>
<para>
Whitespace is defined as all characters recognized by the isspace()
function (see ctype(3C)) except for the newline character ('\n')
The newline is excluded because it identifies the end of the line.
</para>
<orderedlist>
<listitem><para>
The lexical analyzer scans past white space at the beginning of a line.
</para></listitem>
<listitem><para>
Section and parameter names may contain internal white space. All
whitespace within a name is compressed to a single space character.
</para></listitem>
<listitem><para>
Internal whitespace within a parameter value is kept verbatim with
the exception of carriage return characters ('\r'), all of which
are removed.
</para></listitem>
<listitem><para>
Leading and trailing whitespace is removed from names and values.
</para></listitem>
</orderedlist>
</sect2>
<sect2>
<title>Handling of Line Continuation</title>
<para>
Long section header and parameter lines may be extended across
multiple lines by use of the backslash character ('\\'). Line
continuation is ignored for blank and comment lines.
</para>
<para>
If the last (non-whitespace) character within a section header or on
a parameter line is a backslash, then the next line will be
(logically) concatonated with the current line by the lexical
analyzer. For example:
</para>
<para><programlisting>
param name = parameter value string \
with line continuation.
</programlisting></para>
<para>Would be read as</para>
<para><programlisting>
param name = parameter value string with line continuation.
</programlisting></para>
<para>
Note that there are five spaces following the word 'string',
representing the one space between 'string' and '\\' in the top
line, plus the four preceeding the word 'with' in the second line.
(Yes, I'm counting the indentation.)
</para>
<para>
Line continuation characters are ignored on blank lines and at the end
of comments. They are *only* recognized within section and parameter
lines.
</para>
</sect2>
<sect2>
<title>Line Continuation Quirks</title>
<para>Note the following example:</para>
<para><programlisting>
param name = parameter value string \
\
with line continuation.
</programlisting></para>
<para>
The middle line is *not* parsed as a blank line because it is first
concatonated with the top line. The result is
</para>
<para><programlisting>
param name = parameter value string with line continuation.
</programlisting></para>
<para>The same is true for comment lines.</para>
<para><programlisting>
param name = parameter value string \
; comment \
with a comment.
</programlisting></para>
<para>This becomes:</para>
<para><programlisting>
param name = parameter value string ; comment with a comment.
</programlisting></para>
<para>
On a section header line, the closing bracket (']') is considered a
terminating character, and the rest of the line is ignored. The lines
</para>
<para><programlisting>
[ section name ] garbage \
param name = value
</programlisting></para>
<para>are read as</para>
<para><programlisting>
[section name]
param name = value
</programlisting></para>
</sect2>
</sect1>
<sect1>
<title>Syntax</title>
<para>The syntax of the smb.conf file is as follows:</para>
<para><programlisting>
&lt;file&gt; :== { &lt;section&gt; } EOF
&lt;section&gt; :== &lt;section header&gt; { &lt;parameter line&gt; }
&lt;section header&gt; :== '[' NAME ']'
&lt;parameter line&gt; :== NAME '=' VALUE NL
</programlisting></para>
<para>Basically, this means that</para>
<orderedlist>
<listitem><para>
a file is made up of zero or more sections, and is terminated by
an EOF (we knew that).
</para></listitem>
<listitem><para>
A section is made up of a section header followed by zero or more
parameter lines.
</para></listitem>
<listitem><para>
A section header is identified by an opening bracket and
terminated by the closing bracket. The enclosed NAME identifies
the section.
</para></listitem>
<listitem><para>
A parameter line is divided into a NAME and a VALUE. The *first*
equal sign on the line separates the NAME from the VALUE. The
VALUE is terminated by a newline character (NL = '\n').
</para></listitem>
</orderedlist>
<sect2>
<title>About params.c</title>
<para>
The parsing of the config file is a bit unusual if you are used to
lex, yacc, bison, etc. Both lexical analysis (scanning) and parsing
are performed by params.c. Values are loaded via callbacks to
loadparm.c.
</para>
</sect2>
</sect1>
</chapter>

393
docs/docbook/devdoc/printing.xml Normal file
View File

@ -0,0 +1,393 @@
<chapter id="printing">
<chapterinfo>
<author>
<firstname>Gerald</firstname><surname>Carter</surname>
</author>
<pubdate>October 2002</pubdate>
</chapterinfo>
<title>Samba Printing Internals</title>
<sect1>
<title>Abstract</title>
<para>
The purpose of this document is to provide some insight into
Samba's printing functionality and also to describe the semantics
of certain features of Windows client printing.
</para>
</sect1>
<sect1>
<title>
Printing Interface to Various Back ends
</title>
<para>
Samba uses a table of function pointers to seven functions. The
function prototypes are defined in the <varname>printif</varname> structure declared
in <filename>printing.h</filename>.
</para>
<itemizedlist>
<listitem><para>retrieve the contents of a print queue</para></listitem>
<listitem><para>pause the print queue</para></listitem>
<listitem><para>resume a paused print queue</para></listitem>
<listitem><para>delete a job from the queue</para></listitem>
<listitem><para>pause a job in the print queue</para></listitem>
<listitem><para>result a paused print job in the queue</para></listitem>
<listitem><para>submit a job to the print queue</para></listitem>
</itemizedlist>
<para>
Currently there are only two printing back end implementations
defined.
</para>
<itemizedlist>
<listitem><para>a generic set of functions for working with standard UNIX
printing subsystems</para></listitem>
<listitem><para>a set of CUPS specific functions (this is only enabled if
the CUPS libraries were located at compile time).</para></listitem>
</itemizedlist>
</sect1>
<sect1>
<title>
Print Queue TDB's
</title>
<para>
Samba provides periodic caching of the output from the "lpq command"
for performance reasons. This cache time is configurable in seconds.
Obviously the longer the cache time the less often smbd will be
required to exec a copy of lpq. However, the accuracy of the print
queue contents displayed to clients will be diminished as well.
</para>
<para>
The list of currently opened print queue TDB's can be found
be examining the list of tdb_print_db structures ( see print_db_head
in printing.c ). A queue TDB is opened using the wrapper function
printing.c:get_print_db_byname(). The function ensures that smbd
does not open more than MAX_PRINT_DBS_OPEN in an effort to prevent
a large print server from exhausting all available file descriptors.
If the number of open queue TDB's exceeds the MAX_PRINT_DBS_OPEN
limit, smbd falls back to a most recently used algorithm for maintaining
a list of open TDB's.
</para>
<para>
There are two ways in which a a print job can be entered into
a print queue's TDB. The first is to submit the job from a Windows
client which will insert the job information directly into the TDB.
The second method is to have the print job picked up by executing the
"lpq command".
</para>
<para><programlisting>
/* included from printing.h */
struct printjob {
pid_t pid; /* which process launched the job */
int sysjob; /* the system (lp) job number */
int fd; /* file descriptor of open file if open */
time_t starttime; /* when the job started spooling */
int status; /* the status of this job */
size_t size; /* the size of the job so far */
int page_count; /* then number of pages so far */
BOOL spooled; /* has it been sent to the spooler yet? */
BOOL smbjob; /* set if the job is a SMB job */
fstring filename; /* the filename used to spool the file */
fstring jobname; /* the job name given to us by the client */
fstring user; /* the user who started the job */
fstring queuename; /* service number of printer for this job */
NT_DEVICEMODE *nt_devmode;
};
</programlisting></para>
<para>
The current manifestation of the printjob structure contains a field
for the UNIX job id returned from the "lpq command" and a Windows job
ID (32-bit bounded by PRINT_MAX_JOBID). When a print job is returned
by the "lpq command" that does not match an existing job in the queue's
TDB, a 32-bit job ID above the &lt;*vance doesn't know what word is missing here*&gt; is generating by adding UNIX_JOB_START to
the id reported by lpq.
</para>
<para>
In order to match a 32-bit Windows jobid onto a 16-bit lanman print job
id, smbd uses an in memory TDB to match the former to a number appropriate
for old lanman clients.
</para>
<para>
When updating a print queue, smbd will perform the following
steps ( refer to <filename>print.c:print_queue_update()</filename> ):
</para>
<orderedlist>
<listitem><para>Check to see if another smbd is currently in
the process of updating the queue contents by checking the pid
stored in <constant>LOCK/<replaceable>printer_name</replaceable></constant>.
If so, then do not update the TDB.</para></listitem>
<listitem><para>Lock the mutex entry in the TDB and store our own pid.
Check that this succeeded, else fail.</para></listitem>
<listitem><para>Store the updated time stamp for the new cache
listing</para></listitem>
<listitem><para>Retrieve the queue listing via "lpq command"</para></listitem>
<listitem><para><programlisting>
foreach job in the queue
{
if the job is a UNIX job, create a new entry;
if the job has a Windows based jobid, then
{
Lookup the record by the jobid;
if the lookup failed, then
treat it as a UNIX job;
else
update the job status only
}
}</programlisting></para></listitem>
<listitem><para>Delete any jobs in the TDB that are not
in the in the lpq listing</para></listitem>
<listitem><para>Store the print queue status in the TDB</para></listitem>
<listitem><para>update the cache time stamp again</para></listitem>
</orderedlist>
<para>
Note that it is the contents of this TDB that is returned to Windows
clients and not the actual listing from the "lpq command".
</para>
<para>
The NT_DEVICEMODE stored as part of the printjob structure is used to
store a pointer to a non-default DeviceMode associated with the print
job. The pointer will be non-null when the client included a Device
Mode in the OpenPrinterEx() call and subsequently submitted a job for
printing on that same handle. If the client did not include a Device
Mode in the OpenPrinterEx() request, the nt_devmode field is NULL
and the job has the printer's device mode associated with it by default.
</para>
<para>
Only non-default Device Mode are stored with print jobs in the print
queue TDB. Otherwise, the Device Mode is obtained from the printer
object when the client issues a GetJob(level == 2) request.
</para>
</sect1>
<sect1>
<title>
ChangeID and Client Caching of Printer Information
</title>
<para>
[To be filled in later]
</para>
</sect1>
<sect1>
<title>
Windows NT/2K Printer Change Notify
</title>
<para>
When working with Windows NT+ clients, it is possible for a
print server to use RPC to send asynchronous change notification
events to clients for certain printer and print job attributes.
This can be useful when the client needs to know that a new
job has been added to the queue for a given printer or that the
driver for a printer has been changed. Note that this is done
entirely orthogonal to cache updates based on a new ChangeID for
a printer object.
</para>
<para>
The basic set of RPC's used to implement change notification are
</para>
<itemizedlist>
<listitem><para>RemoteFindFirstPrinterChangeNotifyEx ( RFFPCN )</para></listitem>
<listitem><para>RemoteFindNextPrinterChangeNotifyEx ( RFNPCN )</para></listitem>
<listitem><para>FindClosePrinterChangeNotify( FCPCN )</para></listitem>
<listitem><para>ReplyOpenPrinter</para></listitem>
<listitem><para>ReplyClosePrinter</para></listitem>
<listitem><para>RouteRefreshPrinterChangeNotify ( RRPCN )</para></listitem>
</itemizedlist>
<para>
One additional RPC is available to a server, but is never used by the
Windows spooler service:
</para>
<itemizedlist>
<listitem><para>RouteReplyPrinter()</para></listitem>
</itemizedlist>
<para>
The opnum for all of these RPC's are defined in include/rpc_spoolss.h
</para>
<para>
Windows NT print servers use a bizarre method of sending print
notification event to clients. The process of registering a new change
notification handle is as follows. The 'C' is for client and the
'S' is for server. All error conditions have been eliminated.
</para>
<para><programlisting>
C: Obtain handle to printer or to the printer
server via the standard OpenPrinterEx() call.
S: Respond with a valid handle to object
C: Send a RFFPCN request with the previously obtained
handle with either (a) set of flags for change events
to monitor, or (b) a PRINTER_NOTIFY_OPTIONS structure
containing the event information to monitor. The windows
spooler has only been observed to use (b).
S: The &lt;* another missing word*&gt; opens a new TCP session to the client (thus requiring
all print clients to be CIFS servers as well) and sends
a ReplyOpenPrinter() request to the client.
C: The client responds with a printer handle that can be used to
send event notification messages.
S: The server replies success to the RFFPCN request.
C: The windows spooler follows the RFFPCN with a RFNPCN
request to fetch the current values of all monitored
attributes.
S: The server replies with an array SPOOL_NOTIFY_INFO_DATA
structures (contained in a SPOOL_NOTIFY_INFO structure).
C: If the change notification handle is ever released by the
client via a FCPCN request, the server sends a ReplyClosePrinter()
request back to the client first. However a request of this
nature from the client is often an indication that the previous
notification event was not marshalled correctly by the server
or a piece of data was wrong.
S: The server closes the internal change notification handle
(POLICY_HND) and does not send any further change notification
events to the client for that printer or job.
</programlisting></para>
<para>
The current list of notification events supported by Samba can be
found by examining the internal tables in srv_spoolss_nt.c
</para>
<itemizedlist>
<listitem><para>printer_notify_table[]</para></listitem>
<listitem><para>job_notify_table[]</para></listitem>
</itemizedlist>
<para>
When an event occurs that could be monitored, smbd sends a message
to itself about the change. The list of events to be transmitted
are queued by the smbd process sending the message to prevent an
overload of TDB usage and the internal message is sent during smbd's
idle loop (refer to printing/notify.c and the functions
send_spoolss_notify2_msg() and print_notify_send_messages() ).
</para>
<para>
The decision of whether or not the change is to be sent to connected
clients is made by the routine which actually sends the notification.
( refer to srv_spoolss_nt.c:recieve_notify2_message() ).
</para>
<para>
Because it possible to receive a listing of multiple changes for
multiple printers, the notification events must be split into
categories by the printer name. This makes it possible to group
multiple change events to be sent in a single RPC according to the
printer handle obtained via a ReplyOpenPrinter().
</para>
<para>
The actual change notification is performed using the RRPCN request
RPC. This packet contains
</para>
<itemizedlist>
<listitem><para>the printer handle registered with the
client's spooler on which the change occurred</para></listitem>
<listitem><para>The change_low value which was sent as part
of the last RFNPCN request from the client</para></listitem>
<listitem><para>The SPOOL_NOTIFY_INFO container with the event
information</para></listitem>
</itemizedlist>
<para>
A <varname>SPOOL_NOTIFY_INFO</varname> contains:
</para>
<itemizedlist>
<listitem><para>the version and flags field are predefined
and should not be changed</para></listitem>
<listitem><para>The count field is the number of entries
in the SPOOL_NOTIFY_INFO_DATA array</para></listitem>
</itemizedlist>
<para>
The <varname>SPOOL_NOTIFY_INFO_DATA</varname> entries contain:
</para>
<itemizedlist>
<listitem><para>The type defines whether or not this event
is for a printer or a print job</para></listitem>
<listitem><para>The field is the flag identifying the event</para></listitem>
<listitem><para>the notify_data union contains the new valuie of the
attribute</para></listitem>
<listitem><para>The enc_type defines the size of the structure for marshalling
and unmarshalling</para></listitem>
<listitem><para>(a) the id must be 0 for a printer event on a printer handle.
(b) the id must be the job id for an event on a printer job
(c) the id must be the matching number of the printer index used
in the response packet to the RFNPCN when using a print server
handle for notification. Samba currently uses the snum of
the printer for this which can break if the list of services
has been modified since the notification handle was registered.</para></listitem>
<listitem><para>The size is either (a) the string length in UNICODE for strings,
(b) the size in bytes of the security descriptor, or (c) 0 for
data values.</para></listitem>
</itemizedlist>
</sect1>
</chapter>

83
docs/docbook/devdoc/rpc_plugin.xml Normal file
View File

@ -0,0 +1,83 @@
<chapter id="rpc-plugin">
<chapterinfo>
<author>
<firstname>Anthony</firstname><surname>Liguori</surname>
<affiliation>
<orgname>IBM</orgname>
<address><email>aliguor@us.ibm.com</email></address>
</affiliation>
</author>
<author>
<firstname>Jelmer</firstname><surname>Vernooij</surname>
<affiliation>
<orgname>Samba Team</orgname>
<address><email>jelmer@samba.org</email></address>
</affiliation>
</author>
<pubdate>January 2003</pubdate>
</chapterinfo>
<title>RPC Pluggable Modules</title>
<sect1>
<title>About</title>
<para>
This document describes how to make use the new RPC Pluggable Modules features
of Samba 3.0. This architecture was added to increase the maintainability of
Samba allowing RPC Pipes to be worked on separately from the main CVS branch.
The RPM architecture will also allow third-party vendors to add functionality
to Samba through plug-ins.
</para>
</sect1>
<sect1>
<title>General Overview</title>
<para>
When an RPC call is sent to smbd, smbd tries to load a shared library by the
name <filename>librpc_&lt;pipename&gt;.so</filename> to handle the call if
it doesn't know how to handle the call internally. For instance, LSA calls
are handled by <filename>librpc_lsass.so</filename>..
These shared libraries should be located in the <filename>&lt;sambaroot&gt;/lib/rpc</filename>. smbd then attempts to call the init_module function within
the shared library. Check the chapter on modules for more information.
</para>
<para>
In the init_module function, the library should call
rpc_pipe_register_commands(). This function takes the following arguments:
</para>
<para><programlisting>
int rpc_pipe_register_commands(const char *clnt, const char *srv,
const struct api_struct *cmds, int size);
</programlisting></para>
<variablelist>
<varlistentry><term>clnt</term>
<listitem><para>the Client name of the named pipe</para></listitem>
</varlistentry>
<varlistentry><term>srv</term>
<listitem><para>the Server name of the named pipe</para></listitem>
</varlistentry>
<varlistentry><term>cmds</term>
<listitem><para>a list of api_structs that map RPC ordinal numbers to function calls</para></listitem>
</varlistentry>
<varlistentry><term>size</term>
<listitem><para>the number of api_structs contained in cmds</para></listitem>
</varlistentry>
</variablelist>
<para>
See rpc_server/srv_reg.c and rpc_server/srv_reg_nt.c for a small example of
how to use this library.
</para>
</sect1>
</chapter>

357
docs/docbook/devdoc/sam.xml Normal file
View File

@ -0,0 +1,357 @@
<chapter id="sam">
<chapterinfo>
<author>
<firstname>Andrew</firstname><surname>Bartlett</surname>
</author>
<pubdate>1 October 2002</pubdate>
</chapterinfo>
<title>The Upcoming SAM System</title>
<sect1>
<title>Security in the 'new SAM'</title>
<para>One of the biggest problems with passdb is it's implementation of
'security'. Access control is on a 'are you root at the moment' basis,
and it has no concept of NT ACLs. Things like ldapsam had to add
'magic' 'are you root' checks.</para>
<para>We took this very seriously when we started work, and the new structure
is designed with this in mind, from the ground up. Each call to the SAM
has a NT_TOKEN and (if relevant) an 'access desired'. This is either
provided as a parameter, or implicitly supplied by the object being
accessed.</para>
<para>
For example, when you call
</para>
<programlisting>
NTSTATUS sam_get_account_by_name(const SAM_CONTEXT *context, const
NT_USER_TOKEN *access_token, uint32 access_desired, const char *domain,
const char *name, SAM_ACCOUNT_HANDLE **account)
</programlisting>
<para>
The context can be NULL (and is used to allow import/export by setting
up 2 contexts, and allowing calls on both simultaneously)
</para>
<para>
The access token *must* be specified. Normally the user's token out of
current_user, this can also be a global 'system' context.
</para>
<para>
The access desired is as per the ACL, for passing to the seaccess stuff.
</para>
<para>
The domain/username are standard. Even if we only have one domain,
keeping this ensures that we don't get 'unqualified' usernames (same
problem as we had with unqualified SIDs).
</para>
<para>
We return a 'handle'. This is opaque to the rest of Samba, but is
operated on by get/set routines, all of which return NTSTATUS.
</para>
<para>
The access checking is done by the SAM module. The reason it is not
done 'above' the interface is to ensure a 'choke point'. I put a lot of
effort into the auth subsystem to ensure we never 'accidentally' forgot
to check for null passwords, missed a restriction etc. I intend the SAM
to be written with the same caution.
</para>
<para>
The reason the access checking is not handled by the interface itself is
due to the different implementations it make take on. For example, on
ADS, you cannot set a password over a non-SSL connection. Other
backends may have similar requirements - we need to leave this policy up
to the modules. They will naturally have access to 'helper' procedures
and good examples to avoid mishaps.
</para>
<para>
(Furthermore, some backends my actually chose to push the whole ACL
issue to the remote server, and - assuming ldap for this example - bind
as the user directly)
</para>
<para>
Each returned handle has an internal 'access permitted', which allows
the 'get' and 'set' routines to return 'ACCESS_DENIED' for things that
were not able to be retrieved from the backend. This removes the need
to specify the NT_TOKEN on every operation, and allows for 'object not
present' to be easily distinguished from 'access denied'.
</para>
<para>
When you 'set' an object (calling sam_update_account) the internal
details are again used. Each change that has been made to the object
has been flagged, so as to avoid race conditions (on unmodified
components) and to avoid violating any extra ACL requirements on the
actual data store (like the LDAP server).
</para>
<para>
Finally, we have generic get_sec_desc() and set_sec_desc() routines to
allow external ACL manipulation. These do lookups based on SID.
</para>
</sect1>
<sect1>
<title>Standalone from UNIX</title>
<para>
One of the primary tenants of the 'new SAM' is that it would not attempt
to deal with 'what unix id for that'. This would be left to the 'SMS'
(Sid Mapping System') or SID farm, and probably administered via
winbind. We have had constructive discussion on how 'basic' unix
accounts like 'root' would be handled, and we think this can work.
Accounts not preexisting in unix would be served up via winbind.
</para>
<para>
This is an *optional* part, and my preferred end-game. We have a fare
way to go before things like winbind up to it however.
</para>
</sect1>
<sect1>
<title>Handles and Races in the new SAM</title>
<para>
One of the things that the 'new SAM' work has tried to face is both
compatibility with existing code, and a closer alignment to the SAMR
interface. I consider SAMR to be a 'primary customer' to the this work,
because if we get alignment with that wrong, things get more, rather
than less complex. Also, most other parts of Samba are much more
flexible with what they can allow.
</para>
<para>
In any case, that was a decision taken as to how the general design
would progress. BTW, my understanding of SAMR may be completely flawed.
</para>
<para>
One of the most race-prone areas of the new code is the conflicting
update problem. We have taken two approaches:
</para>
<itemizedlist>
<listitem>
<para>'Not conflicting' conflicts. Due to the way usrmgr operates, it will
open a user, display all the properties and *save* them all, even if you
don't change any.
</para>
<para>
For this, see what I've done in rpc_server/srv_samr_util.c. I intend
to take this one step further, and operate on the 'handle' that the
values were read from. This should mean that we only update things that
have *really* changed.
</para>
</listitem>
<listitem>
<para>
'conflicting' updates: Currently we don't deal with this (in passdb
or the new sam stuff), but the design is sufficiently flexible to 'deny'
a second update. I don't foresee locking records however.
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Layers</title>
<sect2>
<title>Application</title>
<para>
This is where smbd, samtest and whatever end-user replacement we have
for pdbedit sits. They use only the SAM interface, and do not get
'special knowledge' of what is below them.
</para>
</sect2>
<sect2>
<title>SAM Interface</title>
<para>
This level 'owns' the various handle structures, the get/set routines on
those structures and provides the public interface. The application
layer may initialize a 'context' to be passed to all interface routines,
else a default, self-initialising context will be supplied. This layser
finds the appropriate backend module for the task, and tries very hard
not to need to much 'knowledge'. It should just provide the required
abstraction to the modules below, and arrange for their initial loading.
</para>
<para>
We could possibly add ACL checking at this layer, to avoid discrepancies
in implementation modules.
</para>
</sect2>
<sect2>
<title>SAM Modules</title>
<para>
These do not communicate with the application directly, only by setting
values in the handles, and receiving requests from the interface. These
modules are responsible for translating values from the handle's
.private into (say) an LDAP modification list. The module is expected
to 'know' things like it's own domain SID, domain name, and any other
state attached to the SAM. Simpler modules may call back to some helper
routine.
</para>
</sect2>
</sect1>
<sect1>
<title>SAM Modules</title>
<sect2>
<title>Special Module: sam_passdb</title>
<para>
In order for there to be a smooth transition, kai is writing a module
that reads existing passdb backends, and translates them into SAM
replies. (Also pulling data from the account policy DB etc). We also
intend to write a module that does the reverse - gives the SAM a passdb
interface.
</para>
</sect2>
<sect2>
<title>sam_ads</title>
<para>
This is the first of the SAM modules to be committed to the tree -
mainly because I needed to coordinate work with metze (who authored most
of it). This module aims to use Samba's libads code to provide an
Active Directory LDAP client, suitable for use on a mixed-mode DC.
While it is currently being tested against Win2k servers (with a
password in the smb.conf file) it is expected to eventually use a
(possibly modified) OpenLDAP server. We hope that this will assist in
the construction of an Samba AD DC.
</para>
<para>
We also intend to construct a Samba 2.2/3.0 compatible ldap module,
again using libads code.
</para>
</sect2>
</sect1>
<sect1>
<title>Memory Management</title>
<para>
The 'new SAM' development effort also concerned itself with getting a
sane implementation of memory management. It was decided that we would
be (as much as possible) talloc based, using an 'internal talloc
context' on many objects. That is, the creation of an object would
initiate it's own internal talloc context, and this would be used for
all operations on that object. Much of this is already implemented in
passdb. Also, like passdb, it will be possible to specify that some
object actually be created on a specified context.
</para>
<para>
Memory management is important here because the APIs in the 'new SAM' do
not use 'pdb_init()' or an equivalent. They always allocate new
objects. Enumeration's are slightly different, and occur on a supplied
context that 'owns' the entire list, rather than per-element. (the
enumeration functions return an array of all elements - not full handles
just basic (and public) info) Likewise for things that fill in a char
**.
</para>
<para>For example:</para>
<para><programlisting>
NTSTATUS sam_lookup_sid(const SAM_CONTEXT *context, const NT_USER_TOKEN
*access_token, TALLOC_CTX *mem_ctx, const DOM_SID *sid, char **name,
uint32 *type)
</programlisting></para>
<para>Takes a context to allocate the 'name' on, while:</para>
<para><programlisting>
NTSTATUS sam_get_account_by_sid(const SAM_CONTEXT *context, const
NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID
*accountsid, SAM_ACCOUNT_HANDLE **account)
</programlisting></para>
<para>Allocates a handle and stores the allocation context on that handle.</para>
<para>I think that the following:</para>
<para><programlisting>
NTSTATUS sam_enum_accounts(const SAM_CONTEXT *context, const
NT_USER_TOKEN *access_token, const DOM_SID *domainsid, uint16 acct_ctrl,
int32 *account_count, SAM_ACCOUNT_ENUM **accounts)
</programlisting></para>
</sect1>
<sect1>
<title>Testing</title>
<para>
Testing is vital in any piece of software, and Samba is certainly no
exception. In designing this new subsystem, we have taken care to ensure
it is easily tested, independent of outside protocols.
</para>
<para>
To this end, Jelmer has constructed 'samtest'.
</para>
<para>
This utility (see torture/samtest.c) is structured like rpcclient, but
instead operates on the SAM subsystem. It creates a 'custom' SAM
context, that may be distinct from the default values used by the rest
of the system, and can load a separate configuration file.
</para>
<para>
A small number of commands are currently implemented, but these have
already proved vital in testing. I expect SAM module authors will find
it particularly valuable.
</para>
<para>Example useage:</para>
<para><prompt>$</prompt> <command>bin/samtest</command></para>
<para><programlisting>
> context ads:ldap://192.168.1.96
</programlisting>
(this loads a new context, using the new ADS module. The parameter is
the 'location' of the ldap server)
</para>
<para><programlisting>
> lookup_name DOMAIN abartlet
</programlisting>
(returns a sid).
</para>
<para>
Because the 'new SAM' is NT ACL based, there will be a command to
specify an arbitrary NT ACL, but for now it uses 'system' by default.
</para>
</sect1>
</chapter>

316
docs/docbook/devdoc/unix-smb.xml Normal file
View File

@ -0,0 +1,316 @@
<chapter id="unix-smb">
<chapterinfo>
<author>
<firstname>Andrew</firstname><surname>Tridgell</surname>
</author>
<pubdate>April 1995</pubdate>
</chapterinfo>
<title>NetBIOS in a Unix World</title>
<sect1>
<title>Introduction</title>
<para>
This is a short document that describes some of the issues that
confront a SMB implementation on unix, and how Samba copes with
them. They may help people who are looking at unix&lt;-&gt;PC
interoperability.
</para>
<para>
It was written to help out a person who was writing a paper on unix to
PC connectivity.
</para>
</sect1>
<sect1>
<title>Usernames</title>
<para>
The SMB protocol has only a loose username concept. Early SMB
protocols (such as CORE and COREPLUS) have no username concept at
all. Even in later protocols clients often attempt operations
(particularly printer operations) without first validating a username
on the server.
</para>
<para>
Unix security is based around username/password pairs. A unix box
should not allow clients to do any substantive operation without some
sort of validation.
</para>
<para>
The problem mostly manifests itself when the unix server is in "share
level" security mode. This is the default mode as the alternative
"user level" security mode usually forces a client to connect to the
server as the same user for each connected share, which is
inconvenient in many sites.
</para>
<para>
In "share level" security the client normally gives a username in the
"session setup" protocol, but does not supply an accompanying
password. The client then connects to resources using the "tree
connect" protocol, and supplies a password. The problem is that the
user on the PC types the username and the password in different
contexts, unaware that they need to go together to give access to the
server. The username is normally the one the user typed in when they
"logged onto" the PC (this assumes Windows for Workgroups). The
password is the one they chose when connecting to the disk or printer.
</para>
<para>
The user often chooses a totally different username for their login as
for the drive connection. Often they also want to access different
drives as different usernames. The unix server needs some way of
divining the correct username to combine with each password.
</para>
<para>
Samba tries to avoid this problem using several methods. These succeed
in the vast majority of cases. The methods include username maps, the
service%user syntax, the saving of session setup usernames for later
validation and the derivation of the username from the service name
(either directly or via the user= option).
</para>
</sect1>
<sect1>
<title>File Ownership</title>
<para>
The commonly used SMB protocols have no way of saying "you can't do
that because you don't own the file". They have, in fact, no concept
of file ownership at all.
</para>
<para>
This brings up all sorts of interesting problems. For example, when
you copy a file to a unix drive, and the file is world writeable but
owned by another user the file will transfer correctly but will
receive the wrong date. This is because the utime() call under unix
only succeeds for the owner of the file, or root, even if the file is
world writeable. For security reasons Samba does all file operations
as the validated user, not root, so the utime() fails. This can stuff
up shared development diectories as programs like "make" will not get
file time comparisons right.
</para>
<para>
There are several possible solutions to this problem, including
username mapping, and forcing a specific username for particular
shares.
</para>
</sect1>
<sect1>
<title>Passwords</title>
<para>
Many SMB clients uppercase passwords before sending them. I have no
idea why they do this. Interestingly WfWg uppercases the password only
if the server is running a protocol greater than COREPLUS, so
obviously it isn't just the data entry routines that are to blame.
</para>
<para>
Unix passwords are case sensitive. So if users use mixed case
passwords they are in trouble.
</para>
<para>
Samba can try to cope with this by either using the "password level"
option which causes Samba to try the offered password with up to the
specified number of case changes, or by using the "password server"
option which allows Samba to do its validation via another machine
(typically a WinNT server).
</para>
<para>
Samba supports the password encryption method used by SMB
clients. Note that the use of password encryption in Microsoft
networking leads to password hashes that are "plain text equivalent".
This means that it is *VERY* important to ensure that the Samba
smbpasswd file containing these password hashes is only readable
by the root user. See the documentation ENCRYPTION.txt for more
details.
</para>
</sect1>
<sect1>
<title>Locking</title>
<para>
Since samba 2.2, samba supports other types of locking as well. This
section is outdated.
</para>
<para>
The locking calls available under a DOS/Windows environment are much
richer than those available in unix. This means a unix server (like
Samba) choosing to use the standard fcntl() based unix locking calls
to implement SMB locking has to improvise a bit.
</para>
<para>
One major problem is that dos locks can be in a 32 bit (unsigned)
range. Unix locking calls are 32 bits, but are signed, giving only a 31
bit range. Unfortunately OLE2 clients use the top bit to select a
locking range used for OLE semaphores.
</para>
<para>
To work around this problem Samba compresses the 32 bit range into 31
bits by appropriate bit shifting. This seems to work but is not
ideal. In a future version a separate SMB lockd may be added to cope
with the problem.
</para>
<para>
It also doesn't help that many unix lockd daemons are very buggy and
crash at the slightest provocation. They normally go mostly unused in
a unix environment because few unix programs use byte range
locking. The stress of huge numbers of lock requests from dos/windows
clients can kill the daemon on some systems.
</para>
<para>
The second major problem is the "opportunistic locking" requested by
some clients. If a client requests opportunistic locking then it is
asking the server to notify it if anyone else tries to do something on
the same file, at which time the client will say if it is willing to
give up its lock. Unix has no simple way of implementing
opportunistic locking, and currently Samba has no support for it.
</para>
</sect1>
<sect1>
<title>Deny Modes</title>
<para>
When a SMB client opens a file it asks for a particular "deny mode" to
be placed on the file. These modes (DENY_NONE, DENY_READ, DENY_WRITE,
DENY_ALL, DENY_FCB and DENY_DOS) specify what actions should be
allowed by anyone else who tries to use the file at the same time. If
DENY_READ is placed on the file, for example, then any attempt to open
the file for reading should fail.
</para>
<para>
Unix has no equivalent notion. To implement this Samba uses either lock
files based on the files inode and placed in a separate lock
directory or a shared memory implementation. The lock file method
is clumsy and consumes processing and file resources,
the shared memory implementation is vastly prefered and is turned on
by default for those systems that support it.
</para>
</sect1>
<sect1>
<title>Trapdoor UIDs</title>
<para>
A SMB session can run with several uids on the one socket. This
happens when a user connects to two shares with different
usernames. To cope with this the unix server needs to switch uids
within the one process. On some unixes (such as SCO) this is not
possible. This means that on those unixes the client is restricted to
a single uid.
</para>
<para>
Note that you can also get the "trapdoor uid" message for other
reasons. Please see the FAQ for details.
</para>
</sect1>
<sect1>
<title>Port numbers</title>
<para>
There is a convention that clients on sockets use high "unprivilaged"
port numbers (>1000) and connect to servers on low "privilaged" port
numbers. This is enforced in Unix as non-root users can't open a
socket for listening on port numbers less than 1000.
</para>
<para>
Most PC based SMB clients (such as WfWg and WinNT) don't follow this
convention completely. The main culprit is the netbios nameserving on
udp port 137. Name query requests come from a source port of 137. This
is a problem when you combine it with the common firewalling technique
of not allowing incoming packets on low port numbers. This means that
these clients can't query a netbios nameserver on the other side of a
low port based firewall.
</para>
<para>
The problem is more severe with netbios node status queries. I've
found that WfWg, Win95 and WinNT3.5 all respond to netbios node status
queries on port 137 no matter what the source port was in the
request. This works between machines that are both using port 137, but
it means it's not possible for a unix user to do a node status request
to any of these OSes unless they are running as root. The answer comes
back, but it goes to port 137 which the unix user can't listen
on. Interestingly WinNT3.1 got this right - it sends node status
responses back to the source port in the request.
</para>
</sect1>
<sect1>
<title>Protocol Complexity</title>
<para>
There are many "protocol levels" in the SMB protocol. It seems that
each time new functionality was added to a Microsoft operating system,
they added the equivalent functions in a new protocol level of the SMB
protocol to "externalise" the new capabilities.
</para>
<para>
This means the protocol is very "rich", offering many ways of doing
each file operation. This means SMB servers need to be complex and
large. It also means it is very difficult to make them bug free. It is
not just Samba that suffers from this problem, other servers such as
WinNT don't support every variation of every call and it has almost
certainly been a headache for MS developers to support the myriad of
SMB calls that are available.
</para>
<para>
There are about 65 "top level" operations in the SMB protocol (things
like SMBread and SMBwrite). Some of these include hundreds of
sub-functions (SMBtrans has at least 120 sub-functions, like
DosPrintQAdd and NetSessionEnum). All of them take several options
that can change the way they work. Many take dozens of possible
"information levels" that change the structures that need to be
returned. Samba supports all but 2 of the "top level" functions. It
supports only 8 (so far) of the SMBtrans sub-functions. Even NT
doesn't support them all.
</para>
<para>
Samba currently supports up to the "NT LM 0.12" protocol, which is the
one preferred by Win95 and WinNT3.5. Luckily this protocol level has a
"capabilities" field which specifies which super-duper new-fangled
options the server suports. This helps to make the implementation of
this protocol level much easier.
</para>
<para>
There is also a problem with the SMB specications. SMB is a X/Open
spec, but the X/Open book is far from ideal, and fails to cover many
important issues, leaving much to the imagination. Microsoft recently
renamed the SMB protocol CIFS (Common Internet File System) and have
published new specifications. These are far superior to the old
X/Open documents but there are still undocumented calls and features.
This specification is actively being worked on by a CIFS developers
mailing list hosted by Microsft.
</para>
</sect1>
</chapter>

79
docs/docbook/devdoc/wins.xml Normal file
View File

@ -0,0 +1,79 @@
<chapter id="wins">
<chapterinfo>
<author>
<firstname>Gerald</firstname><surname>Carter</surname>
</author>
<pubdate>October 2002</pubdate>
</chapterinfo>
<title>Samba WINS Internals</title>
<sect1>
<title>WINS Failover</title>
<para>
The current Samba codebase possesses the capability to use groups of WINS
servers that share a common namespace for NetBIOS name registration and
resolution. The formal parameter syntax is
</para>
<para><programlisting>
WINS_SERVER_PARAM = SERVER [ SEPARATOR SERVER_LIST ]
WINS_SERVER_PARAM = &quot;wins server&quot;
SERVER = ADDR[:TAG]
ADDR = ip_addr | fqdn
TAG = string
SEPARATOR = comma | \s+
SERVER_LIST = SERVER [ SEPARATOR SERVER_LIST ]
</programlisting></para>
<para>
A simple example of a valid wins server setting is
</para>
<para><programlisting>
[global]
wins server = 192.168.1.2 192.168.1.3
</programlisting></para>
<para>
In the event that no TAG is defined in for a SERVER in the list, smbd assigns a default
TAG of &quot;*&quot;. A TAG is used to group servers of a shared NetBIOS namespace together. Upon
startup, nmbd will attempt to register the netbios name value with one server in each
tagged group.
</para>
<para>
An example using tags to group WINS servers together is show here. Note that the use of
interface names in the tags is only by convention and is not a technical requirement.
</para>
<para><programlisting>
[global]
wins server = 192.168.1.2:eth0 192.168.1.3:eth0 192.168.2.2:eth1
</programlisting></para>
<para>
Using this configuration, nmbd would attempt to register the server's NetBIOS name
with one WINS server in each group. Because the &quot;eth0&quot; group has two servers, the
second server would only be used when a registration (or resolution) request to
the first server in that group timed out.
</para>
<para>
NetBIOS name resolution follows a similar pattern as name registration. When resolving
a NetBIOS name via WINS, smbd and other Samba programs will attempt to query a single WINS
server in a tagged group until either a positive response is obtained at least once or
until a server from every tagged group has responded negatively to the name query request.
If a timeout occurs when querying a specific WINS server, that server is marked as down to
prevent further timeouts and the next server in the WINS group is contacted. Once marked as
dead, Samba will not attempt to contact that server for name registration/resolution queries
for a period of 10 minutes.
</para>
</sect1>
</chapter>

101
docs/docbook/faq/clientapp.xml Normal file
View File

@ -0,0 +1,101 @@
<chapter id="FAQ-ClientApp">
<title>Specific client application problems</title>
<sect1>
<title>MS Office Setup reports "Cannot change properties of '\\MSOFFICE\\SETUP.INI'"</title>
<para>
When installing MS Office on a Samba drive for which you have admin
user permissions, ie. admin users = username, you will find the
setup program unable to complete the installation.
</para>
<para>
To get around this problem, do the installation without admin user
permissions The problem is that MS Office Setup checks that a file is
rdonly by trying to open it for writing.
</para>
<para>
Admin users can always open a file for writing, as they run as root.
You just have to install as a non-admin user and then use "chown -R"
to fix the owner.
</para>
</sect1>
<sect1>
<title>How to use a Samba share as an administrative share for MS Office, etc.</title>
<para>
Microsoft Office products can be installed as an administrative installation
from which the application can either be run off the administratively installed
product that resides on a shared resource, or from which that product can be
installed onto workstation clients.
</para>
<para>
The general mechanism for implementing an adminstrative installation involves
running <command>X:\setup /A</command>, where X is the drive letter of either CDROM or floppy.
</para>
<para>
This installation process will NOT install the product for use per se, but
rather results in unpacking of the compressed distribution files into a target
shared folder. For this process you need write privilidge to the share and it
is desirable to enable file locking and share mode operation during this
process.
</para>
<para>
Subsequent installation of MS Office from this share will FAIL unless certain
precautions are taken. This failure will be caused by share mode operation
which will prevent the MS Office installation process from re-opening various
dynamic link library files and will cause sporadic file not found problems.
</para>
<itemizedlist>
<listitem><para>
As soon as the administrative installation (unpacking) has completed
set the following parameters on the share containing it:
</para>
<para><programlisting>
[MSOP95]
path = /where_you_put_it
comment = Your comment
volume = "The_CD_ROM_Label"
read only = yes
available = yes
share modes = no
locking = no
browseable = yes
public = yes
</programlisting></para>
</listitem>
<listitem>
<para>Now you are ready to run the setup program from the Microsoft Windows
workstation as follows: <command>\\"Server_Name"\MSOP95\msoffice\setup</command>
</para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Microsoft Access database opening errors</title>
<para>
Here are some notes on running MS-Access on a Samba drive from <ulink url="stefank@esi.com.au">Stefan Kjellberg</ulink>
</para>
<para><simplelist>
<member>Opening a database in 'exclusive' mode does NOT work. Samba ignores r/w/share modes on file open.</member>
<member>Make sure that you open the database as 'shared' and to 'lock modified records'</member>
<member>Of course locking must be enabled for the particular share (smb.conf)</member>
</simplelist>
</para>
</sect1>
</chapter>

37
docs/docbook/faq/config.xml Normal file
View File

@ -0,0 +1,37 @@
<chapter id="FAQ-Config">
<title>Configuration problems</title>
<sect1>
<title>I have set 'force user' and samba still makes 'root' the owner of all the files I touch!</title>
<para>
When you have a user in 'admin users', samba will always do file operations for
this user as 'root', even if 'force user' has been set.
</para>
</sect1>
<sect1>
<title>I have just installed samba and I'm trying to log in from Windows, but samba refuses all logins!</title>
<para>
Newer windows clients(NT4, 2000, XP) send encrypted passwords. Samba can't compare these
passwords to the unix password database, so it needs it's own user database. You can
add users to this database using "smbpasswd -a user-name".
</para>
<para>
See also the "User database" chapter of the samba HOWTO Collection.
</para>
</sect1>
<sect1>
<title>How can I make samba use netbios scope ID's</title>
<para>By default Samba uses a blank scope ID. This means
all your windows boxes must also have a blank scope ID.
If you really want to use a non-blank scope ID then you will
need to use the 'netbios scope' smb.conf option.
All your PCs will need to have the same setting for
this to work. Scope ID's are not recommended.</para>
</sect1>
</chapter>

176
docs/docbook/faq/errors.xml Normal file
View File

@ -0,0 +1,176 @@
<chapter id="FAQ-errors">
<title>Common errors</title>
<sect1>
<title>Not listening for calling name</title>
<para>
<programlisting>
Session request failed (131,129) with myname=HOBBES destname=CALVIN
Not listening for calling name
</programlisting>
</para>
<para>
If you get this when talking to a Samba box then it means that your
global "hosts allow" or "hosts deny" settings are causing the Samba
server to refuse the connection.
</para>
<para>
Look carefully at your "hosts allow" and "hosts deny" lines in the
global section of smb.conf.
</para>
<para>
It can also be a problem with reverse DNS lookups not functioning
correctly, leading to the remote host identity not being able to
be confirmed, but that is less likely.
</para>
</sect1>
<sect1>
<title>System Error 1240</title>
<para>
System error 1240 means that the client is refusing to talk
to a non-encrypting server. Microsoft changed WinNT in service
pack 3 to refuse to connect to servers that do not support
SMB password encryption.
</para>
<para>There are two main solutions:
<simplelist>
<member>enable SMB password encryption in Samba. See the encryption part of
the samba HOWTO Collection</member>
<member>disable this new behaviour in NT. See the section about
Windows NT in the chapter "Portability" of the samba HOWTO collection
</member>
</simplelist>
</para>
</sect1>
<sect1>
<title>smbclient ignores -N !</title>
<para>
<quote>When getting the list of shares available on a host using the command
<command>smbclient -N -L</command>
the program always prompts for the password if the server is a Samba server.
It also ignores the "-N" argument when querying some (but not all) of our
NT servers.
</quote>
</para>
<para>
No, it does not ignore -N, it is just that your server rejected the
null password in the connection, so smbclient prompts for a password
to try again.
</para>
<para>
To get the behaviour that you probably want use <command>smbclient -L host -U%</command>
</para>
<para>
This will set both the username and password to null, which is
an anonymous login for SMB. Using -N would only set the password
to null, and this is not accepted as an anonymous login for most
SMB servers.
</para>
</sect1>
<sect1>
<title>The data on the CD-Drive I've shared seems to be corrupted!</title>
<para>
Some OSes (notably Linux) default to auto detection of file type on
cdroms and do cr/lf translation. This is a very bad idea when use with
Samba. It causes all sorts of stuff ups.
</para>
<para>
To overcome this problem use conv=binary when mounting the cdrom
before exporting it with Samba.
</para>
</sect1>
<sect1>
<title>Why can users access home directories of other users?</title>
<para>
<quote>
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 that I can
use to configure samba to enforce that only a user may map their own
home directory.
</quote>
</para>
<para><quote>
User xyzzy can map his home directory. Once mapped user xyzzy can also map
*anyone* elses home directory!
</quote></para>
<para>
This is not a security flaw, it is by design. Samba allows
users to have *exactly* the same access to the UNIX filesystem
as they would if they were logged onto the UNIX box, except
that it only allows such views onto the file system as are
allowed by the defined shares.
</para>
<para>
This means that if your UNIX home directories are set up
such that one user can happily cd into another users
directory and do an ls, the UNIX security solution is to
change the UNIX file permissions on the users home directories
such that the cd and ls would be denied.
</para>
<para>
Samba tries very hard not to second guess the UNIX administrators
security policies, and trusts the UNIX admin to set
the policies and permissions he or she desires.
</para>
<para>
Samba does allow the setup you require when you have set the
"only user = yes" option on the share, is that you have not set the
valid users list for the share.
</para>
<para>
Note that only user works in conjunction with the users= list,
so to get the behavior you require, add the line :
<programlisting>
users = %S
</programlisting>
this is equivalent to:
<programlisting>
valid users = %S
</programlisting>
to the definition of the [homes] share, as recommended in
the smb.conf man page.
</para>
</sect1>
<sect1>
<title>Until a few minutes after samba has started, clients get the error "Domain Controller Unavailable"</title>
<para>
A domain controller has to announce on the network who it is. This usually takes a while.
</para>
</sect1>
<sect1>
<title>I'm getting "open_oplock_ipc: Failed to get local UDP socket for address 100007f. Error was Cannot assign requested" in the logs</title>
<para>Your loopback device isn't working correctly. Make sure it's running.
</para>
</sect1>
</chapter>

374
docs/docbook/faq/features.xml Normal file
View File

@ -0,0 +1,374 @@
<chapter id="FAQ-features">
<title>Features</title>
<sect1>
<title>How can I prevent my samba server from being used to distribute the Nimda worm?</title>
<para>Author: HASEGAWA Yosuke (translated by <ulink url="monyo@samba.gr.jp">TAKAHASHI Motonobu</ulink>)</para>
<para>
Nimba Worm is infected through shared disks on a network, as well as through
Microsoft IIS, Internet Explorer and mailer of Outlook series.
</para>
<para>
At this time, the worm copies itself by the name *.nws and *.eml on
the shared disk, moreover, by the name of Riched20.dll in the folder
where *.doc file is included.
</para>
<para>
To prevent infection through the shared disk offered by Samba, set
up as follows:
</para>
<para>
<programlisting>
[global]
...
# This can break Administration installations of Office2k.
# in that case, don't veto the riched20.dll
veto files = /*.eml/*.nws/riched20.dll/
</programlisting>
</para>
<para>
By setting the "veto files" parameter, matched files on the Samba
server are completely hidden from the clients and making it impossible
to access them at all.
</para>
<para>
In addition to it, the following setting is also pointed out by the
samba-jp:09448 thread: when the
"readme.txt.{3050F4D8-98B5-11CF-BB82-00AA00BDCE0B}" file exists on
a Samba server, it is visible only as "readme.txt" and dangerous
code may be executed if this file is double-clicked.
</para>
<para>
Setting the following,
<programlisting>
veto files = /*.{*}/
</programlisting>
any files having CLSID in its file extension will be inaccessible from any
clients.
</para>
<para>
This technical article is created based on the discussion of
samba-jp:09448 and samba-jp:10900 threads.
</para>
</sect1>
<sect1>
<title>How can I use samba as a fax server?</title>
<para>Contributor: <ulink url="mailto:zuber@berlin.snafu.de">Gerhard Zuber</ulink></para>
<para>Requirements:
<simplelist>
<member>UNIX box (Linux preferred) with SAMBA and a faxmodem</member>
<member>ghostscript package</member>
<member>mgetty+sendfax package</member>
<member>pbm package (portable bitmap tools)</member>
</simplelist>
</para>
<para>First, install and configure the required packages. Be sure to read the mgetty+sendfax
manual carefully.</para>
<sect2>
<title>Tools for printing faxes</title>
<para>Your incomed faxes are in:
<filename>/var/spool/fax/incoming</filename>. Print it with:</para>
<para><programlisting>
for i in *
do
g3cat $i | g3tolj | lpr -P hp
done
</programlisting>
</para>
<para>
g3cat is in the tools-section, g3tolj is in the contrib-section
for printing to HP lasers.
</para>
<para>
If you want to produce files for displaying and printing with Windows, use
some tools from the pbm-package like the following command: <command>g3cat $i | g3topbm - | ppmtopcx - >$i.pcx</command>
and view it with your favourite Windows tool (maybe paintbrush)
</para>
</sect2>
<sect2>
<title>Making the fax-server</title>
<para>fetch the file <filename>mgetty+sendfax/frontends/winword/faxfilter</filename> and place it in <filename>/usr/local/etc/mgetty+sendfax/</filename>(replace /usr/local/ with whatever place you installed mgetty+sendfax)</para>
<para>prepare your faxspool file as mentioned in this file
edit fax/faxspool.in and reinstall or change the final
/usr/local/bin/faxspool too.
</para>
<para><programlisting>
if [ "$user" = "root" -o "$user" = "fax" -o \
"$user" = "lp" -o "$user" = "daemon" -o "$user" = "bin" ]
</programlisting></para>
<para>find the first line and change it to the second.</para>
<para>
make sure you have pbmtext (from the pbm-package). This is
needed for creating the small header line on each page.
</para>
<para>Prepare your faxheader <filename>/usr/local/etc/mgetty+sendfax/faxheader</filename></para>
<para>
Edit your /etc/printcap file:
<programlisting>
# FAX
lp3|fax:\
:lp=/dev/null:\
:sd=/usr/spool/lp3:\
:if=/usr/local/etc/mgetty+sendfax/faxfilter:sh:sf:mx#0:\
:lf=/usr/spool/lp3/fax-log:
</programlisting></para>
<para>Now, edit your <filename>smb.conf</filename> so you have a smb based printer named "fax"</para>
</sect2>
<sect2>
<title>Installing the client drivers</title>
<para>
Now you have a printer called "fax" which can be used via
TCP/IP-printing (lpd-system) or via SAMBA (windows printing).
</para>
<para>
On every system you are able to produce postscript-files you
are ready to fax.
</para>
<para>
On Windows 3.1 95 and NT:
</para>
<para>
Install a printer wich produces postscript output,
e.g. apple laserwriter
</para>
<para>Connect the "fax" to your printer.</para>
<para>
Now write your first fax. Use your favourite wordprocessor,
write, winword, notepad or whatever you want, and start
with the headerpage.
</para>
<para>
Usually each fax has a header page. It carries your name,
your address, your phone/fax-number.
</para>
<para>
It carries also the recipient, his address and his *** fax
number ***. Now here is the trick:
</para>
<para>
Use the text:
<programlisting>
Fax-Nr: 123456789
</programlisting>
as the recipients fax-number. Make sure this text does not
occur in regular text ! Make sure this text is not broken
by formatting information, e.g. format it as a single entity.
(Windows Write and Win95 Wordpad are functional, maybe newer
versions of Winword are breaking formatting information).
</para>
<para>
The trick is that postscript output is human readable and
the faxfilter program scans the text for this pattern and
uses the found number as the fax-destination-number.
</para>
<para>
Now print your fax through the fax-printer and it will be
queued for later transmission. Use faxrunq for sending the
queue out.
</para>
</sect2>
<sect2>
<title>Example smb.conf</title>
<para><programlisting>
[global]
printcap name = /etc/printcap
print command = /usr/bin/lpr -r -P %p %s
lpq command = /usr/bin/lpq -P %p
lprm command = /usr/bin/lprm -P %p %j
[fax]
comment = FAX (mgetty+sendfax)
path = /tmp
printable = yes
public = yes
writable = no
create mode = 0700
browseable = yes
guest ok = no
</programlisting></para>
</sect2>
</sect1>
<sect1>
<title>Samba doesn't work well together with DHCP!</title>
<para>
We wish to help those folks who wish to use the ISC DHCP Server and provide
sample configuration settings. Most operating systems today come ship with
the ISC DHCP Server. ISC DHCP is available from:
<ulink url="ftp://ftp.isc.org/isc/dhcp">ftp://ftp.isc.org/isc/dhcp</ulink>
</para>
<para>
Incorrect configuration of MS Windows clients (Windows9X, Windows ME, Windows
NT/2000) will lead to problems with browsing and with general network
operation. Windows 9X/ME users often report problems where the TCP/IP and related
network settings will inadvertantly become reset at machine start-up resulting
in loss of configuration settings. This results in increased maintenance
overheads as well as serious user frustration.
</para>
<para>
In recent times users on one mailing list incorrectly attributed the cause of
network operating problems to incorrect configuration of Samba.
</para>
<para>
One user insisted that the only way to provent Windows95 from periodically
performing a full system reset and hardware detection process on start-up was
to install the NetBEUI protocol in addition to TCP/IP. This assertion is not
correct.
</para>
<para>
In the first place, there is NO need for NetBEUI. All Microsoft Windows clients
natively run NetBIOS over TCP/IP, and that is the only protocol that is
recognised by Samba. Installation of NetBEUI and/or NetBIOS over IPX will
cause problems with browse list operation on most networks. Even Windows NT
networks experience these problems when incorrectly configured Windows95
systems share the same name space. It is important that only those protocols
that are strictly needed for site specific reasons should EVER be installed.
</para>
<para>
Secondly, and totally against common opinion, DHCP is NOT an evil design but is
an extension of the BOOTP protocol that has been in use in Unix environments
for many years without any of the melt-down problems that some sensationalists
would have us believe can be experienced with DHCP. In fact, DHCP in covered by
rfc1541 and is a very safe method of keeping an MS Windows desktop environment
under control and for ensuring stable network operation.
</para>
<para>
Please note that MS Windows systems as of MS Windows NT 3.1 and MS Windows 95
store all network configuration settings a registry. There are a few reports
from MS Windows network administrators that warrant mention here. It would appear
that when one sets certain MS TCP/IP protocol settings (either directly or via
DHCP) that these do get written to the registry. Even though a subsequent
change of setting may occur the old value may persist in the registry. This
has been known to create serious networking problems.
</para>
<para>
An example of this occurs when a manual TCP/IP environment is configured to
include a NetBIOS Scope. In this event, when the administrator then changes the
configuration of the MS TCP/IP protocol stack, without first deleting the
current settings, by simply checking the box to configure the MS TCP/IP stack
via DHCP then the NetBIOS Scope that is still persistent in the registry WILL be
applied to the resulting DHCP offered settings UNLESS the DHCP server also sets
a NetBIOS Scope. It may therefore be prudent to forcibly apply a NULL NetBIOS
Scope from your DHCP server. The can be done in the dhcpd.conf file with the
parameter:
<command>option netbios-scope "";</command>
</para>
<para>
While it is true that the Microsoft DHCP server that comes with Windows NT
Server provides only a sub-set of rfc1533 functionality this is hardly an issue
in those sites that already have a large investment and commitment to Unix
systems and technologies. The current state of the art of the DHCP Server
specification in covered in rfc2132.
</para>
</sect1>
<sect1>
<title>How can I assign NetBIOS names to clients with DHCP?</title>
<para>
SMB network clients need to be configured so that all standard TCP/IP name to
address resolution works correctly. Once this has been achieved the SMB
environment provides additional tools and services that act as helper agents in
the translation of SMB (NetBIOS) names to their appropriate IP Addresses. One
such helper agent is the NetBIOS Name Server (NBNS) or as Microsoft called it
in their Windows NT Server implementation WINS (Windows Internet Name Server).
</para>
<para>
A client needs to be configured so that it has a unique Machine (Computer)
Name.
</para>
<para>
This can be done, but needs a few NT registry hacks and you need to be able to
speak UNICODE, which is of course no problem for a True Wizzard(tm) :)
Instructions on how to do this (including a small util for less capable
Wizzards) can be found at
</para>
<para><ulink url="http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html">http://www.unixtools.org/~nneul/sw/nt/dhcp-netbios-hostname.html</ulink></para>
</sect1>
<sect1>
<title>How do I convert between unix and dos text formats?</title>
<para>
Jim barry has written an <ulink url="ftp://samba.org/pub/samba/contributed/fixcrlf.zip">
excellent drag-and-drop cr/lf converter for
windows</ulink>. Just drag your file onto the icon and it converts the file.
</para>
<para>
The utilities unix2dos and dos2unix(in the mtools package) should do
the job under unix.
</para>
</sect1>
<sect1>
<title>Does samba have wins replication support?</title>
<para>
At the time of writing there is currently being worked on a wins replication implementation(wrepld).
</para>
</sect1>
</chapter>

131
docs/docbook/faq/general.xml Normal file
View File

@ -0,0 +1,131 @@
<chapter id="FAQ-general">
<title>General Information</title>
<sect1>
<title>Where can I get it?</title>
<para>
The Samba suite is available at the <ulink url="http://samba.org/">samba website</ulink>.
</para>
</sect1>
<sect1>
<title>What do the version numbers mean?</title>
<para>
It is not recommended that you run a version of Samba with the word
"alpha" in its name unless you know what you are doing and are willing
to do some debugging. Many, many people just get the latest
recommended stable release version and are happy. If you are brave, by
all means take the plunge and help with the testing and development -
but don't install it on your departmental server. Samba is typically
very stable and safe, and this is mostly due to the policy of many
public releases.
</para>
<para>
How the scheme works:
<simplelist>
<member>When major changes are made the version number is increased. For
example, the transition from 1.9.15 to 1.9.16. However, this version
number will not appear immediately and people should continue to use
1.9.15 for production systems (see next point.)</member>
<member>Just after major changes are made the software is considered
unstable, and a series of alpha releases are distributed, for example
1.9.16alpha1. These are for testing by those who know what they are
doing. The "alpha" in the filename will hopefully scare off those who
are just looking for the latest version to install.</member>
<member>When the release manager, currently Jerry, thinks that the alphas have stabilised to the point
where he would recommend new users install it, he renames it to the
same version number without the alpha, for example 1.9.16.</member>
<member>Inevitably bugs are found in the "stable" releases and minor patch
levels are released which give us the pXX series, for example 1.9.16p2.</member>
</simplelist>
</para>
<para>
So the progression goes:
<programlisting>
1.9.15p7 (production)
1.9.15p8 (production)
1.9.16alpha1 (test sites only)
:
1.9.16alpha20 (test sites only)
1.9.16 (production)
1.9.16p1 (production)
</programlisting>
</para>
<para>
The above system means that whenever someone looks at the samba ftp
site they will be able to grab the highest numbered release without an
alpha in the name and be sure of getting the current recommended
version.
</para>
</sect1>
<sect1>
<title>What platforms are supported?</title>
<para>
Many different platforms have run Samba successfully. The platforms
most widely used and thus best tested are Linux and SunOS.</para>
<para>
At time of writing, there is support (or has been support for in earlier
versions):
</para>
<simplelist>
<member>A/UX 3.0</member>
<member>AIX</member>
<member>Altos Series 386/1000</member>
<member>Amiga</member>
<member>Apollo Domain/OS sr10.3</member>
<member>BSDI </member>
<member>B.O.S. (Bull Operating System)</member>
<member>Cray, Unicos 8.0</member>
<member>Convex</member>
<member>DGUX. </member>
<member>DNIX.</member>
<member>FreeBSD</member>
<member>HP-UX</member>
<member>Intergraph. </member>
<member>Linux with/without shadow passwords and quota</member>
<member>LYNX 2.3.0</member>
<member>MachTen (a unix like system for Macintoshes)</member>
<member>Motorola 88xxx/9xx range of machines</member>
<member>NetBSD</member>
<member>NEXTSTEP Release 2.X, 3.0 and greater (including OPENSTEP for Mach).</member>
<member>OS/2 using EMX 0.9b</member>
<member>OSF1</member>
<member>QNX 4.22</member>
<member>RiscIX. </member>
<member>RISCOs 5.0B</member>
<member>SEQUENT. </member>
<member>SCO (including: 3.2v2, European dist., OpenServer 5)</member>
<member>SGI.</member>
<member>SMP_DC.OSx v1.1-94c079 on Pyramid S series</member>
<member>SONY NEWS, NEWS-OS (4.2.x and 6.1.x)</member>
<member>SUNOS 4</member>
<member>SUNOS 5.2, 5.3, and 5.4 (Solaris 2.2, 2.3, and '2.4 and later')</member>
<member>Sunsoft ISC SVR3V4</member>
<member>SVR4</member>
<member>System V with some berkely extensions (Motorola 88k R32V3.2).</member>
<member>ULTRIX.</member>
<member>UNIXWARE</member>
<member>UXP/DS</member>
</simplelist>
</sect1>
<sect1>
<title>How do I subscribe to the Samba Mailing Lists?</title>
<para>
Look at <ulink url="http://samba.org/samba/archives.html">the samba mailing list page</ulink>
</para>
</sect1>
</chapter>

333
docs/docbook/faq/install.xml Normal file
View File

@ -0,0 +1,333 @@
<chapter id="FAQ-Install">
<title>Compiling and installing Samba on a Unix host</title>
<sect1>
<title>I can't see the Samba server in any browse lists!</title>
<para>
See Browsing.html in the docs directory of the samba source
for more information on browsing.
</para>
<para>
If your GUI client does not permit you to select non-browsable
servers, you may need to do so on the command line. For example, under
Lan Manager you might connect to the above service as disk drive M:
thusly:
<programlisting>
net use M: \\mary\fred
</programlisting>
The details of how to do this and the specific syntax varies from
client to client - check your client's documentation.
</para>
</sect1>
<sect1>
<title>Some files that I KNOW are on the server don't show up when I view the files from my client!</title>
<para>See the next question.</para>
</sect1>
<sect1>
<title>Some files on the server show up with really wierd filenames when I view the files from my client!</title>
<para>
If you check what files are not showing up, you will note that they
are files which contain upper case letters or which are otherwise not
DOS-compatible (ie, they are not legal DOS filenames for some reason).
</para>
<para>
The Samba server can be configured either to ignore such files
completely, or to present them to the client in "mangled" form. If you
are not seeing the files at all, the Samba server has most likely been
configured to ignore them. Consult the man page smb.conf(5) for
details of how to change this - the parameter you need to set is
"mangled names = yes".
</para>
</sect1>
<sect1>
<title>My client reports "cannot locate specified computer" or similar</title>
<para>
This indicates one of three things: You supplied an incorrect server
name, the underlying TCP/IP layer is not working correctly, or the
name you specified cannot be resolved.
</para>
<para>
After carefully checking that the name you typed is the name you
should have typed, try doing things like pinging a host or telnetting
to somewhere on your network to see if TCP/IP is functioning OK. If it
is, the problem is most likely name resolution.
</para>
<para>
If your client has a facility to do so, hardcode a mapping between the
hosts IP and the name you want to use. For example, with Lan Manager
or Windows for Workgroups you would put a suitable entry in the file
LMHOSTS. If this works, the problem is in the communication between
your client and the netbios name server. If it does not work, then
there is something fundamental wrong with your naming and the solution
is beyond the scope of this document.
</para>
<para>
If you do not have any server on your subnet supplying netbios name
resolution, hardcoded mappings are your only option. If you DO have a
netbios name server running (such as the Samba suite's nmbd program),
the problem probably lies in the way it is set up. Refer to Section
Two of this FAQ for more ideas.
</para>
<para>
By the way, remember to REMOVE the hardcoded mapping before further
tests :-)
</para>
</sect1>
<sect1>
<title>My client reports "cannot locate specified share name" or similar</title>
<para>
This message indicates that your client CAN locate the specified
server, which is a good start, but that it cannot find a service of
the name you gave.
</para>
<para>
The first step is to check the exact name of the service you are
trying to connect to (consult your system administrator). Assuming it
exists and you specified it correctly (read your client's docs on how
to specify a service name correctly), read on:
</para>
<simplelist>
<member>Many clients cannot accept or use service names longer than eight characters.</member>
<member>Many clients cannot accept or use service names containing spaces.</member>
<member>Some servers (not Samba though) are case sensitive with service names.</member>
<member>Some clients force service names into upper case.</member>
</simplelist>
</sect1>
<sect1>
<title>Printing doesn't work</title>
<para>
Make sure that the specified print command for the service you are
connecting to is correct and that it has a fully-qualified path (eg.,
use "/usr/bin/lpr" rather than just "lpr").
</para>
<para>
Make sure that the spool directory specified for the service is
writable by the user connected to the service. In particular the user
"nobody" often has problems with printing, even if it worked with an
earlier version of Samba. Try creating another guest user other than
"nobody".
</para>
<para>
Make sure that the user specified in the service is permitted to use
the printer.
</para>
<para>
Check the debug log produced by smbd. Search for the printer name and
see if the log turns up any clues. Note that error messages to do with
a service ipc$ are meaningless - they relate to the way the client
attempts to retrieve status information when using the LANMAN1
protocol.
</para>
<para>
If using WfWg then you need to set the default protocol to TCP/IP, not
Netbeui. This is a WfWg bug.
</para>
<para>
If using the Lanman1 protocol (the default) then try switching to
coreplus. Also not that print status error messages don't mean
printing won't work. The print status is received by a different
mechanism.
</para>
</sect1>
<sect1>
<title>My client reports "This server is not configured to list shared resources"</title>
<para>
Your guest account is probably invalid for some reason. Samba uses the
guest account for browsing in smbd. Check that your guest account is
valid.
</para>
<para>See also 'guest account' in smb.conf man page.</para>
</sect1>
<sect1>
<title>Log message "you appear to have a trapdoor uid system" </title>
<para>
This can have several causes. It might be because you are using a uid
or gid of 65535 or -1. This is a VERY bad idea, and is a big security
hole. Check carefully in your /etc/passwd file and make sure that no
user has uid 65535 or -1. Especially check the "nobody" user, as many
broken systems are shipped with nobody setup with a uid of 65535.
</para>
<para>It might also mean that your OS has a trapdoor uid/gid system :-)</para>
<para>
This means that once a process changes effective uid from root to
another user it can't go back to root. Unfortunately Samba relies on
being able to change effective uid from root to non-root and back
again to implement its security policy. If your OS has a trapdoor uid
system this won't work, and several things in Samba may break. Less
things will break if you use user or server level security instead of
the default share level security, but you may still strike
problems.
</para>
<para>
The problems don't give rise to any security holes, so don't panic,
but it does mean some of Samba's capabilities will be unavailable.
In particular you will not be able to connect to the Samba server as
two different uids at once. This may happen if you try to print as a
"guest" while accessing a share as a normal user. It may also affect
your ability to list the available shares as this is normally done as
the guest user.
</para>
<para>
Complain to your OS vendor and ask them to fix their system.
</para>
<para>
Note: the reason why 65535 is a VERY bad choice of uid and gid is that
it casts to -1 as a uid, and the setreuid() system call ignores (with
no error) uid changes to -1. This means any daemon attempting to run
as uid 65535 will actually run as root. This is not good!
</para>
</sect1>
<sect1>
<title>Why are my file's timestamps off by an hour, or by a few hours?</title>
<para>
This is from Paul Eggert eggert@twinsun.com.
</para>
<para>
Most likely it's a problem with your time zone settings.
</para>
<para>
Internally, Samba maintains time in traditional Unix format,
namely, the number of seconds since 1970-01-01 00:00:00 Universal Time
(or ``GMT''), not counting leap seconds.
</para>
<para>
On the server side, Samba uses the Unix TZ variable to convert
internal timestamps to and from local time. So on the server side, there are
two things to get right.
<simplelist>
<member>The Unix system clock must have the correct Universal time. Use the shell command "sh -c 'TZ=UTC0 date'" to check this.</member>
<member>The TZ environment variable must be set on the server before Samba is invoked. The details of this depend on the server OS, but typically you must edit a file whose name is /etc/TIMEZONE or /etc/default/init, or run the command `zic -l'.</member>
</simplelist>
</para>
<para>TZ must have the correct value.</para>
<para>
If possible, use geographical time zone settings
(e.g. TZ='America/Los_Angeles' or perhaps
TZ=':US/Pacific'). These are supported by most
popular Unix OSes, are easier to get right, and are
more accurate for historical timestamps. If your
operating system has out-of-date tables, you should be
able to update them from the public domain time zone
tables at <ulink url="ftp://elsie.nci.nih.gov/pub/">ftp://elsie.nci.nih.gov/pub/</ulink>.
</para>
<para>If your system does not support geographical timezone
settings, you must use a Posix-style TZ strings, e.g.
TZ='PST8PDT,M4.1.0/2,M10.5.0/2' for US Pacific time.
Posix TZ strings can take the following form (with optional
items in brackets):
<programlisting>
StdOffset[Dst[Offset],Date/Time,Date/Time]
</programlisting>
where:
</para>
<para><simplelist>
<member>`Std' is the standard time designation (e.g. `PST').</member>
<member>`Offset' is the number of hours behind UTC (e.g. `8').
Prepend a `-' if you are ahead of UTC, and
append `:30' if you are at a half-hour offset.
Omit all the remaining items if you do not use
daylight-saving time.</member>
<member>`Dst' is the daylight-saving time designation
(e.g. `PDT').</member>
<member>The optional second `Offset' is the number of
hours that daylight-saving time is behind UTC.
The default is 1 hour ahead of standard time.
</member>
<member>`Date/Time,Date/Time' specify when daylight-saving
time starts and ends. The format for a date is
`Mm.n.d', which specifies the dth day (0 is Sunday)
of the nth week of the mth month, where week 5 means
the last such day in the month. The format for a
time is [h]h[:mm[:ss]], using a 24-hour clock.
</member>
</simplelist>
</para>
<para>
Other Posix string formats are allowed but you don't want
to know about them.</para>
<para>
On the client side, you must make sure that your client's clock and
time zone is also set appropriately. [[I don't know how to do this.]]
Samba traditionally has had many problems dealing with time zones, due
to the bizarre ways that Microsoft network protocols handle time
zones.
</para>
</sect1>
<sect1>
<title>How do I set the printer driver name correctly?</title>
<para>Question:
<quote> On NT, I opened "Printer Manager" and "Connect to Printer".
Enter ["\\ptdi270\ps1"] in the box of printer. I got the
following error message
</quote></para>
<para>
<programlisting>
You do not have sufficient access to your machine
to connect to the selected printer, since a driver
needs to be installed locally.
</programlisting>
</para>
<para>Answer:</para>
<para>In the more recent versions of Samba you can now set the "printer
driver" in smb.conf. This tells the client what driver to use. For
example:</para>
<para><programlisting>
printer driver = HP LaserJet 4L
</programlisting></para>
<para>With this, NT knows to use the right driver. You have to get this string
exactly right.</para>
<para>To find the exact string to use, you need to get to the dialog box in
your client where you select which printer driver to install. The
correct strings for all the different printers are shown in a listbox
in that dialog box.</para>
</sect1>
</chapter>

38
docs/docbook/faq/printing.xml Normal file
View File

@ -0,0 +1,38 @@
<chapter id="FAQ-Printing">
<!-- Kurt Pfeifle's HOWTO chapter on printing should make this obsolete -->
<chapterinfo>
<author>
<firstname>Ronan</firstname><surname>Waide</surname>
</author>
</chapterinfo>
<title>Printing problems</title>
<sect1>
<title>setdriver or cupsaddsmb failes</title>
<para>
setdriver expects the following setup:
<simplelist>
<member>you are a printer admin, or root. this is the smb.conf printer admin group, not the Printer Operators group in NT. I've not tried the latter, but I don't believe it will work based on the current code.</member>
<member>printer admins has to be defined in [global]</member>
<member>upload the driver files to \\server\print$\w32x86 and win40 as appropriate. DON'T put them in the 0 or 2 subdirectories.</member>
<member>Make sure that the user you're connecting as is able to write to the print$ directories</member>
<member>Use adddriver (with appropriate parameters) to create the driver. note, this will not just update samba's notion of drivers, it will also move the files from the w32x86 and win40 directories to an appropriate subdirectory (based on driver version, I think, but not important enough for me to find out)</member>
<member>Use setdriver to associate the driver with a printer</member>
</simplelist>
</para>
<para>
The setdriver call will fail if the printer doesn't already exist in
samba's view of the world. Either create the printer in cups and
restart samba, or create an add printer command (see smb.conf doco)
and use RPC calls to create a printer. NB the add printer command MUST
return a single line of text indicating which port the printer was
added on. If it doesn't, Samba won't reload the printer
definitions. Although samba doesn't really support the notion of
ports, suitable add printer command and enumport command settings can
allow you pretty good remote control of the samba printer setup.
</para>
</sect1>
</chapter>

42
docs/docbook/faq/sambafaq.xml Normal file
View File

@ -0,0 +1,42 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY general SYSTEM "general.xml">
<!ENTITY install SYSTEM "install.xml">
<!ENTITY errors SYSTEM "errors.xml">
<!ENTITY clientapp SYSTEM "clientapp.xml">
<!ENTITY features SYSTEM "features.xml">
<!ENTITY config SYSTEM "config.xml">
<!ENTITY printing SYSTEM "printing.xml">
]>
<book id="Samba-FAQ">
<title>Samba FAQ</title>
<bookinfo>
<author><surname>Samba Team</surname></author>
<pubdate>October 2002</pubdate>
</bookinfo>
<dedication>
<para>
This is the Frequently Asked Questions (FAQ) document for
Samba, the free and very popular SMB server product. An SMB server
allows file and printer connections from clients such as Windows,
OS/2, Linux and others. Current to version 3.0. Please send any
corrections to the samba documentation mailinglist at
<ulink url="mailto:samba-doc@samba.org">samba-doc@samba.org</ulink>.
This FAQ was based on the old Samba FAQ by Dan Shearer and Paul Blackman,
and the old samba text documents which were mostly written by John Terpstra.
</para>
</dedication>
<toc/>
&general;
&install;
&config;
&clientapp;
&errors;
&features;
&printing;
</book>

1
docs/docbook/manpages/.cvsignore Normal file
View File

@ -0,0 +1 @@
smb.conf.5.xml

88
docs/docbook/manpages/editreg.1.xml Normal file
View File

@ -0,0 +1,88 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="editreg.1">
<refmeta>
<refentrytitle>editreg</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>editreg</refname>
<refpurpose>A utility to report and change SIDs in registry files
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>editreg</command>
<arg choice="opt">-v</arg>
<arg choice="opt">-c file</arg>
<arg choice="req">file</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>editreg</command> is a utility that
can visualize windows registry files (currently only NT4) and apply
so-called commandfiles to them.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>registry_file</term>
<listitem><para>Registry file to view or edit. </para></listitem>
</varlistentry>
<varlistentry>
<term>-v,--verbose</term>
<listitem><para>Increases verbosity of messages.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-c commandfile</term>
<listitem><para>Read commands to execute on <filename>registry_file</filename> from <filename>commandfile</filename>. Currently not yet supported!
</para></listitem>
</varlistentry>
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The editreg man page was written by Jelmer Vernooij. </para>
</refsect1>
</refentry>

153
docs/docbook/manpages/findsmb.1.xml Normal file
View File

@ -0,0 +1,153 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="findsmb.1">
<refmeta>
<refentrytitle>findsmb</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>findsmb</refname>
<refpurpose>list info about machines that respond to SMB
name queries on a subnet</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>findsmb</command>
<arg choice="opt">subnet broadcast address</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This perl script is part of the <citerefentry>
<refentrytitle>Samba</refentrytitle><manvolnum>7</manvolnum></citerefentry>
suite.</para>
<para><command>findsmb</command> is a perl script that
prints out several pieces of information about machines
on a subnet that respond to SMB name query requests.
It uses <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
and <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum></citerefentry>
to obtain this information.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-r</term>
<listitem><para>Controls whether <command>findsmb</command> takes
bugs in Windows95 into account when trying to find a Netbios name
registered of the remote machine. This option is disabled by default
because it is specific to Windows 95 and Windows 95 machines only.
If set, <citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
will be called with <constant>-B</constant> option.</para></listitem>
</varlistentry>
<varlistentry>
<term>subnet broadcast address</term>
<listitem><para>Without this option, <command>findsmb
</command> will probe the subnet of the machine where
<citerefentry><refentrytitle>findsmb</refentrytitle><manvolnum>1</manvolnum></citerefentry>
is run. This value is passed to
<citerefentry><refentrytitle>nmblookup</refentrytitle><manvolnum>1</manvolnum></citerefentry>
as part of the <constant>-B</constant> option.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>The output of <command>findsmb</command> lists the following
information for all machines that respond to the initial
<command>nmblookup</command> for any name: IP address, NetBIOS name,
Workgroup name, operating system, and SMB server version.</para>
<para>There will be a '+' in front of the workgroup name for
machines that are local master browsers for that workgroup. There
will be an '*' in front of the workgroup name for
machines that are the domain master browser for that workgroup.
Machines that are running Windows, Windows 95 or Windows 98 will
not show any information about the operating system or server
version.</para>
<para>The command with <constant>-r</constant> option
must be run on a system without <citerefentry>
<refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry> running.
If <command>nmbd</command> is running on the system, you will
only get the IP address and the DNS name of the machine. To
get proper responses from Windows 95 and Windows 98 machines,
the command must be run as root and with <constant>-r</constant>
option on a machine without <command>nmbd</command> running.</para>
<para>For example, running <command>findsmb</command>
without <constant>-r</constant> option set would yield output similar
to the following</para>
<screen>
IP ADDR NETBIOS NAME WORKGROUP/OS/VERSION
---------------------------------------------------------------------
192.168.35.10 MINESET-TEST1 [DMVENGR]
192.168.35.55 LINUXBOX *[MYGROUP] [Unix] [Samba 2.0.6]
192.168.35.56 HERBNT2 [HERB-NT]
192.168.35.63 GANDALF [MVENGR] [Unix] [Samba 2.0.5a for IRIX]
192.168.35.65 SAUNA [WORKGROUP] [Unix] [Samba 1.9.18p10]
192.168.35.71 FROGSTAR [ENGR] [Unix] [Samba 2.0.0 for IRIX]
192.168.35.78 HERBDHCP1 +[HERB]
192.168.35.88 SCNT2 +[MVENGR] [Windows NT 4.0] [NT LAN Manager 4.0]
192.168.35.93 FROGSTAR-PC [MVENGR] [Windows 5.0] [Windows 2000 LAN Manager]
192.168.35.97 HERBNT1 *[HERB-NT] [Windows NT 4.0] [NT LAN Manager 4.0]
</screen>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry>
<refentrytitle>nmbd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>, and <citerefentry><refentrytitle>nmblookup</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink
url="ftp://ftp.icce.rug.nl/pub/unix/">ftp://ftp.icce.rug.nl/pub/unix/</ulink>)
and updated for the Samba 2.0 release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook
XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

120
docs/docbook/manpages/lmhosts.5.xml Normal file
View File

@ -0,0 +1,120 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="lmhosts.5">
<refmeta>
<refentrytitle>lmhosts</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>lmhosts</refname>
<refpurpose>The Samba NetBIOS hosts file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>lmhosts</filename> is the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> NetBIOS name to IP address mapping file.</para>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This file is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><filename>lmhosts</filename> is the <emphasis>Samba
</emphasis> NetBIOS name to IP address mapping file. It
is very similar to the <filename>/etc/hosts</filename> file
format, except that the hostname component must correspond
to the NetBIOS naming format.</para>
</refsect1>
<refsect1>
<title>FILE FORMAT</title>
<para>It is an ASCII file containing one line for NetBIOS name.
The two fields on each line are separated from each other by
white space. Any entry beginning with '#' is ignored. Each line
in the lmhosts file contains the following information:</para>
<itemizedlist>
<listitem><para>IP Address - in dotted decimal format.</para>
</listitem>
<listitem><para>NetBIOS Name - This name format is a
maximum fifteen character host name, with an optional
trailing '#' character followed by the NetBIOS name type
as two hexadecimal digits.</para>
<para>If the trailing '#' is omitted then the given IP
address will be returned for all names that match the given
name, whatever the NetBIOS name type in the lookup.</para>
</listitem>
</itemizedlist>
<para>An example follows:</para>
<programlisting>
#
# Sample Samba lmhosts file.
#
192.9.200.1 TESTPC
192.9.200.20 NTSERVER#20
192.9.200.21 SAMBASERVER
</programlisting>
<para>Contains three IP to NetBIOS name mappings. The first
and third will be returned for any queries for the names "TESTPC"
and "SAMBASERVER" respectively, whatever the type component of
the NetBIOS name requested.</para>
<para>The second mapping will be returned only when the "0x20" name
type for a name "NTSERVER" is queried. Any other name type will not
be resolved.</para>
<para>The default location of the <filename>lmhosts</filename> file
is in the same directory as the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry>
<refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>, and <citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at
<ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook
XML 4.2 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

905
docs/docbook/manpages/net.8.xml Normal file
View File

@ -0,0 +1,905 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
<!-- This one is only used for adding users using RAP -->
<!ENTITY net.arg.flags '
<varlistentry>
<term>-F flags</term>
<listitem><para>
FIXME. Defaults to 0x21
</para></listitem>
</varlistentry>'>
<!-- This one is only used by shutdown (RPC) -->
<!ENTITY net.arg.shutdown '
<varlistentry>
<term>-r</term>
<listitem><para>
Reboot after shutdown.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-f</term>
<listitem><para>
Force shutting down all applications.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-t timeout</term>
<listitem><para>
Timeout before system will be shut down. An interactive
user of the system can use this time to cancel the shutdown.
</para></listitem>
</varlistentry>'>
]>
<refentry id="net.8">
<refmeta>
<refentrytitle>net</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>net</refname>
<refpurpose>Tool for administration of Samba and remote
CIFS servers.
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>net</command>
<arg choice="req">&lt;ads|rap|rpc&gt;</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-w workgroup</arg>
<arg choice="opt">-W myworkgroup</arg>
<arg choice="opt">-U user</arg>
<arg choice="opt">-I ip-address</arg>
<arg choice="opt">-p port</arg>
<arg choice="opt">-n myname</arg>
<arg choice="opt">-s conffile</arg>
<arg choice="opt">-S server</arg>
<arg choice="opt">-l</arg>
<arg choice="opt">-P</arg>
<arg choice="opt">-D debuglevel</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The samba net utility is meant to work just like the net utility
available for windows and DOS. The first argument should be used
to specify the protocol to use when executing a certain command.
ADS is used for ActiveDirectory, RAP is using for old (Win9x/NT3)
clients and RPC can be used for NT4 and Windows 2000. If this
argument is omitted, net will try to determine it automatically.
Not all commands are available on all protocols.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
&stdarg.help;
<varlistentry>
<term>-w target-workgroup</term>
<listitem><para>
Sets target workgroup or domain. You have to specify
either this option or the IP address or the name of a server.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-W workgroup</term>
<listitem><para>
Sets client workgroup or domain
</para></listitem>
</varlistentry>
<varlistentry>
<term>-U user</term>
<listitem><para>
User name to use
</para></listitem>
</varlistentry>
<varlistentry>
<term>-I ip-address</term>
<listitem><para>
IP address of target server to use. You have to
specify either this option or a target workgroup or
a target server.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-p port</term>
<listitem><para>
Port on the target server to connect to (usually 139 or 445).
Defaults to trying 445 first, then 139.
</para></listitem>
</varlistentry>
&stdarg.netbios.name;
&stdarg.configfile;
<varlistentry>
<term>-S server</term>
<listitem><para>
Name of target server. You should specify either
this option or a target workgroup or a target IP address.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-l</term>
<listitem><para>
When listing data, give more information on each item.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-P</term>
<listitem><para>
Make queries to the external server using the machine account of the local server.
</para></listitem>
</varlistentry>
&stdarg.debug;
</variablelist>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<refsect2>
<title>TIME</title>
<para>The <command>NET TIME</command> command allows you to view the time on a remote server
or synchronise the time on the local server with the time on the remote server.</para>
<refsect3>
<title>TIME</title>
<para>Without any options, the <command>NET TIME</command> command
displays the time on the remote server.
</para>
</refsect3>
<refsect3>
<title>TIME SYSTEM</title>
<para> Displays the time on the remote server in a format ready for <command>/bin/date</command></para>
</refsect3>
<refsect3>
<title>TIME SET</title>
<para>Tries to set the date and time of the local server to that on
the remote server using <command>/bin/date</command>. </para>
</refsect3>
<refsect3>
<title>TIME ZONE</title>
<para>Displays the timezone in hours from GMT on the remote computer.</para>
</refsect3>
</refsect2>
<refsect2>
<title>[RPC|ADS] JOIN [TYPE] [-U username[%password]] [options]</title>
<para>
Join a domain. If the account already exists on the server, and
[TYPE] is MEMBER, the machine will attempt to join automatically.
(Assuming that the machine has been created in server manager)
Otherwise, a password will be prompted for, and a new account may
be created.</para>
<para>
[TYPE] may be PDC, BDC or MEMBER to specify the type of server
joining the domain.
</para>
</refsect2>
<refsect2>
<title>[RPC] OLDJOIN [options]</title>
<para>Join a domain. Use the OLDJOIN option to join the domain
using the old style of domain joining - you need to create a trust
account in server manager first.</para>
</refsect2>
<refsect2>
<title>[RPC|ADS] USER</title>
<refsect3>
<title>[RPC|ADS] USER DELETE <replaceable>target</replaceable></title>
<para>Delete specified user</para>
</refsect3>
<refsect3>
<title>[RPC|ADS] USER LIST</title>
<para>List all users</para>
</refsect3>
<refsect3>
<title>[RPC|ADS] USER INFO <replaceable>target</replaceable></title>
<para>List the domain groups of a the specified user.</para>
</refsect3>
<refsect3>
<title>[RPC|ADS] USER ADD <replaceable>name</replaceable> [password] [-F user flags] [-C comment]</title>
<para>Add specified user.</para>
</refsect3>
</refsect2>
<refsect2>
<title>[RPC|ADS] GROUP</title>
<refsect3>
<title>[RPC|ADS] GROUP [misc options] [targets]</title>
<para>List user groups.</para>
</refsect3>
<refsect3>
<title>[RPC|ADS] GROUP DELETE <replaceable>name</replaceable> [misc. options]</title>
<para>Delete specified group.</para>
</refsect3>
<refsect3>
<title>[RPC|ADS] GROUP ADD <replaceable>name</replaceable> [-C comment]</title>
<para>Create specified group.</para>
</refsect3>
</refsect2>
<refsect2>
<title>[RAP|RPC] SHARE</title>
<refsect3>
<title>[RAP|RPC] SHARE [misc. options] [targets]</title>
<para>Enumerates all exported resources (network shares) on target server.</para>
</refsect3>
<refsect3>
<title>[RAP|RPC] SHARE ADD <replaceable>name=serverpath</replaceable> [-C comment] [-M maxusers] [targets]</title>
<para>Adds a share from a server (makes the export active). Maxusers
specifies the number of users that can be connected to the
share simultaneously.</para>
</refsect3>
<refsect3>
<title>SHARE DELETE <replaceable>sharenam</replaceable></title>
<para>Delete specified share.</para>
</refsect3>
</refsect2>
<refsect2>
<title>[RPC|RAP] FILE</title>
<refsect3>
<title>[RPC|RAP] FILE</title>
<para>List all open files on remote server.</para>
</refsect3>
<refsect3>
<title>[RPC|RAP] FILE CLOSE <replaceable>fileid</replaceable></title>
<para>Close file with specified <replaceable>fileid</replaceable> on
remote server.</para>
</refsect3>
<refsect3>
<title>[RPC|RAP] FILE INFO <replaceable>fileid</replaceable></title>
<para>
Print information on specified <replaceable>fileid</replaceable>.
Currently listed are: file-id, username, locks, path, permissions.
</para>
</refsect3>
<refsect3>
<title>[RAP|RPC] FILE USER</title>
&not.implemented;
</refsect3>
</refsect2>
<refsect2>
<title>SESSION</title>
<refsect3>
<title>RAP SESSION</title>
<para>Without any other options, SESSION enumerates all active SMB/CIFS
sessions on the target server.</para>
</refsect3>
<refsect3>
<title>RAP SESSION DELETE|CLOSE <replaceable>CLIENT_NAME</replaceable></title>
<para>Close the specified sessions.</para>
</refsect3>
<refsect3>
<title>RAP SESSION INFO <replaceable>CLIENT_NAME</replaceable></title>
<para>Give a list with all the open files in specified session.</para>
</refsect3>
</refsect2>
<refsect2>
<title>RAP SERVER <replaceable>DOMAIN</replaceable></title>
<para>List all servers in specified domain or workgroup. Defaults
to local domain.</para>
</refsect2>
<refsect2>
<title>RAP DOMAIN</title>
<para>Lists all domains and workgroups visible on the
current network.</para>
</refsect2>
<refsect2>
<title>RAP PRINTQ</title>
<refsect3>
<title>RAP PRINTQ LIST <replaceable>QUEUE_NAME</replaceable></title>
<para>Lists the specified print queue and print jobs on the server.
If the <replaceable>QUEUE_NAME</replaceable> is omitted, all
queues are listed.</para>
</refsect3>
<refsect3>
<title>RAP PRINTQ DELETE <replaceable>JOBID</replaceable></title>
<para>Delete job with specified id.</para>
</refsect3>
</refsect2>
<refsect2>
<title>RAP VALIDATE <replaceable>user</replaceable> [<replaceable>password</replaceable>]</title>
<para>
Validate whether the specified user can log in to the
remote server. If the password is not specified on the commandline, it
will be prompted.
</para>
&not.implemented;
</refsect2>
<refsect2>
<title>RAP GROUPMEMBER</title>
<refsect3>
<title>RAP GROUPMEMBER LIST <replaceable>GROUP</replaceable></title>
<para>List all members of the specified group.</para>
</refsect3>
<refsect3>
<title>RAP GROUPMEMBER DELETE <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title>
<para>Delete member from group.</para>
</refsect3>
<refsect3>
<title>RAP GROUPMEMBER ADD <replaceable>GROUP</replaceable> <replaceable>USER</replaceable></title>
<para>Add member to group.</para>
</refsect3>
</refsect2>
<refsect2>
<title>RAP ADMIN <replaceable>command</replaceable></title>
<para>Execute the specified <replaceable>command</replaceable> on
the remote server. Only works with OS/2 servers.
</para>
&not.implemented;
</refsect2>
<refsect2>
<title>RAP SERVICE</title>
<refsect3>
<title>RAP SERVICE START <replaceable>NAME</replaceable> [arguments...]</title>
<para>Start the specified service on the remote server. Not implemented yet.</para>
&not.implemented;
</refsect3>
<refsect3>
<title>RAP SERVICE STOP</title>
<para>Stop the specified service on the remote server.</para>
&not.implemented;
</refsect3>
</refsect2>
<refsect2>
<title>RAP PASSWORD <replaceable>USER</replaceable> <replaceable>OLDPASS</replaceable> <replaceable>NEWPASS</replaceable></title>
<para>
Change password of <replaceable>USER</replaceable> from <replaceable>OLDPASS</replaceable> to <replaceable>NEWPASS</replaceable>.
</para>
</refsect2>
<refsect2>
<title>LOOKUP</title>
<refsect3>
<title>LOOKUP HOST <replaceable>HOSTNAME</replaceable> [<replaceable>TYPE</replaceable>]</title>
<para>
Lookup the IP address of the given host with the specified type (netbios suffix).
The type defaults to 0x20 (workstation).
</para>
</refsect3>
<refsect3>
<title>LOOKUP LDAP [<replaceable>DOMAIN</replaceable></title>
<para>Give IP address of LDAP server of specified <replaceable>DOMAIN</replaceable>. Defaults to local domain.</para>
</refsect3>
<refsect3>
<title>LOOKUP KDC [<replaceable>REALM</replaceable>]</title>
<para>Give IP address of KDC for the specified <replaceable>REALM</replaceable>.
Defaults to local realm.</para>
</refsect3>
<refsect3>
<title>LOOKUP DC [<replaceable>DOMAIN</replaceable>]</title>
<para>Give IP's of Domain Controllers for specified <replaceable>
DOMAIN</replaceable>. Defaults to local domain.</para>
</refsect3>
<refsect3>
<title>LOOKUP MASTER <replaceable>DOMAIN</replaceable></title>
<para>Give IP of master browser for specified <replaceable>DOMAIN</replaceable>
or workgroup. Defaults to local domain.</para>
</refsect3>
</refsect2>
<refsect2>
<title>CACHE</title>
<para>Samba uses a general caching interface called 'gencache'. It
can be controlled using 'NET CACHE'.</para>
<para>All the timeout parameters support the suffixes:
<simplelist>
<member>s - Seconds</member>
<member>m - Minutes</member>
<member>h - Hours</member>
<member>d - Days</member>
<member>w - Weeks</member>
</simplelist>
</para>
<refsect3>
<title>CACHE ADD <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
<para>Add specified key+data to the cache with the given timeout.</para>
</refsect3>
<refsect3>
<title>CACHE DEL <replaceable>key</replaceable></title>
<para>Delete key from the cache.</para>
</refsect3>
<refsect3>
<title>CACHE SET <replaceable>key</replaceable> <replaceable>data</replaceable> <replaceable>time-out</replaceable></title>
<para>Update data of existing cache entry.</para>
</refsect3>
<refsect3>
<title>CACHE SEARCH <replaceable>PATTERN</replaceable></title>
<para>Search for the specified pattern in the cache data.</para>
</refsect3>
<refsect3>
<title>CACHE LIST</title>
<para>
List all current items in the cache.
</para>
</refsect3>
<refsect3>
<title>CACHE FLUSH</title>
<para>Remove all the current items from the cache.</para>
</refsect3>
</refsect2>
<refsect2>
<title>GETLOCALSID [DOMAIN]</title>
<para>Print the SID of the specified domain, or if the parameter is
omitted, the SID of the domain the local server is in.</para>
</refsect2>
<refsect2>
<title>SETLOCALSID S-1-5-21-x-y-z</title>
<para>Sets domain sid for the local server to the specified SID.</para>
</refsect2>
<refsect2>
<title>GROUPMAP</title>
<para>Manage the mappings between Windows group SIDs and UNIX groups.
Parameters take the for "parameter=value". Common options include:</para>
<itemizedlist>
<listitem><para>unixgroup - Name of the UNIX group</para></listitem>
<listitem><para>ntgroup - Name of the Windows NT group (must be
resolvable to a SID</para></listitem>
<listitem><para>rid - Unsigned 32-bit integer</para></listitem>
<listitem><para>sid - Full SID in the form of "S-1-..."</para></listitem>
<listitem><para>type - Type of the group; either 'domain', 'local',
or 'builtin'</para></listitem>
<listitem><para>comment - Freeform text description of the group</para></listitem>
</itemizedlist>
<refsect3>
<title>GROUPMAP ADD</title>
<para>Add a new group mapping entry</para>
<para>net groupmap add {rid=int|sid=string} unixgroup=string [type={domain|local|builtin}] [ntgroup=string] [comment=string]</para>
</refsect3>
<refsect3>
<title>GROUPMAP DELETE</title>
<para>Delete a group mapping entry</para>
<para>net groupmap delete {ntgroup=string|sid=SID}</para>
</refsect3>
<refsect3>
<title>GROUPMAP MODIFY</title>
<para>Update en existing group entry</para>
<para>net groupmap modify {ntgroup=string|sid=SID} [unixgroup=string] [comment=string] [type={domain|local}</para>
</refsect3>
<refsect3>
<title>GROUPMAP LIST</title>
<para>List existing group mapping entries</para>
<para>net groupmap list [verbose] [ntgroup=string] [sid=SID]</para>
</refsect3>
</refsect2>
<refsect2>
<title>MAXRID</title>
<para>Prints out the highest RID currently in use on the local
server (by the active 'passdb backend').
</para>
</refsect2>
<refsect2>
<title>RPC INFO</title>
<para>Print information about the domain of the remote server,
such as domain name, domain sid and number of users and groups.
</para>
</refsect2>
<refsect2>
<title>[RPC|ADS] TESTJOIN</title>
<para>Check whether participation in a domain is still valid.</para>
</refsect2>
<refsect2>
<title>[RPC|ADS] CHANGETRUSTPW</title>
<para>Force change of domain trust password.</para>
</refsect2>
<refsect2>
<title>RPC TRUSTDOM</title>
<refsect3>
<title>RPC TRUSTDOM ADD <replaceable>DOMAIN</replaceable></title>
<para>Add a interdomain trust account for
<replaceable>DOMAIN</replaceable> to the remote server.
</para>
</refsect3>
<refsect3>
<title>RPC TRUSTDOM DEL <replaceable>DOMAIM</replaceable></title>
<para>Remove interdomain trust account for
<replaceable>DOMAIN</replaceable> from the remote server.
</para>
&not.implemented;
</refsect3>
<refsect3>
<title>RPC TRUSTDOM ESTABLISH <replaceable>DOMAIN</replaceable></title>
<para>
Establish a trust relationship to a trusting domain.
Interdomain account must already be created on the remote PDC.
</para>
</refsect3>
<refsect3>
<title>RPC TRUSTDOM REVOKE <replaceable>DOMAIN</replaceable></title>
<para>Abandon relationship to trusted domain</para>
</refsect3>
<refsect3>
<title>RPC TRUSTDOM LIST</title>
<para>List all current interdomain trust relationships.</para>
</refsect3>
</refsect2>
<refsect2>
<title>RPC ABORTSHUTDOWN</title>
<para>Abort the shutdown of a remote server.</para>
</refsect2>
<refsect2>
<title>SHUTDOWN [-t timeout] [-r] [-f] [-C message]</title>
<para>Shut down the remote server.</para>
<variablelist>
&net.arg.shutdown;
<varlistentry>
<term>-C message</term>
<listitem><para>Display the specified message on the screen to
announce the shutdown.</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>SAMDUMP</title>
<para>Print out sam database of remote server. You need
to run this on either a BDC. <!--
Is that correct? - Jelmer --></para>
</refsect2>
<refsect2>
<title>VAMPIRE</title>
<para>Export users, aliases and groups from remote server to
local server. Can only be run an a BDC.
</para>
</refsect2>
<refsect2>
<title>GETSID</title>
<para>Fetch domain SID and store it in the local <filename>secrets.tdb</filename>. </para>
</refsect2>
<refsect2>
<title>ADS LEAVE</title>
<para>Make the remote host leave the domain it is part of. </para>
</refsect2>
<refsect2>
<title>ADS STATUS</title>
<para>Print out status of machine account of the local machine in ADS.
Prints out quite some debug info. Aimed at developers, regular
users should use <command>NET ADS TESTJOIN</command>.</para>
</refsect2>
<refsect2>
<title>ADS PRINTER</title>
<refsect3>
<title>ADS PRINTER INFO [<replaceable>PRINTER</replaceable>] [<replaceable>SERVER</replaceable>]</title>
<para>
Lookup info for <replaceable>PRINTER</replaceable> on <replaceable>SERVER</replaceable>. The printer name defaults to "*", the
server name defaults to the local host.</para>
</refsect3>
<refsect3>
<title>ADS PRINTER PUBLISH <replaceable>PRINTER</replaceable></title>
<para>Publish specified printer using ADS.</para>
</refsect3>
<refsect3>
<title>ADS PRINTER REMOVE <replaceable>PRINTER</replaceable></title>
<para>Remove specified printer from ADS directory.</para>
</refsect3>
</refsect2>
<refsect2>
<title>ADS SEARCH <replaceable>EXPRESSION</replaceable> <replaceable>ATTRIBUTES...</replaceable></title>
<para>Perform a raw LDAP search on a ADS server and dump the results. The
expression is a standard LDAP search expression, and the
attributes are a list of LDAP fields to show in the results.</para>
<para>Example: <userinput>net ads search '(objectCategory=group)' sAMAccountName</userinput>
</para>
</refsect2>
<refsect2>
<title>ADS DN <replaceable>DN</replaceable> <replaceable>(attributes)</replaceable></title>
<para>
Perform a raw LDAP search on a ADS server and dump the results. The
DN standard LDAP DN, and the attributes are a list of LDAP fields
to show in the result.
</para>
<para>Example: <userinput>net ads dn 'CN=administrator,CN=Users,DC=my,DC=domain' SAMAccountName</userinput></para>
</refsect2>
<refsect2>
<title>WORKGROUP</title>
<para>Print out workgroup name for specified kerberos realm.</para>
</refsect2>
<refsect2>
<title>HELP [COMMAND]</title>
<para>Gives usage information for the specified command.</para>
</refsect2>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is complete for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The net manpage was written by Jelmer Vernooij.</para>
</refsect1>
</refentry>

302
docs/docbook/manpages/nmbd.8.xml Normal file
View File

@ -0,0 +1,302 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="nmbd.8">
<refmeta>
<refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>nmbd</refname>
<refpurpose>NetBIOS name server to provide NetBIOS
over IP naming services to clients</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>nmbd</command>
<arg choice="opt">-D</arg>
<arg choice="opt">-F</arg>
<arg choice="opt">-S</arg>
<arg choice="opt">-a</arg>
<arg choice="opt">-i</arg>
<arg choice="opt">-o</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-V</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-H &lt;lmhosts file&gt;</arg>
<arg choice="opt">-l &lt;log directory&gt;</arg>
<arg choice="opt">-n &lt;primary netbios name&gt;</arg>
<arg choice="opt">-p &lt;port number&gt;</arg>
<arg choice="opt">-s &lt;configuration file&gt;</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>nmbd</command> is a server that understands
and can reply to NetBIOS over IP name service requests, like
those produced by SMB/CIFS clients such as Windows 95/98/ME,
Windows NT, Windows 2000, Windows XP and LanManager clients. It also
participates in the browsing protocols which make up the
Windows "Network Neighborhood" view.</para>
<para>SMB/CIFS clients, when they start up, may wish to
locate an SMB/CIFS server. That is, they wish to know what
IP number a specified host is using.</para>
<para>Amongst other services, <command>nmbd</command> will
listen for such requests, and if its own NetBIOS name is
specified it will respond with the IP number of the host it
is running on. Its "own NetBIOS name" is by
default the primary DNS name of the host it is running on,
but this can be overridden with the <emphasis>-n</emphasis>
option (see OPTIONS below). Thus <command>nmbd</command> will
reply to broadcast queries for its own name(s). Additional
names for <command>nmbd</command> to respond on can be set
via parameters in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> configuration file.</para>
<para><command>nmbd</command> can also be used as a WINS
(Windows Internet Name Server) server. What this basically means
is that it will act as a WINS database server, creating a
database from name registration requests that it receives and
replying to queries from clients for these names.</para>
<para>In addition, <command>nmbd</command> can act as a WINS
proxy, relaying broadcast queries from clients that do
not understand how to talk the WINS protocol to a WINS
server.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-D</term>
<listitem><para>If specified, this parameter causes
<command>nmbd</command> to operate as a daemon. That is,
it detaches itself and runs in the background, fielding
requests on the appropriate port. By default, <command>nmbd</command>
will operate as a daemon if launched from a command shell.
nmbd can also be operated from the <command>inetd</command>
meta-daemon, although this is not recommended.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-F</term>
<listitem><para>If specified, this parameter causes
the main <command>nmbd</command> process to not daemonize,
i.e. double-fork and disassociate with the terminal.
Child processes are still created as normal to service
each connection request, but the main process does not
exit. This operation mode is suitable for running
<command>nmbd</command> under process supervisors such
as <command>supervise</command> and <command>svscan</command>
from Daniel J. Bernstein's <command>daemontools</command>
package, or the AIX process monitor.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-S</term>
<listitem><para>If specified, this parameter causes
<command>nmbd</command> to log to standard output rather
than a file.</para></listitem>
</varlistentry>
<varlistentry>
<term>-i</term>
<listitem><para>If this parameter is specified it causes the
server to run "interactively", not as a daemon, even if the
server is executed on the command line of a shell. Setting this
parameter negates the implicit daemon mode when run from the
command line. <command>nmbd</command> also logs to standard
output, as if the <constant>-S</constant> parameter had been
given. </para></listitem>
</varlistentry>
&stdarg.help;
<varlistentry>
<term>-H &lt;filename&gt;</term>
<listitem><para>NetBIOS lmhosts file. The lmhosts
file is a list of NetBIOS names to IP addresses that
is loaded by the nmbd server and used via the name
resolution mechanism <ulink url="smb.conf.5.html#nameresolveorder"><parameter>name resolve
order</parameter></ulink> described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> to resolve any
NetBIOS name queries needed by the server. Note
that the contents of this file are <emphasis>NOT</emphasis>
used by <command>nmbd</command> to answer any name queries.
Adding a line to this file affects name NetBIOS resolution
from this host <emphasis>ONLY</emphasis>.</para>
<para>The default path to this file is compiled into
Samba as part of the build process. Common defaults
are <filename>/usr/local/samba/lib/lmhosts</filename>,
<filename>/usr/samba/lib/lmhosts</filename> or
<filename>/etc/samba/lmhosts</filename>. See the <citerefentry><refentrytitle>lmhosts</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> man page for details on the contents of this file.</para></listitem>
</varlistentry>
&popt.common.samba;
<varlistentry>
<term>-p &lt;UDP port number&gt;</term>
<listitem><para>UDP port number is a positive integer value.
This option changes the default UDP port number (normally 137)
that <command>nmbd</command> responds to name queries on. Don't
use this option unless you are an expert, in which case you
won't need help!</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/inetd.conf</filename></term>
<listitem><para>If the server is to be run by the
<command>inetd</command> meta-daemon, this file
must contain suitable startup information for the
meta-daemon. See the <ulink
url="install.html">install</ulink> document
for details.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/rc</filename></term>
<listitem><para>or whatever initialization script your
system uses).</para>
<para>If running the server as a daemon at startup,
this file will need to contain an appropriate startup
sequence for the server. See the <ulink
url="install.html">"How to Install and Test SAMBA"</ulink> document
for details.</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/services</filename></term>
<listitem><para>If running the server via the
meta-daemon <command>inetd</command>, this file
must contain a mapping of service name (e.g., netbios-ssn)
to service port (e.g., 139) and protocol type (e.g., tcp).
See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink>
document for details.</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/usr/local/samba/lib/smb.conf</filename></term>
<listitem><para>This is the default location of
the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> server
configuration file. Other common places that systems
install this file are <filename>/usr/samba/lib/smb.conf</filename>
and <filename>/etc/samba/smb.conf</filename>.</para>
<para>When run as a WINS server (see the
<ulink url="smb.conf.5.html#WINSSUPPORT"><constant>wins support</constant></ulink>
parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> man page),
<command>nmbd</command>
will store the WINS database in the file <filename>wins.dat</filename>
in the <filename>var/locks</filename> directory configured under
wherever Samba was configured to install itself.</para>
<para>If <command>nmbd</command> is acting as a <emphasis>
browse master</emphasis> (see the <ulink
url="smb.conf.5.html#LOCALMASTER"><constant>local master</constant></ulink>
parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> man page, <command>nmbd</command>
will store the browsing database in the file <filename>browse.dat
</filename> in the <filename>var/locks</filename> directory
configured under wherever Samba was configured to install itself.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SIGNALS</title>
<para>To shut down an <command>nmbd</command> process it is recommended
that SIGKILL (-9) <emphasis>NOT</emphasis> be used, except as a last
resort, as this may leave the name database in an inconsistent state.
The correct way to terminate <command>nmbd</command> is to send it
a SIGTERM (-15) signal and wait for it to die on its own.</para>
<para><command>nmbd</command> will accept SIGHUP, which will cause
it to dump out its namelists into the file <filename>namelist.debug
</filename> in the <filename>/usr/local/samba/var/locks</filename>
directory (or the <filename>var/locks</filename> directory configured
under wherever Samba was configured to install itself). This will also
cause <command>nmbd</command> to dump out its server database in
the <filename>log.nmb</filename> file.</para>
<para>The debug log level of nmbd may be raised or lowered
using <citerefentry><refentrytitle>smbcontrol</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> (SIGUSR[1|2] signals
are no longer used since Samba 2.2). This is to allow
transient problems to be diagnosed, whilst still running
at a normally low log level.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>
<citerefentry><refentrytitle>inetd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, and the Internet
RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
In addition the CIFS (formerly SMB) specification is available
as a link from the Web page <ulink url="http://samba.org/cifs/">
http://samba.org/cifs/</ulink>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook
XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

224
docs/docbook/manpages/nmblookup.1.xml Normal file
View File

@ -0,0 +1,224 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="nmblookup">
<refmeta>
<refentrytitle>nmblookup</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>nmblookup</refname>
<refpurpose>NetBIOS over TCP/IP client used to lookup NetBIOS
names</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>nmblookup</command>
<arg choice="opt">-M</arg>
<arg choice="opt">-R</arg>
<arg choice="opt">-S</arg>
<arg choice="opt">-r</arg>
<arg choice="opt">-A</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-B &lt;broadcast address&gt;</arg>
<arg choice="opt">-U &lt;unicast address&gt;</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-s &lt;smb config file&gt;</arg>
<arg choice="opt">-i &lt;NetBIOS scope&gt;</arg>
<arg choice="opt">-T</arg>
<arg choice="opt">-f</arg>
<arg choice="req">name</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>nmblookup</command> is used to query NetBIOS names
and map them to IP addresses in a network using NetBIOS over TCP/IP
queries. The options allow the name queries to be directed at a
particular IP broadcast area or to a particular machine. All queries
are done over UDP.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-M</term>
<listitem><para>Searches for a master browser by looking
up the NetBIOS name <replaceable>name</replaceable> with a
type of <constant>0x1d</constant>. If <replaceable>
name</replaceable> is "-" then it does a lookup on the special name
<constant>__MSBROWSE__</constant>. Please note that in order to
use the name "-", you need to make sure "-" isn't parsed as an
argument, e.g. use :
<userinput>nmblookup -M -- -</userinput>.</para></listitem>
</varlistentry>
<varlistentry>
<term>-R</term>
<listitem><para>Set the recursion desired bit in the packet
to do a recursive lookup. This is used when sending a name
query to a machine running a WINS server and the user wishes
to query the names in the WINS server. If this bit is unset
the normal (broadcast responding) NetBIOS processing code
on a machine is used instead. See RFC1001, RFC1002 for details.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-S</term>
<listitem><para>Once the name query has returned an IP
address then do a node status query as well. A node status
query returns the NetBIOS names registered by a host.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-r</term>
<listitem><para>Try and bind to UDP port 137 to send and receive UDP
datagrams. The reason for this option is a bug in Windows 95
where it ignores the source port of the requesting packet
and only replies to UDP port 137. Unfortunately, on most UNIX
systems root privilege is needed to bind to this port, and
in addition, if the <citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> daemon is running on this machine it also binds to this port.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-A</term>
<listitem><para>Interpret <replaceable>name</replaceable> as
an IP Address and do a node status query on this address.</para>
</listitem>
</varlistentry>
&popt.common.connection;
&stdarg.help;
<varlistentry>
<term>-B &lt;broadcast address&gt;</term>
<listitem><para>Send the query to the given broadcast address. Without
this option the default behavior of nmblookup is to send the
query to the broadcast address of the network interfaces as
either auto-detected or defined in the <ulink
url="smb.conf.5.html#INTERFACES"><parameter>interfaces</parameter>
</ulink> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-U &lt;unicast address&gt;</term>
<listitem><para>Do a unicast query to the specified address or
host <replaceable>unicast address</replaceable>. This option
(along with the <parameter>-R</parameter> option) is needed to
query a WINS server.</para></listitem>
</varlistentry>
&popt.common.samba;
<varlistentry>
<term>-T</term>
<listitem><para>This causes any IP addresses found in the
lookup to be looked up via a reverse DNS lookup into a
DNS name, and printed out before each</para>
<para><emphasis>IP address .... NetBIOS name</emphasis></para>
<para> pair that is the normal output.</para></listitem>
</varlistentry>
<varlistentry>
<term>-f</term>
<listitem><para>
Show which flags apply to the name that has been looked up. Possible
answers are zero or more of: Response, Authoritative,
Truncated, Recursion_Desired, Recursion_Available, Broadcast.
</para></listitem>
</varlistentry>
<varlistentry>
<term>name</term>
<listitem><para>This is the NetBIOS name being queried. Depending
upon the previous options this may be a NetBIOS name or IP address.
If a NetBIOS name then the different name types may be specified
by appending '#&lt;type&gt;' to the name. This name may also be
'*', which will return all registered names within a broadcast
area.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para><command>nmblookup</command> can be used to query
a WINS server (in the same way <command>nslookup</command> is
used to query DNS servers). To query a WINS server, <command>nmblookup</command>
must be called like this:</para>
<para><command>nmblookup -U server -R 'name'</command></para>
<para>For example, running :</para>
<para><command>nmblookup -U samba.org -R 'IRIX#1B'</command></para>
<para>would query the WINS server samba.org for the domain
master browser (1B name type) for the IRIX workgroup.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>, and <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook
XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

130
docs/docbook/manpages/ntlm_auth.1.xml Normal file
View File

@ -0,0 +1,130 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="ntlm-auth.1">
<refmeta>
<refentrytitle>ntlm_auth</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>ntlm_auth</refname>
<refpurpose>tool to allow external access to Winbind's NTLM authentication function</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ntlm_auth</command>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-l logfile</arg>
<arg choice="opt">-s &lt;smb config file&gt;</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>ntlm_auth</command> is a helper utility that authenticates
users using NT/LM authentication. It returns 0 if the users is authenticated
successfully and 1 if access was denied. ntlm_auth uses winbind to access
the user and authentication data for a domain. This utility
is only to be used by other programs (currently squid).
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>--helper-protocol=PROTO</term>
<listitem><para>
Operate as a stdio-based helper
</para></listitem>
</varlistentry>
<varlistentry>
<term>--username=USERNAME</term>
<listitem><para>
Specify username of user to authenticate
</para></listitem>
</varlistentry>
<varlistentry>
<term>--domain=DOMAIN</term>
<listitem><para>
Specify domain of user to authenticate
</para></listitem>
</varlistentry>
<varlistentry>
<term>--workstation=WORKSTATION</term>
<listitem><para>
Specify the workstation the user authenticated from
</para></listitem>
</varlistentry>
<varlistentry>
<term>--challenge=STRING</term>
<listitem><para>challenge (HEX encoded)</para></listitem>
</varlistentry>
<varlistentry>
<term>--lm-response=RESPONSE</term>
<listitem><para>LM Response to the challenge (HEX encoded)</para></listitem>
</varlistentry>
<varlistentry>
<term>--nt-response=RESPONSE</term>
<listitem><para>NT or NTLMv2 Response to the challenge (HEX encoded)</para></listitem>
</varlistentry>
<varlistentry>
<term>--password=PASSWORD</term>
<listitem><para>User's plaintext password</para></listitem>
</varlistentry>
<varlistentry>
<term>--request-lm-key</term>
<listitem><para>Retreive LM session key</para></listitem>
</varlistentry>
<varlistentry>
<term>--request-nt-key</term>
<listitem><para>Request NT key</para></listitem>
</varlistentry>
&popt.common.samba;
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The ntlm_auth manpage was written by Jelmer Vernooij.</para>
</refsect1>
</refentry>

378
docs/docbook/manpages/pdbedit.8.xml Normal file
View File

@ -0,0 +1,378 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="pdbedit.8">
<refmeta>
<refentrytitle>pdbedit</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>pdbedit</refname>
<refpurpose>manage the SAM database</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>pdbedit</command>
<arg choice="opt">-l</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-w</arg>
<arg choice="opt">-u username</arg>
<arg choice="opt">-f fullname</arg>
<arg choice="opt">-h homedir</arg>
<arg choice="opt">-D drive</arg>
<arg choice="opt">-S script</arg>
<arg choice="opt">-p profile</arg>
<arg choice="opt">-a</arg>
<arg choice="opt">-m</arg>
<arg choice="opt">-x</arg>
<arg choice="opt">-i passdb-backend</arg>
<arg choice="opt">-e passdb-backend</arg>
<arg choice="opt">-g</arg>
<arg choice="opt">-b passdb-backend</arg>
<arg choice="opt">-g</arg>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-s configfile</arg>
<arg choice="opt">-P account-policy</arg>
<arg choice="opt">-C value</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The pdbedit program is used to manage the users accounts
stored in the sam database and can only be run by root.</para>
<para>The pdbedit tool uses the passdb modular interface and is
independent from the kind of users database used (currently there
are smbpasswd, ldap, nis+ and tdb based and more can be added
without changing the tool).</para>
<para>There are five main ways to use pdbedit: adding a user account,
removing a user account, modifing a user account, listing user
accounts, importing users accounts.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-l</term>
<listitem><para>This option lists all the user accounts
present in the users database.
This option prints a list of user/uid pairs separated by
the ':' character.</para>
<para>Example: <command>pdbedit -l</command></para>
<para><screen>
sorce:500:Simo Sorce
samba:45:Test User
</screen></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem><para>This option enables the verbose listing format.
It causes pdbedit to list the users in the database, printing
out the account fields in a descriptive format.</para>
<para>Example: <command>pdbedit -l -v</command></para>
<para><screen>
---------------
username: sorce
user ID/Group: 500/500
user RID/GRID: 2000/2001
Full Name: Simo Sorce
Home Directory: \\BERSERKER\sorce
HomeDir Drive: H:
Logon Script: \\BERSERKER\netlogon\sorce.bat
Profile Path: \\BERSERKER\profile
---------------
username: samba
user ID/Group: 45/45
user RID/GRID: 1090/1091
Full Name: Test User
Home Directory: \\BERSERKER\samba
HomeDir Drive:
Logon Script:
Profile Path: \\BERSERKER\profile
</screen></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-w</term>
<listitem><para>This option sets the "smbpasswd" listing format.
It will make pdbedit list the users in the database, printing
out the account fields in a format compatible with the
<filename>smbpasswd</filename> file format. (see the
<citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for details)</para>
<para>Example: <command>pdbedit -l -w</command></para>
<screen>
sorce:500:508818B733CE64BEAAD3B435B51404EE:D2A2418EFC466A8A0F6B1DBB5C3DB80C:[UX ]:LCT-00000000:
samba:45:0F2B255F7B67A7A9AAD3B435B51404EE:BC281CE3F53B6A5146629CD4751D3490:[UX ]:LCT-3BFA1E8D:
</screen>
</listitem>
</varlistentry>
<varlistentry>
<term>-u username</term>
<listitem><para>This option specifies the username to be
used for the operation requested (listing, adding, removing).
It is <emphasis>required</emphasis> in add, remove and modify
operations and <emphasis>optional</emphasis> in list
operations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f fullname</term>
<listitem><para>This option can be used while adding or
modifing a user account. It will specify the user's full
name. </para>
<para>Example: <command>-f "Simo Sorce"</command></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-h homedir</term>
<listitem><para>This option can be used while adding or
modifing a user account. It will specify the user's home
directory network path.</para>
<para>Example: <command>-h "\\\\BERSERKER\\sorce"</command>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-D drive</term>
<listitem><para>This option can be used while adding or
modifing a user account. It will specify the windows drive
letter to be used to map the home directory.</para>
<para>Example: <command>-d "H:"</command>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-S script</term>
<listitem><para>This option can be used while adding or
modifing a user account. It will specify the user's logon
script path.</para>
<para>Example: <command>-s "\\\\BERSERKER\\netlogon\\sorce.bat"</command>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p profile</term>
<listitem><para>This option can be used while adding or
modifing a user account. It will specify the user's profile
directory.</para>
<para>Example: <command>-p "\\\\BERSERKER\\netlogon"</command>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-a</term>
<listitem><para>This option is used to add a user into the
database. This command needs a user name specified with
the -u switch. When adding a new user, pdbedit will also
ask for the password to be used.</para>
<para>Example: <command>pdbedit -a -u sorce</command>
<programlisting>new password:
retype new password
</programlisting>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-m</term>
<listitem><para>This option may only be used in conjunction
with the <parameter>-a</parameter> option. It will make
pdbedit to add a machine trust account instead of a user
account (-u username will provide the machine name).</para>
<para>Example: <command>pdbedit -a -m -u w2k-wks</command>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-x</term>
<listitem><para>This option causes pdbedit to delete an account
from the database. It needs a username specified with the
-u switch.</para>
<para>Example: <command>pdbedit -x -u bob</command></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-i passdb-backend</term>
<listitem><para>Use a different passdb backend to retrieve users
than the one specified in smb.conf. Can be used to import data into
your local user database.</para>
<para>This option will ease migration from one passdb backend to
another.</para>
<para>Example: <command>pdbedit -i smbpasswd:/etc/smbpasswd.old
</command></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-e passdb-backend</term>
<listitem><para>Exports all currently available users to the
specified password database backend.</para>
<para>This option will ease migration from one passdb backend to
another and will ease backing up.</para>
<para>Example: <command>pdbedit -e smbpasswd:/root/samba-users.backup</command></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-g</term>
<listitem><para>If you specify <parameter>-g</parameter>,
then <parameter>-i in-backend -e out-backend</parameter>
applies to the group mapping instead of the user database.</para>
<para>This option will ease migration from one passdb backend to
another and will ease backing up.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-g</term>
<listitem><para>If you specify <parameter>-g</parameter>,
then <parameter>-i in-backend -e out-backend</parameter>
applies to the group mapping instead of the user database.</para>
<para>This option will ease migration from one passdb backend to
another and will ease backing up.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-b passdb-backend</term>
<listitem><para>Use a different default passdb backend. </para>
<para>Example: <command>pdbedit -b xml:/root/pdb-backup.xml -l</command></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-P account-policy</term>
<listitem><para>Display an account policy</para>
<para>Valid policies are: minimum password age, reset count minutes, disconnect time,
user must logon to change password, password history, lockout duration, min password length,
maximum password age and bad lockout attempt.</para>
<para>Example: <command>pdbedit -P "bad lockout attempt"</command></para>
<para><programlisting>
account policy value for bad lockout attempt is 0
</programlisting></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-C account-policy-value</term>
<listitem><para>Sets an account policy to a specified value.
This option may only be used in conjunction
with the <parameter>-P</parameter> option.
</para>
<para>Example: <command>pdbedit -P "bad lockout attempt" -C 3</command></para>
<para><programlisting>
account policy value for bad lockout attempt was 0
account policy value for bad lockout attempt is now 3
</programlisting></para>
</listitem>
</varlistentry>
&stdarg.help;
&popt.common.samba;
</variablelist>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>This command may be used only by root.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 2.2 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook
XML 4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

89
docs/docbook/manpages/profiles.1.xml Normal file
View File

@ -0,0 +1,89 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="profiles.1">
<refmeta>
<refentrytitle>profiles</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>profiles</refname>
<refpurpose>A utility to report and change SIDs in registry files
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>profiles</command>
<arg choice="opt">-v</arg>
<arg choice="opt">-c SID</arg>
<arg choice="opt">-n SID</arg>
<arg choice="req">file</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>profiles</command> is a utility that
reports and changes SIDs in windows registry files. It currently only
supports NT.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>file</term>
<listitem><para>Registry file to view or edit. </para></listitem>
</varlistentry>
<varlistentry>
<term>-v,--verbose</term>
<listitem><para>Increases verbosity of messages.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-c SID1 -n SID2</term>
<listitem><para>Change all occurences of SID1 in <filename>file</filename> by SID2.
</para></listitem>
</varlistentry>
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The profiles man page was written by Jelmer Vernooij. </para>
</refsect1>
</refentry>

471
docs/docbook/manpages/rpcclient.1.xml Normal file
View File

@ -0,0 +1,471 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="rpcclient.1">
<refmeta>
<refentrytitle>rpcclient</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>rpcclient</refname>
<refpurpose>tool for executing client side
MS-RPC functions</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>rpcclient</command>
<arg choice="opt">-A authfile</arg>
<arg choice="opt">-c &lt;command string&gt;</arg>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-l logfile</arg>
<arg choice="opt">-N</arg>
<arg choice="opt">-s &lt;smb config file&gt;</arg>
<arg choice="opt">-U username[%password]</arg>
<arg choice="opt">-W workgroup</arg>
<arg choice="opt">-N</arg>
<arg choice="opt">-I destinationIP</arg>
<arg choice="req">server</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>rpcclient</command> is a utility initially developed
to test MS-RPC functionality in Samba itself. It has undergone
several stages of development and stability. Many system administrators
have now written scripts around it to manage Windows NT clients from
their UNIX workstation. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>server</term>
<listitem><para>NetBIOS name of Server to which to connect.
The server can be any SMB/CIFS server. The name is
resolved using the <ulink url="smb.conf.5.html#NAMERESOLVEORDER">
<parameter>name resolve order</parameter></ulink> line from <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>.</para></listitem>
</varlistentry>
<varlistentry>
<term>-c|--command='command string'</term>
<listitem><para>execute semicolon separated commands (listed
below)) </para></listitem>
</varlistentry>
<varlistentry>
<term>-I IP-address</term>
<listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
It should be specified in standard "a.b.c.d" notation. </para>
<para>Normally the client would attempt to locate a named
SMB/CIFS server by looking it up via the NetBIOS name resolution
mechanism described above in the <parameter>name resolve order</parameter>
parameter above. Using this parameter will force the client
to assume that the server is on the machine with the specified IP
address and the NetBIOS name component of the resource being
connected to will be ignored. </para>
<para>There is no default for this parameter. If not supplied,
it will be determined automatically by the client as described
above. </para></listitem>
</varlistentry>
&popt.common.samba;
&popt.common.credentials;
&popt.common.connection;
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<refsect2>
<title>LSARPC</title>
<variablelist>
<varlistentry><term>lsaquery</term><listitem><para>Query info policy</para></listitem></varlistentry>
<varlistentry><term>lookupsids</term><listitem><para>Resolve a list
of SIDs to usernames.
</para></listitem></varlistentry>
<varlistentry><term>lookupnames</term><listitem><para>Resolve a list
of usernames to SIDs.
</para></listitem></varlistentry>
<varlistentry><term>enumtrusts</term><listitem><para>Enumerate trusted domains</para></listitem></varlistentry>
<varlistentry><term>enumprivs</term><listitem><para>Enumerate privileges</para></listitem></varlistentry>
<varlistentry><term>getdispname</term><listitem><para>Get the privilege name</para></listitem></varlistentry>
<varlistentry><term>lsaenumsid</term><listitem><para>Enumerate the LSA SIDS</para></listitem></varlistentry>
<varlistentry><term>lsaenumprivsaccount</term><listitem><para>Enumerate the privileges of an SID</para></listitem></varlistentry>
<varlistentry><term>lsaenumacctrights</term><listitem><para>Enumerate the rights of an SID</para></listitem></varlistentry>
<varlistentry><term>lsaenumacctwithright</term><listitem><para>Enumerate accounts with a right</para></listitem></varlistentry>
<varlistentry><term>lsaaddacctrights</term><listitem><para>Add rights to an account</para></listitem></varlistentry>
<varlistentry><term>lsaremoveacctrights</term><listitem><para>Remove rights from an account</para></listitem></varlistentry>
<varlistentry><term>lsalookupprivvalue</term><listitem><para>Get a privilege value given its name</para></listitem></varlistentry>
<varlistentry><term>lsaquerysecobj</term><listitem><para>Query LSA security object</para></listitem></varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>LSARPC-DS</title>
<variablelist>
<varlistentry><term>dsroledominfo</term><listitem><para>Get Primary Domain Information</para></listitem></varlistentry>
</variablelist>
<para> </para>
<para><emphasis>DFS</emphasis></para>
<variablelist>
<varlistentry><term>dfsexist</term><listitem><para>Query DFS support</para></listitem></varlistentry>
<varlistentry><term>dfsadd</term><listitem><para>Add a DFS share</para></listitem></varlistentry>
<varlistentry><term>dfsremove</term><listitem><para>Remove a DFS share</para></listitem></varlistentry>
<varlistentry><term>dfsgetinfo</term><listitem><para>Query DFS share info</para></listitem></varlistentry>
<varlistentry><term>dfsenum</term><listitem><para>Enumerate dfs shares</para></listitem></varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>REG</title>
<variablelist>
<varlistentry><term>shutdown</term><listitem><para>Remote Shutdown</para></listitem></varlistentry>
<varlistentry><term>abortshutdown</term><listitem><para>Abort Shutdown</para></listitem></varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>SRVSVC</title>
<variablelist>
<varlistentry><term>srvinfo</term><listitem><para>Server query info</para></listitem></varlistentry>
<varlistentry><term>netshareenum</term><listitem><para>Enumerate shares</para></listitem></varlistentry>
<varlistentry><term>netfileenum</term><listitem><para>Enumerate open files</para></listitem></varlistentry>
<varlistentry><term>netremotetod</term><listitem><para>Fetch remote time of day</para></listitem></varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>SAMR</title>
<variablelist>
<varlistentry><term>queryuser</term><listitem><para>Query user info</para></listitem></varlistentry>
<varlistentry><term>querygroup</term><listitem><para>Query group info</para></listitem></varlistentry>
<varlistentry><term>queryusergroups</term><listitem><para>Query user groups</para></listitem></varlistentry>
<varlistentry><term>querygroupmem</term><listitem><para>Query group membership</para></listitem></varlistentry>
<varlistentry><term>queryaliasmem</term><listitem><para>Query alias membership</para></listitem></varlistentry>
<varlistentry><term>querydispinfo</term><listitem><para>Query display info</para></listitem></varlistentry>
<varlistentry><term>querydominfo</term><listitem><para>Query domain info</para></listitem></varlistentry>
<varlistentry><term>enumdomusers</term><listitem><para>Enumerate domain users</para></listitem></varlistentry>
<varlistentry><term>enumdomgroups</term><listitem><para>Enumerate domain groups</para></listitem></varlistentry>
<varlistentry><term>enumalsgroups</term><listitem><para>Enumerate alias groups</para></listitem></varlistentry>
<varlistentry><term>createdomuser</term><listitem><para>Create domain user</para></listitem></varlistentry>
<varlistentry><term>samlookupnames</term><listitem><para>Look up names</para></listitem></varlistentry>
<varlistentry><term>samlookuprids</term><listitem><para>Look up names</para></listitem></varlistentry>
<varlistentry><term>deletedomuser</term><listitem><para>Delete domain user</para></listitem></varlistentry>
<varlistentry><term>samquerysecobj</term><listitem><para>Query SAMR security object</para></listitem></varlistentry>
<varlistentry><term>getdompwinfo</term><listitem><para>Retrieve domain password info</para></listitem></varlistentry>
<varlistentry><term>lookupdomain</term><listitem><para>Look up domain</para></listitem></varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>SPOOLSS</title>
<variablelist>
<varlistentry><term>adddriver &lt;arch&gt; &lt;config&gt;</term>
<listitem><para>
Execute an AddPrinterDriver() RPC to install the printer driver
information on the server. Note that the driver files should
already exist in the directory returned by
<command>getdriverdir</command>. Possible values for
<parameter>arch</parameter> are the same as those for
the <command>getdriverdir</command> command.
The <parameter>config</parameter> parameter is defined as
follows: </para>
<para><programlisting>
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
</programlisting></para>
<para>Any empty fields should be enter as the string "NULL". </para>
<para>Samba does not need to support the concept of Print Monitors
since these only apply to local printers whose driver can make
use of a bi-directional link for communication. This field should
be "NULL". On a remote NT print server, the Print Monitor for a
driver must already be installed prior to adding the driver or
else the RPC will fail. </para></listitem></varlistentry>
<varlistentry><term>addprinter &lt;printername&gt;
&lt;sharename&gt; &lt;drivername&gt; &lt;port&gt;</term>
<listitem><para>
Add a printer on the remote server. This printer
will be automatically shared. Be aware that the printer driver
must already be installed on the server (see <command>adddriver</command>)
and the <parameter>port</parameter>must be a valid port name (see
<command>enumports</command>.</para>
</listitem></varlistentry>
<varlistentry><term>deldriver</term><listitem><para>Delete the
specified printer driver for all architectures. This
does not delete the actual driver files from the server,
only the entry from the server's list of drivers.
</para></listitem></varlistentry>
<varlistentry><term>enumdata</term><listitem><para>Enumerate all
printer setting data stored on the server. On Windows NT clients,
these values are stored in the registry, while Samba servers
store them in the printers TDB. This command corresponds
to the MS Platform SDK GetPrinterData() function (* This
command is currently unimplemented).</para></listitem></varlistentry>
<varlistentry><term>enumdataex</term><listitem><para>Enumerate printer data for a key</para></listitem></varlistentry>
<varlistentry><term>enumjobs &lt;printer&gt;</term>
<listitem><para>List the jobs and status of a given printer.
This command corresponds to the MS Platform SDK EnumJobs()
function</para></listitem></varlistentry>
<varlistentry><term>enumkey</term><listitem><para>Enumerate
printer keys</para></listitem></varlistentry>
<varlistentry><term>enumports [level]</term>
<listitem><para>
Executes an EnumPorts() call using the specified
info level. Currently only info levels 1 and 2 are supported.
</para></listitem></varlistentry>
<varlistentry><term>enumdrivers [level]</term>
<listitem><para>
Execute an EnumPrinterDrivers() call. This lists the various installed
printer drivers for all architectures. Refer to the MS Platform SDK
documentation for more details of the various flags and calling
options. Currently supported info levels are 1, 2, and 3.</para></listitem></varlistentry>
<varlistentry><term>enumprinters [level]</term>
<listitem><para>Execute an EnumPrinters() call. This lists the various installed
and share printers. Refer to the MS Platform SDK documentation for
more details of the various flags and calling options. Currently
supported info levels are 0, 1, and 2.</para></listitem></varlistentry>
<varlistentry><term>getdata &lt;printername&gt; &lt;valuename;&gt;</term>
<listitem><para>Retrieve the data for a given printer setting. See
the <command>enumdata</command> command for more information.
This command corresponds to the GetPrinterData() MS Platform
SDK function. </para></listitem></varlistentry>
<varlistentry><term>getdataex</term><listitem><para>Get
printer driver data with
keyname</para></listitem></varlistentry>
<varlistentry><term>getdriver &lt;printername&gt;</term>
<listitem><para>
Retrieve the printer driver information (such as driver file,
config file, dependent files, etc...) for
the given printer. This command corresponds to the GetPrinterDriver()
MS Platform SDK function. Currently info level 1, 2, and 3 are supported.
</para></listitem></varlistentry>
<varlistentry><term>getdriverdir &lt;arch&gt;</term>
<listitem><para>
Execute a GetPrinterDriverDirectory()
RPC to retrieve the SMB share name and subdirectory for
storing printer driver files for a given architecture. Possible
values for <parameter>arch</parameter> are "Windows 4.0"
(for Windows 95/98), "Windows NT x86", "Windows NT PowerPC", "Windows
Alpha_AXP", and "Windows NT R4000". </para></listitem></varlistentry>
<varlistentry><term>getprinter &lt;printername&gt;</term>
<listitem><para>Retrieve the current printer information. This command
corresponds to the GetPrinter() MS Platform SDK function.
</para></listitem></varlistentry>
<varlistentry><term>getprintprocdir</term><listitem><para>Get
print processor
directory</para></listitem></varlistentry>
<varlistentry><term>openprinter &lt;printername&gt;</term>
<listitem><para>Execute an OpenPrinterEx() and ClosePrinter() RPC
against a given printer. </para></listitem></varlistentry>
<varlistentry><term>setdriver &lt;printername&gt;
&lt;drivername&gt;</term>
<listitem><para>Execute a SetPrinter() command to update the printer driver
associated with an installed printer. The printer driver must
already be correctly installed on the print server. </para>
<para>See also the <command>enumprinters</command> and
<command>enumdrivers</command> commands for obtaining a list of
of installed printers and drivers.</para></listitem></varlistentry>
<varlistentry><term>addform</term><listitem><para>Add form</para></listitem></varlistentry>
<varlistentry><term>setform</term><listitem><para>Set form</para></listitem></varlistentry>
<varlistentry><term>getform</term><listitem><para>Get form</para></listitem></varlistentry>
<varlistentry><term>deleteform</term><listitem><para>Delete form</para></listitem></varlistentry>
<varlistentry><term>enumforms</term><listitem><para>Enumerate form</para></listitem></varlistentry>
<varlistentry><term>setprinter</term><listitem><para>Set printer comment</para></listitem></varlistentry>
<varlistentry><term>setprinterdata</term><listitem><para>Set REG_SZ printer data</para></listitem></varlistentry>
<varlistentry><term>rffpcnex</term><listitem><para>Rffpcnex test</para></listitem></varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>NETLOGON</title>
<variablelist>
<varlistentry><term>logonctrl2</term>
<listitem><para>Logon Control 2</para></listitem>
</varlistentry>
<varlistentry><term>logonctrl</term>
<listitem><para>Logon Control</para></listitem>
</varlistentry>
<varlistentry><term>samsync</term>
<listitem><para>Sam Synchronisation</para></listitem>
</varlistentry>
<varlistentry><term>samdeltas</term>
<listitem><para>Query Sam Deltas</para></listitem>
</varlistentry>
<varlistentry><term>samlogon</term>
<listitem><para>Sam Logon</para></listitem>
</varlistentry>
</variablelist>
</refsect2>
<refsect2>
<title>GENERAL COMMANDS</title>
<variablelist>
<varlistentry><term>debuglevel</term><listitem><para>Set the current
debug level used to log information.</para></listitem></varlistentry>
<varlistentry><term>help (?)</term><listitem><para>Print a listing of all
known commands or extended help on a particular command.
</para></listitem></varlistentry>
<varlistentry><term>quit (exit)</term><listitem><para>Exit <command>rpcclient
</command>.</para></listitem></varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
<title>BUGS</title>
<para><command>rpcclient</command> is designed as a developer testing tool
and may not be robust in certain areas (such as command line parsing).
It has been known to generate a core dump upon failures when invalid
parameters where passed to the interpreter. </para>
<para>From Luke Leighton's original rpcclient man page:</para>
<para><emphasis>WARNING!</emphasis> The MSRPC over SMB code has
been developed from examining Network traces. No documentation is
available from the original creators (Microsoft) on how MSRPC over
SMB works, or how the individual MSRPC services work. Microsoft's
implementation of these services has been demonstrated (and reported)
to be... a bit flaky in places. </para>
<para>The development of Samba's implementation is also a bit rough,
and as more of the services are understood, it can even result in
versions of <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>rpcclient</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> that are incompatible for some commands or services. Additionally,
the developers are sending reports to Microsoft, and problems found
or reported to Microsoft are fixed in Service Packs, which may
result in incompatibilities.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original rpcclient man page was written by Matthew
Geddes, Luke Kenneth Casson Leighton, and rewritten by Gerald Carter.
The conversion to DocBook for Samba 2.2 was done by Gerald
Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was
done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

378
docs/docbook/manpages/samba.7.xml Normal file
View File

@ -0,0 +1,378 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="samba.7">
<refmeta>
<refentrytitle>samba</refentrytitle>
<manvolnum>7</manvolnum>
</refmeta>
<refnamediv>
<refname>Samba</refname>
<refpurpose>A Windows SMB/CIFS fileserver for UNIX</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis><command>Samba</command></cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>The Samba software suite is a collection of programs
that implements the Server Message Block (commonly abbreviated
as SMB) protocol for UNIX systems. This protocol is sometimes
also referred to as the Common Internet File System (CIFS). For a
more thorough description, see <ulink url="http://www.ubiqx.org/cifs/">
http://www.ubiqx.org/cifs/</ulink>. Samba also implements the NetBIOS
protocol in nmbd.</para>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para>The <command>smbd</command> daemon provides the file and print services to
SMB clients, such as Windows 95/98, Windows NT, Windows
for Workgroups or LanManager. The configuration file
for this daemon is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para>The <command>nmbd</command>
daemon provides NetBIOS nameservice and browsing
support. The configuration file for this daemon
is described in <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbclient</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>smbclient</command>
program implements a simple ftp-like client. This
is useful for accessing SMB shares on other compatible
servers (such as Windows NT), and can also be used
to allow a UNIX box to print to a printer attached to
any SMB server (such as a PC running Windows NT).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>testparm</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>testparm</command>
utility is a simple syntax checker for Samba's <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> configuration file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>testprns</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>testprns</command>
utility supports testing printer names defined
in your <filename>printcap</filename> file used
by Samba.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbstatus</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>smbstatus</command>
tool provides access to information about the
current connections to <command>smbd</command>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>nmblookup</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>nmblookup</command>
tools allows NetBIOS name queries to be made
from a UNIX host.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbgroupedit</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para>The <command>smbgroupedit</command>
tool allows for mapping unix groups to NT Builtin,
Domain, or Local groups. Also it allows setting
priviledges for that group, such as saAddUser, etc.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para>The <command>smbpasswd</command>
command is a tool for changing LanMan and Windows NT
password hashes on Samba and Windows NT servers.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbcacls</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>smbcacls</command> command is
a tool to set ACL's on remote CIFS servers. </para>
</listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbsh</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>smbsh</command> command is
a program that allows you to run a unix shell with
with an overloaded VFS.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbtree</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>smbtree</command> command
is a text-based network neighborhood tool.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbtar</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>smbtar</command> can make
backups of data on CIFS/SMB servers.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbspool</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para><command>smbspool</command> is a
helper utility for printing on printers connected
to CIFS servers. </para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbcontrol</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>smbcontrol</command> is a utility
that can change the behaviour of running samba daemons.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>rpcclient</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>rpcclient</command> is a utility
that can be used to execute RPC commands on remote
CIFS servers.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>pdbedit</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para>The <command>pdbedit</command> command
can be used to maintain the local user database on
a samba server.</para></listitem></varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>findsmb</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para>The <command>findsmb</command> command
can be used to find SMB servers on the local network.
</para></listitem></varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>net</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para>The <command>net</command> command
is supposed to work similar to the DOS/Windows
NET.EXE command.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>swat</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para><command>swat</command> is a web-based
interface to configuring <filename>smb.conf</filename>.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></term>
<listitem><para><command>winbindd</command> is a daemon
that is used for integrating authentication and
the user database into unix.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>wbinfo</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>wbinfo</command> is a utility
that retrieves and stores information related to winbind.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>editreg</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>editreg</command> is a command-line
utility that can edit windows registry files.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>profiles</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>profiles</command> is a command-line
utility that can be used to replace all occurences of
a certain SID with another SID.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>vfstest</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>vfstest</command> is a utility
that can be used to test vfs modules.</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>ntlm_auth</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>ntlm_auth</command> is a helper-utility
for external programs wanting to do NTLM-authentication.
</para></listitem></varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbmount</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbumount</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbmount</refentrytitle><manvolnum>8</manvolnum></citerefentry></term>
<listitem><para><command>smbmount</command>,<command>smbmnt</command> and <command>smbmnt</command> are commands that can be used to
mount CIFS/SMB shares on Linux.
</para></listitem>
</varlistentry>
<varlistentry>
<term><citerefentry><refentrytitle>smbcquotas</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></term>
<listitem><para><command>smbcquotas</command> is a tool that
can set remote QUOTA's on server with NTFS 5. </para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>COMPONENTS</title>
<para>The Samba suite is made up of several components. Each
component is described in a separate manual page. It is strongly
recommended that you read the documentation that comes with Samba
and the manual pages of those components that you use. If the
manual pages and documents aren't clear enough then please visit
<ulink url="http://devel.samba.org/">http://devel.samba.org</ulink>
for information on how to file a bug report or submit a patch.</para>
<para>If you require help, visit the Samba webpage at
<ulink url="http://samba.org/">http://www.samba.org/</ulink> and
explore the many option available to you.
</para>
</refsect1>
<refsect1>
<title>AVAILABILITY</title>
<para>The Samba software suite is licensed under the
GNU Public License(GPL). A copy of that license should
have come with the package in the file COPYING. You are
encouraged to distribute copies of the Samba suite, but
please obey the terms of this license.</para>
<para>The latest version of the Samba suite can be
obtained via anonymous ftp from samba.org in the
directory pub/samba/. It is also available on several
mirror sites worldwide.</para>
<para>You may also find useful information about Samba
on the newsgroup <ulink url="news:comp.protocols.smb">
comp.protocol.smb</ulink> and the Samba mailing
list. Details on how to join the mailing list are given in
the README file that comes with Samba.</para>
<para>If you have access to a WWW viewer (such as Mozilla
or Konqueror) then you will also find lots of useful information,
including back issues of the Samba mailing list, at
<ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the
Samba suite. </para>
</refsect1>
<refsect1>
<title>CONTRIBUTIONS</title>
<para>If you wish to contribute to the Samba project,
then I suggest you join the Samba mailing list at
<ulink url="http://lists.samba.org/">http://lists.samba.org</ulink>.
</para>
<para>If you have patches to submit, visit
<ulink url="http://devel.samba.org/">http://devel.samba.org/</ulink>
for information on how to do it properly. We prefer patches
in <command>diff -u</command> format.</para>
</refsect1>
<refsect1>
<title>CONTRIBUTORS</title>
<para>Contributors to the project are now too numerous
to mention here but all deserve the thanks of all Samba
users. To see a full list, look at <ulink
url="ftp://samba.org/pub/samba/alpha/change-log">
ftp://samba.org/pub/samba/alpha/change-log</ulink>
for the pre-CVS changes and at <ulink
url="ftp://samba.org/pub/samba/alpha/cvs.log">
ftp://samba.org/pub/samba/alpha/cvs.log</ulink>
for the contributors to Samba post-CVS. CVS is the Open Source
source code control system used by the Samba Team to develop
Samba. The project would have been unmanageable without it.</para>
<para>In addition, several commercial organizations now help
fund the Samba Team with money and equipment. For details see
the Samba Web pages at <ulink
url="http://samba.org/samba/samba-thanks.html">
http://samba.org/samba/samba-thanks.html</ulink>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML
4.2 for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

264
docs/docbook/manpages/smbcacls.1.xml Normal file
View File

@ -0,0 +1,264 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbcacls.1">
<refmeta>
<refentrytitle>smbcacls</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbcacls</refname>
<refpurpose>Set or get ACLs on an NT file or directory names</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbcacls</command>
<arg choice="req">//server/share</arg>
<arg choice="req">filename</arg>
<arg choice="opt">-D acls</arg>
<arg choice="opt">-M acls</arg>
<arg choice="opt">-A acls</arg>
<arg choice="opt">-S acls</arg>
<arg choice="opt">-C name</arg>
<arg choice="opt">-G name</arg>
<arg choice="opt">-n</arg>
<arg choice="opt">-t</arg>
<arg choice="opt">-U username</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-d</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>smbcacls</command> program manipulates NT Access Control
Lists (ACLs) on SMB file shares. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available to the <command>smbcacls</command> program.
The format of ACLs is described in the section ACL FORMAT </para>
<variablelist>
<varlistentry>
<term>-A acls</term>
<listitem><para>Add the ACLs specified to the ACL list. Existing
access control entries are unchanged. </para></listitem>
</varlistentry>
<varlistentry>
<term>-M acls</term>
<listitem><para>Modify the mask value (permissions) for the ACLs
specified on the command line. An error will be printed for each
ACL specified that was not already present in the ACL list
</para></listitem>
</varlistentry>
<varlistentry>
<term>-D acls</term>
<listitem><para>Delete any ACLs specified on the command line.
An error will be printed for each ACL specified that was not
already present in the ACL list. </para></listitem>
</varlistentry>
<varlistentry>
<term>-S acls</term>
<listitem><para>This command sets the ACLs on the file with
only the ones specified on the command line. All other ACLs are
erased. Note that the ACL specified must contain at least a revision,
type, owner and group for the call to succeed. </para></listitem>
</varlistentry>
<varlistentry>
<term>-U username</term>
<listitem><para>Specifies a username used to connect to the
specified service. The username may be of the form "username" in
which case the user is prompted to enter in a password and the
workgroup specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file is
used, or "username%password" or "DOMAIN\username%password" and the
password and workgroup names are used as provided. </para></listitem>
</varlistentry>
<varlistentry>
<term>-C name</term>
<listitem><para>The owner of a file or directory can be changed
to the name given using the <parameter>-C</parameter> option.
The name can be a sid in the form S-1-x-y-z or a name resolved
against the server specified in the first argument. </para>
<para>This command is a shortcut for -M OWNER:name.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-G name</term>
<listitem><para>The group owner of a file or directory can
be changed to the name given using the <parameter>-G</parameter>
option. The name can be a sid in the form S-1-x-y-z or a name
resolved against the server specified n the first argument.
</para>
<para>This command is a shortcut for -M GROUP:name.</para></listitem>
</varlistentry>
<varlistentry>
<term>-n</term>
<listitem><para>This option displays all ACL information in numeric
format. The default is to convert SIDs to names and ACE types
and masks to a readable string format. </para></listitem>
</varlistentry>
<varlistentry>
<term>-t</term>
<listitem><para>
Don't actually do anything, only validate the correctness of
the arguments.
</para></listitem>
</varlistentry>
&stdarg.help;
&popt.common.samba;
</variablelist>
</refsect1>
<refsect1>
<title>ACL FORMAT</title>
<para>The format of an ACL is one or more ACL entries separated by
either commas or newlines. An ACL entry is one of the following: </para>
<para><programlisting>
REVISION:&lt;revision number&gt;
OWNER:&lt;sid or name&gt;
GROUP:&lt;sid or name&gt;
ACL:&lt;sid or name&gt;:&lt;type&gt;/&lt;flags&gt;/&lt;mask&gt;
</programlisting></para>
<para>The revision of the ACL specifies the internal Windows
NT ACL revision for the security descriptor.
If not specified it defaults to 1. Using values other than 1 may
cause strange behaviour. </para>
<para>The owner and group specify the owner and group sids for the
object. If a SID in the format CWS-1-x-y-z is specified this is used,
otherwise the name specified is resolved using the server on which
the file or directory resides. </para>
<para>ACLs specify permissions granted to the SID. This SID again
can be specified in CWS-1-x-y-z format or as a name in which case
it is resolved against the server on which the file or directory
resides. The type, flags and mask values determine the type of
access granted to the SID. </para>
<para>The type can be either 0 or 1 corresponding to ALLOWED or
DENIED access to the SID. The flags values are generally
zero for file ACLs and either 9 or 2 for directory ACLs. Some
common flags are: </para>
<itemizedlist>
<listitem><para><constant>#define SEC_ACE_FLAG_OBJECT_INHERIT 0x1</constant></para></listitem>
<listitem><para><constant>#define SEC_ACE_FLAG_CONTAINER_INHERIT 0x2</constant></para></listitem>
<listitem><para><constant>#define SEC_ACE_FLAG_NO_PROPAGATE_INHERIT 0x4</constant></para></listitem>
<listitem><para><constant>#define SEC_ACE_FLAG_INHERIT_ONLY 0x8</constant></para></listitem>
</itemizedlist>
<para>At present flags can only be specified as decimal or
hexadecimal values.</para>
<para>The mask is a value which expresses the access right
granted to the SID. It can be given as a decimal or hexadecimal value,
or by using one of the following text strings which map to the NT
file permissions of the same name. </para>
<itemizedlist>
<listitem><para><emphasis>R</emphasis> - Allow read access </para></listitem>
<listitem><para><emphasis>W</emphasis> - Allow write access</para></listitem>
<listitem><para><emphasis>X</emphasis> - Execute permission on the object</para></listitem>
<listitem><para><emphasis>D</emphasis> - Delete the object</para></listitem>
<listitem><para><emphasis>P</emphasis> - Change permissions</para></listitem>
<listitem><para><emphasis>O</emphasis> - Take ownership</para></listitem>
</itemizedlist>
<para>The following combined permissions can be specified:</para>
<itemizedlist>
<listitem><para><emphasis>READ</emphasis> - Equivalent to 'RX'
permissions</para></listitem>
<listitem><para><emphasis>CHANGE</emphasis> - Equivalent to 'RXWD' permissions
</para></listitem>
<listitem><para><emphasis>FULL</emphasis> - Equivalent to 'RWXDPO'
permissions</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<para>The <command>smbcacls</command> program sets the exit status
depending on the success or otherwise of the operations performed.
The exit status may be one of the following values. </para>
<para>If the operation succeeded, smbcacls returns and exit
status of 0. If <command>smbcacls</command> couldn't connect to the specified server,
or there was an error getting or setting the ACLs, an exit status
of 1 is returned. If there was an error parsing any command line
arguments, an exit status of 2 is returned. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para><command>smbcacls</command> was written by Andrew Tridgell
and Tim Potter.</para>
<para>The conversion to DocBook for Samba 2.2 was done
by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0 was done
by Alexander Bokovoy.</para>
</refsect1>
</refentry>

958
docs/docbook/manpages/smbclient.1.xml Normal file
View File

@ -0,0 +1,958 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbclient.1">
<refmeta>
<refentrytitle>smbclient</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbclient</refname>
<refpurpose>ftp-like client to access SMB/CIFS resources
on servers</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbclient</command>
<arg choice="req">servicename</arg>
<arg choice="opt">password</arg>
<arg choice="opt">-b &lt;buffer size&gt;</arg>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-D Directory</arg>
<arg choice="opt">-U username</arg>
<arg choice="opt">-W workgroup</arg>
<arg choice="opt">-M &lt;netbios name&gt;</arg>
<arg choice="opt">-m maxprotocol</arg>
<arg choice="opt">-A authfile</arg>
<arg choice="opt">-N</arg>
<arg choice="opt">-l logfile</arg>
<arg choice="opt">-L &lt;netbios name&gt;</arg>
<arg choice="opt">-I destinationIP</arg>
<arg choice="opt">-E</arg>
<arg choice="opt">-c &lt;command string&gt;</arg>
<arg choice="opt">-i scope</arg>
<arg choice="opt">-O &lt;socket options&gt;</arg>
<arg choice="opt">-p port</arg>
<arg choice="opt">-R &lt;name resolve order&gt;</arg>
<arg choice="opt">-s &lt;smb config file&gt;</arg>
<arg choice="opt">-T&lt;c|x&gt;IXFqgbNan</arg>
<arg choice="opt">-k</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbclient</command> is a client that can
'talk' to an SMB/CIFS server. It offers an interface
similar to that of the ftp program (see <citerefentry><refentrytitle>ftp</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>).
Operations include things like getting files from the server
to the local machine, putting files from the local machine to
the server, retrieving directory information from the server
and so on. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>servicename</term>
<listitem><para>servicename is the name of the service
you want to use on the server. A service name takes the form
<filename>//server/service</filename> where <parameter>server
</parameter> is the NetBIOS name of the SMB/CIFS server
offering the desired service and <parameter>service</parameter>
is the name of the service offered. Thus to connect to
the service "printer" on the SMB/CIFS server "smbserver",
you would use the servicename <filename>//smbserver/printer
</filename></para>
<para>Note that the server name required is NOT necessarily
the IP (DNS) host name of the server ! The name required is
a NetBIOS server name, which may or may not be the
same as the IP hostname of the machine running the server.
</para>
<para>The server name is looked up according to either
the <parameter>-R</parameter> parameter to <command>smbclient</command> or
using the name resolve order parameter in
the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file,
allowing an administrator to change the order and methods
by which server names are looked up. </para></listitem>
</varlistentry>
<varlistentry>
<term>password</term>
<listitem><para>The password required to access the specified
service on the specified server. If this parameter is
supplied, the <parameter>-N</parameter> option (suppress
password prompt) is assumed. </para>
<para>There is no default password. If no password is supplied
on the command line (either by using this parameter or adding
a password to the <parameter>-U</parameter> option (see
below)) and the <parameter>-N</parameter> option is not
specified, the client will prompt for a password, even if
the desired service does not require one. (If no password is
required, simply press ENTER to provide a null password.)
</para>
<para>Note: Some servers (including OS/2 and Windows for
Workgroups) insist on an uppercase password. Lowercase
or mixed case passwords may be rejected by these servers.
</para>
<para>Be cautious about including passwords in scripts.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-R &lt;name resolve order&gt;</term>
<listitem><para>This option is used by the programs in the Samba
suite to determine what naming services and in what order to resolve
host names to IP addresses. The option takes a space-separated
string of different name resolution options.</para>
<para>The options are :"lmhosts", "host", "wins" and "bcast". They
cause names to be resolved as follows:</para>
<itemizedlist>
<listitem><para><constant>lmhosts</constant>: Lookup an IP
address in the Samba lmhosts file. If the line in lmhosts has
no name type attached to the NetBIOS name (see
the <citerefentry><refentrytitle>lmhosts</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for details) then
any name type matches for lookup.</para>
</listitem>
<listitem><para><constant>host</constant>: Do a standard host
name to IP address resolution, using the system <filename>/etc/hosts
</filename>, NIS, or DNS lookups. This method of name resolution
is operating system dependent, for instance on IRIX or Solaris this
may be controlled by the <filename>/etc/nsswitch.conf</filename>
file). Note that this method is only used if the NetBIOS name
type being queried is the 0x20 (server) name type, otherwise
it is ignored.</para>
</listitem>
<listitem><para><constant>wins</constant>: Query a name with
the IP address listed in the <parameter>wins server</parameter>
parameter. If no WINS server has
been specified this method will be ignored.</para>
</listitem>
<listitem><para><constant>bcast</constant>: Do a broadcast on
each of the known local interfaces listed in the
<parameter>interfaces</parameter>
parameter. This is the least reliable of the name resolution
methods as it depends on the target host being on a locally
connected subnet.</para>
</listitem>
</itemizedlist>
<para>If this parameter is not set then the name resolve order
defined in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file parameter
(name resolve order) will be used. </para>
<para>The default order is lmhosts, host, wins, bcast and without
this parameter or any entry in the <parameter>name resolve order
</parameter> parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file the name resolution
methods will be attempted in this order. </para></listitem>
</varlistentry>
<varlistentry>
<term>-M NetBIOS name</term>
<listitem><para>This options allows you to send messages, using
the "WinPopup" protocol, to another computer. Once a connection is
established you then type your message, pressing ^D (control-D) to
end. </para>
<para>If the receiving computer is running WinPopup the user will
receive the message and probably a beep. If they are not running
WinPopup the message will be lost, and no error message will
occur. </para>
<para>The message is also automatically truncated if the message
is over 1600 bytes, as this is the limit of the protocol.
</para>
<para>One useful trick is to cat the message through
<command>smbclient</command>. For example: <command>
cat mymessage.txt | smbclient -M FRED </command> will
send the message in the file <filename>mymessage.txt</filename>
to the machine FRED. </para>
<para>You may also find the <parameter>-U</parameter> and
<parameter>-I</parameter> options useful, as they allow you to
control the FROM and TO parts of the message. </para>
<para>See the <parameter>message command</parameter> parameter in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for a description of how to handle incoming
WinPopup messages in Samba. </para>
<para><emphasis>Note</emphasis>: Copy WinPopup into the startup group
on your WfWg PCs if you want them to always be able to receive
messages. </para></listitem>
</varlistentry>
<varlistentry>
<term>-p port</term>
<listitem><para>This number is the TCP port number that will be used
when making connections to the server. The standard (well-known)
TCP port number for an SMB/CIFS server is 139, which is the
default. </para></listitem>
</varlistentry>
<varlistentry>
<term>-l logfilename</term>
<listitem><para>If specified, <replaceable>logfilename</replaceable> specifies a base filename
into which operational data from the running client will be
logged. </para>
<para>The default base name is specified at compile time.</para>
<para>The base name is used to generate actual log file names.
For example, if the name specified was "log", the debug file
would be <filename>log.client</filename>.</para>
<para>The log file generated is never removed by the client.
</para></listitem>
</varlistentry>
&stdarg.help;
<varlistentry>
<term>-I IP-address</term>
<listitem><para><replaceable>IP address</replaceable> is the address of the server to connect to.
It should be specified in standard "a.b.c.d" notation. </para>
<para>Normally the client would attempt to locate a named
SMB/CIFS server by looking it up via the NetBIOS name resolution
mechanism described above in the <parameter>name resolve order</parameter>
parameter above. Using this parameter will force the client
to assume that the server is on the machine with the specified IP
address and the NetBIOS name component of the resource being
connected to will be ignored. </para>
<para>There is no default for this parameter. If not supplied,
it will be determined automatically by the client as described
above. </para></listitem>
</varlistentry>
<varlistentry>
<term>-E</term>
<listitem><para>This parameter causes the client to write messages
to the standard error stream (stderr) rather than to the standard
output stream. </para>
<para>By default, the client writes messages to standard output
- typically the user's tty. </para></listitem>
</varlistentry>
<varlistentry>
<term>-L</term>
<listitem><para>This option allows you to look at what services
are available on a server. You use it as <command>smbclient -L
host</command> and a list should appear. The <parameter>-I
</parameter> option may be useful if your NetBIOS names don't
match your TCP/IP DNS host names or if you are trying to reach a
host on another network. </para></listitem>
</varlistentry>
<varlistentry>
<term>-t terminal code</term>
<listitem><para>This option tells <command>smbclient</command> how to interpret
filenames coming from the remote server. Usually Asian language
multibyte UNIX implementations use different character sets than
SMB/CIFS servers (<emphasis>EUC</emphasis> instead of <emphasis>
SJIS</emphasis> for example). Setting this parameter will let
<command>smbclient</command> convert between the UNIX filenames and
the SMB filenames correctly. This option has not been seriously tested
and may have some problems. </para>
<para>The terminal codes include CWsjis, CWeuc, CWjis7, CWjis8,
CWjunet, CWhex, CWcap. This is not a complete list, check the Samba
source code for the complete list. </para></listitem>
</varlistentry>
<varlistentry>
<term>-b buffersize</term>
<listitem><para>This option changes the transmit/send buffer
size when getting or putting a file from/to the server. The default
is 65520 bytes. Setting this value smaller (to 1200 bytes) has been
observed to speed up file transfers to and from a Win9x server.
</para></listitem>
</varlistentry>
&popt.common.samba;
&popt.common.credentials;
&popt.common.connection;
<varlistentry>
<term>-T tar options</term>
<listitem><para>smbclient may be used to create <command>tar(1)
</command> compatible backups of all the files on an SMB/CIFS
share. The secondary tar flags that can be given to this option
are : </para>
<itemizedlist>
<listitem><para><parameter>c</parameter> - Create a tar file on UNIX.
Must be followed by the name of a tar file, tape device
or "-" for standard output. If using standard output you must
turn the log level to its lowest value -d0 to avoid corrupting
your tar file. This flag is mutually exclusive with the
<parameter>x</parameter> flag. </para></listitem>
<listitem><para><parameter>x</parameter> - Extract (restore) a local
tar file back to a share. Unless the -D option is given, the tar
files will be restored from the top level of the share. Must be
followed by the name of the tar file, device or "-" for standard
input. Mutually exclusive with the <parameter>c</parameter> flag.
Restored files have their creation times (mtime) set to the
date saved in the tar file. Directories currently do not get
their creation dates restored properly. </para></listitem>
<listitem><para><parameter>I</parameter> - Include files and directories.
Is the default behavior when filenames are specified above. Causes
tar files to be included in an extract or create (and therefore
everything else to be excluded). See example below. Filename globbing
works in one of two ways. See r below. </para></listitem>
<listitem><para><parameter>X</parameter> - Exclude files and directories.
Causes tar files to be excluded from an extract or create. See
example below. Filename globbing works in one of two ways now.
See <parameter>r</parameter> below. </para></listitem>
<listitem><para><parameter>b</parameter> - Blocksize. Must be followed
by a valid (greater than zero) blocksize. Causes tar file to be
written out in blocksize*TBLOCK (usually 512 byte) blocks.
</para></listitem>
<listitem><para><parameter>g</parameter> - Incremental. Only back up
files that have the archive bit set. Useful only with the
<parameter>c</parameter> flag. </para></listitem>
<listitem><para><parameter>q</parameter> - Quiet. Keeps tar from printing
diagnostics as it works. This is the same as tarmode quiet.
</para></listitem>
<listitem><para><parameter>r</parameter> - Regular expression include
or exclude. Uses regular expression matching for
excluding or excluding files if compiled with HAVE_REGEX_H.
However this mode can be very slow. If not compiled with
HAVE_REGEX_H, does a limited wildcard match on '*' and '?'.
</para></listitem>
<listitem><para><parameter>N</parameter> - Newer than. Must be followed
by the name of a file whose date is compared against files found
on the share during a create. Only files newer than the file
specified are backed up to the tar file. Useful only with the
<parameter>c</parameter> flag. </para></listitem>
<listitem><para><parameter>a</parameter> - Set archive bit. Causes the
archive bit to be reset when a file is backed up. Useful with the
<parameter>g</parameter> and <parameter>c</parameter> flags.
</para></listitem>
</itemizedlist>
<para><emphasis>Tar Long File Names</emphasis></para>
<para><command>smbclient</command>'s tar option now supports long
file names both on backup and restore. However, the full path
name of the file must be less than 1024 bytes. Also, when
a tar archive is created, <command>smbclient</command>'s tar option places all
files in the archive with relative names, not absolute names.
</para>
<para><emphasis>Tar Filenames</emphasis></para>
<para>All file names can be given as DOS path names (with '\\'
as the component separator) or as UNIX path names (with '/' as
the component separator). </para>
<para><emphasis>Examples</emphasis></para>
<para>Restore from tar file <filename>backup.tar</filename> into myshare on mypc
(no password on share). </para>
<para><command>smbclient //mypc/yshare "" -N -Tx backup.tar
</command></para>
<para>Restore everything except <filename>users/docs</filename>
</para>
<para><command>smbclient //mypc/myshare "" -N -TXx backup.tar
users/docs</command></para>
<para>Create a tar file of the files beneath <filename>
users/docs</filename>. </para>
<para><command>smbclient //mypc/myshare "" -N -Tc
backup.tar users/docs </command></para>
<para>Create the same tar file as above, but now use
a DOS path name. </para>
<para><command>smbclient //mypc/myshare "" -N -tc backup.tar
users\edocs </command></para>
<para>Create a tar file of all the files and directories in
the share. </para>
<para><command>smbclient //mypc/myshare "" -N -Tc backup.tar *
</command></para>
</listitem>
</varlistentry>
<varlistentry>
<term>-D initial directory</term>
<listitem><para>Change to initial directory before starting. Probably
only of any use with the tar -T option. </para></listitem>
</varlistentry>
<varlistentry>
<term>-c command string</term>
<listitem><para>command string is a semicolon-separated list of
commands to be executed instead of prompting from stdin. <parameter>
-N</parameter> is implied by <parameter>-c</parameter>.</para>
<para>This is particularly useful in scripts and for printing stdin
to the server, e.g. <command>-c 'print -'</command>. </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>OPERATIONS</title>
<para>Once the client is running, the user is presented with
a prompt : </para>
<para><prompt>smb:\&gt; </prompt></para>
<para>The backslash ("\\") indicates the current working directory
on the server, and will change if the current working directory
is changed. </para>
<para>The prompt indicates that the client is ready and waiting to
carry out a user command. Each command is a single word, optionally
followed by parameters specific to that command. Command and parameters
are space-delimited unless these notes specifically
state otherwise. All commands are case-insensitive. Parameters to
commands may or may not be case sensitive, depending on the command.
</para>
<para>You can specify file names which have spaces in them by quoting
the name with double quotes, for example "a long file name". </para>
<para>Parameters shown in square brackets (e.g., "[parameter]") are
optional. If not given, the command will use suitable defaults. Parameters
shown in angle brackets (e.g., "&lt;parameter&gt;") are required.
</para>
<para>Note that all commands operating on the server are actually
performed by issuing a request to the server. Thus the behavior may
vary from server to server, depending on how the server was implemented.
</para>
<para>The commands available are given here in alphabetical order. </para>
<variablelist>
<varlistentry>
<term>? [command]</term>
<listitem><para>If <replaceable>command</replaceable> is specified, the ? command will display
a brief informative message about the specified command. If no
command is specified, a list of available commands will
be displayed. </para></listitem>
</varlistentry>
<varlistentry>
<term>! [shell command]</term>
<listitem><para>If <replaceable>shell command</replaceable> is specified, the !
command will execute a shell locally and run the specified shell
command. If no command is specified, a local shell will be run.
</para></listitem>
</varlistentry>
<varlistentry>
<term>altname file</term>
<listitem><para>The client will request that the server return
the "alternate" name (the 8.3 name) for a file or directory.
</para></listitem>
</varlistentry>
<varlistentry>
<term>cancel jobid0 [jobid1] ... [jobidN]</term>
<listitem><para>The client will request that the server cancel
the printjobs identified by the given numeric print job ids.
</para></listitem>
</varlistentry>
<varlistentry>
<term>chmod file mode in octal</term>
<listitem><para>This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
change the UNIX permissions to the given octal mode, in standard UNIX format.
</para></listitem>
</varlistentry>
<varlistentry>
<term>chown file uid gid</term>
<listitem><para>This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
change the UNIX user and group ownership to the given decimal values. Note there is
currently no way to remotely look up the UNIX uid and gid values for a given name.
This may be addressed in future versions of the CIFS UNIX extensions.
</para></listitem>
</varlistentry>
<varlistentry>
<term>cd [directory name]</term>
<listitem><para>If "directory name" is specified, the current
working directory on the server will be changed to the directory
specified. This operation will fail if for any reason the specified
directory is inaccessible. </para>
<para>If no directory name is specified, the current working
directory on the server will be reported. </para></listitem>
</varlistentry>
<varlistentry>
<term>del &lt;mask&gt;</term>
<listitem><para>The client will request that the server attempt
to delete all files matching <replaceable>mask</replaceable> from the current working
directory on the server. </para></listitem>
</varlistentry>
<varlistentry>
<term>dir &lt;mask&gt;</term>
<listitem><para>A list of the files matching <replaceable>mask</replaceable> in the current
working directory on the server will be retrieved from the server
and displayed. </para></listitem>
</varlistentry>
<varlistentry>
<term>exit</term>
<listitem><para>Terminate the connection with the server and exit
from the program. </para></listitem>
</varlistentry>
<varlistentry>
<term>get &lt;remote file name&gt; [local file name]</term>
<listitem><para>Copy the file called <filename>remote file name</filename> from
the server to the machine running the client. If specified, name
the local copy <filename>local file name</filename>. Note that all transfers in
<command>smbclient</command> are binary. See also the
lowercase command. </para></listitem>
</varlistentry>
<varlistentry>
<term>help [command]</term>
<listitem><para>See the ? command above. </para></listitem>
</varlistentry>
<varlistentry>
<term>lcd [directory name]</term>
<listitem><para>If <replaceable>directory name</replaceable> is specified, the current
working directory on the local machine will be changed to
the directory specified. This operation will fail if for any
reason the specified directory is inaccessible. </para>
<para>If no directory name is specified, the name of the
current working directory on the local machine will be reported.
</para></listitem>
</varlistentry>
<varlistentry>
<term>link source destination</term>
<listitem><para>This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
create a hard link between the source and destination files. The source file
must not exist.
</para></listitem>
</varlistentry>
<varlistentry>
<term>lowercase</term>
<listitem><para>Toggle lowercasing of filenames for the get and
mget commands. </para>
<para>When lowercasing is toggled ON, local filenames are converted
to lowercase when using the get and mget commands. This is
often useful when copying (say) MSDOS files from a server, because
lowercase filenames are the norm on UNIX systems. </para></listitem>
</varlistentry>
<varlistentry>
<term>ls &lt;mask&gt;</term>
<listitem><para>See the dir command above. </para></listitem>
</varlistentry>
<varlistentry>
<term>mask &lt;mask&gt;</term>
<listitem><para>This command allows the user to set up a mask
which will be used during recursive operation of the mget and
mput commands. </para>
<para>The masks specified to the mget and mput commands act as
filters for directories rather than files when recursion is
toggled ON. </para>
<para>The mask specified with the mask command is necessary
to filter files within those directories. For example, if the
mask specified in an mget command is "source*" and the mask
specified with the mask command is "*.c" and recursion is
toggled ON, the mget command will retrieve all files matching
"*.c" in all directories below and including all directories
matching "source*" in the current working directory. </para>
<para>Note that the value for mask defaults to blank (equivalent
to "*") and remains so until the mask command is used to change it.
It retains the most recently specified value indefinitely. To
avoid unexpected results it would be wise to change the value of
mask back to "*" after using the mget or mput commands. </para></listitem>
</varlistentry>
<varlistentry>
<term>md &lt;directory name&gt;</term>
<listitem><para>See the mkdir command. </para></listitem>
</varlistentry>
<varlistentry>
<term>mget &lt;mask&gt;</term>
<listitem><para>Copy all files matching <replaceable>mask</replaceable> from the server to
the machine running the client. </para>
<para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
operation and non-recursive operation - refer to the recurse and
mask commands for more information. Note that all transfers in
<command>smbclient</command> are binary. See also the lowercase command. </para></listitem>
</varlistentry>
<varlistentry>
<term>mkdir &lt;directory name&gt;</term>
<listitem><para>Create a new directory on the server (user access
privileges permitting) with the specified name. </para></listitem>
</varlistentry>
<varlistentry>
<term>mput &lt;mask&gt;</term>
<listitem><para>Copy all files matching <replaceable>mask</replaceable> in the current working
directory on the local machine to the current working directory on
the server. </para>
<para>Note that <replaceable>mask</replaceable> is interpreted differently during recursive
operation and non-recursive operation - refer to the recurse and mask
commands for more information. Note that all transfers in <command>smbclient</command>
are binary. </para></listitem>
</varlistentry>
<varlistentry>
<term>print &lt;file name&gt;</term>
<listitem><para>Print the specified file from the local machine
through a printable service on the server. </para>
<para>See also the printmode command.</para></listitem>
</varlistentry>
<varlistentry>
<term>printmode &lt;graphics or text&gt;</term>
<listitem><para>Set the print mode to suit either binary data
(such as graphical information) or text. Subsequent print
commands will use the currently set print mode. </para></listitem>
</varlistentry>
<varlistentry>
<term>prompt</term>
<listitem><para>Toggle prompting for filenames during operation
of the mget and mput commands. </para>
<para>When toggled ON, the user will be prompted to confirm
the transfer of each file during these commands. When toggled
OFF, all specified files will be transferred without prompting.
</para></listitem>
</varlistentry>
<varlistentry>
<term>put &lt;local file name&gt; [remote file name]</term>
<listitem><para>Copy the file called <filename>local file name</filename> from the
machine running the client to the server. If specified,
name the remote copy <filename>remote file name</filename>. Note that all transfers
in <command>smbclient</command> are binary. See also the lowercase command.
</para></listitem>
</varlistentry>
<varlistentry>
<term>queue</term>
<listitem><para>Displays the print queue, showing the job id,
name, size and current status. </para></listitem>
</varlistentry>
<varlistentry>
<term>quit</term>
<listitem><para>See the exit command. </para></listitem>
</varlistentry>
<varlistentry>
<term>rd &lt;directory name&gt;</term>
<listitem><para>See the rmdir command. </para></listitem>
</varlistentry>
<varlistentry>
<term>recurse</term>
<listitem><para>Toggle directory recursion for the commands mget
and mput. </para>
<para>When toggled ON, these commands will process all directories
in the source directory (i.e., the directory they are copying
from ) and will recurse into any that match the mask specified
to the command. Only files that match the mask specified using
the mask command will be retrieved. See also the mask command.
</para>
<para>When recursion is toggled OFF, only files from the current
working directory on the source machine that match the mask specified
to the mget or mput commands will be copied, and any mask specified
using the mask command will be ignored. </para></listitem>
</varlistentry>
<varlistentry>
<term>rm &lt;mask&gt;</term>
<listitem><para>Remove all files matching <replaceable>mask</replaceable> from the current
working directory on the server. </para></listitem>
</varlistentry>
<varlistentry>
<term>rmdir &lt;directory name&gt;</term>
<listitem><para>Remove the specified directory (user access
privileges permitting) from the server. </para></listitem>
</varlistentry>
<varlistentry>
<term>setmode &lt;filename&gt; &lt;perm=[+|\-]rsha&gt;</term>
<listitem><para>A version of the DOS attrib command to set
file permissions. For example: </para>
<para><command>setmode myfile +r </command></para>
<para>would make myfile read only. </para></listitem>
</varlistentry>
<varlistentry>
<term>symlink source destination</term>
<listitem><para>This command depends on the server supporting the CIFS
UNIX extensions and will fail if the server does not. The client requests that the server
create a symbolic hard link between the source and destination files. The source file
must not exist. Note that the server will not create a link to any path that lies
outside the currently connected share. This is enforced by the Samba server.
</para></listitem>
</varlistentry>
<varlistentry>
<term>tar &lt;c|x&gt;[IXbgNa]</term>
<listitem><para>Performs a tar operation - see the <parameter>-T
</parameter> command line option above. Behavior may be affected
by the tarmode command (see below). Using g (incremental) and N
(newer) will affect tarmode settings. Note that using the "-" option
with tar x may not work - use the command line option instead.
</para></listitem>
</varlistentry>
<varlistentry>
<term>blocksize &lt;blocksize&gt;</term>
<listitem><para>Blocksize. Must be followed by a valid (greater
than zero) blocksize. Causes tar file to be written out in
<replaceable>blocksize</replaceable>*TBLOCK (usually 512 byte) blocks. </para></listitem>
</varlistentry>
<varlistentry>
<term>tarmode &lt;full|inc|reset|noreset&gt;</term>
<listitem><para>Changes tar's behavior with regard to archive
bits. In full mode, tar will back up everything regardless of the
archive bit setting (this is the default mode). In incremental mode,
tar will only back up files with the archive bit set. In reset mode,
tar will reset the archive bit on all files it backs up (implies
read/write share). </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>Some servers are fussy about the case of supplied usernames,
passwords, share names (AKA service names) and machine names.
If you fail to connect try giving all parameters in uppercase.
</para>
<para>It is often necessary to use the -n option when connecting
to some types of servers. For example OS/2 LanManager insists
on a valid NetBIOS name being used, so you need to supply a valid
name that would be known to the server.</para>
<para>smbclient supports long file names where the server
supports the LANMAN2 protocol or above. </para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The variable <envar>USER</envar> may contain the
username of the person using the client. This information is
used only if the protocol level is high enough to support
session-level passwords.</para>
<para>The variable <envar>PASSWD</envar> may contain
the password of the person using the client. This information is
used only if the protocol level is high enough to support
session-level passwords. </para>
<para>The variable <envar>LIBSMB_PROG</envar> may contain
the path, executed with system(), which the client should connect
to instead of connecting to a server. This functionality is primarily
intended as a development aid, and works best when using a LMHOSTS
file</para>
</refsect1>
<refsect1>
<title>INSTALLATION</title>
<para>The location of the client program is a matter for
individual system administrators. The following are thus
suggestions only. </para>
<para>It is recommended that the smbclient software be installed
in the <filename>/usr/local/samba/bin/</filename> or <filename>
/usr/samba/bin/</filename> directory, this directory readable
by all, writeable only by root. The client program itself should
be executable by all. The client should <emphasis>NOT</emphasis> be
setuid or setgid! </para>
<para>The client log files should be put in a directory readable
and writeable only by the user. </para>
<para>To test the client, you will need to know the name of a
running SMB/CIFS server. It is possible to run <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> as an ordinary user - running that server as a daemon
on a user-accessible port (typically any port number over 1024)
would provide a suitable test server. </para>
</refsect1>
<refsect1>
<title>DIAGNOSTICS</title>
<para>Most diagnostics issued by the client are logged in a
specified log file. The log file name is specified at compile time,
but may be overridden on the command line. </para>
<para>The number and nature of diagnostics available depends
on the debug level used by the client. If you have problems,
set the debug level to 3 and peruse the log files. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 2.2 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

291
docs/docbook/manpages/smbcontrol.1.xml Normal file
View File

@ -0,0 +1,291 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbcontrol.1">
<refmeta>
<refentrytitle>smbcontrol</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbcontrol</refname>
<refpurpose>send messages to smbd, nmbd or winbindd processes</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbcontrol</command>
<arg>-i</arg>
<arg>-s</arg>
</cmdsynopsis>
<cmdsynopsis>
<command>smbcontrol</command>
<arg>destination</arg>
<arg>message-type</arg>
<arg>parameter</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbcontrol</command> is a very small program, which
sends messages to a <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, a <citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, or a <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> daemon running on the system.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
&stdarg.help;
&stdarg.configfile;
<varlistentry>
<term>-i</term>
<listitem><para>Run interactively. Individual commands
of the form destination message-type parameters can be entered
on STDIN. An empty command line or a "q" will quit the
program.</para></listitem>
</varlistentry>
<varlistentry>
<term>destination</term>
<listitem><para>One of <parameter>nmbd</parameter>, <parameter>smbd</parameter> or a process ID.</para>
<para>The <parameter>smbd</parameter> destination causes the
message to "broadcast" to all smbd daemons.</para>
<para>The <parameter>nmbd</parameter> destination causes the
message to be sent to the nmbd daemon specified in the
<filename>nmbd.pid</filename> file.</para>
<para>If a single process ID is given, the message is sent
to only that process.</para></listitem>
</varlistentry>
<varlistentry>
<term>message-type</term>
<listitem><para>Type of message to send. See
the section <constant>MESSAGE-TYPES</constant> for details.
</para></listitem></varlistentry>
<varlistentry>
<term>parameters</term>
<listitem><para>any parameters required for the message-type</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>MESSAGE-TYPES</title>
<para>Available message types are:</para>
<variablelist>
<varlistentry><term>close-share</term>
<listitem><para>Order smbd to close the client
connections to the named share. Note that this doesn't affect client
connections to any other shares. This message-type takes an argument of the
share name for which client connections will be closed, or the
"*" character which will close all currently open shares.
This may be useful if you made changes to the access controls on the share.
This message can only be sent to <constant>smbd</constant>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>debug</term>
<listitem><para>Set debug level to the value specified by the
parameter. This can be sent to any of the destinations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>force-election</term>
<listitem><para>This message causes the <command>nmbd</command> daemon to
force a new browse master election. </para>
</listitem></varlistentry>
<varlistentry>
<term>ping</term>
<listitem><para>
Send specified number of "ping" messages and
wait for the same number of reply "pong" messages. This can be sent to
any of the destinations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>profile</term>
<listitem><para>Change profile settings of a daemon, based on the
parameter. The parameter can be "on" to turn on profile stats
collection, "off" to turn off profile stats collection, "count"
to enable only collection of count stats (time stats are
disabled), and "flush" to zero the current profile stats. This can
be sent to any smbd or nmbd destinations.</para>
</listitem></varlistentry>
<varlistentry>
<term>debuglevel</term>
<listitem><para>
Request debuglevel of a certain daemon and write it to stdout. This
can be sent to any of the destinations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>profilelevel</term>
<listitem><para>
Request profilelevel of a certain daemon and write it to stdout.
This can be sent to any smbd or nmbd destinations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>printnotify</term>
<listitem><para>
Order smbd to send a printer notify message to any Windows NT clients
connected to a printer. This message-type takes the following arguments:
</para>
<variablelist>
<varlistentry>
<term>queuepause printername</term>
<listitem><para>Send a queue pause change notify
message to the printer specified.</para></listitem>
</varlistentry>
<varlistentry>
<term>queueresume printername</term>
<listitem><para>Send a queue resume change notify
message for the printer specified.</para></listitem>
</varlistentry>
<varlistentry>
<term>jobpause printername unixjobid</term>
<listitem><para>Send a job pause change notify
message for the printer and unix jobid
specified.</para></listitem>
</varlistentry>
<varlistentry>
<term>jobresume printername unixjobid</term>
<listitem><para>Send a job resume change notify
message for the printer and unix jobid
specified.</para></listitem>
</varlistentry>
<varlistentry>
<term>jobdelete printername unixjobid</term>
<listitem><para>Send a job delete change notify
message for the printer and unix jobid
specified.</para></listitem>
</varlistentry>
</variablelist>
<para>
Note that this message only sends notification that an
event has occured. It doesn't actually cause the
event to happen.
</para>
<para>This message can only be sent to <constant>smbd</constant>. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>samsync</term>
<listitem><para>Order smbd to synchronise sam database from PDC (being BDC). Can only be sent to <constant>smbd</constant>. </para>
<note><para>Not working at the moment</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term>samrepl</term>
<listitem><para>Send sam replication message, with specified serial. Can only be sent to <constant>smbd</constant>. Should not be used manually.</para></listitem>
</varlistentry>
<varlistentry>
<term>dmalloc-mark</term>
<listitem><para>Set a mark for dmalloc. Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
</varlistentry>
<varlistentry>
<term>dmalloc-log-changed</term>
<listitem><para>
Dump the pointers that have changed since the mark set by dmalloc-mark.
Can be sent to both smbd and nmbd. Only available if samba is built with dmalloc support. </para></listitem>
</varlistentry>
<varlistentry>
<term>shutdown</term>
<listitem><para>Shut down specified daemon. Can be sent to both smbd and nmbd.</para></listitem>
</varlistentry>
<varlistentry>
<term>pool-usage</term>
<listitem><para>Print a human-readable description of all
talloc(pool) memory usage by the specified daemon/process. Available
for both smbd and nmbd.</para></listitem>
</varlistentry>
<varlistentry>
<term>drvupgrade</term>
<listitem><para>Force clients of printers using specified driver
to update their local version of the driver. Can only be
sent to smbd.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

183
docs/docbook/manpages/smbcquotas.1.xml Normal file
View File

@ -0,0 +1,183 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbcquotas.1">
<refmeta>
<refentrytitle>smbcquotas</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbcquotas</refname>
<refpurpose>Set or get QUOTAs of NTFS 5 shares</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbcquotas</command>
<arg choice="req">//server/share</arg>
<arg choice="opt">-u user</arg>
<arg choice="opt">-L</arg>
<arg choice="opt">-F</arg>
<arg choice="opt">-S QUOTA_SET_COMMAND</arg>
<arg choice="opt">-n</arg>
<arg choice="opt">-t</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-s configfile</arg>
<arg choice="opt">-l logfilebase</arg>
<arg choice="opt">-V</arg>
<arg choice="opt">-U username</arg>
<arg choice="opt">-N</arg>
<arg choice="opt">-k</arg>
<arg choice="opt">-A</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>smbcquotas</command> program manipulates NT Quotas on SMB file shares. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>The following options are available to the <command>smbcquotas</command> program. </para>
<variablelist>
<varlistentry>
<term>-u user</term>
<listitem><para> Specifies the user of whom the quotas are get or set.
By default the current user's username will be used.</para></listitem>
</varlistentry>
<varlistentry>
<term>-L</term>
<listitem><para>Lists all quota records of the share.</para></listitem>
</varlistentry>
<varlistentry>
<term>-F</term>
<listitem><para>Show the share quota status and default limits.</para></listitem>
</varlistentry>
<varlistentry>
<term>-S QUOTA_SET_COMMAND</term>
<listitem><para>This command set/modify quotas for a user or on the share,
depending on the QUOTA_SET_COMMAND parameter witch is described later</para></listitem>
</varlistentry>
<varlistentry>
<term>-n</term>
<listitem><para>This option displays all QUOTA information in numeric
format. The default is to convert SIDs to names and QUOTA limits
to a readable string format. </para></listitem>
</varlistentry>
<varlistentry>
<term>-t</term>
<listitem><para>
Don't actually do anything, only validate the correctness of
the arguments.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem><para>
Be verbose.
</para></listitem>
</varlistentry>
&stdarg.help;
&popt.common.samba;
&popt.common.credentials;
</variablelist>
</refsect1>
<refsect1>
<title>QUOTA_SET_COMAND</title>
<para>The format of an ACL is one or more ACL entries separated by
either commas or newlines. An ACL entry is one of the following: </para>
<para>
for user setting quotas for the specified by -u or the current username:
</para>
<para><userinput>
UQLIM:&lt;username&gt;&lt;softlimit&gt;&lt;hardlimit&gt;
</userinput></para>
<para>
for setting the share quota defaults limits:
</para>
<para><userinput>
FSQLIM:&lt;softlimit&gt;&lt;hardlimit&gt;
</userinput></para>
<para>
for changing the share quota settings:
</para>
<para><userinput>
FSQFLAGS:QUOTA_ENABLED/DENY_DISK/LOG_SOFTLIMIT/LOG_HARD_LIMIT
</userinput></para>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<para>The <command>smbcquotas</command> program sets the exit status
depending on the success or otherwise of the operations performed.
The exit status may be one of the following values. </para>
<para>If the operation succeeded, smbcquotas returns an exit
status of 0. If <command>smbcquotas</command> couldn't connect to the specified server,
or when there was an error getting or setting the quota(s), an exit status
of 1 is returned. If there was an error parsing any command line
arguments, an exit status of 2 is returned. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para><command>smbcacls</command> was written by Stefan Metzmacher.</para>
</refsect1>
</refentry>

376
docs/docbook/manpages/smbd.8.xml Normal file
View File

@ -0,0 +1,376 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbd.8">
<refmeta>
<refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>smbd</refname>
<refpurpose>server to provide SMB/CIFS services to clients</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbd</command>
<arg choice="opt">-D</arg>
<arg choice="opt">-F</arg>
<arg choice="opt">-S</arg>
<arg choice="opt">-i</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-V</arg>
<arg choice="opt">-b</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-l &lt;log directory&gt;</arg>
<arg choice="opt">-p &lt;port number&gt;</arg>
<arg choice="opt">-O &lt;socket option&gt;</arg>
<arg choice="opt">-s &lt;configuration file&gt;</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbd</command> is the server daemon that
provides filesharing and printing services to Windows clients.
The server provides filespace and printer services to
clients using the SMB (or CIFS) protocol. This is compatible
with the LanManager protocol, and can service LanManager
clients. These include MSCLIENT 3.0 for DOS, Windows for
Workgroups, Windows 95/98/ME, Windows NT, Windows 2000,
OS/2, DAVE for Macintosh, and smbfs for Linux.</para>
<para>An extensive description of the services that the
server can provide is given in the man page for the
configuration file controlling the attributes of those
services (see <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>. This man page will not describe the
services, but will concentrate on the administrative aspects
of running the server.</para>
<para>Please note that there are significant security
implications to running this server, and the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> manual page should be regarded as mandatory reading before
proceeding with installation.</para>
<para>A session is created whenever a client requests one.
Each client gets a copy of the server for each session. This
copy then services all connections made by the client during
that session. When all connections from its client are closed,
the copy of the server for that client terminates.</para>
<para>The configuration file, and any files that it includes,
are automatically reloaded every minute, if they change. You
can force a reload by sending a SIGHUP to the server. Reloading
the configuration file will not affect connections to any service
that is already established. Either the user will have to
disconnect from the service, or <command>smbd</command> killed and restarted.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-D</term>
<listitem><para>If specified, this parameter causes
the server to operate as a daemon. That is, it detaches
itself and runs in the background, fielding requests
on the appropriate port. Operating the server as a
daemon is the recommended way of running <command>smbd</command> for
servers that provide more than casual use file and
print services. This switch is assumed if <command>smbd
</command> is executed on the command line of a shell.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-F</term>
<listitem><para>If specified, this parameter causes
the main <command>smbd</command> process to not daemonize,
i.e. double-fork and disassociate with the terminal.
Child processes are still created as normal to service
each connection request, but the main process does not
exit. This operation mode is suitable for running
<command>smbd</command> under process supervisors such
as <command>supervise</command> and <command>svscan</command>
from Daniel J. Bernstein's <command>daemontools</command>
package, or the AIX process monitor.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-S</term>
<listitem><para>If specified, this parameter causes
<command>smbd</command> to log to standard output rather
than a file.</para></listitem>
</varlistentry>
<varlistentry>
<term>-i</term>
<listitem><para>If this parameter is specified it causes the
server to run "interactively", not as a daemon, even if the
server is executed on the command line of a shell. Setting this
parameter negates the implicit deamon mode when run from the
command line. <command>smbd</command> also logs to standard
output, as if the <command>-S</command> parameter had been
given.
</para></listitem>
</varlistentry>
&popt.common.samba;
&stdarg.help;
<varlistentry>
<term>-b</term>
<listitem><para>Prints information about how
Samba was built.</para></listitem>
</varlistentry>
<varlistentry>
<term>-l &lt;log directory&gt;</term>
<listitem><para>If specified,
<replaceable>log directory</replaceable>
specifies a log directory into which the "log.smbd" log
file will be created for informational and debug
messages from the running server. The log
file generated is never removed by the server although
its size may be controlled by the <ulink
url="smb.conf.5.html#maxlogsize"><parameter>max log size</parameter></ulink>
option in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file. <emphasis>Beware:</emphasis>
If the directory specified does not exist, <command>smbd</command>
will log to the default debug log location defined at compile time.
</para>
<para>The default log directory is specified at
compile time.</para></listitem>
</varlistentry>
<varlistentry>
<term>-p &lt;port number&gt;</term>
<listitem><para><replaceable>port number</replaceable> is a positive integer
value. The default value if this parameter is not
specified is 139.</para>
<para>This number is the port number that will be
used when making connections to the server from client
software. The standard (well-known) port number for the
SMB over TCP is 139, hence the default. If you wish to
run the server as an ordinary user rather than
as root, most systems will require you to use a port
number greater than 1024 - ask your system administrator
for help if you are in this situation.</para>
<para>In order for the server to be useful by most
clients, should you configure it on a port other
than 139, you will require port redirection services
on port 139, details of which are outlined in rfc1002.txt
section 4.3.5.</para>
<para>This parameter is not normally specified except
in the above situation.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/inetd.conf</filename></term>
<listitem><para>If the server is to be run by the
<command>inetd</command> meta-daemon, this file
must contain suitable startup information for the
meta-daemon. See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink>
document for details.
</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/rc</filename></term>
<listitem><para>or whatever initialization script your
system uses).</para>
<para>If running the server as a daemon at startup,
this file will need to contain an appropriate startup
sequence for the server. See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink>
document for details.</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/services</filename></term>
<listitem><para>If running the server via the
meta-daemon <command>inetd</command>, this file
must contain a mapping of service name (e.g., netbios-ssn)
to service port (e.g., 139) and protocol type (e.g., tcp).
See the <ulink url="install.html">"How to Install and Test SAMBA"</ulink>
document for details.</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/usr/local/samba/lib/smb.conf</filename></term>
<listitem><para>This is the default location of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> server configuration file. Other common places that systems
install this file are <filename>/usr/samba/lib/smb.conf</filename>
and <filename>/etc/samba/smb.conf</filename>.</para>
<para>This file describes all the services the server
is to make available to clients. See <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for more information.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>LIMITATIONS</title>
<para>On some systems <command>smbd</command> cannot change uid back
to root after a setuid() call. Such systems are called
trapdoor uid systems. If you have such a system,
you will be unable to connect from a client (such as a PC) as
two different users at once. Attempts to connect the
second user will result in access denied or
similar.</para>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<variablelist>
<varlistentry>
<term><envar>PRINTER</envar></term>
<listitem><para>If no printer name is specified to
printable services, most systems will use the value of
this variable (or <constant>lp</constant> if this variable is
not defined) as the name of the printer to use. This
is not specific to the server, however.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>PAM INTERACTION</title>
<para>Samba uses PAM for authentication (when presented with a plaintext
password), for account checking (is this account disabled?) and for
session management. The degree too which samba supports PAM is restricted
by the limitations of the SMB protocol and the <ulink url="smb.conf.5.html#OBEYPAMRESRICTIONS"><parameter>obey
pam restricions</parameter></ulink> <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> paramater. When this is set, the following restrictions apply:
</para>
<itemizedlist>
<listitem><para><emphasis>Account Validation</emphasis>: All accesses to a
samba server are checked
against PAM to see if the account is vaild, not disabled and is permitted to
login at this time. This also applies to encrypted logins.
</para></listitem>
<listitem><para><emphasis>Session Management</emphasis>: When not using share
level secuirty, users must pass PAM's session checks before access
is granted. Note however, that this is bypassed in share level secuirty.
Note also that some older pam configuration files may need a line
added for session support.
</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>DIAGNOSTICS</title>
<para>Most diagnostics issued by the server are logged
in a specified log file. The log file name is specified
at compile time, but may be overridden on the command line.</para>
<para>The number and nature of diagnostics available depends
on the debug level used by the server. If you have problems, set
the debug level to 3 and peruse the log files.</para>
<para>Most messages are reasonably self-explanatory. Unfortunately,
at the time this man page was created, there are too many diagnostics
available in the source code to warrant describing each and every
diagnostic. At this stage your best bet is still to grep the
source code and inspect the conditions that gave rise to the
diagnostics you are seeing.</para>
</refsect1>
<refsect1>
<title>SIGNALS</title>
<para>Sending the <command>smbd</command> a SIGHUP will cause it to
reload its <filename>smb.conf</filename> configuration
file within a short period of time.</para>
<para>To shut down a user's <command>smbd</command> process it is recommended
that <command>SIGKILL (-9)</command> <emphasis>NOT</emphasis>
be used, except as a last resort, as this may leave the shared
memory area in an inconsistent state. The safe way to terminate
an <command>smbd</command> is to send it a SIGTERM (-15) signal and wait for
it to die on its own.</para>
<para>The debug log level of <command>smbd</command> may be raised
or lowered using <citerefentry><refentrytitle>smbcontrol</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> program (SIGUSR[1|2] signals are no longer
used since Samba 2.2). This is to allow transient problems to be diagnosed,
whilst still running at a normally low log level.</para>
<para>Note that as the signal handlers send a debug write,
they are not re-entrant in <command>smbd</command>. This you should wait until
<command>smbd</command> is in a state of waiting for an incoming SMB before
issuing them. It is possible to make the signal handlers safe
by un-blocking the signals before the select call and re-blocking
them after, however this would affect performance.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>hosts_access</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>inetd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testparm</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>testprns</refentrytitle>
<manvolnum>1</manvolnum></citerefentry>, and the
Internet RFC's <filename>rfc1001.txt</filename>, <filename>rfc1002.txt</filename>.
In addition the CIFS (formerly SMB) specification is available
as a link from the Web page <ulink url="http://samba.org/cifs/">
http://samba.org/cifs/</ulink>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

122
docs/docbook/manpages/smbmnt.8.xml Normal file
View File

@ -0,0 +1,122 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbmnt.8">
<refmeta>
<refentrytitle>smbmnt</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>smbmnt</refname>
<refpurpose>helper utility for mounting SMB filesystems</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbmnt</command>
<arg choice="req">mount-point</arg>
<arg choice="opt">-s &lt;share&gt;</arg>
<arg choice="opt">-r</arg>
<arg choice="opt">-u &lt;uid&gt;</arg>
<arg choice="opt">-g &lt;gid&gt;</arg>
<arg choice="opt">-f &lt;mask&gt;</arg>
<arg choice="opt">-d &lt;mask&gt;</arg>
<arg choice="opt">-o &lt;options&gt;</arg>
<arg choice="opt">-h</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>smbmnt</command> is a helper application used
by the smbmount program to do the actual mounting of SMB shares.
<command>smbmnt</command> can be installed setuid root if you want
normal users to be able to mount their SMB shares.</para>
<para>A setuid smbmnt will only allow mounts on directories owned
by the user, and that the user has write permission on.</para>
<para>The <command>smbmnt</command> program is normally invoked
by <citerefentry><refentrytitle>smbmount</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>. It should not be invoked directly by users. </para>
<para>smbmount searches the normal PATH for smbmnt. You must ensure
that the smbmnt version in your path matches the smbmount used.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-r</term>
<listitem><para>mount the filesystem read-only
</para></listitem>
</varlistentry>
<varlistentry>
<term>-u uid</term>
<listitem><para>specify the uid that the files will
be owned by </para></listitem>
</varlistentry>
<varlistentry>
<term>-g gid</term>
<listitem><para>specify the gid that the files will be
owned by </para></listitem>
</varlistentry>
<varlistentry>
<term>-f mask</term>
<listitem><para>specify the octal file mask applied
</para></listitem>
</varlistentry>
<varlistentry>
<term>-d mask</term>
<listitem><para>specify the octal directory mask
applied </para></listitem>
</varlistentry>
<varlistentry>
<term>-o options</term>
<listitem><para>
list of options that are passed as-is to smbfs, if this
command is run on a 2.4 or higher Linux kernel.
</para></listitem>
</varlistentry>
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield
and others.</para>
<para>The current maintainer of smbfs and the userspace
tools <command>smbmount</command>, <command>smbumount</command>,
and <command>smbmnt</command> is <ulink
url="mailto:urban@teststation.com">Urban Widmark</ulink>.
The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
is the preferred place to ask questions regarding these programs.
</para>
<para>The conversion of this manpage for Samba 2.2 was performed
by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

335
docs/docbook/manpages/smbmount.8.xml Normal file
View File

@ -0,0 +1,335 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbmount.8">
<refmeta>
<refentrytitle>smbmount</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>smbmount</refname>
<refpurpose>mount an smbfs filesystem</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbmount</command>
<arg choice="req">service</arg>
<arg choice="req">mount-point</arg>
<arg choice="opt">-o options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para><command>smbmount</command> mounts a Linux SMB filesystem. It
is usually invoked as <command>mount.smbfs</command> by
the <citerefentry><refentrytitle>mount</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> command when using the
"-t smbfs" option. This command only works in Linux, and the kernel must
support the smbfs filesystem. </para>
<para>Options to <command>smbmount</command> are specified as a comma-separated
list of key=value pairs. It is possible to send options other
than those listed here, assuming that smbfs supports them. If
you get mount failures, check your kernel log for errors on
unknown options.</para>
<para><command>smbmount</command> is a daemon. After mounting it keeps running until
the mounted smbfs is umounted. It will log things that happen
when in daemon mode using the "machine name" smbmount, so
typically this output will end up in <filename>log.smbmount</filename>. The <command>
smbmount</command> process may also be called mount.smbfs.</para>
<para><emphasis>NOTE:</emphasis> <command>smbmount</command>
calls <citerefentry><refentrytitle>smbmnt</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> to do the actual mount. You
must make sure that <command>smbmnt</command> is in the path so
that it can be found. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>username=&lt;arg&gt;</term>
<listitem><para>specifies the username to connect as. If
this is not given, then the environment variable <envar>
USER</envar> is used. This option can also take the
form "user%password" or "user/workgroup" or
"user/workgroup%password" to allow the password and workgroup
to be specified as part of the username.</para></listitem>
</varlistentry>
<varlistentry>
<term>password=&lt;arg&gt;</term>
<listitem><para>specifies the SMB password. If this
option is not given then the environment variable
<envar>PASSWD</envar> is used. If it can find
no password <command>smbmount</command> will prompt
for a passeword, unless the guest option is
given. </para>
<para>
Note that passwords which contain the argument delimiter
character (i.e. a comma ',') will failed to be parsed correctly
on the command line. However, the same password defined
in the PASSWD environment variable or a credentials file (see
below) will be read correctly.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>credentials=&lt;filename&gt;</term>
<listitem><para>specifies a file that contains a username and/or password.
The format of the file is:
<programlisting>
username = &lt;value&gt;
password = &lt;value&gt;
</programlisting></para>
<para>This is preferred over having passwords in plaintext in a
shared file, such as <filename>/etc/fstab</filename>. Be sure to protect any
credentials file properly.
</para></listitem>
</varlistentry>
<varlistentry>
<term>krb</term>
<listitem><para>Use kerberos (Active Directory). </para></listitem>
</varlistentry>
<varlistentry>
<term>netbiosname=&lt;arg&gt;</term>
<listitem><para>sets the source NetBIOS name. It defaults
to the local hostname. </para></listitem>
</varlistentry>
<varlistentry>
<term>uid=&lt;arg&gt;</term>
<listitem><para>sets the uid that will own all files on
the mounted filesystem.
It may be specified as either a username or a numeric uid.
</para></listitem>
</varlistentry>
<varlistentry>
<term>gid=&lt;arg&gt;</term>
<listitem><para>sets the gid that will own all files on
the mounted filesystem.
It may be specified as either a groupname or a numeric
gid. </para></listitem>
</varlistentry>
<varlistentry>
<term>port=&lt;arg&gt;</term>
<listitem><para>sets the remote SMB port number. The default
is 139. </para></listitem>
</varlistentry>
<varlistentry>
<term>fmask=&lt;arg&gt;</term>
<listitem><para>sets the file mask. This determines the
permissions that remote files have in the local filesystem.
The default is based on the current umask. </para></listitem>
</varlistentry>
<varlistentry>
<term>dmask=&lt;arg&gt;</term>
<listitem><para>Sets the directory mask. This determines the
permissions that remote directories have in the local filesystem.
The default is based on the current umask. </para></listitem>
</varlistentry>
<varlistentry>
<term>debug=&lt;arg&gt;</term>
<listitem><para>Sets the debug level. This is useful for
tracking down SMB connection problems. A suggested value to
start with is 4. If set too high there will be a lot of
output, possibly hiding the useful output.</para></listitem>
</varlistentry>
<varlistentry>
<term>ip=&lt;arg&gt;</term>
<listitem><para>Sets the destination host or IP address.
</para></listitem>
</varlistentry>
<varlistentry>
<term>workgroup=&lt;arg&gt;</term>
<listitem><para>Sets the workgroup on the destination </para>
</listitem>
</varlistentry>
<varlistentry>
<term>sockopt=&lt;arg&gt;</term>
<listitem><para>Sets the TCP socket options. See the <ulink
url="smb.conf.5.html#SOCKETOPTIONS"><citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></ulink> <parameter>socket options</parameter> option.
</para></listitem>
</varlistentry>
<varlistentry>
<term>scope=&lt;arg&gt;</term>
<listitem><para>Sets the NetBIOS scope </para></listitem>
</varlistentry>
<varlistentry>
<term>guest</term>
<listitem><para>Don't prompt for a password </para></listitem>
</varlistentry>
<varlistentry>
<term>ro</term>
<listitem><para>mount read-only </para></listitem>
</varlistentry>
<varlistentry>
<term>rw</term><listitem><para>mount read-write </para></listitem>
</varlistentry>
<varlistentry>
<term>iocharset=&lt;arg&gt;</term>
<listitem><para>
sets the charset used by the Linux side for codepage
to charset translations (NLS). Argument should be the
name of a charset, like iso8859-1. (Note: only kernel
2.4.0 or later)
</para></listitem>
</varlistentry>
<varlistentry>
<term>codepage=&lt;arg&gt;</term>
<listitem><para>
sets the codepage the server uses. See the iocharset
option. Example value cp850. (Note: only kernel 2.4.0
or later)
</para></listitem>
</varlistentry>
<varlistentry>
<term>ttl=&lt;arg&gt;</term>
<listitem><para>
sets how long a directory listing is cached in milliseconds
(also affects visibility of file size and date
changes). A higher value means that changes on the
server take longer to be noticed but it can give
better performance on large directories, especially
over long distances. Default is 1000ms but something
like 10000ms (10 seconds) is probably more reasonable
in many cases.
(Note: only kernel 2.4.2 or later)
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The variable <envar>USER</envar> may contain the username of the
person using the client. This information is used only if the
protocol level is high enough to support session-level
passwords. The variable can be used to set both username and
password by using the format username%password.</para>
<para>The variable <envar>PASSWD</envar> may contain the password of the
person using the client. This information is used only if the
protocol level is high enough to support session-level
passwords.</para>
<para>The variable <envar>PASSWD_FILE</envar> may contain the pathname
of a file to read the password from. A single line of input is
read and used as the password.</para>
</refsect1>
<refsect1>
<title>BUGS</title>
<para>Passwords and other options containing , can not be handled.
For passwords an alternative way of passing them is in a credentials
file or in the PASSWD environment.</para>
<para>The credentials file does not handle usernames or passwords with
leading space.</para>
<para>One smbfs bug is important enough to mention here, even if it
is a bit misplaced:</para>
<itemizedlist>
<listitem><para>Mounts sometimes stop working. This is usually
caused by smbmount terminating. Since smbfs needs smbmount to
reconnect when the server disconnects, the mount will eventually go
dead. An umount/mount normally fixes this. At least 2 ways to
trigger this bug are known.</para></listitem>
</itemizedlist>
<para>Note that the typical response to a bug report is suggestion
to try the latest version first. So please try doing that first,
and always include which versions you use of relevant software
when reporting bugs (minimum: samba, kernel, distribution)</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>Documentation/filesystems/smbfs.txt in the linux kernel
source tree may contain additional options and information.</para>
<para>FreeBSD also has a smbfs, but it is not related to smbmount</para>
<para>For Solaris, HP-UX and others you may want to look at <citerefentry><refentrytitle>smbsh</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> or at other solutions, such as
Sharity or perhaps replacing the SMB server with a NFS server.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield
and others.</para>
<para>The current maintainer of smbfs and the userspace
tools <command>smbmount</command>, <command>smbumount</command>,
and <command>smbmnt</command> is <ulink
url="mailto:urban@teststation.com">Urban Widmark</ulink>.
The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
is the preferred place to ask questions regarding these programs.
</para>
<para>The conversion of this manpage for Samba 2.2 was performed
by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

209
docs/docbook/manpages/smbpasswd.5.xml Normal file
View File

@ -0,0 +1,209 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbpasswd.5">
<refmeta>
<refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>smbpasswd</refname>
<refpurpose>The Samba encrypted password file</refpurpose>
</refnamediv>
<refsynopsisdiv>
<para><filename>smbpasswd</filename></para>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>smbpasswd is the Samba encrypted password file. It contains
the username, Unix user id and the SMB hashed passwords of the
user, as well as account flag information and the time the
password was last changed. This file format has been evolving with
Samba and has had several different formats in the past. </para>
</refsect1>
<refsect1>
<title>FILE FORMAT</title>
<para>The format of the smbpasswd file used by Samba 2.2
is very similar to the familiar Unix <filename>passwd(5)</filename>
file. It is an ASCII file containing one line for each user. Each field
ithin each line is separated from the next by a colon. Any entry
beginning with '#' is ignored. The smbpasswd file contains the
following information for each user: </para>
<variablelist>
<varlistentry>
<term>name</term>
<listitem><para> This is the user name. It must be a name that
already exists in the standard UNIX passwd file. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>uid</term>
<listitem><para>This is the UNIX uid. It must match the uid
field for the same user entry in the standard UNIX passwd file.
If this does not match then Samba will refuse to recognize
this smbpasswd file entry as being valid for a user.
</para></listitem>
</varlistentry>
<varlistentry>
<term>Lanman Password Hash</term>
<listitem><para>This is the LANMAN hash of the user's password,
encoded as 32 hex digits. The LANMAN hash is created by DES
encrypting a well known string with the user's password as the
DES key. This is the same password used by Windows 95/98 machines.
Note that this password hash is regarded as weak as it is
vulnerable to dictionary attacks and if two users choose the
same password this entry will be identical (i.e. the password
is not "salted" as the UNIX password is). If the user has a
null password this field will contain the characters "NO PASSWORD"
as the start of the hex string. If the hex string is equal to
32 'X' characters then the user's account is marked as
<constant>disabled</constant> and the user will not be able to
log onto the Samba server. </para>
<para><emphasis>WARNING !!</emphasis> Note that, due to
the challenge-response nature of the SMB/CIFS authentication
protocol, anyone with a knowledge of this password hash will
be able to impersonate the user on the network. For this
reason these hashes are known as <emphasis>plain text
equivalents</emphasis> and must <emphasis>NOT</emphasis> be made
available to anyone but the root user. To protect these passwords
the smbpasswd file is placed in a directory with read and
traverse access only to the root user and the smbpasswd file
itself must be set to be read/write only by root, with no
other access. </para></listitem>
</varlistentry>
<varlistentry>
<term>NT Password Hash</term>
<listitem><para>This is the Windows NT hash of the user's
password, encoded as 32 hex digits. The Windows NT hash is
created by taking the user's password as represented in
16-bit, little-endian UNICODE and then applying the MD4
(internet rfc1321) hashing algorithm to it. </para>
<para>This password hash is considered more secure than
the LANMAN Password Hash as it preserves the case of the
password and uses a much higher quality hashing algorithm.
However, it is still the case that if two users choose the same
password this entry will be identical (i.e. the password is
not "salted" as the UNIX password is). </para>
<para><emphasis>WARNING !!</emphasis>. Note that, due to
the challenge-response nature of the SMB/CIFS authentication
protocol, anyone with a knowledge of this password hash will
be able to impersonate the user on the network. For this
reason these hashes are known as <emphasis>plain text
equivalents</emphasis> and must <emphasis>NOT</emphasis> be made
available to anyone but the root user. To protect these passwords
the smbpasswd file is placed in a directory with read and
traverse access only to the root user and the smbpasswd file
itself must be set to be read/write only by root, with no
other access. </para></listitem>
</varlistentry>
<varlistentry>
<term>Account Flags</term>
<listitem><para>This section contains flags that describe
the attributes of the users account. In the Samba 2.2 release
this field is bracketed by '[' and ']' characters and is always
13 characters in length (including the '[' and ']' characters).
The contents of this field may be any of the following characters:
</para>
<itemizedlist>
<listitem><para><emphasis>U</emphasis> - This means
this is a "User" account, i.e. an ordinary user. Only User
and Workstation Trust accounts are currently supported
in the smbpasswd file. </para></listitem>
<listitem><para><emphasis>N</emphasis> - This means the
account has no password (the passwords in the fields LANMAN
Password Hash and NT Password Hash are ignored). Note that this
will only allow users to log on with no password if the <parameter>
null passwords</parameter> parameter is set in the <ulink
url="smb.conf.5.html#NULLPASSWORDS"><citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></ulink> config file. </para></listitem>
<listitem><para><emphasis>D</emphasis> - This means the account
is disabled and no SMB/CIFS logins will be allowed for this user. </para></listitem>
<listitem><para><emphasis>W</emphasis> - This means this account
is a "Workstation Trust" account. This kind of account is used
in the Samba PDC code stream to allow Windows NT Workstations
and Servers to join a Domain hosted by a Samba PDC. </para>
</listitem>
</itemizedlist>
<para>Other flags may be added as the code is extended in future.
The rest of this field space is filled in with spaces. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>Last Change Time</term>
<listitem><para>This field consists of the time the account was
last modified. It consists of the characters 'LCT-' (standing for
"Last Change Time") followed by a numeric encoding of the UNIX time
in seconds since the epoch (1970) that the last change was made.
</para></listitem>
</varlistentry>
</variablelist>
<para>All other colon separated fields are ignored at this time.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>, and
the Internet RFC1321 for details on the MD4 algorithm.
</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

409
docs/docbook/manpages/smbpasswd.8.xml Normal file
View File

@ -0,0 +1,409 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbpasswd.8">
<refmeta>
<refentrytitle>smbpasswd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>smbpasswd</refname>
<refpurpose>change a user's SMB password</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbpasswd</command>
<arg choice="opt">-a</arg>
<arg choice="opt">-x</arg>
<arg choice="opt">-d</arg>
<arg choice="opt">-e</arg>
<arg choice="opt">-D debuglevel</arg>
<arg choice="opt">-n</arg>
<arg choice="opt">-r &lt;remote machine&gt;</arg>
<arg choice="opt">-R &lt;name resolve order&gt;</arg>
<arg choice="opt">-m</arg>
<arg choice="opt">-U username[%password]</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-s</arg>
<arg choice="opt">-w pass</arg>
<arg choice="opt">-i</arg>
<arg choice="opt">-L</arg>
<arg choice="opt">username</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The smbpasswd program has several different
functions, depending on whether it is run by the <emphasis>root</emphasis> user
or not. When run as a normal user it allows the user to change
the password used for their SMB sessions on any machines that store
SMB passwords. </para>
<para>By default (when run with no arguments) it will attempt to
change the current user's SMB password on the local machine. This is
similar to the way the <command>passwd(1)</command> program works. <command>
smbpasswd</command> differs from how the passwd program works
however in that it is not <emphasis>setuid root</emphasis> but works in
a client-server mode and communicates with a
locally running <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>. As a consequence in order for this to
succeed the smbd daemon must be running on the local machine. On a
UNIX machine the encrypted SMB passwords are usually stored in
the <citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file. </para>
<para>When run by an ordinary user with no options, smbpasswd
will prompt them for their old SMB password and then ask them
for their new password twice, to ensure that the new password
was typed correctly. No passwords will be echoed on the screen
whilst being typed. If you have a blank SMB password (specified by
the string "NO PASSWORD" in the smbpasswd file) then just press
the &lt;Enter&gt; key when asked for your old password. </para>
<para>smbpasswd can also be used by a normal user to change their
SMB password on remote machines, such as Windows NT Primary Domain
Controllers. See the (<parameter>-r</parameter>) and <parameter>-U</parameter> options
below. </para>
<para>When run by root, smbpasswd allows new users to be added
and deleted in the smbpasswd file, as well as allows changes to
the attributes of the user in this file to be made. When run by root, <command>
smbpasswd</command> accesses the local smbpasswd file
directly, thus enabling changes to be made even if smbd is not
running. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-a</term>
<listitem><para>This option specifies that the username
following should be added to the local smbpasswd file, with the
new password typed (type &lt;Enter&gt; for the old password). This
option is ignored if the username following already exists in
the smbpasswd file and it is treated like a regular change
password command. Note that the default passdb backends require
the user to already exist in the system password file (usually
<filename>/etc/passwd</filename>), else the request to add the
user will fail. </para>
<para>This option is only available when running smbpasswd
as root. </para></listitem>
</varlistentry>
<varlistentry>
<term>-x</term>
<listitem><para>This option specifies that the username
following should be deleted from the local smbpasswd file.
</para>
<para>This option is only available when running smbpasswd as
root.</para></listitem>
</varlistentry>
<varlistentry>
<term>-d</term>
<listitem><para>This option specifies that the username following
should be <constant>disabled</constant> in the local smbpasswd
file. This is done by writing a <constant>'D'</constant> flag
into the account control space in the smbpasswd file. Once this
is done all attempts to authenticate via SMB using this username
will fail. </para>
<para>If the smbpasswd file is in the 'old' format (pre-Samba 2.0
format) there is no space in the user's password entry to write
this information and the command will FAIL. See <citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for details on the 'old' and new password file formats.
</para>
<para>This option is only available when running smbpasswd as
root.</para></listitem>
</varlistentry>
<varlistentry>
<term>-e</term>
<listitem><para>This option specifies that the username following
should be <constant>enabled</constant> in the local smbpasswd file,
if the account was previously disabled. If the account was not
disabled this option has no effect. Once the account is enabled then
the user will be able to authenticate via SMB once again. </para>
<para>If the smbpasswd file is in the 'old' format, then <command>
smbpasswd</command> will FAIL to enable the account.
See <citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for
details on the 'old' and new password file formats. </para>
<para>This option is only available when running smbpasswd as root.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-D debuglevel</term>
<listitem><para><replaceable>debuglevel</replaceable> is an integer
from 0 to 10. The default value if this parameter is not specified
is zero. </para>
<para>The higher this value, the more detail will be logged to the
log files about the activities of smbpasswd. At level 0, only
critical errors and serious warnings will be logged. </para>
<para>Levels above 1 will generate considerable amounts of log
data, and should only be used when investigating a problem. Levels
above 3 are designed for use only by developers and generate
HUGE amounts of log data, most of which is extremely cryptic.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-n</term>
<listitem><para>This option specifies that the username following
should have their password set to null (i.e. a blank password) in
the local smbpasswd file. This is done by writing the string "NO
PASSWORD" as the first part of the first password stored in the
smbpasswd file. </para>
<para>Note that to allow users to logon to a Samba server once
the password has been set to "NO PASSWORD" in the smbpasswd
file the administrator must set the following parameter in the [global]
section of the <filename>smb.conf</filename> file : </para>
<para><command>null passwords = yes</command></para>
<para>This option is only available when running smbpasswd as
root.</para></listitem>
</varlistentry>
<varlistentry>
<term>-r remote machine name</term>
<listitem><para>This option allows a user to specify what machine
they wish to change their password on. Without this parameter
smbpasswd defaults to the local host. The <replaceable>remote
machine name</replaceable> is the NetBIOS name of the SMB/CIFS
server to contact to attempt the password change. This name is
resolved into an IP address using the standard name resolution
mechanism in all programs of the Samba suite. See the <parameter>-R
name resolve order</parameter> parameter for details on changing
this resolving mechanism. </para>
<para>The username whose password is changed is that of the
current UNIX logged on user. See the <parameter>-U username</parameter>
parameter for details on changing the password for a different
username. </para>
<para>Note that if changing a Windows NT Domain password the
remote machine specified must be the Primary Domain Controller for
the domain (Backup Domain Controllers only have a read-only
copy of the user account database and will not allow the password
change).</para>
<para><emphasis>Note</emphasis> that Windows 95/98 do not have
a real password database so it is not possible to change passwords
specifying a Win95/98 machine as remote machine target. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>-R name resolve order</term>
<listitem><para>This option allows the user of smbpasswd to determine
what name resolution services to use when looking up the NetBIOS
name of the host being connected to. </para>
<para>The options are :"lmhosts", "host", "wins" and "bcast". They
cause names to be resolved as follows: </para>
<itemizedlist>
<listitem><para><constant>lmhosts</constant>: Lookup an IP
address in the Samba lmhosts file. If the line in lmhosts has
no name type attached to the NetBIOS name (see the <citerefentry><refentrytitle>lmhosts</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> for details) then
any name type matches for lookup.</para></listitem>
<listitem><para><constant>host</constant>: Do a standard host
name to IP address resolution, using the system <filename>/etc/hosts
</filename>, NIS, or DNS lookups. This method of name resolution
is operating system depended for instance on IRIX or Solaris this
may be controlled by the <filename>/etc/nsswitch.conf</filename>
file). Note that this method is only used if the NetBIOS name
type being queried is the 0x20 (server) name type, otherwise
it is ignored.</para></listitem>
<listitem><para><constant>wins</constant>: Query a name with
the IP address listed in the <parameter>wins server</parameter>
parameter. If no WINS server has been specified this method
will be ignored.</para></listitem>
<listitem><para><constant>bcast</constant>: Do a broadcast on
each of the known local interfaces listed in the
<parameter>interfaces</parameter> parameter. This is the least
reliable of the name resolution methods as it depends on the
target host being on a locally connected subnet.</para></listitem>
</itemizedlist>
<para>The default order is <command>lmhosts, host, wins, bcast</command>
and without this parameter or any entry in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file the name resolution methods will
be attempted in this order. </para></listitem>
</varlistentry>
<varlistentry>
<term>-m</term>
<listitem><para>This option tells smbpasswd that the account
being changed is a MACHINE account. Currently this is used
when Samba is being used as an NT Primary Domain Controller.</para>
<para>This option is only available when running smbpasswd as root.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-U username</term>
<listitem><para>This option may only be used in conjunction
with the <parameter>-r</parameter> option. When changing
a password on a remote machine it allows the user to specify
the user name on that machine whose password will be changed. It
is present to allow users who have different user names on
different systems to change these passwords. </para></listitem>
</varlistentry>
<varlistentry>
<term>-h</term>
<listitem><para>This option prints the help string for <command>
smbpasswd</command>, selecting the correct one for running as root
or as an ordinary user. </para></listitem>
</varlistentry>
<varlistentry>
<term>-s</term>
<listitem><para>This option causes smbpasswd to be silent (i.e.
not issue prompts) and to read its old and new passwords from
standard input, rather than from <filename>/dev/tty</filename>
(like the <command>passwd(1)</command> program does). This option
is to aid people writing scripts to drive smbpasswd</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-w password</term>
<listitem><para>This parameter is only available if Samba
has been configured to use the experimental
<command>--with-ldapsam</command> option. The <parameter>-w</parameter>
switch is used to specify the password to be used with the
<ulink url="smb.conf.5.html#LDAPADMINDN"><parameter>ldap admin
dn</parameter></ulink>. Note that the password is stored in
the <filename>secrets.tdb</filename> and is keyed off
of the admin's DN. This means that if the value of <parameter>ldap
admin dn</parameter> ever changes, the password will need to be
manually updated as well.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-i</term>
<listitem><para>This option tells smbpasswd that the account
being changed is an interdomain trust account. Currently this is used
when Samba is being used as an NT Primary Domain Controller.
The account contains the info about another trusted domain.</para>
<para>This option is only available when running smbpasswd as root.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-L</term>
<listitem><para>Run in local mode.</para></listitem>
</varlistentry>
<varlistentry>
<term>username</term>
<listitem><para>This specifies the username for all of the
<emphasis>root only</emphasis> options to operate on. Only root
can specify this parameter as only root has the permission needed
to modify attributes directly in the local smbpasswd file.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>Since <command>smbpasswd</command> works in client-server
mode communicating with a local smbd for a non-root user then
the smbd daemon must be running for this to work. A common problem
is to add a restriction to the hosts that may access the <command>
smbd</command> running on the local machine by specifying either <parameter>allow
hosts</parameter> or <parameter>deny hosts</parameter> entry in
the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file and neglecting to
allow "localhost" access to the smbd. </para>
<para>In addition, the smbpasswd command is only useful if Samba
has been set up to use encrypted passwords. See the document <ulink url="pwencrypt.html">
"LanMan and NT Password Encryption in Samba"</ulink> in the docs directory for details
on how to do this. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbpasswd</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

165
docs/docbook/manpages/smbsh.1.xml Normal file
View File

@ -0,0 +1,165 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbsh.1">
<refmeta>
<refentrytitle>smbsh</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbsh</refname>
<refpurpose>Allows access to Windows NT filesystem
using UNIX commands</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbsh</command>
<arg choice="opt">-W workgroup</arg>
<arg choice="opt">-U username</arg>
<arg choice="opt">-P prefix</arg>
<arg choice="opt">-R &lt;name resolve order&gt;</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-l logfile</arg>
<arg choice="opt">-L libdir</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbsh</command> allows you to access an NT filesystem
using UNIX commands such as <command>ls</command>, <command>
egrep</command>, and <command>rcp</command>. You must use a
shell that is dynamically linked in order for <command>smbsh</command>
to work correctly.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-W WORKGROUP</term>
<listitem><para>Override the default workgroup specified in the
workgroup parameter of the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file
for this session. This may be needed to connect to some
servers. </para></listitem>
</varlistentry>
<varlistentry>
<term>-U username[%pass]</term>
<listitem><para>Sets the SMB username or username and password.
If this option is not specified, the user will be prompted for
both the username and the password. If %pass is not specified,
the user will be prompted for the password.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-P prefix</term>
<listitem><para>This option allows
the user to set the directory prefix for SMB access. The
default value if this option is not specified is
<emphasis>smb</emphasis>.
</para></listitem>
</varlistentry>
&stdarg.configfile;
&stdarg.debug;
&stdarg.resolve.order;
<varlistentry>
<term>-L libdir</term>
<listitem><para>This parameter specifies the location of the
shared libraries used by <command>smbsh</command>. The default
value is specified at compile time.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>EXAMPLES</title>
<para>To use the <command>smbsh</command> command, execute <command>
smbsh</command> from the prompt and enter the username and password
that authenticates you to the machine running the Windows NT
operating system.
<programlisting>
<prompt>system% </prompt><userinput>smbsh</userinput>
<prompt>Username: </prompt><userinput>user</userinput>
<prompt>Password: </prompt><userinput>XXXXXXX</userinput>
</programlisting></para>
<para>Any dynamically linked command you execute from
this shell will access the <filename>/smb</filename> directory
using the smb protocol. For example, the command <command>ls /smb
</command> will show a list of workgroups. The command
<command>ls /smb/MYGROUP </command> will show all the machines in
the workgroup MYGROUP. The command
<command>ls /smb/MYGROUP/&lt;machine-name&gt;</command> will show the share
names for that machine. You could then, for example, use the <command>
cd</command> command to change directories, <command>vi</command> to
edit files, and <command>rcp</command> to copy files.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>BUGS</title>
<para><command>smbsh</command> works by intercepting the standard
libc calls with the dynamically loaded versions in <filename>
smbwrapper.o</filename>. Not all calls have been "wrapped", so
some programs may not function correctly under <command>smbsh
</command>.</para>
<para>Programs which are not dynamically linked cannot make
use of <command>smbsh</command>'s functionality. Most versions
of UNIX have a <command>file</command> command that will
describe how a program was linked.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

133
docs/docbook/manpages/smbspool.8.xml Normal file
View File

@ -0,0 +1,133 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbspool.8">
<refmeta>
<refentrytitle>smbspool</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>smbspool</refname>
<refpurpose>send a print file to an SMB printer</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbspool</command>
<arg choice="req">job</arg>
<arg choice="req">user</arg>
<arg choice="req">title</arg>
<arg choice="req">copies</arg>
<arg choice="req">options</arg>
<arg choice="opt">filename</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>smbspool is a very small print spooling program that
sends a print file to an SMB printer. The command-line arguments
are position-dependent for compatibility with the Common UNIX
Printing System, but you can use smbspool with any printing system
or from a program or script.</para>
<para><emphasis>DEVICE URI</emphasis></para>
<para>smbspool specifies the destination using a Uniform Resource
Identifier ("URI") with a method of "smb". This string can take
a number of forms:</para>
<itemizedlist>
<listitem><para>smb://server/printer</para></listitem>
<listitem><para>smb://workgroup/server/printer</para></listitem>
<listitem><para>smb://username:password@server/printer</para></listitem>
<listitem><para>smb://username:password@workgroup/server/printer</para></listitem>
</itemizedlist>
<para>smbspool tries to get the URI from argv[0]. If argv[0]
contains the name of the program then it looks in the <envar>
DEVICE_URI</envar> environment variable.</para>
<para>Programs using the <command>exec(2)</command> functions can
pass the URI in argv[0], while shell scripts must set the
<envar>DEVICE_URI</envar> environment variable prior to
running smbspool.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<itemizedlist>
<listitem><para>The job argument (argv[1]) contains the
job ID number and is presently not used by smbspool.
</para></listitem>
<listitem><para>The user argument (argv[2]) contains the
print user's name and is presently not used by smbspool.
</para></listitem>
<listitem><para>The title argument (argv[3]) contains the
job title string and is passed as the remote file name
when sending the print job.</para></listitem>
<listitem><para>The copies argument (argv[4]) contains
the number of copies to be printed of the named file. If
no filename is provided then this argument is not used by
smbspool.</para></listitem>
<listitem><para>The options argument (argv[5]) contains
the print options in a single string and is currently
not used by smbspool.</para></listitem>
<listitem><para>The filename argument (argv[6]) contains the
name of the file to print. If this argument is not specified
then the print file is read from the standard input.</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para><command>smbspool</command> was written by Michael Sweet
at Easy Software Products.</para>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

142
docs/docbook/manpages/smbstatus.1.xml Normal file
View File

@ -0,0 +1,142 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbstatus.1">
<refmeta>
<refentrytitle>smbstatus</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbstatus</refname>
<refpurpose>report on current Samba connections</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbstatus</command>
<arg choice="opt">-P</arg>
<arg choice="opt">-b</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-L</arg>
<arg choice="opt">-B</arg>
<arg choice="opt">-p</arg>
<arg choice="opt">-S</arg>
<arg choice="opt">-s &lt;configuration file&gt;</arg>
<arg choice="opt">-u &lt;username&gt;</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbstatus</command> is a very simple program to
list the current Samba connections.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-P|--profile</term>
<listitem><para>If samba has been compiled with the
profiling option, print only the contents of the profiling
shared memory area.</para></listitem>
</varlistentry>
<varlistentry>
<term>-b|--brief</term>
<listitem><para>gives brief output.</para></listitem>
</varlistentry>
&popt.common.samba;
<varlistentry>
<term>-v|--verbose</term>
<listitem><para>gives verbose output.</para></listitem>
</varlistentry>
<varlistentry>
<term>-L|--locks</term>
<listitem><para>causes smbstatus to only list locks.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-B|--byterange</term>
<listitem><para>causes smbstatus to include byte range locks.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-p|--processes</term>
<listitem><para>print a list of <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> processes and exit.
Useful for scripting.</para></listitem>
</varlistentry>
<varlistentry>
<term>-S|--shares</term>
<listitem><para>causes smbstatus to only list shares.</para>
</listitem>
</varlistentry>
&stdarg.help;
<varlistentry>
<term>-u|--user=&lt;username&gt;</term>
<listitem><para>selects information relevant to
<parameter>username</parameter> only.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> and <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

238
docs/docbook/manpages/smbtar.1.xml Normal file
View File

@ -0,0 +1,238 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbtar.1">
<refmeta>
<refentrytitle>smbtar</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbtar</refname>
<refpurpose>shell script for backing up SMB/CIFS shares
directly to UNIX tape drives</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbtar</command>
<arg choice="opt">-r</arg>
<arg choice="opt">-i</arg>
<arg choice="opt">-a</arg>
<arg choice="opt">-v</arg>
<arg choice="req">-s server</arg>
<arg choice="opt">-p password</arg>
<arg choice="opt">-x services</arg>
<arg choice="opt">-X</arg>
<arg choice="opt">-N filename</arg>
<arg choice="opt">-b blocksize</arg>
<arg choice="opt">-d directory</arg>
<arg choice="opt">-l loglevel</arg>
<arg choice="opt">-u user</arg>
<arg choice="opt">-t tape</arg>
<arg choice="req">filenames</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbtar</command> is a very small shell script on top
of <citerefentry><refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
</citerefentry> which dumps SMB shares directly to tape.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-s server</term>
<listitem><para>The SMB/CIFS server that the share resides
upon.</para></listitem>
</varlistentry>
<varlistentry>
<term>-x service</term>
<listitem><para>The share name on the server to connect to.
The default is "backup".</para></listitem>
</varlistentry>
<varlistentry>
<term>-X</term>
<listitem><para>Exclude mode. Exclude filenames... from tar
create or restore. </para></listitem>
</varlistentry>
<varlistentry>
<term>-d directory</term>
<listitem><para>Change to initial <parameter>directory
</parameter> before restoring / backing up files. </para></listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem><para>Verbose mode.</para></listitem>
</varlistentry>
<varlistentry>
<term>-p password</term>
<listitem><para>The password to use to access a share.
Default: none </para></listitem>
</varlistentry>
<varlistentry>
<term>-u user</term>
<listitem><para>The user id to connect as. Default:
UNIX login name. </para></listitem>
</varlistentry>
<varlistentry>
<term>-a</term>
<listitem><para>Reset DOS archive bit mode to
indicate file has been archived. </para></listitem>
</varlistentry>
<varlistentry>
<term>-t tape</term>
<listitem><para>Tape device. May be regular file or tape
device. Default: <parameter>$TAPE</parameter> environmental
variable; if not set, a file called <filename>tar.out
</filename>. </para></listitem>
</varlistentry>
<varlistentry>
<term>-b blocksize</term>
<listitem><para>Blocking factor. Defaults to 20. See
<command>tar(1)</command> for a fuller explanation. </para></listitem>
</varlistentry>
<varlistentry>
<term>-N filename</term>
<listitem><para>Backup only files newer than filename. Could
be used (for example) on a log file to implement incremental
backups. </para></listitem>
</varlistentry>
<varlistentry>
<term>-i</term>
<listitem><para>Incremental mode; tar files are only backed
up if they have the archive bit set. The archive bit is reset
after each file is read. </para></listitem>
</varlistentry>
<varlistentry>
<term>-r</term>
<listitem><para>Restore. Files are restored to the share
from the tar file. </para></listitem>
</varlistentry>
<varlistentry>
<term>-l log level</term>
<listitem><para>Log (debug) level. Corresponds to the
<parameter>-d</parameter> flag of <citerefentry>
<refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>ENVIRONMENT VARIABLES</title>
<para>The <parameter>$TAPE</parameter> variable specifies the
default tape device to write to. May be overridden
with the -t option. </para>
</refsect1>
<refsect1>
<title>BUGS</title>
<para>The <command>smbtar</command> script has different
options from ordinary tar and from smbclient's tar command. </para>
</refsect1>
<refsect1>
<title>CAVEATS</title>
<para>Sites that are more careful about security may not like
the way the script handles PC passwords. Backup and restore work
on entire shares; should work on file lists. smbtar works best
with GNU tar and may not work well with other versions. </para>
</refsect1>
<refsect1>
<title>DIAGNOSTICS</title>
<para>See the <emphasis>DIAGNOSTICS</emphasis> section for the <citerefentry>
<refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
</citerefentry> command.</para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>smbclient</refentrytitle><manvolnum>1</manvolnum>
</citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para><ulink url="mailto:poultenr@logica.co.uk">Ricky Poulten</ulink>
wrote the tar extension and this man page. The <command>smbtar</command>
script was heavily rewritten and improved by <ulink
url="mailto:Martin.Kraemer@mch.sni.de">Martin Kraemer</ulink>. Many
thanks to everyone who suggested extensions, improvements, bug
fixes, etc. The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

96
docs/docbook/manpages/smbtree.1.xml Normal file
View File

@ -0,0 +1,96 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbtree.1">
<refmeta>
<refentrytitle>smbtree</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>smbtree</refname>
<refpurpose>A text based smb network browser
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbtree</command>
<arg choice="opt">-b</arg>
<arg choice="opt">-D</arg>
<arg choice="opt">-S</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>smbtree</command> is a smb browser program
in text mode. It is similar to the "Network Neighborhood" found
on Windows computers. It prints a tree with all
the known domains, the servers in those domains and
the shares on the servers.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-b</term>
<listitem><para>Query network nodes by sending requests
as broadcasts instead of querying the (domain) master browser.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-D</term>
<listitem><para>Only print a list of all
the domains known on broadcast or by the
master browser</para></listitem>
</varlistentry>
<varlistentry>
<term>-S</term>
<listitem><para>Only print a list of
all the domains and servers responding on broadcast or
known by the master browser.
</para></listitem>
</varlistentry>
&popt.common.samba;
&popt.common.credentials;
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The smbtree man page was written by Jelmer Vernooij. </para>
</refsect1>
</refentry>

79
docs/docbook/manpages/smbumount.8.xml Normal file
View File

@ -0,0 +1,79 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="smbumount.8">
<refmeta>
<refentrytitle>smbumount</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>smbumount</refname>
<refpurpose>smbfs umount for normal users</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>smbumount</command>
<arg choice="req">mount-point</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>With this program, normal users can unmount smb-filesystems,
provided that it is suid root. <command>smbumount</command> has
been written to give normal Linux users more control over their
resources. It is safe to install this program suid root, because only
the user who has mounted a filesystem is allowed to unmount it again.
For root it is not necessary to use smbumount. The normal umount
program works perfectly well, but it would certainly be problematic
to make umount setuid root.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>mount-point</term>
<listitem><para>The directory to unmount.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>smbmount</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>Volker Lendecke, Andrew Tridgell, Michael H. Warfield
and others.</para>
<para>The current maintainer of smbfs and the userspace
tools <command>smbmount</command>, <command>smbumount</command>,
and <command>smbmnt</command> is <ulink
url="mailto:urban@teststation.com">Urban Widmark</ulink>.
The <ulink url="mailto:samba@samba.org">SAMBA Mailing list</ulink>
is the preferred place to ask questions regarding these programs.
</para>
<para>The conversion of this manpage for Samba 2.2 was performed
by Gerald Carter. The conversion to DocBook XML 4.2 for Samba 3.0
was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

228
docs/docbook/manpages/swat.8.xml Normal file
View File

@ -0,0 +1,228 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="swat.8">
<refmeta>
<refentrytitle>swat</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>swat</refname>
<refpurpose>Samba Web Administration Tool</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>swat</command>
<arg choice="opt">-s &lt;smb config file&gt;</arg>
<arg choice="opt">-a</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>swat</command> allows a Samba administrator to
configure the complex <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file via a Web browser. In addition,
a <command>swat</command> configuration page has help links
to all the configurable options in the <filename>smb.conf</filename> file allowing an
administrator to easily look up the effects of any change. </para>
<para><command>swat</command> is run from <command>inetd</command> </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-s smb configuration file</term>
<listitem><para>The default configuration file path is
determined at compile time. The file specified contains
the configuration details required by the <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> server. This is the file
that <command>swat</command> will modify.
The information in this file includes server-specific
information such as what printcap file to use, as well as
descriptions of all the services that the server is to provide.
See <filename>smb.conf</filename> for more information.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-a</term>
<listitem><para>This option disables authentication and puts
<command>swat</command> in demo mode. In that mode anyone will be able to modify
the <filename>smb.conf</filename> file. </para>
<para><emphasis>WARNING: Do NOT enable this option on a production
server. </emphasis></para></listitem>
</varlistentry>
&popt.common.samba;
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>INSTALLATION</title>
<para>Swat is included as binary package with most distributions. The
package manager in this case takes care of the installation and
configuration. This section is only for those who have compiled
swat from scratch.
</para>
<para>After you compile SWAT you need to run <command>make install
</command> to install the <command>swat</command> binary
and the various help files and images. A default install would put
these in: </para>
<itemizedlist>
<listitem><para>/usr/local/samba/bin/swat</para></listitem>
<listitem><para>/usr/local/samba/swat/images/*</para></listitem>
<listitem><para>/usr/local/samba/swat/help/*</para></listitem>
</itemizedlist>
<refsect2>
<title>Inetd Installation</title>
<para>You need to edit your <filename>/etc/inetd.conf
</filename> and <filename>/etc/services</filename>
to enable SWAT to be launched via <command>inetd</command>.</para>
<para>In <filename>/etc/services</filename> you need to
add a line like this: </para>
<para><command>swat 901/tcp</command></para>
<para>Note for NIS/YP and LDAP users - you may need to rebuild the
NIS service maps rather than alter your local <filename>
/etc/services</filename> file. </para>
<para>the choice of port number isn't really important
except that it should be less than 1024 and not currently
used (using a number above 1024 presents an obscure security
hole depending on the implementation details of your
<command>inetd</command> daemon). </para>
<para>In <filename>/etc/inetd.conf</filename> you should
add a line like this: </para>
<para><command>swat stream tcp nowait.400 root
/usr/local/samba/bin/swat swat</command></para>
<para>One you have edited <filename>/etc/services</filename>
and <filename>/etc/inetd.conf</filename> you need to send a
HUP signal to inetd. To do this use <command>kill -1 PID
</command> where PID is the process ID of the inetd daemon. </para>
</refsect2>
</refsect1>
<refsect1>
<title>LAUNCHING</title>
<para>To launch SWAT just run your favorite web browser and
point it at "http://localhost:901/".</para>
<para>Note that you can attach to SWAT from any IP connected
machine but connecting from a remote machine leaves your
connection open to password sniffing as passwords will be sent
in the clear over the wire. </para>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/inetd.conf</filename></term>
<listitem><para>This file must contain suitable startup
information for the meta-daemon.</para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/etc/services</filename></term>
<listitem><para>This file must contain a mapping of service name
(e.g., swat) to service port (e.g., 901) and protocol type
(e.g., tcp). </para></listitem>
</varlistentry>
<varlistentry>
<term><filename>/usr/local/samba/lib/smb.conf</filename></term>
<listitem><para>This is the default location of the <citerefentry>
<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> server configuration file that swat edits. Other
common places that systems install this file are <filename>
/usr/samba/lib/smb.conf</filename> and <filename>/etc/smb.conf
</filename>. This file describes all the services the server
is to make available to clients. </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>WARNINGS</title>
<para><command>swat</command> will rewrite your <citerefentry>
<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> file. It will rearrange the entries and delete all
comments, <parameter>include=</parameter> and <parameter>copy=
</parameter> options. If you have a carefully crafted <filename>
smb.conf</filename> then back it up or don't use swat! </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><command>inetd(5)</command>, <citerefentry>
<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>, <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2 for
Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

136
docs/docbook/manpages/tdbbackup.8.xml Normal file
View File

@ -0,0 +1,136 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="tdbbackup.8">
<refmeta>
<refentrytitle>tdbbackup</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>tdbbackup</refname>
<refpurpose>tool for backing up and for validating the integrity of samba .tdb files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>tdbbackup</command>
<arg choice="opt">-s suffix</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-h</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>1</manvolnum></citerefentry> suite.</para>
<para><command>tdbbackup</command> 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, in which case, if it find file damage and it finds a prior backup
it will restore the backup file.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-h</term>
<listitem><para>
Get help information.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-s suffix</term>
<listitem><para>
The <command>-s</command> option allows the adminisistrator to specify a file
backup extension. This way it is possible to keep a history of tdb backup
files by using a new suffix for each backup.
</para> </listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem><para>
The <command>-v</command> will check the database for damages (currupt data)
which if detected causes the backup to be restored.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<para><emphasis>GENERAL INFORMATION</emphasis></para>
<para>
The <command>tdbbackup</command> utility should be run as soon as samba has shut down.
Do NOT run this command on a live database. Typical usage for the command will be:
</para>
<para>tdbbackup [-s suffix] *.tdb</para>
<para>
Before restarting samba the following command may be run to validate .tdb files:
</para>
<para>tdbbackup -v [-s suffix] *.tdb</para>
<para>
Samba .tdb files are stored in various locations, be sure to run backup all
.tdb file on the system. Imporatant files includes:
</para>
<itemizedlist>
<listitem><para>
<command>secrets.tdb</command> - usual location is in the /usr/local/samba/private
directory, or on some systems in /etc/samba.
</para></listitem>
<listitem><para>
<command>passdb.tdb</command> - usual location is in the /usr/local/samba/private
directory, or on some systems in /etc/samba.
</para></listitem>
<listitem><para>
<command>*.tdb</command> located in the /usr/local/samba/var directory or on some
systems in the /var/cache or /var/lib/samba directories.
</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
The original Samba software and related utilities were created by Andrew Tridgell.
Samba is now developed by the Samba Team as an Open Source project similar to the way
the Linux kernel is developed.
</para>
<para>The tdbbackup man page was written by John H Terpstra.</para>
</refsect1>
</refentry>

192
docs/docbook/manpages/testparm.1.xml Normal file
View File

@ -0,0 +1,192 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="testparm.1">
<refmeta>
<refentrytitle>testparm</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>testparm</refname>
<refpurpose>check an smb.conf configuration file for
internal correctness</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>testparm</command>
<arg choice="opt">-s</arg>
<arg choice="opt">-h</arg>
<arg choice="opt">-v</arg>
<arg choice="opt">-L &lt;servername&gt;</arg>
<arg choice="opt">-t &lt;encoding&gt;</arg>
<arg choice="req">config filename</arg>
<arg choice="opt">hostname hostIP</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>testparm</command> is a very simple test program
to check an <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> configuration file for
internal correctness. If this program reports no problems, you
can use the configuration file with confidence that <command>smbd
</command> will successfully load the configuration file.</para>
<para>Note that this is <emphasis>NOT</emphasis> a guarantee that
the services specified in the configuration file will be
available or will operate as expected. </para>
<para>If the optional host name and host IP address are
specified on the command line, this test program will run through
the service entries reporting whether the specified host
has access to each service. </para>
<para>If <command>testparm</command> finds an error in the <filename>
smb.conf</filename> file it returns an exit code of 1 to the calling
program, else it returns an exit code of 0. This allows shell scripts
to test the output from <command>testparm</command>.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-s</term>
<listitem><para>Without this option, <command>testparm</command>
will prompt for a carriage return after printing the service
names and before dumping the service definitions.</para></listitem>
</varlistentry>
&stdarg.help;
&stdarg.version;
<varlistentry>
<term>-L servername</term>
<listitem><para>Sets the value of the %L macro to <replaceable>servername</replaceable>.
This is useful for testing include files specified with the
%L macro. </para></listitem>
</varlistentry>
<varlistentry>
<term>-v</term>
<listitem><para>If this option is specified, testparm
will also output all options that were not used in <citerefentry>
<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> and are thus set to their defaults.</para></listitem>
</varlistentry>
<varlistentry>
<term>-t encoding</term>
<listitem><para>
Output data in specified encoding.
</para></listitem>
</varlistentry>
<varlistentry>
<term>configfilename</term>
<listitem><para>This is the name of the configuration file
to check. If this parameter is not present then the
default <citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> file will be checked.
</para></listitem>
</varlistentry>
<varlistentry>
<term>hostname</term>
<listitem><para>If this parameter and the following are
specified, then <command>testparm</command> will examine the <parameter>hosts
allow</parameter> and <parameter>hosts deny</parameter>
parameters in the <citerefentry>
<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> file to
determine if the hostname with this IP address would be
allowed access to the <command>smbd</command> server. If
this parameter is supplied, the hostIP parameter must also
be supplied.</para></listitem>
</varlistentry>
<varlistentry>
<term>hostIP</term>
<listitem><para>This is the IP address of the host specified
in the previous parameter. This address must be supplied
if the hostname parameter is supplied. </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><citerefentry><refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry></term>
<listitem><para>This is usually the name of the configuration
file used by <citerefentry><refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>DIAGNOSTICS</title>
<para>The program will issue a message saying whether the
configuration file loaded OK or not. This message may be preceded by
errors and warnings if the file did not load. If the file was
loaded OK, the program then dumps all known service details
to stdout. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry>
<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry>, <citerefentry>
<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

149
docs/docbook/manpages/testprns.1.xml Normal file
View File

@ -0,0 +1,149 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="testprns.1">
<refmeta>
<refentrytitle>testprns</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>testprns</refname>
<refpurpose>check printer name for validity with smbd</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>testprns</command>
<arg choice="req">printername</arg>
<arg choice="opt">printcapname</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>testprns</command> is a very simple test program
to determine whether a given printer name is valid for use in
a service to be provided by <citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>.</para>
<para>"Valid" in this context means "can be found in the
printcap specified". This program is very stupid - so stupid in
fact that it would be wisest to always specify the printcap file
to use. </para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>printername</term>
<listitem><para>The printer name to validate.</para>
<para>Printer names are taken from the first field in each
record in the printcap file, single printer names and sets
of aliases separated by vertical bars ("|") are recognized.
Note that no validation or checking of the printcap syntax is
done beyond that required to extract the printer name. It may
be that the print spooling system is more forgiving or less
forgiving than <command>testprns</command>. However, if
<command>testprns</command> finds the printer then <citerefentry>
<refentrytitle>smbd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry> should do so as well. </para></listitem>
</varlistentry>
<varlistentry>
<term>printcapname</term>
<listitem><para>This is the name of the printcap file within
which to search for the given printer name. </para>
<para>If no printcap name is specified <command>testprns
</command> will attempt to scan the printcap file name
specified at compile time. </para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/printcap</filename></term>
<listitem><para>This is usually the default printcap
file to scan. See <filename>printcap (5)</filename>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>DIAGNOSTICS</title>
<para>If a printer is found to be valid, the message
"Printer name &lt;printername&gt; is valid" will be
displayed. </para>
<para>If a printer is found to be invalid, the message
"Printer name &lt;printername&gt; is not valid" will be
displayed. </para>
<para>All messages that would normally be logged during
operation of the Samba daemons are logged by this program to the
file <filename>test.log</filename> in the current directory. The
program runs at debuglevel 3, so quite extensive logging
information is written. The log should be checked carefully
for errors and warnings. </para>
<para>Other messages are self-explanatory. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><filename>printcap(5)</filename>,
<citerefentry><refentrytitle>smbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>smbclient</refentrytitle>
<manvolnum>1</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The original Samba man pages were written by Karl Auer.
The man page sources were converted to YODL format (another
excellent piece of Open Source software, available at <ulink url="ftp://ftp.icce.rug.nl/pub/unix/">
ftp://ftp.icce.rug.nl/pub/unix/</ulink>) and updated for the Samba 2.0
release by Jeremy Allison. The conversion to DocBook for
Samba 2.2 was done by Gerald Carter. The conversion to DocBook XML 4.2
for Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

153
docs/docbook/manpages/vfstest.1.xml Normal file
View File

@ -0,0 +1,153 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="vfstest.1">
<refmeta>
<refentrytitle>vfstest</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>vfstest</refname>
<refpurpose>tool for testing samba VFS modules </refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>vfstest</command>
<arg choice="opt">-d debuglevel</arg>
<arg choice="opt">-c command</arg>
<arg choice="opt">-l logfile</arg>
<arg choice="opt">-h</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>vfstest</command> is a small command line
utility that has the ability to test dso samba VFS modules. It gives the
user the ability to call the various VFS functions manually and
supports cascaded VFS modules.
</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-c|--command=command</term>
<listitem><para>Execute the specified (colon-separated) commands.
See below for the commands that are available.
</para> </listitem>
</varlistentry>
&stdarg.help;
<varlistentry>
<term>-l|--logfile=logbasename</term>
<listitem><para>File name for log/debug files. The extension
<constant>'.client'</constant> will be appended. The log file is never removed
by the client.
</para></listitem>
</varlistentry>
&popt.common.samba;
</variablelist>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<para><emphasis>VFS COMMANDS</emphasis></para>
<itemizedlist>
<listitem><para><command>load &lt;module.so&gt;</command> - Load specified VFS module </para></listitem>
<listitem><para><command>populate &lt;char&gt; &lt;size&gt;</command> - Populate a data buffer with the specified data
</para></listitem>
<listitem><para><command>showdata [&lt;offset&gt; &lt;len&gt;]</command> - Show data currently in data buffer
</para></listitem>
<listitem><para><command>connect</command> - VFS connect()</para></listitem>
<listitem><para><command>disconnect</command> - VFS disconnect()</para></listitem>
<listitem><para><command>disk_free</command> - VFS disk_free()</para></listitem>
<listitem><para><command>opendir</command> - VFS opendir()</para></listitem>
<listitem><para><command>readdir</command> - VFS readdir()</para></listitem>
<listitem><para><command>mkdir</command> - VFS mkdir()</para></listitem>
<listitem><para><command>rmdir</command> - VFS rmdir()</para></listitem>
<listitem><para><command>closedir</command> - VFS closedir()</para></listitem>
<listitem><para><command>open</command> - VFS open()</para></listitem>
<listitem><para><command>close</command> - VFS close()</para></listitem>
<listitem><para><command>read</command> - VFS read()</para></listitem>
<listitem><para><command>write</command> - VFS write()</para></listitem>
<listitem><para><command>lseek</command> - VFS lseek()</para></listitem>
<listitem><para><command>rename</command> - VFS rename()</para></listitem>
<listitem><para><command>fsync</command> - VFS fsync()</para></listitem>
<listitem><para><command>stat</command> - VFS stat()</para></listitem>
<listitem><para><command>fstat</command> - VFS fstat()</para></listitem>
<listitem><para><command>lstat</command> - VFS lstat()</para></listitem>
<listitem><para><command>unlink</command> - VFS unlink()</para></listitem>
<listitem><para><command>chmod</command> - VFS chmod()</para></listitem>
<listitem><para><command>fchmod</command> - VFS fchmod()</para></listitem>
<listitem><para><command>chown</command> - VFS chown()</para></listitem>
<listitem><para><command>fchown</command> - VFS fchown()</para></listitem>
<listitem><para><command>chdir</command> - VFS chdir()</para></listitem>
<listitem><para><command>getwd</command> - VFS getwd()</para></listitem>
<listitem><para><command>utime</command> - VFS utime()</para></listitem>
<listitem><para><command>ftruncate</command> - VFS ftruncate()</para></listitem>
<listitem><para><command>lock</command> - VFS lock()</para></listitem>
<listitem><para><command>symlink</command> - VFS symlink()</para></listitem>
<listitem><para><command>readlink</command> - VFS readlink()</para></listitem>
<listitem><para><command>link</command> - VFS link()</para></listitem>
<listitem><para><command>mknod</command> - VFS mknod()</para></listitem>
<listitem><para><command>realpath</command> - VFS realpath()</para></listitem>
</itemizedlist>
<para><emphasis>GENERAL COMMANDS</emphasis></para>
<itemizedlist>
<listitem><para><command>conf &lt;smb.conf&gt;</command> - Load a different configuration file</para></listitem>
<listitem><para><command>help [&lt;command&gt;]</command> - Get list of commands or info about specified command</para></listitem>
<listitem><para><command>debuglevel &lt;level&gt;</command> - Set debug level</para></listitem>
<listitem><para><command>freemem</command> - Free memory currently in use</para></listitem>
<listitem><para><command>exit</command> - Exit vfstest</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of the Samba
suite.</para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para>The vfstest man page was written by Jelmer Vernooij.</para>
</refsect1>
</refentry>

281
docs/docbook/manpages/wbinfo.1.xml Normal file
View File

@ -0,0 +1,281 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="wbinfo.1">
<refmeta>
<refentrytitle>wbinfo</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>wbinfo</refname>
<refpurpose>Query information from winbind daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>wbinfo</command>
<arg choice="opt">-u</arg>
<arg choice="opt">-g</arg>
<arg choice="opt">-N netbios-name</arg>
<arg choice="opt">-I ip</arg>
<arg choice="opt">-n name</arg>
<arg choice="opt">-s sid</arg>
<arg choice="opt">-U uid</arg>
<arg choice="opt">-G gid</arg>
<arg choice="opt">-S sid</arg>
<arg choice="opt">-Y sid</arg>
<arg choice="opt">-t</arg>
<arg choice="opt">-m</arg>
<arg choice="opt">--sequence</arg>
<arg choice="opt">-r user</arg>
<arg choice="opt">-a user%password</arg>
<arg choice="opt">-A user%password</arg>
<arg choice="opt">--get-auth-user</arg>
<arg choice="opt">-p</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This tool is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para>The <command>wbinfo</command> program queries and returns information
created and used by the <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> daemon. </para>
<para>The <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> daemon must be configured
and running for the <command>wbinfo</command> program to be able
to return information.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-u</term>
<listitem><para>This option will list all users available
in the Windows NT domain for which the <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> daemon is operating in. Users in all trusted domains
will also be listed. Note that this operation does not assign
user ids to any users that have not already been seen by <citerefentry>
<refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
.</para></listitem>
</varlistentry>
<varlistentry>
<term>-g</term>
<listitem><para>This option will list all groups available
in the Windows NT domain for which the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> daemon is operating in. Groups in all trusted domains
will also be listed. Note that this operation does not assign
group ids to any groups that have not already been
seen by <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>. </para></listitem>
</varlistentry>
<varlistentry>
<term>-N name</term>
<listitem><para>The <parameter>-N</parameter> option
queries <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> to query the WINS
server for the IP address associated with the NetBIOS name
specified by the <parameter>name</parameter> parameter.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-I ip</term>
<listitem><para>The <parameter>-I</parameter> option
queries <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> to send a node status
request to get the NetBIOS name associated with the IP address
specified by the <parameter>ip</parameter> parameter.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-n name</term>
<listitem><para>The <parameter>-n</parameter> option
queries <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> for the SID
associated with the name specified. Domain names can be specified
before the user name by using the winbind separator character.
For example CWDOM1/Administrator refers to the Administrator
user in the domain CWDOM1. If no domain is specified then the
domain used is the one specified in the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> <parameter>workgroup
</parameter> parameter. </para></listitem>
</varlistentry>
<varlistentry>
<term>-s sid</term>
<listitem><para>Use <parameter>-s</parameter> to resolve
a SID to a name. This is the inverse of the <parameter>-n
</parameter> option above. SIDs must be specified as ASCII strings
in the traditional Microsoft format. For example,
S-1-5-21-1455342024-3071081365-2475485837-500. </para></listitem>
</varlistentry>
<varlistentry>
<term>-U uid</term>
<listitem><para>Try to convert a UNIX user id to a Windows NT
SID. If the uid specified does not refer to one within
the winbind uid range then the operation will fail. </para></listitem>
</varlistentry>
<varlistentry>
<term>-G gid</term>
<listitem><para>Try to convert a UNIX group id to a Windows
NT SID. If the gid specified does not refer to one within
the winbind gid range then the operation will fail. </para></listitem>
</varlistentry>
<varlistentry>
<term>-S sid</term>
<listitem><para>Convert a SID to a UNIX user id. If the SID
does not correspond to a UNIX user mapped by <citerefentry>
<refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry> then the operation will fail. </para></listitem>
</varlistentry>
<varlistentry>
<term>-Y sid</term>
<listitem><para>Convert a SID to a UNIX group id. If the SID
does not correspond to a UNIX group mapped by <citerefentry>
<refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum></citerefentry> then
the operation will fail. </para></listitem>
</varlistentry>
<varlistentry>
<term>-t</term>
<listitem><para>Verify that the workstation trust account
created when the Samba server is added to the Windows NT
domain is working. </para></listitem>
</varlistentry>
<varlistentry>
<term>-m</term>
<listitem><para>Produce a list of domains trusted by the
Windows NT server <citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> contacts
when resolving names. This list does not include the Windows
NT domain the server is a Primary Domain Controller for.
</para></listitem>
</varlistentry>
<varlistentry>
<term>--sequence</term>
<listitem><para>Show sequence numbers of
all known domains</para></listitem>
</varlistentry>
<varlistentry>
<term>-r username</term>
<listitem><para>Try to obtain the list of UNIX group ids
to which the user belongs. This only works for users
defined on a Domain Controller.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-a username%password</term>
<listitem><para>Attempt to authenticate a user via winbindd.
This checks both authenticaion methods and reports its results.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-A username%password</term>
<listitem><para>Store username and password used by winbindd
during session setup to a domain controller. This enables
winbindd to operate in a Windows 2000 domain with Restrict
Anonymous turned on (a.k.a. Permissions compatiable with
Windows 2000 servers only).
</para></listitem>
</varlistentry>
<varlistentry>
<term>--get-auth-user</term>
<listitem><para>Print username and password used by winbindd
during session setup to a domain controller. Username
and password can be set using '-A'. Only available for
root.</para></listitem>
</varlistentry>
<varlistentry>
<term>-p</term>
<listitem><para>Check whether winbindd is still alive.
Prints out either 'succeeded' or 'failed'.
</para></listitem>
</varlistentry>
&stdarg.version;
&stdarg.help;
</variablelist>
</refsect1>
<refsect1>
<title>EXIT STATUS</title>
<para>The wbinfo program returns 0 if the operation
succeeded, or 1 if the operation failed. If the <citerefentry>
<refentrytitle>winbindd</refentrytitle><manvolnum>8</manvolnum>
</citerefentry> daemon is not working <command>wbinfo</command> will always return
failure. </para>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><citerefentry><refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para><command>wbinfo</command> and <command>winbindd</command>
were written by Tim Potter.</para>
<para>The conversion to DocBook for Samba 2.2 was done
by Gerald Carter. The conversion to DocBook XML 4.2 for Samba
3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

460
docs/docbook/manpages/winbindd.8.xml Normal file
View File

@ -0,0 +1,460 @@
<?xml version="1.0" encoding="iso8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
<refentry id="winbindd.8">
<refmeta>
<refentrytitle>winbindd</refentrytitle>
<manvolnum>8</manvolnum>
</refmeta>
<refnamediv>
<refname>winbindd</refname>
<refpurpose>Name Service Switch daemon for resolving names
from NT servers</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>winbindd</command>
<arg choice="opt">-F</arg>
<arg choice="opt">-S</arg>
<arg choice="opt">-i</arg>
<arg choice="opt">-B</arg>
<arg choice="opt">-d &lt;debug level&gt;</arg>
<arg choice="opt">-s &lt;smb config file&gt;</arg>
<arg choice="opt">-n</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This program is part of the <citerefentry><refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry> suite.</para>
<para><command>winbindd</command> is a daemon that provides
a service for the Name Service Switch capability that is present
in most modern C libraries. The Name Service Switch allows user
and system information to be obtained from different databases
services such as NIS or DNS. The exact behaviour can be configured
throught the <filename>/etc/nsswitch.conf</filename> file.
Users and groups are allocated as they are resolved to a range
of user and group ids specified by the administrator of the
Samba system.</para>
<para>The service provided by <command>winbindd</command> is called `winbind' and
can be used to resolve user and group information from a
Windows NT server. The service can also provide authentication
services via an associated PAM module. </para>
<para>
The <filename>pam_winbind</filename> module in the 2.2.2 release only
supports the <parameter>auth</parameter> and <parameter>account</parameter>
module-types. The latter simply
performs a getpwnam() to verify that the system can obtain a uid for the
user. If the <filename>libnss_winbind</filename> library has been correctly
installed, this should always succeed.
</para>
<para>The following nsswitch databases are implemented by
the winbindd service: </para>
<variablelist>
<varlistentry>
<term>hosts</term>
<listitem><para>User information traditionally stored in
the <filename>hosts(5)</filename> file and used by
<command>gethostbyname(3)</command> functions. Names are
resolved through the WINS server or by broadcast.
</para></listitem>
</varlistentry>
<varlistentry>
<term>passwd</term>
<listitem><para>User information traditionally stored in
the <filename>passwd(5)</filename> file and used by
<command>getpwent(3)</command> functions. </para></listitem>
</varlistentry>
<varlistentry>
<term>group</term>
<listitem><para>Group information traditionally stored in
the <filename>group(5)</filename> file and used by
<command>getgrent(3)</command> functions. </para></listitem>
</varlistentry>
</variablelist>
<para>For example, the following simple configuration in the
<filename>/etc/nsswitch.conf</filename> file can be used to initially
resolve user and group information from <filename>/etc/passwd
</filename> and <filename>/etc/group</filename> and then from the
Windows NT server.
<programlisting>
passwd: files winbind
group: files winbind
</programlisting></para>
<para>The following simple configuration in the
<filename>/etc/nsswitch.conf</filename> file can be used to initially
resolve hostnames from <filename>/etc/hosts</filename> and then from the
WINS server.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>-F</term>
<listitem><para>If specified, this parameter causes
the main <command>winbindd</command> process to not daemonize,
i.e. double-fork and disassociate with the terminal.
Child processes are still created as normal to service
each connection request, but the main process does not
exit. This operation mode is suitable for running
<command>winbindd</command> under process supervisors such
as <command>supervise</command> and <command>svscan</command>
from Daniel J. Bernstein's <command>daemontools</command>
package, or the AIX process monitor.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-S</term>
<listitem><para>If specified, this parameter causes
<command>winbindd</command> to log to standard output rather
than a file.</para></listitem>
</varlistentry>
&popt.common.samba;
&stdarg.help;
<varlistentry>
<term>-i</term>
<listitem><para>Tells <command>winbindd</command> to not
become a daemon and detach from the current terminal. This
option is used by developers when interactive debugging
of <command>winbindd</command> is required.
<command>winbindd</command> also logs to standard output,
as if the <command>-S</command> parameter had been given.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-n</term>
<listitem><para>Disable caching. This means winbindd will
always have to wait for a response from the domain controller
before it can respond to a client and this thus makes things
slower. The results will however be more accurate, since
results from the cache might not be up-to-date. This
might also temporarily hang winbindd if the DC doesn't respond.
</para></listitem>
</varlistentry>
<varlistentry>
<term>-B</term>
<listitem><para>Dual daemon mode. This means winbindd will run
as 2 threads. The first will answer all requests from the cache,
thus making responses to clients faster. The other will
update the cache for the query that the first has just responded.
Advantage of this is that responses stay accurate and are faster.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>NAME AND ID RESOLUTION</title>
<para>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 <command>
winbindd</command> performs. </para>
<para>As winbindd 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. </para>
<para>WARNING: The rid to unix id database is the only location
where the user and group mappings are stored by winbindd. If this
file is deleted or corrupted, there is no way for winbindd to
determine which user and group ids correspond to Windows NT user
and group rids. </para>
</refsect1>
<refsect1>
<title>CONFIGURATION</title>
<para>Configuration of the <command>winbindd</command> daemon
is done through configuration parameters in the <citerefentry>
<refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
</citerefentry> file. All parameters should be specified in the
[global] section of smb.conf. </para>
<itemizedlist>
<listitem><para><ulink url="smb.conf.5.html#WINBINDSEPARATOR">
<parameter>winbind separator</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#WINBINDUID">
<parameter>winbind uid</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#WINBINDGID">
<parameter>winbind gid</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#WINBINDCACHETIME">
<parameter>winbind cache time</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#WINBINDENUMUSERS">
<parameter>winbind enum users</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#WINBINDENUMGROUPS">
<parameter>winbind enum groups</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#TEMPLATEHOMEDIR">
<parameter>template homedir</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#TEMPLATESHELL">
<parameter>template shell</parameter></ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#WINBINDUSEDEFAULTDOMAIN">
<parameter>winbind use default domain</parameter></ulink></para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>EXAMPLE SETUP</title>
<para>To setup winbindd for user and group lookups plus
authentication from a domain controller use something like the
following setup. This was tested on a RedHat 6.2 Linux box. </para>
<para>In <filename>/etc/nsswitch.conf</filename> put the
following:
<programlisting>
passwd: files winbind
group: files winbind
</programlisting></para>
<para>In <filename>/etc/pam.d/*</filename> replace the <parameter>
auth</parameter> lines with something like this:
<programlisting>
auth required /lib/security/pam_securetty.so
auth required /lib/security/pam_nologin.so
auth sufficient /lib/security/pam_winbind.so
auth required /lib/security/pam_pwdb.so use_first_pass shadow nullok
</programlisting></para>
<para>Note in particular the use of the <parameter>sufficient
</parameter> keyword and the <parameter>use_first_pass</parameter> keyword. </para>
<para>Now replace the account lines with this: </para>
<para><command>account required /lib/security/pam_winbind.so
</command></para>
<para>The next step is to join the domain. To do that use the
<command>net</command> program like this: </para>
<para><command>net join -S PDC -U Administrator</command></para>
<para>The username after the <parameter>-U</parameter> can be any
Domain user that has administrator privileges on the machine.
Substitute the name or IP of your PDC for "PDC".</para>
<para>Next copy <filename>libnss_winbind.so</filename> to
<filename>/lib</filename> and <filename>pam_winbind.so
</filename> to <filename>/lib/security</filename>. A symbolic link needs to be
made from <filename>/lib/libnss_winbind.so</filename> to
<filename>/lib/libnss_winbind.so.2</filename>. If you are using an
older version of glibc then the target of the link should be
<filename>/lib/libnss_winbind.so.1</filename>.</para>
<para>Finally, setup a <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> containing directives like the
following:
<programlisting>
[global]
winbind separator = +
winbind cache time = 10
template shell = /bin/bash
template homedir = /home/%D/%U
winbind uid = 10000-20000
winbind gid = 10000-20000
workgroup = DOMAIN
security = domain
password server = *
</programlisting></para>
<para>Now start winbindd and you should find that your user and
group database is expanded to include your NT users and groups,
and that you can login to your unix box as a domain user, using
the DOMAIN+user syntax for the username. You may wish to use the
commands <command>getent passwd</command> and <command>getent group
</command> to confirm the correct operation of winbindd.</para>
</refsect1>
<refsect1>
<title>NOTES</title>
<para>The following notes are useful when configuring and
running <command>winbindd</command>: </para>
<para><citerefentry><refentrytitle>nmbd</refentrytitle>
<manvolnum>8</manvolnum></citerefentry> must be running on the local machine
for <command>winbindd</command> to work. <command>winbindd</command> queries
the list of trusted domains for the Windows NT server
on startup and when a SIGHUP is received. Thus, for a running <command>
winbindd</command> to become aware of new trust relationships between
servers, it must be sent a SIGHUP signal. </para>
<para>PAM is really easy to misconfigure. Make sure you know what
you are doing when modifying PAM configuration files. It is possible
to set up PAM such that you can no longer log into your system. </para>
<para>If more than one UNIX machine is running <command>winbindd</command>,
then in general the user and groups ids allocated by winbindd will not
be the same. The user and group ids will only be valid for the local
machine.</para>
<para>If the the Windows NT RID to UNIX user and group id mapping
file is damaged or destroyed then the mappings will be lost. </para>
</refsect1>
<refsect1>
<title>SIGNALS</title>
<para>The following signals can be used to manipulate the
<command>winbindd</command> daemon. </para>
<variablelist>
<varlistentry>
<term>SIGHUP</term>
<listitem><para>Reload the <citerefentry><refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry> file and
apply any parameter changes to the running
version of winbindd. This signal also clears any cached
user and group information. The list of other domains trusted
by winbindd is also reloaded. </para></listitem>
</varlistentry>
<varlistentry>
<term>SIGUSR1</term>
<listitem><para>The SIGUSR1 signal will cause <command>
winbindd</command> to write status information to the winbind
log file including information about the number of user and
group ids allocated by <command>winbindd</command>.</para>
<para>Log files are stored in the filename specified by the
log file parameter.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>/etc/nsswitch.conf(5)</filename></term>
<listitem><para>Name service switch configuration file.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>/tmp/.winbindd/pipe</term>
<listitem><para>The UNIX pipe over which clients communicate with
the <command>winbindd</command> program. For security reasons, the
winbind client will only attempt to connect to the winbindd daemon
if both the <filename>/tmp/.winbindd</filename> directory
and <filename>/tmp/.winbindd/pipe</filename> file are owned by
root. </para></listitem>
</varlistentry>
<varlistentry>
<term>$LOCKDIR/winbindd_privilaged/pipe</term>
<listitem><para>The UNIX pipe over which 'privilaged' clients
communicate with the <command>winbindd</command> program. For security
reasons, access to some winbindd functions - like those needed by
the <command>ntlm_auth</command> utility - is restricted. By default,
only users in the 'root' group will get this access, however the administrator
may change the group permissions on $LOCKDIR/winbindd_privilaged to allow
programs like 'squid' to use ntlm_auth.
Note that the winbind client will only attempt to connect to the winbindd daemon
if both the <filename>$LOCKDIR/winbindd_privilaged</filename> directory
and <filename>$LOCKDIR/winbindd_privilaged/pipe</filename> file are owned by
root. </para></listitem>
</varlistentry>
<varlistentry>
<term>/lib/libnss_winbind.so.X</term>
<listitem><para>Implementation of name service switch library.
</para></listitem>
</varlistentry>
<varlistentry>
<term>$LOCKDIR/winbindd_idmap.tdb</term>
<listitem><para>Storage for the Windows NT rid to UNIX user/group
id mapping. The lock directory is specified when Samba is initially
compiled using the <parameter>--with-lockdir</parameter> option.
This directory is by default <filename>/usr/local/samba/var/locks
</filename>. </para></listitem>
</varlistentry>
<varlistentry>
<term>$LOCKDIR/winbindd_cache.tdb</term>
<listitem><para>Storage for cached user and group information.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>VERSION</title>
<para>This man page is correct for version 3.0 of
the Samba suite.</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para><filename>nsswitch.conf(5)</filename>, <citerefentry>
<refentrytitle>Samba</refentrytitle>
<manvolnum>7</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>wbinfo</refentrytitle>
<manvolnum>8</manvolnum></citerefentry>, <citerefentry>
<refentrytitle>smb.conf</refentrytitle>
<manvolnum>5</manvolnum></citerefentry></para>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>The original Samba software and related utilities
were created by Andrew Tridgell. Samba is now developed
by the Samba Team as an Open Source project similar
to the way the Linux kernel is developed.</para>
<para><command>wbinfo</command> and <command>winbindd</command> were
written by Tim Potter.</para>
<para>The conversion to DocBook for Samba 2.2 was done
by Gerald Carter. The conversion to DocBook XML 4.2 for
Samba 3.0 was done by Alexander Bokovoy.</para>
</refsect1>
</refentry>

167
docs/docbook/projdoc/ADS-HOWTO.xml Normal file
View File

@ -0,0 +1,167 @@
<chapter id="ADS">
<chapterinfo>
&author.tridge;
&author.jelmer;
<pubdate>2002/2003</pubdate>
</chapterinfo>
<title>Samba as a ADS domain member</title>
<para>
This is a rough guide to setting up Samba 3.0 with kerberos authentication against a
Windows2000 KDC.
</para>
<sect1>
<title>Setup your <filename>smb.conf</filename></title>
<para>You must use at least the following 3 options in smb.conf:</para>
<para><programlisting>
realm = YOUR.KERBEROS.REALM
security = ADS
encrypt passwords = yes
</programlisting></para>
<para>
In case samba can't figure out your ads server using your realm name, use the
<command>ads server</command> option in <filename>smb.conf</filename>:
<programlisting>
ads server = your.kerberos.server
</programlisting>
</para>
<note><para>You do *not* need a smbpasswd file, and older clients will
be authenticated as if <command>security = domain</command>,
although it won't do any harm
and allows you to have local users not in the domain.
I expect that the above required options will change soon when we get better
active directory integration.</para></note>
</sect1>
<sect1>
<title>Setup your <filename>/etc/krb5.conf</filename></title>
<para>Note: you will need the krb5 workstation, devel, and libs installed</para>
<para>The minimal configuration for <filename>krb5.conf</filename> is:</para>
<para><programlisting>
[realms]
YOUR.KERBEROS.REALM = {
kdc = your.kerberos.server
}
</programlisting></para>
<para>Test your config by doing a <userinput>kinit
<replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput> and
making sure that your password is accepted by the Win2000 KDC.
</para>
<note><para>The realm must be uppercase or you will get "Cannot find KDC for requested
realm while getting initial credentials" error </para></note>
<note><para>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 is more than five minutes. </para></note>
<para>
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 (ie. the hostname with no
domain attached) or it can alternatively be the netbios name
followed by the realm.
</para>
<para>
The easiest way to ensure you get this right is to add a
<filename>/etc/hosts</filename> entry mapping the IP address of your KDC to
its netbios name. If you don't get this right then you will get a
"local error" when you try to join the realm.
</para>
<para>
If all you want is kerberos support in &smbclient; then you can skip
straight to <link linkend="ads-test-smbclient">Test with &smbclient;</link> now.
<link linkend="ads-create-machine-account">Creating a computer account</link>
and <link linkend="ads-test-server">testing your servers</link>
is only needed if you want kerberos support for &smbd; and &winbindd;.
</para>
</sect1>
<sect1 id="ads-create-machine-account">
<title>Create the computer account</title>
<para>
As a user that has write permission on the Samba private directory
(usually root) run:
<programlisting>
<userinput>net join -U Administrator%password</userinput>
</programlisting>
</para>
<sect2>
<title>Possible errors</title>
<para>
<variablelist>
<varlistentry><term>"ADS support not compiled in"</term>
<listitem><para>Samba must be reconfigured (remove config.cache) and recompiled
(make clean all install) after the kerberos libs and headers are installed.
</para></listitem></varlistentry>
<varlistentry><term>net join prompts for user name</term>
<listitem><para>You need to login to the domain using <userinput>kinit
<replaceable>USERNAME</replaceable>@<replaceable>REALM</replaceable></userinput>.
<replaceable>USERNAME</replaceable> must be a user who has rights to add a machine
to the domain. </para></listitem></varlistentry>
</variablelist>
</para>
</sect2>
</sect1>
<sect1 id="ads-test-server">
<title>Test your server setup</title>
<para>
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.
</para>
<para>
On a Windows 2000 client try <userinput>net use * \\server\share</userinput>. You should
be logged in with kerberos without needing to know a password. If
this fails then run <userinput>klist tickets</userinput>. Did you get a ticket for the
server? Does it have an encoding type of DES-CBC-MD5 ?
</para>
</sect1>
<sect1 id="ads-test-smbclient">
<title>Testing with &smbclient;</title>
<para>
On your Samba server try to login to a Win2000 server or your Samba
server using &smbclient; and kerberos. Use &smbclient; as usual, but
specify the <parameter>-k</parameter> option to choose kerberos authentication.
</para>
</sect1>
<sect1>
<title>Notes</title>
<para>You must change administrator password at least once after DC
install, to create the right encoding types</para>
<para>w2k doesn't seem to create the _kerberos._udp and _ldap._tcp in
their defaults DNS setup. Maybe fixed in service packs?</para>
</sect1>
</chapter>

291
docs/docbook/projdoc/AdvancedNetworkAdmin.xml Normal file
View File

@ -0,0 +1,291 @@
<chapter id="AdvancedNetworkManagement">
<chapterinfo>
&author.jht;
<pubdate>April 3 2003</pubdate>
</chapterinfo>
<title>Advanced Network Manangement</title>
<para>
This section attempts to document 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.
</para>
<sect1>
<title>Configuring Samba Share Access Controls</title>
<para>
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 a very 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 <emphasis>Everyone</emphasis> Full Control (ie: Full control, Change and Read).
</para>
<para>
At this time Samba does NOT provide a tool for configuring access control setting on the Share
itself. Samba does have the capacity to store and act on access control settings, but the only
way to create those settings is to use either the NT4 Server Manager or the Windows 200x MMC for
Computer Management.
</para>
<para>
Samba stores the per share access control settings in a file called <filename>share_info.tdb</filename>.
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 <filename>/usr/local/samba/var</filename>. If the <filename>tdbdump</filename>
utility has been compiled and installed on your system then you can examine the contents of this file
by: <userinput>tdbdump share_info.tdb</userinput>.
</para>
<sect2>
<title>Share Permissions Management</title>
<para>
The best tool for the task is platform dependant. Choose the best tool for your environmemt.
</para>
<sect3>
<title>Windows NT4 Workstation/Server</title>
<para>
The tool you need to use to manage share permissions on a Samba 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 Microsoft - see details below.
</para>
<procedure>
<title>Instructions</title>
<step><para>
Launch the NT4 Server Manager, click on the Samba server you want to administer, then from the menu
select Computer, then click on the Shared Directories entry.
</para></step>
<step><para>
Now click on the share that you wish to manage, then click on the Properties tab, next click on
the Permissions tab. Now you can Add or change access control settings as you wish.
</para></step>
</procedure>
</sect3>
<sect3>
<title>Windows 200x/XP</title>
<para>
On MS Windows NT4/200x/XP system access control lists on the share itself are set using native
tools, usually from filemanager. For example, in Windows 200x: right click on the shared folder,
then select 'Sharing', then click on 'Permissions'. The default Windows NT4/200x permission allows
<emphasis>Everyone</emphasis> Full Control on the Share.
</para>
<para>
MS Windows 200x and later all comes with a tool called the 'Computer Management' snap-in for the
Microsoft Management Console (MMC). This tool is located by clicking on <filename>Control Panel ->
Administrative Tools -> Computer Management</filename>.
</para>
<procedure>
<title>Instructions</title>
<step><para>
After launching the MMC with the Computer Management snap-in, click on the menu item 'Action',
select '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 where already logged in with administrative privilidge this step is not offered.
</para></step>
<step><para>
If the Samba server is not shown in the Select Computer box, then type in the name of the target
Samba server in the field 'Name:'. Now click on the [+] next to 'System Tools', then on the [+]
next to 'Shared Folders' in the left panel.
</para></step>
<step><para>
Now in the right panel, double-click on the share you wish to set access control permissions on.
Then click on the tab 'Share Permissions'. It is now possible to add access control entities
to the shared folder. Do NOT forget to set what type of access (full control, change, read) you
wish to assign for each entry.
</para></step>
</procedure>
<warning>
<para>
Be careful. If you take away all permissions from the Everyone user without removing this user
then effectively no user will be able to access the share. This is a result of what is known as
ACL precidence. ie: Everyone with NO ACCESS means that MaryK who is part of the group Everyone
will have no access even if this user is given explicit full control access.
</para>
</warning>
</sect3>
</sect2>
</sect1>
<sect1>
<title>Remote Server Administration</title>
<para>
<emphasis>How do I get 'User Manager' and 'Server Manager'?</emphasis>
</para>
<para>
Since I don't need to buy an NT4 Server, how do I get the 'User Manager for Domains',
the 'Server Manager'?
</para>
<para>
Microsoft distributes a version of these tools called nexus for installation on Windows 9x / Me
systems. The tools set includes:
</para>
<itemizedlist>
<listitem><para>Server Manager</para></listitem>
<listitem><para>User Manager for Domains</para></listitem>
<listitem><para>Event Viewer</para></listitem>
</itemizedlist>
<para>
Click here to download the archived file <ulink
url="ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/NEXUS.EXE</ulink>
</para>
<para>
The Windows NT 4.0 version of the 'User Manager for
Domains' and 'Server Manager' are available from Microsoft via ftp
from <ulink url="ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE">ftp://ftp.microsoft.com/Softlib/MSLFILES/SRVTOOLS.EXE</ulink>
</para>
</sect1>
<sect1>
<title>Network Logon Script Magic</title>
<para>
This section needs work. Volunteer contributions most welcome. Please send your patches or updates
to <ulink url="mailto:jht@samba.org">John Terpstra</ulink>.
</para>
<para>
There are several opportunities for creating a custom network startup configuration environment.
</para>
<simplelist>
<member>No Logon Script</member>
<member>Simple universal Logon Script that applies to all users</member>
<member>Use of a conditional Logon Script that applies per user or per group attirbutes</member>
<member>Use of Samba's Preexec and Postexec functions on access to the NETLOGON share to create
a custom Logon Script and then execute it.</member>
<member>User of a tool such as KixStart</member>
</simplelist>
<para>
The Samba source code tree includes two logon script generation/execution tools. See <filename>examples</filename> directory <filename>genlogon</filename> and <filename>ntlogon</filename> subdirectories.
</para>
<para>
The following listings are from the genlogon directory.
</para>
<para>
This is the genlogon.pl file:
<programlisting>
#!/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 Standard's 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 - 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;
</programlisting>
</para>
<para>
Those wishing to use more elaborate or capable logon processing system should check out the following sites:
</para>
<simplelist>
<member>http://www.craigelachie.org/rhacer/ntlogon</member>
<member>http://www.kixtart.org</member>
<member>http://support.microsoft.com/default.asp?scid=kb;en-us;189105</member>
</simplelist>
<sect2>
<title>Adding printers without user intervention</title>
<para>
Printers may be added automatically during logon script processing through the use of:
<programlisting>
rundll32 printui.dll,PrintUIEntry /?
</programlisting>
See the documentation in the Microsoft knowledgebase article no: 189105 referred to above.
</para>
</sect2>
</sect1>
</chapter>

201
docs/docbook/projdoc/Bugs.xml Normal file
View File

@ -0,0 +1,201 @@
<chapter id="bugreport">
<chapterinfo>
&author.jelmer;
<author>
<affiliation>
<orgname>Samba Team</orgname>
</affiliation>
</author>
<pubdate> 27 June 1997 </pubdate>
</chapterinfo>
<title>Reporting Bugs</title>
<sect1>
<title>Introduction</title>
<para>Please report bugs using <ulink url="https://bugzilla.samba.org/">bugzilla</ulink>.</para>
<para>
Please take the time to read this file before you submit a bug
report. Also, please see if it has changed between releases, as we
may be changing the bug reporting mechanism at some time.
</para>
<para>
Please also 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 about it than
we can possibly answer, so you have a much higher chance of an answer
and a fix if you send us a "developer friendly" bug report that lets
us fix it fast.
</para>
<para>
Do not assume that if you post the bug to the comp.protocols.smb
newsgroup or the mailing list that we will read it. If you suspect that your
problem is not a bug but a configuration problem then it is better to send
it to the Samba mailing list, as there are (at last count) 5000 other users on
that list that may be able to help you.
</para>
<para>
You may also like to look though the recent mailing list archives,
which are conveniently accessible on the Samba web pages
at <ulink url="http://samba.org/samba/">http://samba.org/samba/</ulink>.
</para>
</sect1>
<sect1>
<title>General info</title>
<para>
Before submitting a bug report check your config for silly
errors. Look in your log files for obvious messages that tell you that
you've misconfigured something and run testparm to test your config
file for correct syntax.
</para>
<para>
Have you run through the <link linkend="diagnosis">diagnosis</link>?
This is very important.
</para>
<para>
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.
</para>
</sect1>
<sect1>
<title>Debug levels</title>
<para>
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 very useful. Depending on the problem a log level of between 3 and
10 showing the problem may be appropriate. A higher level givesmore
detail, but may use too much disk space.
</para>
<para>
To set the debug level use <command>log level =</command> in your
&smb.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 use:
</para>
<para><programlisting>
log level = 10
log file = /usr/local/samba/lib/log.%m
include = /usr/local/samba/lib/smb.conf.%m
</programlisting></para>
<para>
then create a file
<filename>/usr/local/samba/lib/smb.conf.<replaceable>machine</replaceable></filename> where
<replaceable>machine</replaceable> is the name of the client you wish to debug. In that file
put any &smb.conf; commands you want, for example
<command>log level=</command> may be useful. This also allows you to
experiment with different security systems, protocol levels etc on just
one machine.
</para>
<para>
The &smb.conf; entry <command>log level =</command>
is synonymous with the entry <command>debuglevel =</command> that has been
used in older versions of Samba and is being retained for backwards
compatibility of &smb.conf; files.
</para>
<para>
As the <command>log level =</command> value is increased you will record
a significantly increasing level of debugging information. For most
debugging operations you may not need a setting higher than 3. Nearly
all bugs can be tracked at a setting of 10, but be prepared for a VERY
large volume of log data.
</para>
</sect1>
<sect1>
<title>Internal errors</title>
<para>
If you get a "INTERNAL ERROR" message 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).
</para>
<para>
If the message came from smbd then it will probably be accompanied by
a message which details the last SMB message received by smbd. This
info is often very useful in tracking down the problem so please
include it in your bug report.
</para>
<para>
You should also detail how to reproduce the problem, if
possible. Please make this reasonably detailed.
</para>
<para>
You may also find that a core file appeared in a <filename>corefiles</filename>
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:
</para>
<para><command>gdb smbd core</command></para>
<para>
adding appropriate paths to smbd and core so gdb can find them. If you
don't have gdb then try <userinput>dbx</userinput>. Then within the debugger use the
command <userinput>where</userinput> to give a stack trace of where the problem
occurred. Include this in your mail.
</para>
<para>
If you know any assembly language then do a <userinput>disass</userinput> of the routine
where the problem occurred (if its 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
don't know assembly then incuding this info in the bug report can be
useful.
</para>
</sect1>
<sect1>
<title>Attaching to a running process</title>
<para>
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 <userinput>gdb smbd <replaceable>PID</replaceable></userinput> where you get <replaceable>PID</replaceable> from
<application>smbstatus</application>. Then use <userinput>c</userinput> to continue and try to cause the core dump
using the client. The debugger should catch the fault and tell you
where it occurred.
</para>
</sect1>
<sect1>
<title>Patches</title>
<para>
The best sort of bug report is one that includes a fix! If you send us
patches please use <userinput>diff -u</userinput> format if your version of
diff supports it, otherwise use <userinput>diff -c4</userinput>. Make sure
you do the diff against a clean version of the source and let me know
exactly what version you used.
</para>
</sect1>
</chapter>

1793
docs/docbook/projdoc/CUPS-printing.xml Normal file
View File

File diff suppressed because it is too large Load Diff

438
docs/docbook/projdoc/Compiling.xml Normal file
View File

@ -0,0 +1,438 @@
<chapter id="compiling">
<chapterinfo>
<author>
<affiliation>
<orgname>Samba Team</orgname>
</affiliation>
</author>
&author.jelmer;
<pubdate> (22 May 2001) </pubdate>
<pubdate> 18 March 2003 </pubdate>
</chapterinfo>
<title>How to compile SAMBA</title>
<para>
You can obtain the samba source from the <ulink url="http://samba.org/">samba website</ulink>. To obtain a development version,
you can download samba from CVS or using rsync.
</para>
<sect1>
<title>Access Samba source code via CVS</title>
<sect2>
<title>Introduction</title>
<para>
Samba is developed in an open environment. Developers use CVS
(Concurrent Versioning System) to "checkin" (also known as
"commit") new source code. Samba's various CVS branches can
be accessed via anonymous CVS using the instructions
detailed in this chapter.
</para>
<para>
This chapter is a modified version of the instructions found at
<ulink url="http://samba.org/samba/cvs.html">http://samba.org/samba/cvs.html</ulink>
</para>
</sect2>
<sect2>
<title>CVS Access to samba.org</title>
<para>
The machine samba.org runs a publicly accessible CVS
repository for access to the source code of several packages,
including samba, rsync and jitterbug. There are two main ways of
accessing the CVS server on this host.
</para>
<sect3>
<title>Access via CVSweb</title>
<para>
You can access the source code via your
favourite 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.
</para>
<para>
Use the URL : <ulink
url="http://samba.org/cgi-bin/cvsweb">http://samba.org/cgi-bin/cvsweb</ulink>
</para>
</sect3>
<sect3>
<title>Access via cvs</title>
<para>
You can also access the source code via a
normal cvs client. This gives you much more control over what you can
do with the repository and allows you to checkout whole source trees
and keep them up to date via normal cvs commands. This is the
preferred method of access if you are a developer and not
just a casual browser.
</para>
<para>
To download the latest cvs source code, point your
browser at the URL : <ulink url="http://www.cyclic.com/">http://www.cyclic.com/</ulink>.
and click on the 'How to get cvs' link. CVS is free software under
the GNU GPL (as is Samba). Note that there are several graphical CVS clients
which provide a graphical interface to the sometimes mundane CVS commands.
Links to theses clients are also available from http://www.cyclic.com.
</para>
<para>
To gain access via anonymous cvs use the following steps.
For this example it is assumed that you want a copy of the
samba source code. For the other source code repositories
on this system just substitute the correct package name
</para>
<orderedlist>
<listitem>
<para>
Install a recent copy of cvs. All you really need is a
copy of the cvs client binary.
</para>
</listitem>
<listitem>
<para>
Run the command
</para>
<para>
<userinput>cvs -d :pserver:cvs@samba.org:/cvsroot login</userinput>
</para>
<para>
When it asks you for a password type <userinput>cvs</userinput>.
</para>
</listitem>
<listitem>
<para>
Run the command
</para>
<para>
<userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co samba</userinput>
</para>
<para>
This will create a directory called samba containing the
latest samba source code (i.e. the HEAD tagged cvs branch). This
currently corresponds to the 3.0 development tree.
</para>
<para>
CVS branches other then HEAD can be obtained by using the <parameter>-r</parameter>
and defining a tag name. A list of branch tag names can be found on the
"Development" page of the samba web site. A common request is to obtain the
latest 2.2 release code. This could be done by using the following userinput.
</para>
<para>
<userinput>cvs -d :pserver:cvs@samba.org:/cvsroot co -r SAMBA_2_2 samba</userinput>
</para>
</listitem>
<listitem>
<para>
Whenever you want to merge in the latest code changes use
the following command from within the samba directory:
</para>
<para>
<userinput>cvs update -d -P</userinput>
</para>
</listitem>
</orderedlist>
</sect3>
</sect2>
</sect1>
<sect1>
<title>Accessing the samba sources via rsync and ftp</title>
<para>
pserver.samba.org also exports unpacked copies of most parts of the CVS tree at <ulink url="ftp://pserver.samba.org/pub/unpacked">ftp://pserver.samba.org/pub/unpacked</ulink> and also via anonymous rsync at rsync://pserver.samba.org/ftp/unpacked/. I recommend using rsync rather than ftp.
See <ulink url="http://rsync.samba.org/">the rsync homepage</ulink> for more info on rsync.
</para>
<para>
The disadvantage of the unpacked trees
is that they do not support automatic
merging of local changes like CVS does.
rsync access is most convenient for an
initial install.
</para>
</sect1>
<sect1>
<title>Verifying Samba's PGP signature</title>
<para>
In these days of insecurity, it's strongly recommended that you verify the PGP signature for any
source file before installing it. According to Jerry Carter of the Samba Team, only about 22% of
all Samba downloads have had a corresponding PGP signature download (a very low percentage, which
should be considered a bad thing). Even if you're not downloading from a mirror site, verifying PGP
signatures should be a standard reflex.
</para>
<para>
With that said, go ahead and download the following files:
</para>
<para><programlisting>
$ wget http://us1.samba.org/samba/ftp/samba-2.2.8a.tar.asc
$ wget http://us1.samba.org/samba/ftp/samba-pubkey.asc
</programlisting></para>
<para>
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:
</para>
<programlisting>
$ gpg --import samba-pubkey.asc
</programlisting>
<para>
And verify the Samba source code integrity with:
</para>
<programlisting>
$ gzip -d samba-2.2.8a.tar.gz
$ gpg --verify samba-2.2.8a.tar.asc
</programlisting>
<para>
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:
</para>
<programlisting>
gpg: BAD signature from "Samba Distribution Verification Key"
</programlisting>
</sect1>
<sect1>
<title>Building the Binaries</title>
<para>To do this, first run the program <userinput>./configure
</userinput> in the source directory. This should automatically
configure Samba for your operating system. If you have unusual
needs then you may wish to run</para>
<para><prompt>root# </prompt><userinput>./configure --help
</userinput></para>
<para>first to see what special options you can enable.
Then executing</para>
<para><prompt>root# </prompt><userinput>make</userinput></para>
<para>will create the binaries. Once it's successfully
compiled you can use </para>
<para><prompt>root# </prompt><userinput>make install</userinput></para>
<para>to install the binaries and manual pages. You can
separately install the binaries and/or man pages using</para>
<para><prompt>root# </prompt><userinput>make installbin
</userinput></para>
<para>and</para>
<para><prompt>root# </prompt><userinput>make installman
</userinput></para>
<para>Note that if you are upgrading for a previous version
of Samba you might like to know that the old versions of
the binaries will be renamed with a ".old" extension. You
can go back to the previous version with</para>
<para><prompt>root# </prompt><userinput>make revert
</userinput></para>
<para>if you find this version a disaster!</para>
<sect2>
<title>Compiling samba with Active Directory support</title>
<para>In order to compile samba with ADS support, you need to have installed
on your system:</para>
<itemizedlist>
<listitem><para>the MIT kerberos development libraries
(either install from the sources or use a package). The
heimdal libraries will not work.</para></listitem>
<listitem><para>the OpenLDAP development libraries.</para></listitem>
</itemizedlist>
<para>If your kerberos libraries are in a non-standard location then
remember to add the configure option --with-krb5=DIR.</para>
<para>After you run configure make sure that <filename>include/config.h</filename> it generates contains lines like this:</para>
<para><programlisting>
#define HAVE_KRB5 1
#define HAVE_LDAP 1
</programlisting></para>
<para>If it doesn't then configure did not find your krb5 libraries or
your ldap libraries. Look in config.log to figure out why and fix
it.</para>
<sect3>
<title>Installing the required packages for Debian</title>
<para>On Debian you need to install the following packages:</para>
<para>
<itemizedlist>
<listitem>libkrb5-dev</listitem>
<listitem>krb5-user</listitem>
</itemizedlist>
</para>
</sect3>
<sect3>
<title>Installing the required packages for RedHat</title>
<para>On RedHat this means you should have at least: </para>
<para>
<itemizedlist>
<listitem>krb5-workstation (for kinit)</listitem>
<listitem>krb5-libs (for linking with)</listitem>
<listitem>krb5-devel (because you are compiling from source)</listitem>
</itemizedlist>
</para>
<para>in addition to the standard development environment.</para>
<para>Note that these are not standard on a RedHat install, and you may need
to get them off CD2.</para>
</sect3>
</sect2>
</sect1>
<sect1>
<title>Starting the smbd and nmbd</title>
<para>You must choose to start smbd and nmbd either
as daemons or from <application>inetd</application>Don't try
to do both! Either you can put them in <filename>
inetd.conf</filename> and have them started on demand
by <application>inetd</application>, or you can start them as
daemons either from the command line or in <filename>
/etc/rc.local</filename>. See the man pages for details
on the command line options. Take particular care to read
the bit about what user you need to be in order to start
Samba. In many cases you must be root.</para>
<para>The main advantage of starting <application>smbd</application>
and <application>nmbd</application> using the recommended daemon method
is that they will respond slightly more quickly to an initial connection
request.</para>
<sect2>
<title>Starting from inetd.conf</title>
<para>NOTE; The following will be different if
you use NIS, NIS+ or LDAP to distribute services maps.</para>
<para>Look at your <filename>/etc/services</filename>.
What is defined at port 139/tcp. If nothing is defined
then add a line like this:</para>
<para><userinput>netbios-ssn 139/tcp</userinput></para>
<para>similarly for 137/udp you should have an entry like:</para>
<para><userinput>netbios-ns 137/udp</userinput></para>
<para>Next edit your <filename>/etc/inetd.conf</filename>
and add two lines something like this:</para>
<para><programlisting>
netbios-ssn stream tcp nowait root /usr/local/samba/bin/smbd smbd
netbios-ns dgram udp wait root /usr/local/samba/bin/nmbd nmbd
</programlisting></para>
<para>The exact syntax of <filename>/etc/inetd.conf</filename>
varies between unixes. Look at the other entries in inetd.conf
for a guide.</para>
<note><para>Some unixes already have entries like netbios_ns
(note the underscore) in <filename>/etc/services</filename>.
You must either edit <filename>/etc/services</filename> or
<filename>/etc/inetd.conf</filename> to make them consistent.</para></note>
<note><para>On many systems you may need to use the
<command>interfaces</command> option in &smb.conf; to specify the IP address
and netmask of your interfaces. Run <application>ifconfig</application>
as root if you don't know what the broadcast is for your
net. &nmbd; tries to determine it at run
time, but fails on some unixes.
</para></note>
<warning><para>Many unixes only accept around 5
parameters on the command line in <filename>inetd.conf</filename>.
This means you shouldn't use spaces between the options and
arguments, or you should use a script, and start the script
from <command>inetd</command>.</para></warning>
<para>Restart <command>inetd</command>, perhaps just send
it a HUP. If you have installed an earlier version of <application>
nmbd</application> then you may need to kill nmbd as well.</para>
</sect2>
<sect2>
<title>Alternative: starting it as a daemon</title>
<para>To start the server as a daemon you should create
a script something like this one, perhaps calling
it <filename>startsmb</filename>.</para>
<para><programlisting>
#!/bin/sh
/usr/local/samba/bin/smbd -D
/usr/local/samba/bin/nmbd -D
</programlisting></para>
<para>then make it executable with <command>chmod
+x startsmb</command></para>
<para>You can then run <command>startsmb</command> by
hand or execute it from <filename>/etc/rc.local</filename>
</para>
<para>To kill it send a kill signal to the processes
<command>nmbd</command> and <command>smbd</command>.</para>
<note><para>If you use the SVR4 style init system then
you may like to look at the <filename>examples/svr4-startup</filename>
script to make Samba fit into that system.</para></note>
</sect2>
</sect1>
</chapter>

161
docs/docbook/projdoc/DOMAIN_MEMBER.xml Normal file
View File

@ -0,0 +1,161 @@
<chapter id="domain-member">
<chapterinfo>
&author.jeremy;
&author.jerry;
<pubdate>16 Apr 2001</pubdate>
</chapterinfo>
<title>Samba as a NT4 or Win2k domain member</title>
<sect1>
<title>Joining an NT Domain with Samba 3.0</title>
<para><emphasis>Assumptions:</emphasis>
<programlisting>
NetBIOS name: SERV1
Win2K/NT domain name: DOM
Domain's PDC NetBIOS name: DOMPDC
Domain's BDC NetBIOS names: DOMBDC1 and DOMBDC2
</programlisting>
</para>
<para>First, you must edit your &smb.conf; file to tell Samba it should
now use domain security.</para>
<para>Change (or add) your <ulink url="smb.conf.5.html#SECURITY">
<parameter>security =</parameter></ulink> line in the [global] section
of your &smb.conf; to read:</para>
<para><command>security = domain</command></para>
<para>Next change the <ulink url="smb.conf.5.html#WORKGROUP"><parameter>
workgroup =</parameter></ulink> line in the [global] section to read: </para>
<para><command>workgroup = DOM</command></para>
<para>as this is the name of the domain we are joining. </para>
<para>You must also have the parameter <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">
<parameter>encrypt passwords</parameter></ulink> set to <constant>yes
</constant> in order for your users to authenticate to the NT PDC.</para>
<para>Finally, add (or modify) a <ulink url="smb.conf.5.html#PASSWORDSERVER">
<parameter>password server =</parameter></ulink> line in the [global]
section to read: </para>
<para><command>password server = DOMPDC DOMBDC1 DOMBDC2</command></para>
<para>These are the primary and backup domain controllers 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.</para>
<para>Alternatively, if you want smbd to automatically determine
the list of Domain controllers to use for authentication, you may
set this line to be :</para>
<para><command>password server = *</command></para>
<para>This method, allows Samba to use exactly the same
mechanism that NT does. This
method either broadcasts or uses a WINS database in order to
find domain controllers to authenticate against.</para>
<para>In order to actually join the domain, you must run this
command:</para>
<para><prompt>root# </prompt><userinput>net join -S DOMPDC
-U<replaceable>Administrator%password</replaceable></userinput></para>
<para>
If the <userinput>-S DOMPDC</userinput> argument is not given then
the domain name will be obtained from smb.conf.
</para>
<para>as we are joining the domain DOM and the PDC for that domain
(the only machine that has write access to the domain SAM database)
is DOMPDC. The <replaceable>Administrator%password</replaceable> is
the login name and password for an account which has the necessary
privilege to add machines to the domain. If this is successful
you will see the message:</para>
<para><computeroutput>Joined domain DOM.</computeroutput>
or <computeroutput>Joined 'SERV1' to realm 'MYREALM'</computeroutput>
</para>
<para>in your terminal window. See the <ulink url="net.8.html">
net(8)</ulink> man page for more details.</para>
<para>This process joins the server to the domain
without having to create the machine trust account on the PDC
beforehand.</para>
<para>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 an smbpasswd file would be stored - normally :</para>
<para><filename>/usr/local/samba/private/secrets.tdb</filename></para>
<para>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.</para>
<para>Finally, restart your Samba daemons and get ready for
clients to begin using domain security!</para>
</sect1>
<sect1>
<title>Why is this better than security = server?</title>
<para>Currently, domain security in Samba doesn't free you from
having to create local Unix users to represent the users attaching
to your server. This means that if domain user <constant>DOM\fred
</constant> attaches to your domain security Samba server, there needs
to be a local Unix user fred to represent that user in the Unix
filesystem. This is very similar to the older Samba security mode
<ulink url="smb.conf.5.html#SECURITYEQUALSSERVER">security = server</ulink>,
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.
</para>
<para>Please refer to the <ulink url="winbind.html">Winbind
paper</ulink> for information on a system to automatically
assign UNIX uids and gids to Windows NT Domain users and groups.
</para>
<para>The advantage to 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).</para>
<para>In addition, with <command>security = server</command> 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 <command>security = domain</command>,
however, the Samba daemons connect to the PDC/BDC only for as long
as is necessary to authenticate the user, and then drop the connection,
thus conserving PDC connection resources.</para>
<para>And 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, etc. </para>
<note><para> Much of the text of this document
was first published in the Web magazine <ulink url="http://www.linuxworld.com">
LinuxWorld</ulink> as the article <ulink
url="http://www.linuxworld.com/linuxworld/lw-1998-10/lw-10-samba.html">Doing
the NIS/NT Samba</ulink>.</para></note>
</sect1>
</chapter>

522
docs/docbook/projdoc/Diagnosis.xml Normal file
View File

@ -0,0 +1,522 @@
<chapter id="diagnosis">
<chapterinfo>
&author.tridge;
&author.jelmer;
<pubdate>Wed Jan 15</pubdate>
</chapterinfo>
<title>The samba checklist</title>
<sect1>
<title>Introduction</title>
<para>
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.
</para>
<para>
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 as there
have been some instances when continuing with the tests has helped
to solve a problem.
</para>
<para>
If you send one of the samba mailing lists an email saying "it doesn't work"
and you have not followed this test procedure then you should not be surprised
if your email is ignored.
</para>
</sect1>
<sect1>
<title>Assumptions</title>
<para>
In all of the tests it is assumed you have a Samba server called
BIGSERVER and a PC called ACLIENT both in workgroup TESTGROUP.
</para>
<para>
The procedure is similar for other types of clients.
</para>
<para>
It is also assumed you know the name of an available share in your
&smb.conf;. I will assume this share is called <replaceable>tmp</replaceable>.
You can add a <replaceable>tmp</replaceable> share like this by adding the
following to &smb.conf;:
</para>
<para><programlisting>
[tmp]
comment = temporary files
path = /tmp
read only = yes
</programlisting>
</para>
<note><para>
These tests assume version 3.0 or later of the samba suite.
Some commands shown did not exist in earlier versions.
</para></note>
<para>
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. eg: Make sure your <filename>/etc/resolv.conf</filename>
file points to name servers that really do exist.
</para>
<para>
Also, if you do not have DNS server access for name resolution please check
that the settings for your &smb.conf; file results in <command>dns proxy = no</command>. The
best way to check this is with <userinput>testparm smb.conf</userinput>.
</para>
<para>
It is helpful to monitor the log files during testing by using the
<command>tail -F <replaceable>log_file_name</replaceable></command> 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
<filename>/usr/local/samba/var</filename>. Also, connection logs from
machines can be found here or possibly in <filename>/var/log/samba</filename>
depending on how or if you specified logging in your &smb.conf; file.
</para>
<para>
If you make changes to your &smb.conf; file while going through these test,
don't forget to restart &smbd; and &nmbd;.
</para>
</sect1>
<sect1>
<title>The tests</title>
<procedure>
<title>Diagnosing your samba server</title>
<step performance="required">
<para>
In the directory in which you store your &smb.conf; file, run the command
<userinput>testparm smb.conf</userinput>. If it reports any errors then your &smb.conf;
configuration file is faulty.
</para>
<note><para>
Your &smb.conf; file may be located in: <filename>/etc/samba</filename>
Or in: <filename>/usr/local/samba/lib</filename>
</para></note>
</step>
<step performance="required">
<para>
Run the command <userinput>ping BIGSERVER</userinput> from the PC and
<userinput>ping ACLIENT</userinput> from
the unix box. If you don't get a valid response then your TCP/IP
software is not correctly installed.
</para>
<para>
Note that you will need to start a "dos prompt" window on the PC to
run ping.
</para>
<para>
If you get a message saying "host not found" or similar then your DNS
software or <filename>/etc/hosts</filename> file is not correctly setup.
It is possible to
run samba without DNS entries for the server and client, but I assume
you do have correct entries for the remainder of these tests.
</para>
<para>
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 <application>ipfwadm</application> program.)
</para>
<para>
Note: Modern Linux distributions install ipchains/iptables by default.
This is a common problem that is often overlooked.
</para>
</step>
<step performance="required">
<para>
Run the command <userinput>smbclient -L BIGSERVER</userinput> on the unix box. You
should get a list of available shares back.
</para>
<para>
If you get a error message containing the string "Bad password" then
you probably have either an incorrect <command>hosts allow</command>,
<command>hosts deny</command> or <command>valid users</command> line in your
&smb.conf;, or your guest account is not
valid. Check what your guest account is using &testparm; and
temporarily remove any <command>hosts allow</command>, <command>hosts deny</command>, <command>valid users</command> or <command>invalid users</command> lines.
</para>
<para>
If you get a "connection refused" response then the smbd server may
not be running. If you installed it in inetd.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 <userinput>netstat -a</userinput>.
</para>
<note><para>
Some Unix / Linux systems use <command>xinetd</command> in place of
<command>inetd</command>. Check your system documentation for the location
of the control file/s for your particular system implementation of
this network super daemon.
</para></note>
<para>
If you get a "session request failed" then the server refused the
connection. If it says "Your server software is being unfriendly" then
its 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 (&smb.conf;) for syntax errors with &testparm;
and that the various directories where samba keeps its log and lock
files exist.
</para>
<para>
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 following &smb.conf; file entries:
</para>
<para><programlisting>
hosts deny = ALL
hosts allow = xxx.xxx.xxx.xxx/yy
bind interfaces only = Yes
</programlisting></para>
<para>
In the above, no allowance has been made for any session requests that
will automatically translate to the loopback adaptor address 127.0.0.1.
To solve this problem change these lines to:
</para>
<para><programlisting>
hosts deny = ALL
hosts allow = xxx.xxx.xxx.xxx/yy 127.
</programlisting></para>
<para>
Do NOT use the <command>bind interfaces only</command> parameter where you
may wish to
use the samba password change facility, or where &smbclient; may need to
access a local service for name resolution or for local resource
connections. (Note: the <command>bind interfaces only</command> parameter deficiency
where it will not allow connections to the loopback address will be
fixed soon).
</para>
<para>
Another common cause of these two errors is having something already running
on port 139, such as Samba (ie: smbd is running from <application>inetd</application> already) or
something like Digital's Pathworks. Check your <filename>inetd.conf</filename> file before trying
to start &smbd; as a daemon, it can avoid a lot of frustration!
</para>
<para>
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 <filename>log.nmb</filename> file.
</para>
</step>
<step performance="required">
<para>
Run the command <userinput>nmblookup -B BIGSERVER __SAMBA__</userinput>. You should get the
IP address of your Samba server back.
</para>
<para>
If you don't then nmbd is incorrectly installed. Check your <filename>inetd.conf</filename>
if you run it from there, or that the daemon is running and listening
to udp port 137.
</para>
<para>
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.
</para>
</step>
<step performance="required">
<para>run the command <userinput>nmblookup -B ACLIENT '*'</userinput></para>
<para>
You should get the PCs IP address back. If you don't then the client
software on the PC isn't installed correctly, or isn't started, or you
got the name of the PC wrong.
</para>
<para>
If ACLIENT doesn't resolve via DNS then use the IP address of the
client in the above test.
</para>
</step>
<step performance="required">
<para>
Run the command <userinput>nmblookup -d 2 '*'</userinput>
</para>
<para>
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/TCPIP hosts on the network should respond, although Samba may
not catch all of the responses in the short time it listens. You
should see "got a positive name query response" messages from several
hosts.
</para>
<para>
If this doesn't give a similar result 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
<command>interfaces</command> option in &smb.conf; to manually configure your IP
address, broadcast and netmask.
</para>
<para>
If your PC and server aren't on the same subnet then you will need to
use the <parameter>-B</parameter> option to set the broadcast address to that of the PCs
subnet.
</para>
<para>
This test will probably fail if your subnet mask and broadcast address are
not correct. (Refer to TEST 3 notes above).
</para>
</step>
<step performance="required">
<para>
Run the command <userinput>smbclient //BIGSERVER/TMP</userinput>. You should
then be prompted for a password. You should use the password of the account
you are logged into the unix box with. If you want to test with
another account then add the <parameter>-U <replaceable>accountname</replaceable></parameter> option to the end of
the command line. eg:
<userinput>smbclient //bigserver/tmp -Ujohndoe</userinput>
</para>
<note><para>
It is possible to specify the password along with the username
as follows:
<userinput>smbclient //bigserver/tmp -Ujohndoe%secret</userinput>
</para></note>
<para>
Once you enter the password you should get the <prompt>smb></prompt> prompt. If you
don't then look at the error message. If it says "invalid network
name" then the service "tmp" is not correctly setup in your &smb.conf;.
</para>
<para>
If it says "bad password" then the likely causes are:
</para>
<orderedlist>
<listitem>
<para>
you have shadow passords (or some other password system) but didn't
compile in support for them in &smbd;
</para>
</listitem>
<listitem>
<para>
your <command>valid users</command> configuration is incorrect
</para>
</listitem>
<listitem>
<para>
you have a mixed case password and you haven't enabled the <command>password
level</command> option at a high enough level
</para>
</listitem>
<listitem>
<para>
the <command>path =</command> line in &smb.conf; is incorrect. Check it with &testparm;
</para>
</listitem>
<listitem>
<para>
you enabled password encryption but didn't create the SMB encrypted
password file
</para>
</listitem>
</orderedlist>
<para>
Once connected you should be able to use the commands
<command>dir</command> <command>get</command> <command>put</command> etc.
Type <command>help <replaceable>command</replaceable></command> for instructions. You should
especially check that the amount of free disk space shown is correct
when you type <command>dir</command>.
</para>
</step>
<step performance="required">
<para>
On the PC, type the command <userinput>net view \\BIGSERVER</userinput>. You will
need to do this from within a "dos prompt" window. You should get back a
list of available shares on the server.
</para>
<para>
If you get a "network name not found" or similar error then netbios
name resolution is not working. This is usually caused by a problem in
nmbd. To overcome it you could do one of the following (you only need
to choose one of them):
</para>
<orderedlist>
<listitem><para>
fixup the &nmbd; installation
</para></listitem>
<listitem><para>
add the IP address of BIGSERVER to the <command>wins server</command> box in the
advanced tcp/ip setup on the PC.
</para></listitem>
<listitem><para>
enable windows name resolution via DNS in the advanced section of
the tcp/ip setup
</para></listitem>
<listitem><para>
add BIGSERVER to your lmhosts file on the PC.
</para></listitem>
</orderedlist>
<para>
If you get a "invalid network name" or "bad password error" then the
same fixes apply as they did for the <userinput>smbclient -L</userinput> test above. In
particular, make sure your <command>hosts allow</command> line is correct (see the man
pages)
</para>
<para>
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.
</para>
<para>
If you get "specified computer is not receiving requests" or similar
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 <filename>hosts.allow</filename> file for your client (or subnet, etc.)
</para>
</step>
<step performance="required">
<para>
Run the command <userinput>net use x: \\BIGSERVER\TMP</userinput>. You should
be prompted for a password then you should get a "command completed
successfully" message. If not then your PC software is incorrectly
installed or your smb.conf is incorrect. make sure your <command>hosts allow</command>
and other config lines in &smb.conf; are correct.
</para>
<para>
It's also possible that the server can't work out what user name to
connect you as. To see if this is the problem add the line <command>user =
<replaceable>username</replaceable></command> to the <command>[tmp]</command> section of
&smb.conf; where <replaceable>username</replaceable> is the
username corresponding to the password you typed. If you find this
fixes things you may need the username mapping option.
</para>
<para>
It might also be the case that your client only sends encrypted passwords
and you have <command>encrypt passwords = no</command> in &smb.conf;
Turn it back on to fix.
</para>
</step>
<step performance="required">
<para>
Run the command <userinput>nmblookup -M <replaceable>testgroup</replaceable></userinput> where
<replaceable>testgroup</replaceable> 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.
</para>
<para>
If you don't 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 &smb.conf;. Make
sure you have <command>preferred master = yes</command> to ensure that
an election is held at startup.
</para>
</step>
<step performance="required">
<para>
>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 smb.conf). You should be able to double click on the name
of the server and get a list of shares. If you get a "invalid
password" error when you do then you are probably running WinNT 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
<command>security = server</command> AND
<command>password server = Windows_NT_Machine</command> in your
&smb.conf; file, or make sure <command>encrypted passwords</command> is
set to "yes".
</para>
</step>
</procedure>
</sect1>
<sect1>
<title>Still having troubles?</title>
<para>Read the chapter on
<link linkend="problems">Analysing and Solving Problems</link>.
</para>
</sect1>
</chapter>

104
docs/docbook/projdoc/GROUP-MAPPING-HOWTO.xml Normal file
View File

@ -0,0 +1,104 @@
<?xml version="1.0" encoding="iso8859-1"?>
<chapter id="groupmapping">
<chapterinfo>
<author>
<firstname>Jean François</firstname><surname>Micouleau</surname>
</author>
&author.jerry;
</chapterinfo>
<title>Configuring Group Mapping</title>
<para>
Starting with Samba 3.0 alpha 2, new group mapping functionality
is available to create associations between Windows SIDs and UNIX
groups. The <parameter>groupmap</parameter> subcommand included with
the <command>net</command> tool can be used to manage these associations.
</para>
<para>
The first immediate reason to use the group mapping on a Samba PDC, is that
the <parameter>domain admin group</parameter> &smb.conf; has been removed.
This parameter was used to give the listed users membership in the "Domain Admins"
Windows group which gave local admin rights on their workstations (in
default configurations).
</para>
<para>
When installing NT/W2K on a computer, the installer program creates some users
and groups. Notably the 'Administrators' group, and gives to that group some
privileges like the ability to change the date and time or to kill any process
(or close too) running on the local machine. The 'Administrator' user is a
member of the 'Administrators' group, and thus 'inherit' the 'Administrators'
group privileges. If a 'joe' user is created and become a member of the
'Administrator' group, 'joe' has exactly the same rights as 'Administrator'.
</para>
<para>
When a NT/W2K machine is joined to a domain, the "Domain Adminis" group of the
PDC is added to the local 'Administrators' group of the workstation. Every
member of the 'Domain Administrators' group 'inherit' the
rights of the local 'Administrators' group when logging on the workstation.
</para>
<para>
The following steps describe how to make samba PDC users members of the
'Domain Admins' group?
</para>
<orderedlist>
<listitem><para>create a unix group (usually in <filename>/etc/group</filename>),
let's call it domadm</para></listitem>
<listitem><para>add to this group the users that must be Administrators. For example
if you want joe,john and mary, your entry in <filename>/etc/group</filename> will
look like:</para>
<para><programlisting>
domadm:x:502:joe,john,mary
</programlisting></para>
</listitem>
<listitem><para>Map this domadm group to the "Domain Admins" group
by running the command:</para>
<para><prompt>root# </prompt><userinput>net groupmap add ntgroup="Domain Admins" unixgroup=domadm</userinput></para>
<para>The quotes around "Domain Admins" are necessary due to the space in the group name. Also make
sure to leave no whitespace surrounding the equal character (=).</para>
</listitem>
</orderedlist>
<para>Now joe, john and mary are domain administrators!</para>
<para>
It is possible to map any arbitrary UNIX group to any Windows NT
group as well as making any UNIX group a Windows domain group.
For example, if you wanted to include a UNIX group (e.g. acct) in a 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:
</para>
<para><prompt>root# </prompt><userinput>net groupmap add rid=1000 ntgroup="Accounting" unixgroup=acct</userinput></para>
<para>Be aware that the rid parmeter is a unsigned 32 bit integer that should
normally start at 1000. However, this rid must not overlap with any RID assigned
to a user. Verifying this is done differently depending on on the passdb backend
you are using. Future versions of the tools may perform the verification automatically,
but for now the burden in on you.</para>
<para>You can list the various groups in the mapping database by executing
<command>net groupmap list</command>. Here is an example:</para>
<para><programlisting><prompt>root# </prompt>net groupmap list
System Administrators (S-1-5-21-2547222302-1596225915-2414751004-1002) -> sysadmin
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
</programlisting></para>
<para>For complete details on <command>net groupmap</command>, refer to the
net(8) man page.</para>
</chapter>

545
docs/docbook/projdoc/Integrating-with-Windows.xml Normal file
View File

@ -0,0 +1,545 @@
<chapter id="integrate-ms-networks">
<chapterinfo>
&author.jht;
<pubdate> (Jan 01 2001) </pubdate>
</chapterinfo>
<title>Integrating MS Windows networks with Samba</title>
<para>
This section 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 use of
NetBIOS over TCP/IP then this section may help you to resolve networking problems.
</para>
<note>
<para>
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 mis-apprehension.
</para>
</note>
<para>
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 TCP port 445 will be
used and UDP port 137 and TCP port 139 will not.
</para>
<note>
<para>
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).
</para>
</note>
<para>
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
Dynamic DNS with Service Resource Records (SRV RR) and with Incremental Zone Transfers (IXFR).
Use of DHCP with ADS is recommended as a further means of maintaining central control
over client workstation network configuration.
</para>
<sect1>
<title>Name Resolution in a pure Unix/Linux world</title>
<para>
The key configuration files covered in this section are:
</para>
<itemizedlist>
<listitem><para><filename>/etc/hosts</filename></para></listitem>
<listitem><para><filename>/etc/resolv.conf</filename></para></listitem>
<listitem><para><filename>/etc/host.conf</filename></para></listitem>
<listitem><para><filename>/etc/nsswitch.conf</filename></para></listitem>
</itemizedlist>
<sect2>
<title><filename>/etc/hosts</filename></title>
<para>
Contains a static list of IP Addresses and names.
eg:
</para>
<para><programlisting>
127.0.0.1 localhost localhost.localdomain
192.168.1.1 bigbox.caldera.com bigbox alias4box
</programlisting></para>
<para>
The purpose of <filename>/etc/hosts</filename> is to provide a
name resolution mechanism so that uses do not need to remember
IP addresses.
</para>
<para>
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 (4) decimal
numbers that are separated by a dot (or period). eg: 168.192.1.1
</para>
<para>
MAC Addresses use 48 bits (or 6 bytes) and are typically represented
as two digit hexadecimal numbers separated by colons. eg:
40:8e:0a:12:34:56
</para>
<para>
Every network interfrace must have an MAC address. Associated with
a MAC address there may be one or more IP addresses. There is NO
relationship between an IP address and a MAC address, all such assignments
are arbitary or discretionary in nature. At the most basic level all
network communications takes place using MAC addressing. Since MAC
addresses must be globally unique, and generally remains 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 ARP reply.
</para>
<para>
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
<filename>/etc/hosts</filename> is one such file.
</para>
<para>
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 stands for Address
Resolution Protocol, and is a broadcast oriented method that
uses UDP (User Datagram Protocol) to send a request to all
interfaces on the local network segment using the all 1's 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.
</para>
<para>
The <filename>/etc/hosts</filename> file is foundational to all
Unix/Linux TCP/IP installations and as a minumum 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 that a basic level of name
resolution can exist before any other method of name resolution
becomes available.
</para>
</sect2>
<sect2>
<title><filename>/etc/resolv.conf</filename></title>
<para>
This file tells the name resolution libraries:
</para>
<itemizedlist>
<listitem><para>The name of the domain to which the machine
belongs
</para></listitem>
<listitem><para>The name(s) of any domains that should be
automatically searched when trying to resolve unqualified
host names to their IP address
</para></listitem>
<listitem><para>The name or IP address of available Domain
Name Servers that may be asked to perform name to address
translation lookups
</para></listitem>
</itemizedlist>
</sect2>
<sect2>
<title><filename>/etc/host.conf</filename></title>
<para>
<filename>/etc/host.conf</filename> is the primary means by
which the setting in /etc/resolv.conf may be affected. It is a
critical configuration file. This file controls the order by
which name resolution may procede. The typical structure is:
</para>
<para><programlisting>
order hosts,bind
multi on
</programlisting></para>
<para>
then both addresses should be returned. Please refer to the
man page for host.conf for further details.
</para>
</sect2>
<sect2>
<title><filename>/etc/nsswitch.conf</filename></title>
<para>
This file controls the actual name resolution targets. The
file typically has resolver object specifications as follows:
</para>
<para><programlisting>
# /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+ hesoid db compat ldap wins
networks: nis files dns
ethers: nis files
protocols: nis files
rpc: nis files
services: nis files
</programlisting></para>
<para>
Of course, each of these mechanisms requires that the appropriate
facilities and/or services are correctly configured.
</para>
<para>
It should be noted that unless a network request/message must be
sent, TCP/IP networks are silent. All TCP/IP communications assumes a
principal of speaking only when necessary.
</para>
<para>
Starting with version 2.2.0 samba has Linux support for extensions to
the name service switch infrastructure so that 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 (ie: <command>make
nsswitch/libnss_wins.so</command>). The resulting library should
then be installed in the <filename>/lib</filename> directory and
the "wins" parameter needs to be added to the "hosts:" line in
the <filename>/etc/nsswitch.conf</filename> file. At this point it
will be possible to ping any MS Windows machine by it's NetBIOS
machine name, so long as that machine is within the workgroup to
which both the samba machine and the MS Windows machine belong.
</para>
</sect2>
</sect1>
<sect1>
<title>Name resolution as used within MS Windows networking</title>
<para>
MS Windows networking is predicated about the name each machine
is given. This name is known variously (and inconsistently) as
the "computer name", "machine name", "networking name", "netbios name",
"SMB name". All terms mean the same thing with the exception of
"netbios name" which can apply also to the name of the workgroup or the
domain name. The terms "workgroup" and "domain" are really just a
simply name with which the machine is associated. All NetBIOS names
are exactly 16 characters in length. The 16th character is reserved.
It is used to store a one 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.
</para>
<para>
The following are typical NetBIOS name/service type registrations:
</para>
<para><programlisting>
Unique NetBIOS Names:
MACHINENAME&lt;00&gt; = Server Service is running on MACHINENAME
MACHINENAME&lt;03&gt; = Generic Machine Name (NetBIOS name)
MACHINENAME&lt;20&gt; = LanMan Server service is running on MACHINENAME
WORKGROUP&lt;1b&gt; = Domain Master Browser
Group Names:
WORKGROUP&lt;03&gt; = Generic Name registered by all members of WORKGROUP
WORKGROUP&lt;1c&gt; = Domain Controllers / Netlogon Servers
WORKGROUP&lt;1d&gt; = Local Master Browsers
WORKGROUP&lt;1e&gt; = Internet Name Resolvers
</programlisting></para>
<para>
It should be noted that all NetBIOS machines register their own
names as per the above. This is in vast contrast to TCP/IP
installations where traditionally the system administrator will
determine in the /etc/hosts or in the DNS database what names
are associated with each IP address.
</para>
<para>
One further point of clarification should be noted, the <filename>/etc/hosts</filename>
file and the DNS records do not provide the NetBIOS name type 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 *&lt;1c&gt;. A logon request is then sent to each
IP address that is returned in the enumerated list of IP addresses. Which
ever machine first replies then ends up providing the logon services.
</para>
<para>
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 use of
just a password (known as SHARE MODE 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 MODE security in a WORKGROUP environment, thus requiring use
of a user name and a matching password.
</para>
<para>
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.
</para>
<para>
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.
</para>
<sect2>
<title>The NetBIOS Name Cache</title>
<para>
All MS Windows machines employ an in memory buffer in which is
stored the NetBIOS names and IP addresses for all external
machines that that machine has communicated with over the
past 10-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.
</para>
<para>
If a machine whose name is in the local name cache has been shut
down before the name had been expired and flushed from the cache, then
an attempt to exchange a message with that machine will be subject
to time-out delays. i.e.: Its name is in the cache, so a name resolution
lookup will succeed, but the machine can not respond. This can be
frustrating for users - but it is a characteristic of the protocol.
</para>
<para>
The MS Windows utility that allows examination of the NetBIOS
name cache is called "nbtstat". The Samba equivalent of this
is called "nmblookup".
</para>
</sect2>
<sect2>
<title>The LMHOSTS file</title>
<para>
This file is usually located in MS Windows NT 4.0 or
2000 in <filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> and contains
the IP Address and the machine name in matched pairs. The
<filename>LMHOSTS</filename> file performs NetBIOS name
to IP address mapping.
</para>
<para>
It typically looks like:
</para>
<para><programlisting>
# 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 computernames
# (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 computername. The address and the comptername
# 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:&lt;domain&gt;
# #INCLUDE &lt;filename&gt;
# #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:&lt;domain&gt;" tag will associate the
# entry with the domain specified by &lt;domain&gt;. This affects 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 &lt;domain&gt; is always preloaded although it will not
# be shown when the name cache is viewed.
#
# Specifying "#INCLUDE &lt;filename&gt;" will force the RFC NetBIOS (NBT)
# software to seek the specified &lt;filename&gt; and parse it as if it were
# local. &lt;filename&gt; 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 addtion the share "public" in the example below must be in the
# LanManServer 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
# preloaded, 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.
</programlisting></para>
</sect2>
<sect2>
<title>HOSTS file</title>
<para>
This file is usually located in MS Windows NT 4.0 or 2000 in
<filename>C:\WINNT\SYSTEM32\DRIVERS\ETC</filename> 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 <filename>/etc/hosts</filename> file.
</para>
</sect2>
<sect2>
<title>DNS Lookup</title>
<para>
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 dependant on what the NetBIOS
Node Type parameter is configured to. A Node Type of 0 means use
NetBIOS broadcast (over UDP broadcast) is first 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.
</para>
</sect2>
<sect2>
<title>WINS Lookup</title>
<para>
A WINS (Windows Internet Name Server) service is the equivaent 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.
</para>
<para>
To configure Samba to be a WINS server the following parameter needs
to be added to the &smb.conf; file:
</para>
<para><programlisting>
wins support = Yes
</programlisting></para>
<para>
To configure Samba to use a WINS server the following parameters are
needed in the &smb.conf; file:
</para>
<para><programlisting>
wins support = No
wins server = xxx.xxx.xxx.xxx
</programlisting></para>
<para>
where <replaceable>xxx.xxx.xxx.xxx</replaceable> is the IP address
of the WINS server.
</para>
</sect2>
</sect1>
</chapter>

222
docs/docbook/projdoc/InterdomainTrusts.xml Normal file
View File

@ -0,0 +1,222 @@
<chapter id="InterdomainTrusts">
<chapterinfo>
&author.jht;
&author.mimir;
<pubdate>April 3, 2003</pubdate>
</chapterinfo>
<title>Interdomain Trust Relationships</title>
<para>
Samba-3 supports NT4 style domain trust relationships. This is feature that many sites
will want to use if they migrate to Samba-3 from and NT4 style domain and do NOT want to
adopt Active Directory or an LDAP based authentication back end. This section explains
some background information regarding trust relationships and how to create them. It is now
possible for Samba-3 to NT4 trust (and vice versa), as well as Samba3 to Samba3 trusts.
</para>
<sect1>
<title>Trust Relationship Background</title>
<para>
MS Windows NT3.x/4.0 type security domains employ a non-hierarchical security structure.
The limitations of this architecture as it affects the scalability of MS Windows networking
in large organisations is well known. Additionally, the flat-name space that results from
this design significantly impacts the delegation of administrative responsibilities in
large and diverse organisations.
</para>
<para>
Microsoft developed Active Directory Service (ADS), based on Kerberos and LDAP, as a means
of circumventing the limitations of the older technologies. Not every organisation is ready
or willing to embrace ADS. For small companies the older NT4 style domain security paradigm
is quite adequate, there thus remains an entrenched user base for whom there is no direct
desire to go through a disruptive change to adopt ADS.
</para>
<para>
Microsoft introduced with MS Windows NT the ability to allow differing security domains
to affect a mechanism so that 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
<emphasis>Trusts</emphasis>. Specifically, one domain will <emphasis>trust</emphasis> the users
from another domain. The domain from which users are available to 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,
thus if users in both domains are to have privileges and rights in each others' domain, then it is
necessary to establish two (2) relationships, one in each direction.
</para>
<para>
In an NT4 style MS security domain, all trusts are non-transitive. This means that if there
are three (3) 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. ie: Relationships are explicit and not
transitive.
</para>
<para>
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 above, 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.
</para>
</sect1>
<sect1>
<title>Native MS Windows NT4 Trusts Configuration</title>
<para>
There are two steps to creating an interdomain trust relationship.
</para>
<sect2>
<title>NT4 as the Trusting Domain (ie. creating the trusted account)</title>
<para>
For MS Windows NT4, all domain trust relationships are configured using the Domain User Manager.
To affect a two way trust relationship it is necessary for each domain administrator to make
available (for use by an external domain) it's security resources. This is done from the Domain
User Manager Policies entry on the menu bar. From the Policy menu, select Trust Relationships, then
next to the lower box that is labelled "Permitted to Trust this Domain" are two buttons, "Add" and
"Remove". The "Add" button will open a panel in which needs to be entered the remote domain that
will be able to assign user rights to your domain. In addition it is necessary to enter a password
that is specific to this trust relationship. The password needs to be
typed twice (for standard confirmation).
</para>
</sect2>
<sect2>
<title>NT4 as the Trusted Domain (ie. creating trusted account's password)</title>
<para>
A trust relationship will work only when the other (trusting) domain makes the appropriate connections
with the trusted domain. To consumate the trust relationship the administrator will launch the
Domain User Manager, from the menu select Policies, then select Trust Relationships, then click on the
"Add" button that is next to the box that is labelled "Trusted Domains". A panel will open in
which must be entered the name of the remote domain as well as the password assigned to that trust.
</para>
</sect2>
</sect1>
<sect1>
<title>Configuring Samba NT-style Domain Trusts</title>
<para>
This description is meant to be a fairly short introduction about how to set up a Samba server so
that it could participate in interdomain trust relationships. Trust relationship support in Samba
is in its early stage, so lot of things don't work yet.
</para>
<para>
Each of the procedures described below is treated as they were performed with Windows NT4 Server on
one end. 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 below leads to trust
between domains in purely Samba environment.
</para>
<sect2>
<title>Samba-3 as the Trusting Domain</title>
<para>
In order to set the Samba PDC to be the trusted party of the relationship first you need
to create special account for the domain that will be the trusting party. To do that,
you can use the 'smbpasswd' utility. Creating the trusted domain account is very
similiar 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 favourite shell:
</para>
<para>
<screen>
<prompt>deity#</prompt> <userinput>smbpasswd -a -i rumba</userinput>
New SMB password: XXXXXXXX
Retype SMB password: XXXXXXXX
Added user rumba$
</screen>
where <parameter>-a</parameter> means to add a new account into the
passdb database and <parameter>-i</parameter> means: ''create this
account with the InterDomain trust flag''
</para>
<para>
The account name will be 'rumba$' (the name of the remote domain)
</para>
<para>
After issuing this command you'll 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 stardard way depending on your configuration) and see that account's name is
really RUMBA$ and it has 'I' flag in the flags field. Now you're ready to confirm
the trust by establishing it from Windows NT Server.
</para>
<para>
Open 'User Manager for Domains' and from menu 'Policies' select 'Trust Relationships...'.
Right beside 'Trusted domains' list box press 'Add...' button. You will be prompted for
the trusted domain name and the relationship password. Type in SAMBA, as this is
your domain name, and the password used at the time of account creation.
Press OK and, if everything went without incident, you will see 'Trusted domain relationship
successfully established' message.
</para>
</sect2>
<sect2>
<title>Samba-3 as the Trusted Domain</title>
<para>
This time activities are somewhat reversed. Again, we'll assume that your domain
controlled by the Samba PDC is called SAMBA and NT-controlled domain is called RUMBA.
</para>
<para>
The very first thing requirement is to add an account for the SAMBA domain on RUMBA's PDC.
</para>
<para>
Launch the Domain User Manager, then from the menu select 'Policies', 'Trust Relationships'.
Now, next to 'Trusted Domains' box press the 'Add' button, and type in the name of the trusted
domain (SAMBA) and password securing the relationship.
</para>
<para>
The password can be arbitrarily chosen. It is easy to change the password
from the Samba server whenever you want. After confirming the password your account is
ready for use. Now it's Samba's turn.
</para>
<para>
Using your favourite shell while being logged in as root, issue this command:
</para>
<para>
<prompt>deity# </prompt><userinput>net rpc trustdom establish rumba</userinput>
</para>
<para>
You will be prompted for the password you just typed on your Windows NT4 Server box.
Do not worry if you see an error message that mentions a returned code of
<errorname>NT_STATUS_NOLOGON_INTERDOMAIN_TRUST_ACCOUNT</errorname>. 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), you should see the 'Success' message. Congratulations! Your trust
relationship has just been established.
</para>
<note><para>
Note that you have to run this command as root because you must have write access to
the <filename>secrets.tdb</filename> file.
</para></note>
</sect2>
</sect1>
</chapter>

370
docs/docbook/projdoc/IntroSMB.xml Normal file
View File

@ -0,0 +1,370 @@
<chapter id="IntroSMB">
<chapterinfo>
&author.dlechnyr;
<pubdate>April 14, 2003</pubdate>
</chapterinfo>
<title>Introduction to Samba</title>
<para><emphasis>
"If you understand what you're doing, you're not learning anything."
-- Anonymous
</emphasis></para>
<para>
Samba is a file and print server for Windows-based clients using TCP/IP as the underlying
transport protocol. In fact, it can support any SMB/CIFS-enabled client. One of Samba's big
strengths is that you can use it to blend your mix of Windows and Linux machines together
without requiring a separate Windows NT/2000/2003 Server. Samba is actively being developed
by a global team of about 30 active programmers and was originally developed by Andrew Tridgell.
</para>
<sect1>
<title>Background</title>
<para>
Once long ago, there was a buzzword referred to as DCE/RPC. This stood for Distributed
Computing Environment/Remote Procedure Calls and conceptually was a good idea. It was
originally developed by Apollo/HP as NCA 1.0 (Network Computing Architecture) and only
ran over UDP. When there was a need to run it over TCP so that it would be compatible
with DECnet 3.0, it was redesigned, submitted to The Open Group, and officially became
known as DCE/RPC. Microsoft came along and decided, rather than pay $20 per seat to
license this technology, to reimplement DCE/RPC themselves as MSRPC. From this, the
concept continued in the form of SMB (Server Message Block, or the "what") using the
NetBIOS (Network Basic Input/Output System, or the "how") compatibility layer. You can
run SMB (i.e., transport) over several different protocols; many different implementations
arose as a result, including NBIPX (NetBIOS over IPX, NwLnkNb, or NWNBLink) and NBT
(NetBIOS over TCP/IP, or NetBT). As the years passed, NBT became the most common form
of implementation until the advance of "Direct-Hosted TCP" -- the Microsoft marketing
term for eliminating NetBIOS entirely and running SMB by itself across TCP port 445
only. As of yet, direct-hosted TCP has yet to catch on.
</para>
<para>
Perhaps the best summary of the origins of SMB are voiced in the 1997 article titled, CIFS:
Common Insecurities Fail Scrutiny:
</para>
<para><emphasis>
Several megabytes of NT-security archives, random whitepapers, RFCs, the CIFS spec, the Samba
stuff, a few MS knowledge-base articles, strings extracted from binaries, and packet dumps have
been dutifully waded through during the information-gathering stages of this project, and there
are *still* many missing pieces... While often tedious, at least the way has been generously
littered with occurrences of clapping hand to forehead and muttering 'crikey, what are they
thinking?
</emphasis></para>
</sect1>
<sect1>
<title>Terminology</title>
<itemizedlist>
<listitem><para>
SMB: Acronym for "Server Message Block". This is Microsoft's file and printer sharing protocol.
</para></listitem>
<listitem><para>
CIFS: Acronym for "Common Internet File System". Around 1996, Microsoft apparently
decided that SMB needed the word "Internet" in it, so they changed it to CIFS.
</para></listitem>
<listitem><para>
Direct-Hosted: A method of providing file/printer sharing services over port 445/tcp
only using DNS for name resolution instead of WINS.
</para></listitem>
<listitem><para>
IPC: Acronym for "Inter-Process Communication". A method to communicate specific
information between programs.
</para></listitem>
<listitem><para>
Marshalling: - A method of serializing (i.e., sequential ordering of) variable data
suitable for transmission via a network connection or storing in a file. The source
data can be re-created using a similar process called unmarshalling.
</para></listitem>
<listitem><para>
NetBIOS: Acronym for "Network Basic Input/Output System". This is not a protocol;
it is a method of communication across an existing protocol. This is a standard which
was originally developed for IBM by Sytek in 1983. To exaggerate the analogy a bit,
it can help to think of this in comparison your computer's BIOS -- it controls the
essential functions of your input/output hardware -- whereas NetBIOS controls the
essential functions of your input/output traffic via the network. Again, this is a bit
of an exaggeration but it should help that paradigm shift. What is important to realize
is that NetBIOS is a transport standard, not a protocol. Unfortunately, even technically
brilliant people tend to interchange NetBIOS with terms like NetBEUI without a second
thought; this will cause no end (and no doubt) of confusion.
</para></listitem>
<listitem><para>
NetBEUI: Acronym for the "NetBIOS Extended User Interface". Unlike NetBIOS, NetBEUI
is a protocol, not a standard. It is also not routable, so traffic on one side of a
router will be unable to communicate with the other side. Understanding NetBEUI is
not essential to deciphering SMB; however it helps to point out that it is not the
same as NetBIOS and to improve your score in trivia at parties. NetBEUI was originally
referred to by Microsoft as "NBF", or "The Windows NT NetBEUI Frame protocol driver".
It is not often heard from these days.
</para></listitem>
<listitem><para>
NBT: Acronym for "NetBIOS over TCP"; also known as "NetBT". Allows the continued use
of NetBIOS traffic proxied over TCP/IP. As a result, NetBIOS names are made
to IP addresses and NetBIOS name types are conceptually equivalent to TCP/IP ports.
This is how file and printer sharing are accomplished in Windows 95/98/ME. They
traditionally rely on three ports: NetBIOS Name Service (nbname) via UDP port 137,
NetBIOS Datagram Service (nbdatagram) via UDP port 138, and NetBIOS Session Service
(nbsession) via TCP port 139. All name resolution is done via WINS, NetBIOS broadcasts,
and DNS. NetBIOS over TCP is documented in RFC 1001 (Concepts and methods) and RFC 1002
(Detailed specifications).
</para></listitem>
<listitem><para>
W2K: Acronym for Windows 2000 Professional or Server
</para></listitem>
<listitem><para>
W3K: Acronym for Windows 2003 Server
</para></listitem>
</itemizedlist>
<para>If you plan on getting help, make sure to subscribe to the Samba Mailing List (available at
http://www.samba.org). Optionally, you could just search mailing.unix.samba at http://groups.google.com
</para>
</sect1>
<sect1>
<title>Related Projects</title>
<para>
There are currently two network filesystem client projects for Linux that are directly
related to Samba: SMBFS and CIFS VFS. These are both available in the Linux kernel itself.
</para>
<itemizedlist>
<listitem><para>
SMBFS (Server Message Block File System) allows you to mount SMB shares (the protocol
that Microsoft Windows and OS/2 Lan Manager use to share files and printers
over local networks) and access them just like any other Unix directory. This is useful
if you just want to mount such filesystems without being a SMBFS server.
</para></listitem>
<listitem><para>
CIFS VFS (Common Internet File System Virtual File System) is the successor to SMBFS, and
is being actively developed for the upcoming version of the Linux kernel. The intent of this module
is to provide advanced network file system functionality including support for dfs (heirarchical
name space), secure per-user session establishment, safe distributed caching (oplock),
optional packet signing, Unicode and other internationalization improvements, and optional
Winbind (nsswitch) integration.
</para></listitem>
</itemizedlist>
<para>
Again, it's important to note that these are implementations for client filesystems, and have
nothing to do with acting as a file and print server for SMB/CIFS clients.
</para>
<para>
There are other Open Source CIFS client implementations, such as the jCIFS project
(jcifs.samba.org) which provides an SMB client toolkit written in Java.
</para>
</sect1>
<sect1>
<title>SMB Methodology</title>
<para>
Traditionally, SMB uses UDP port 137 (NetBIOS name service, or netbios-ns),
UDP port 138 (NetBIOS datagram service, or netbios-dgm), and TCP port 139 (NetBIOS
session service, or netbios-ssn). Anyone looking at their network with a good
packet sniffer will be amazed at the amount of traffic generated by just opening
up a single file. In general, SMB sessions are established in the following order:
</para>
<itemizedlist>
<listitem><para>
"TCP Connection" - establish 3-way handshake (connection) to port 139/tcp
or 445/tcp.
</para></listitem>
<listitem><para>
"NetBIOS Session Request" - using the following "Calling Names": The local
machine's NetBIOS name plus the 16th character 0x00; The server's NetBIOS
name plus the 16th character 0x20
</para></listitem>
<listitem><para>
"SMB Negotiate Protocol" - determine the protocol dialect to use, which will
be one of the following: PC Network Program 1.0 (Core) - share level security
mode only; Microsoft Networks 1.03 (Core Plus) - share level security
mode only; Lanman1.0 (LAN Manager 1.0) - uses Challenge/Response
Authentication; Lanman2.1 (LAN Manager 2.1) - uses Challenge/Response
Authentication; NT LM 0.12 (NT LM 0.12) - uses Challenge/Response
Authentication
</para></listitem>
<listitem><para>
SMB Session Startup. Passwords are encrypted (or not) according to one of
the following methods: Null (no encryption); Cleartext (no encryption); LM
and NTLM; NTLM; NTLMv2
</para></listitem>
<listitem><para>
SMB Tree Connect: Connect to a share name (e.g., \\servername\share); Connect
to a service type (e.g., IPC$ named pipe)
</para></listitem>
</itemizedlist>
<para>
A good way to examine this process in depth is to try out SecurityFriday's SWB program
at http://www.securityfriday.com/ToolDownload/SWB/swb_doc.html. It allows you to
walk through the establishment of a SMB/CIFS session step by step.
</para>
</sect1>
<sect1>
<title>Additional Resources</title>
<itemizedlist>
<listitem><para>
<ulink url="http://hr.uoregon.edu/davidrl/cifs.txt">
<emphasis>CIFS: Common Insecurities Fail Scrutiny</emphasis> by "Hobbit"</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://afr.com/it/2002/10/01/FFXDF43AP6D.html">
<emphasis>Doing the Samba on Windows</emphasis> by Financial Review
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://ubiqx.org/cifs/">
<emphasis>Implementing CIFS</emphasis> by Christopher R. Hertel
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://samba.anu.edu.au/cifs/docs/what-is-smb.html">
<emphasis>Just What Is SMB?</emphasis> by Richard Sharpe
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.linux-mag.com/1999-05/samba_01.html">
<emphasis>Opening Windows Everywhere</emphasis> by Mike Warfield
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.tldp.org/HOWTO/SMB-HOWTO.html">
<emphasis>SMB HOWTO</emphasis> by David Wood
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.phrack.org/phrack/60/p60-0x0b.txt">
<emphasis>SMB/CIFS by The Root</emphasis> by "ledin"
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.linux-mag.com/1999-09/samba_01.html">
<emphasis>The Story of Samba</emphasis> by Christopher R. Hertel
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://hr.uoregon.edu/davidrl/samba/">
<emphasis>The Unofficial Samba HOWTO</emphasis> by David Lechnyr
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.linux-mag.com/2001-05/smb_01.html">
<emphasis>Understanding the Network Neighborhood</emphasis> by Christopher R. Hertel
</ulink>
</para></listitem>
<listitem><para>
<ulink url="http://www.linux-mag.com/2002-02/samba_01.html">
<emphasis>Using Samba as a PDC</emphasis> by Andrew Bartlett
</ulink>
</para></listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Epilogue</title>
<para><emphasis>
"What's fundamentally wrong is that nobody ever had any taste when they
did it. Microsoft has been very much into making the user interface look good,
but internally it's just a complete mess. And even people who program for Microsoft
and who have had years of experience, just don't know how it works internally.
Worse, nobody dares change it. Nobody dares to fix bugs because it's such a
mess that fixing one bug might just break a hundred programs that depend on
that bug. And Microsoft isn't interested in anyone fixing bugs -- they're interested
in making money. They don't have anybody who takes pride in Windows 95 as an
operating system.
</emphasis></para>
<para><emphasis>
People inside Microsoft know it's a bad operating system and they still
continue obviously working on it because they want to get the next version out
because they want to have all these new features to sell more copies of the
system.
</emphasis></para>
<para><emphasis>
The problem with that is that over time, when you have this kind of approach,
and because nobody understands it, because nobody REALLY fixes bugs (other than
when they're really obvious), the end result is really messy. You can't trust
it because under certain circumstances it just spontaneously reboots or just
halts in the middle of something that shouldn't be strange. Normally it works
fine and then once in a blue moon for some completely unknown reason, it's dead,
and nobody knows why. Not Microsoft, not the experienced user and certainly
not the completely clueless user who probably sits there shivering thinking
"What did I do wrong?" when they didn't do anything wrong at all.
</emphasis></para>
<para><emphasis>
That's what's really irritating to me."
</emphasis></para>
<para>--
<ulink url="http://hr.uoregon.edu/davidrl/boot.txt">Linus Torvalds, from an interview with BOOT Magazine, Sept 1998</ulink>
</para>
</sect1>
<sect1>
<title>Miscellaneous</title>
<para>
This chapter was lovingly handcrafted on a Dell Latitude C400 laptop running Slackware Linux 9.0,
in case anyone asks.
</para>
<para>
This chapter is Copyright &copy; 2003 David Lechnyr (david at lechnyr dot com).
Permission is granted to copy, distribute and/or modify this document under the terms
of the GNU Free Documentation License, Version 1.2 or any later version published by the Free
Software Foundation. A copy of the license is available at http://www.gnu.org/licenses/fdl.txt.
</para>
</sect1>
</chapter>

507
docs/docbook/projdoc/NT4Migration.xml Normal file
View File

@ -0,0 +1,507 @@
<chapter id="NT4Migration">
<chapterinfo>
&author.jht;
<pubdate>April 3, 2003</pubdate>
</chapterinfo>
<title>Migration from NT4 PDC to Samba-3 PDC</title>
<para>
This is a rough guide to assist those wishing to migrate from NT4 domain control to
Samba-3 based domain control.
</para>
<sect1>
<title>Planning and Getting Started</title>
<para>
In the IT world there is often a saying that all problems are encountered because of
poor planning. The corrollary to this saying is that not all problems can be anticpated
and planned for. Then again, good planning will anticpate most show stopper type situations.
</para>
<para>
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 under way.
</para>
<sect2>
<title>Objectives</title>
<para>
The key objective for most organisations will be 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 one of 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.
</para>
<para>
It is strongly advised that before attempting a migration to a Samba-3 controlled network
that every possible effort be made to gain all-round commitment to the change. Firstly, you
should know precisely <emphasis>why</emphasis> the change is important for the organisation.
Possible motivations to make a change include:
</para>
<itemizedlist>
<listitem>
<para>Improve network manageability</para>
</listitem>
<listitem>
<para>Obtain better user level functionality</para>
</listitem>
<listitem>
<para>Reduce network operating costs</para>
</listitem>
<listitem>
<para>Reduce exposure caused by Microsoft withdrawal of NT4 support</para>
</listitem>
<listitem>
<para>Avoid MS License 6 implications</para>
</listitem>
<listitem>
<para>Reduce organisation's dependency on Microsoft</para>
</listitem>
</itemizedlist>
<para>
It is vital that it be well recognised that Samba-3 is NOT MS Windows NT4. Samba-3 offers
an alternative solution that is both different from MS Windows NT4 and that offers some
advantages compared with it. It should also be recognised 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).
</para>
<para>
What are the features that Samba-3 can NOT provide?
</para>
<itemizedlist>
<listitem>
<para>Active Directory Server</para>
</listitem>
<listitem>
<para>Group Policy Objects (in Active Direcrtory)</para>
</listitem>
<listitem>
<para>Machine Policy objects</para>
</listitem>
<listitem>
<para>Logon Scripts in Active Directorty</para>
</listitem>
<listitem>
<para>Software Application and Access Controls in Active Directory</para>
</listitem>
</itemizedlist>
<para>
The features that Samba-3 DOES provide and that may be of compelling interest to your site
includes:
</para>
<itemizedlist>
<listitem>
<para>Lower Cost of Ownership</para>
</listitem>
<listitem>
<para>Global availability of support with no strings attached</para>
</listitem>
<listitem>
<para>Dynamic SMB Servers (ie:Can run more than one server per Unix/Linux system)</para>
</listitem>
<listitem>
<para>Creation of on-the-fly logon scripts</para>
</listitem>
<listitem>
<para>Creation of on-the-fly Policy Files</para>
</listitem>
<listitem>
<para>Greater Stability, Reliability, Performance and Availability</para>
</listitem>
<listitem>
<para>Manageability via an ssh connection</para>
</listitem>
<listitem>
<para>Flexible choices of back-end authentication technologies (tdbsam, ldapsam, mysqlsam)</para>
</listitem>
<listitem>
<para>Ability to implement a full single-signon architecture</para>
</listitem>
<listitem>
<para>Ability to distribute authentication systems for absolute minimum wide area network bandwidth demand</para>
</listitem>
</itemizedlist>
<para>
Before migrating a network from MS Windows NT4 to Samba-3 it is vital that all necessary factors are
considered. Users should be educated about changes they may experience so that the change will be a
welcome one and not become an obstacle to the work they need to do. The following are some of the
factors that will go into a successful migration:
</para>
<sect3>
<title>Domain Layout</title>
<para>
Samba-3 can be configured as a domain controller, a back-up domain controller (probably best called
a secondary controller), a domain member, or as a stand-alone 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).
It should be noted that 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. This means that in a complex organisation there can be a single LDAP database, that itself
can be distributed, that can simultaneously serve multiple domains (that can also be widely distributed).
</para>
<para>
It is recommended that from a design perspective, the number of users per server, as well as the number
of servers, per domain should be scaled according to needs and should also consider server capacity
and network bandwidth.
</para>
<para>
A physical network segment may house several domains, each of which may span multiple network segments.
Where domains span routed network segments it is most advisable to consider and test the performance
implications of the design and layout of a network. A Centrally located domain controller that is being
designed to serve mulitple routed network segments may result in severe performance problems if the
response time (eg: ping timing) between the remote segment and the PDC is more than 100 ms. In situations
where the delay is too long it is highly recommended to locate a backup controller (BDC) to serve as
the local authentication and access control server.
</para>
</sect3>
<sect3>
<title>Server Share and Directory Layout</title>
<para>
There are few cardinal rules to effective network design that can be broken with impunity.
The most important rule of effective network management is that 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.
</para>
<para>
The nature of the data that must be stored needs to be born in mind when deciding how many
shares must be created. The physical disk space layout should also be taken into account
when designing where share points will be created. Keep in mind that all data needs to be
backed up, thus the simpler the disk layout the easier it will be to keep track of what must
be backed up to tape or other off-line storage medium. Always plan and implement for minimum
maintenance. Leave nothing to chance in your design, above all, do not leave backups to chance:
Backup and test, validate every backup, create a disaster recovery plan and prove that it works.
</para>
<para>
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.
</para>
<para>
Many network administrators who are new to the game will attempt to use elaborate techniques
to set access controls, on files, directories, shares, as well as in share definitions.
There is the ever present danger that that administrator's successor will not understand the
complex mess that has been inherited. Remember, apparent job security through complex design
and implementation may ultimately cause loss of operations and downtime to users as the new
administrator learns to untangle your web. Keep access controls simple and effective and
make sure that users will never be interrupted by the stupidity of complexity.
</para>
</sect3>
<sect3>
<title>Logon Scripts</title>
<para>
Please refer to the section of this document on Advanced Network Adminsitration for information
regarding the network logon script options for Samba-3. Logon scripts can help to ensure that
all users gain share and printer connections they need.
</para>
<para>
Logon scripts can be created on-the-fly so that all commands executed are specific to the
rights and privilidges granted to the user. The preferred controls should be affected through
group membership so that group information can be used to custom create a logong script using
the <filename>root preexec</filename> parameters to the <filename>NETLOGON</filename> share.
</para>
<para>
Some sites prefer to use a tool such as <filename>kixstart</filename> 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 knowledgebase article KB189105 that
deals with how to add printers without user intervention via the logon script process.
</para>
</sect3>
<sect3>
<title>Profile Migration/Creation</title>
<para>
User and Group Profiles may be migrated using the tools described in the section titled Desktop Profile
Management.
</para>
<para>
Profiles may also be managed using the Samba-3 tool <filename>profiles</filename>. This tool allows
the MS Windows NT style security identifiers (SIDs) that are stored inside the profile NTuser.DAT file
to be changed to the SID of the Samba-3 domain.
</para>
</sect3>
<sect3>
<title>User and Group Accounts</title>
<para>
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 it is STRONGLY advised to create in Samba-3 the
groups that are present on the MS Windows NT4 domain <emphasis>AND</emphasis> to connect these to
suitable Unix/Linux groups. Following this simple advice will mean that all user and group attributes
should migrate painlessly.
</para>
</sect3>
</sect2>
<sect2>
<title>Steps In Migration Process</title>
<para>
The approximate migration process is described below.
</para>
<itemizedlist>
<listitem><para>
You will have an NT4 PDC that has the users, groups, policies and profiles to be migrated
</para></listitem>
<listitem><para>
Samba-3 set up as a DC with netlogon share, profile share, etc.
</para></listitem>
</itemizedlist>
<procedure><title>The Account Migration Process</title>
<step><para>Create a BDC account for the samba server using NT Server Manager</para>
<substeps><step><para>Samba must NOT be running</para></step></substeps></step>
<step>
<para>rpcclient NT4PDC -U Administrator%passwd</para>
<substeps><step><para>lsaquery</para></step>
<step><para>Note the SID returned</para></step>
</substeps>
</step>
<step><para>net getsid -S NT4PDC -w DOMNAME -U Administrator%passwd</para>
<substeps><step><para>Note the SID</para></step></substeps>
</step>
<step><para>net getlocalsid</para>
<substeps>
<step><para>Note the SID, now check that all three SIDS reported are the same!</para></step>
</substeps>
</step>
<step><para>net rpc join -S NT4PDC -w DOMNAME -U Administrator%passwd</para></step>
<step><para>net rpc vampire -S NT4PDC -U administrator%passwd</para></step>
<step><para>pdbedit -l</para>
<substeps><step><para>Note - did the users migrate?</para></step></substeps>
</step>
<step><para>initGrps.sh DOMNAME</para></step>
<step><para>net groupmap list</para>
<substeps><step><para>Now check that all groups are recognised</para></step></substeps>
</step>
<step><para>net rpc campire -S NT4PDC -U administrator%passwd</para></step>
<step><para>pdbedit -lv</para>
<substeps><step>
<para>Note - check that all group membership has been migrated</para>
</step></substeps>
</step>
</procedure>
<para>
Now it is time to migrate all the profiles, then migrate all policy files.
More later.
</para>
</sect2>
</sect1>
<sect1>
<title>Migration Options</title>
<para>
Based on feedback from many sites as well as from actual installation and maintenance
experience sites that wish to migrate from MS Windows NT4 Domain Control to a Samba
based solution fit into three basic categories.
</para>
<table frame="all"><title>The 3 Major Site Types</title>
<tgroup cols="2">
<thead>
<row><entry>Number of Users</entry><entry>Description</entry></row>
</thead>
<tbody>
<row><entry>&lt; 50</entry><entry><para>Want simple conversion with NO pain</para></entry></row>
<row><entry>50 - 250</entry><entry><para>Want new features, can manage some in-house complexity</para></entry></row>
<row><entry>&gt; 250</entry><entry><para>Solution/Implementation MUST scale well, complex needs. Cross departmental decision process. Local expertise in most areas</para></entry></row>
</tbody>
</tgroup>
</table>
<sect2>
<title>Planning for Success</title>
<para>
There are three basic choices for sites that intend to migrate from MS Windwows NT4
to Samba-3.
</para>
<itemizedlist>
<listitem><para>
Simple Conversion (total replacement)
</para></listitem>
<listitem><para>
Upgraded Conversion (could be one of integration)
</para></listitem>
<listitem><para>
Complete Redesign (completely new solution)
</para></listitem>
</itemizedlist>
<para>
No matter what choice you make, the following rules will minimise down-stream problems:
</para>
<itemizedlist>
<listitem><para>
Take sufficient time
</para></listitem>
<listitem><para>
Avoid Panic
</para></listitem>
<listitem><para>
Test ALL assumptions
</para></listitem>
<listitem><para>
Test full roll-out program, including workstation deployment
</para></listitem>
</itemizedlist>
<table frame="top"><title>Nature of the Conversion Choices</title>
<tgroup cols="3">
<thead>
<row><entry>Simple</entry><entry>Upgraded</entry><entry>Redesign</entry></row>
</thead>
<tbody>
<row>
<entry><para>Make use of minimal OS specific features</para></entry>
<entry><para>Translate NT4 features to new host OS features</para></entry>
<entry><para>Decide:</para></entry>
</row>
<row>
<entry><para>Suck all accounts from NT4 into Samba-3</para></entry>
<entry><para>Copy and improve:</para></entry>
<entry><para>Authentication Regime (database location and access)</para></entry>
</row>
<row>
<entry><para>Make least number of operational changes</para></entry>
<entry><para>Make progressive improvements</para></entry>
<entry><para>Desktop Management Methods</para></entry>
</row>
<row>
<entry><para>Take least amount of time to migrate</para></entry>
<entry><para>Minimise user impact</para></entry>
<entry><para>Better Control of Desktops / Users</para></entry>
</row>
<row>
<entry><para>Live versus Isolated Conversion</para></entry>
<entry><para>Maximise functionality</para></entry>
<entry><para>Identify Needs for: Manageability, Scalability, Security, Availability</para></entry>
</row>
<row>
<entry><para>Integrate Samba-3 then migrate while users are active, then Change of control (ie: swap out)</para></entry>
<entry><para>Take advantage of lower maintenance opportunity</para></entry>
<entry><para></para></entry>
</row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2>
<title>Samba Implementation Choices</title>
<para><programlisting>
Authentication database back end
Winbind (external Samba or NT4/200x server)
Can use pam_mkhomedir.so to auto-create home dirs
External server could use Active Directory or NT4 Domain
Database type
smbpasswd, tdbsam, ldapsam, MySQLsam
Access Control Points
On the Share itself (Use NT4 Server Manager)
On the file system
Unix permissions on files and directories
Posix ACLs enablement in file system?
Through Samba share parameters
Not recommended - except as only resort
Policies (migrate or create new ones)
Group Policy Editor (NT4)
Watch out for Tattoo effect
User and Group Profiles
Platform specific so use platform tool to change from a Local
to a Roaming profile Can use new profiles tool to change SIDs
(NTUser.DAT)
Logon Scripts (Know how they work)
User and Group mapping to Unix/Linux
username map facility may be needed
Use 'net groupmap' to connect NT4 groups to Unix groups
Use pdbedit to set/change user configuration
NOTE:
If migrating to LDAP back end it may be easier to dump initial LDAP database
to LDIF, then edit, then reload into LDAP
OS specific scripts / programs may be needed
Add / delete Users
Note OS limits on size of name (Linux 8 chars)
NT4 up to 254 chars
Add / delete machines
Applied only to domain members (note up to 16 chars)
Add / delete Groups
Note OS limits on size and nature
Linux limit is 16 char,
no spaces and no upper case chars (groupadd)
Migration Tools
Domain Control (NT4 Style)
Profiles, Policies, Access Controls, Security
Migration Tools
Samba: net, rpcclient, smbpasswd, pdbedit, profiles
Windows: NT4 Domain User Manager, Server Manager (NEXUS)
Authentication
New SAM back end (smbpasswd, tdbsam, ldapsam, mysqlsam)
</programlisting>
</para>
</sect2>
</sect1>
</chapter>

335
docs/docbook/projdoc/NT_Security.xml Normal file
View File

@ -0,0 +1,335 @@
<chapter id="unix-permissions">
<chapterinfo>
&author.jeremy;
<pubdate>12 Apr 1999</pubdate>
</chapterinfo>
<title>UNIX Permission Bits and Windows NT Access Control Lists</title>
<sect1>
<title>Viewing and changing UNIX permissions using the NT
security dialogs</title>
<para>Windows NT clients can use their native security settings
dialog box to view and modify the underlying UNIX permissions.</para>
<para>Note that this ability is careful not to compromise
the security of the UNIX host Samba is running on, and
still obeys all the file permission rules that a Samba
administrator can set.</para>
<note>
<para>
All access to Unix/Linux system file via Samba is controlled at
the operating system file access control level. When trying to
figure out file access problems it is vitally important to identify
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.
</para>
</note>
</sect1>
<sect1>
<title>How to view file security on a Samba share</title>
<para>From an NT4/2000/XP client, single-click with the right
mouse button on any file or directory in a Samba mounted
drive letter or UNC path. When the menu pops-up, click
on the <emphasis>Properties</emphasis> entry at the bottom of
the menu. This brings up the file properties dialog
box. Click on the tab <emphasis>Security</emphasis> and you
will see three buttons, <emphasis>Permissions</emphasis>,
<emphasis>Auditing</emphasis>, and <emphasis>Ownership</emphasis>.
The <emphasis>Auditing</emphasis> button will cause either
an error message <errorname>A requested privilege is not held
by the client</errorname> to appear if the user is not the
NT Administrator, or a dialog which is 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
non-functional with a Samba share at this time, as the only
useful button, the <command>Add</command> button will not currently
allow a list of users to be seen.</para>
</sect1>
<sect1>
<title>Viewing file ownership</title>
<para>Clicking on the <command>"Ownership"</command> button
brings up a dialog box telling you who owns the given file. The
owner name will be of the form :</para>
<para><command>"SERVER\user (Long name)"</command></para>
<para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of
the Samba server, <replaceable>user</replaceable> is the user name of
the UNIX user who owns the file, and <replaceable>(Long name)</replaceable>
is the descriptive string identifying the user (normally found in the
GECOS field of the UNIX password database). Click on the <command>Close
</command> button to remove this dialog.</para>
<para>If the parameter <parameter>nt acl support</parameter>
is set to <constant>false</constant> then the file owner will
be shown as the NT user <command>"Everyone"</command>.</para>
<para>The <command>Take Ownership</command> button will not allow
you to change the ownership of this file to yourself (clicking on
it will display a dialog box complaining that the user 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 <emphasis>root</emphasis>
user. As 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.</para>
<para>There is an NT 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 filesystem or remote mounted NTFS
or Samba drive. This is available as part of the <emphasis>Seclib
</emphasis> NT security library written by Jeremy Allison of
the Samba Team, available from the main Samba ftp site.</para>
</sect1>
<sect1>
<title>Viewing file or directory permissions</title>
<para>The third button is the <command>"Permissions"</command>
button. Clicking on this brings up a dialog box that shows both
the permissions and the UNIX owner of the file or directory.
The owner is displayed in the form :</para>
<para><command>"SERVER\user (Long name)"</command></para>
<para>Where <replaceable>SERVER</replaceable> is the NetBIOS name of
the Samba server, <replaceable>user</replaceable> is the user name of
the UNIX user who owns the file, and <replaceable>(Long name)</replaceable>
is the descriptive string identifying the user (normally found in the
GECOS field of the UNIX password database).</para>
<para>If the parameter <parameter>nt acl support</parameter>
is set to <constant>false</constant> then the file owner will
be shown as the NT user <command>"Everyone"</command> and the
permissions will be shown as NT "Full Control".</para>
<para>The permissions field is displayed differently for files
and directories, so I'll describe the way file permissions
are displayed first.</para>
<sect2>
<title>File Permissions</title>
<para>The standard UNIX user/group/world triple and
the corresponding "read", "write", "execute" permissions
triples 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 <command>Everyone</command>, followed
by the list of permissions allowed for UNIX world. The UNIX
owner and group permissions are displayed as an NT
<command>user</command> icon and an NT <command>local
group</command> icon respectively followed by the list
of permissions allowed for the UNIX user and group.</para>
<para>As many UNIX permission sets don't map into common
NT names such as <command>"read"</command>, <command>
"change"</command> or <command>"full control"</command> then
usually the permissions will be prefixed by the words <command>
"Special Access"</command> in the NT display list.</para>
<para>But what happens if the file has no permissions allowed
for a particular UNIX user group or world component ? In order
to allow "no permissions" to be seen and modified then Samba
overloads the NT <command>"Take Ownership"</command> ACL attribute
(which has no meaning in UNIX) and reports a component with
no permissions as having the NT <command>"O"</command> bit set.
This was chosen of course to make it look like a zero, meaning
zero permissions. More details on the decision behind this will
be given below.</para>
</sect2>
<sect2>
<title>Directory Permissions</title>
<para>Directories on an NT NTFS file system have two
different sets of permissions. The first set of permissions
is the ACL set on the directory itself, this is usually displayed
in the first set of parentheses in the normal <command>"RW"</command>
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.</para>
<para>The second set of directory permissions has no real meaning
in the UNIX permissions world and represents the <command>
"inherited"</command> permissions that any file created within
this directory would inherit.</para>
<para>Samba synthesises 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.</para>
</sect2>
</sect1>
<sect1>
<title>Modifying file or directory permissions</title>
<para>Modifying file and directory permissions is as simple
as changing the displayed permissions in the dialog box, and
clicking the <command>OK</command> button. 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 need to also be taken into account.</para>
<para>If the parameter <parameter>nt acl support</parameter>
is set to <constant>false</constant> then any attempt to set
security permissions will fail with an <command>"Access Denied"
</command> message.</para>
<para>The first thing to note is that the <command>"Add"</command>
button will not return a list of users in Samba (it will give
an error message of <command>"The remote procedure call failed
and did not execute"</command>). This means that you can only
manipulate the current user/group/world permissions listed in
the dialog box. This actually works quite well as these are the
only permissions that UNIX actually has.</para>
<para>If a permission triple (either user, group, or world)
is removed from the list of permissions in the NT dialog box,
then when the <command>"OK"</command> button is pressed it will
be applied as "no permissions" on the UNIX side. If you then
view the permissions again the "no permissions" entry will appear
as the NT <command>"O"</command> flag, as described above. This
allows you to add permissions back to a file or directory once
you have removed them from a triple component.</para>
<para>As UNIX supports only the "r", "w" and "x" bits of
an NT ACL then if other NT security attributes such as "Delete
access" are selected then they will be ignored when applied on
the Samba server.</para>
<para>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 <command>"Replace
permissions on existing files"</command> checkbox in the NT
dialog before clicking <command>"OK"</command>.</para>
<para>If you wish to remove all permissions from a
user/group/world component then you may either highlight the
component and click the <command>"Remove"</command> button,
or set the component to only have the special <command>"Take
Ownership"</command> permission (displayed as <command>"O"
</command>) highlighted.</para>
</sect1>
<sect1>
<title>Interaction with the standard Samba create mask
parameters</title>
<para>There are four parameters
to control interaction with the standard Samba create mask parameters.
These are :</para>
<para><parameter>security mask</parameter></para>
<para><parameter>force security mode</parameter></para>
<para><parameter>directory security mask</parameter></para>
<para><parameter>force directory security mode</parameter></para>
<para>Once a user clicks <command>"OK"</command> to apply the
permissions Samba maps the given permissions into a user/group/world
r/w/x triple set, and then will check the changed permissions for a
file against the bits set in the <ulink url="smb.conf.5.html#SECURITYMASK">
<parameter>security mask</parameter></ulink> parameter. Any bits that
were changed that are not set to '1' in this parameter are left alone
in the file permissions.</para>
<para>Essentially, zero bits in the <parameter>security mask</parameter>
mask may be treated as a set of bits the user is <emphasis>not</emphasis>
allowed to change, and one bits are those the user is allowed to change.
</para>
<para>If not set explicitly this parameter is set to the same value as
the <ulink url="smb.conf.5.html#CREATEMASK"><parameter>create mask
</parameter></ulink> parameter. To allow a user to modify all the
user/group/world permissions on a file, set this parameter
to 0777.</para>
<para>Next Samba checks the changed permissions for a file against
the bits set in the <ulink url="smb.conf.5.html#FORCESECURITYMODE">
<parameter>force security mode</parameter></ulink> parameter. Any bits
that were changed that correspond to bits set to '1' in this parameter
are forced to be set.</para>
<para>Essentially, bits set in the <parameter>force security mode
</parameter> parameter may be treated as a set of bits that, when
modifying security on a file, the user has always set to be 'on'.</para>
<para>If not set explicitly this parameter is set to the same value
as the <ulink url="smb.conf.5.html#FORCECREATEMODE"><parameter>force
create mode</parameter></ulink> parameter.
To allow a user to modify all the user/group/world permissions on a file
with no restrictions set this parameter to 000.</para>
<para>The <parameter>security mask</parameter> and <parameter>force
security mode</parameter> parameters are applied to the change
request in that order.</para>
<para>For a directory Samba will perform the same operations as
described above for a file except using the parameter <parameter>
directory security mask</parameter> instead of <parameter>security
mask</parameter>, and <parameter>force directory security mode
</parameter> parameter instead of <parameter>force security mode
</parameter>.</para>
<para>The <parameter>directory security mask</parameter> parameter
by default is set to the same value as the <parameter>directory mask
</parameter> parameter and the <parameter>force directory security
mode</parameter> parameter by default is set to the same value as
the <parameter>force directory mode</parameter> parameter. </para>
<para>In this way Samba enforces the permission restrictions that
an administrator can set on a Samba share, whilst still allowing users
to modify the permission bits within that restriction.</para>
<para>If you want to set up a share that allows users full control
in modifying the permission bits on their files and directories and
doesn't force any particular bits to be set 'on', then set the following
parameters in the &smb.conf; file in that share specific section :</para>
<para><parameter>security mask = 0777</parameter></para>
<para><parameter>force security mode = 0</parameter></para>
<para><parameter>directory security mask = 0777</parameter></para>
<para><parameter>force directory security mode = 0</parameter></para>
</sect1>
<sect1>
<title>Interaction with the standard Samba file attribute
mapping</title>
<para>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.
</para>
<para>One way this can show up is 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 info in another tab.</para>
<para>What this can mean is that if the owner changes the permissions
to allow themselves read access using the security dialog, clicks
<command>"OK"</command> to get back to the standard attributes tab
dialog, and then clicks <command>"OK"</command> 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 <command>"OK"</command> to get back to the
attributes dialog you should always hit <command>"Cancel"</command>
rather than <command>"OK"</command> to ensure that your changes
are not overridden.</para>
</sect1>
</chapter>

1288
docs/docbook/projdoc/NetworkBrowsing.xml Normal file
View File

File diff suppressed because it is too large Load Diff

373
docs/docbook/projdoc/Other-Clients.xml Normal file
View File

@ -0,0 +1,373 @@
<chapter id="Other-Clients">
<chapterinfo>
&author.jmcd;
&author.jelmer;
<pubdate>5 Mar 2001</pubdate>
</chapterinfo>
<title>Samba and other CIFS clients</title>
<para>This chapter contains client-specific information.</para>
<sect1>
<title>Macintosh clients?</title>
<para>
Yes. <ulink url="http://www.thursby.com/">Thursby</ulink> now have a CIFS Client / Server called <ulink url="http://www.thursby.com/products/dave.html">DAVE</ulink>
</para>
<para>
They test it against Windows 95, Windows NT and samba for
compatibility issues. At the time of writing, DAVE was at version
1.0.1. The 1.0.0 to 1.0.1 update is available as a free download from
the Thursby web site (the speed of finder copies has been greatly
enhanced, and there are bug-fixes included).
</para>
<para>
Alternatives - There are two free implementations of AppleTalk for
several kinds of UNIX machnes, 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 omplementations are
<ulink url="http://www.umich.edu/~rsug/netatalk/">Netatalk</ulink>, and
<ulink url="http://www.cs.mu.oz.au/appletalk/atalk.html">CAP</ulink>.
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
<ulink url="http://www.eats.com/linux_mac_win.html">http://www.eats.com/linux_mac_win.html</ulink>
</para>
</sect1>
<sect1>
<title>OS2 Client</title>
<sect2>
<title>How can I configure OS/2 Warp Connect or
OS/2 Warp 4 as a client for Samba?</title>
<para>A more complete answer to this question can be
found on <ulink url="http://carol.wins.uva.nl/~leeuw/samba/warp.html">
http://carol.wins.uva.nl/~leeuw/samba/warp.html</ulink>.</para>
<para>Basically, you need three components:</para>
<itemizedlist>
<listitem><para>The File and Print Client ('IBM Peer')
</para></listitem>
<listitem><para>TCP/IP ('Internet support')
</para></listitem>
<listitem><para>The "NetBIOS over TCP/IP" driver ('TCPBEUI')
</para></listitem>
</itemizedlist>
<para>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.</para>
<para>Adding the "NetBIOS over TCP/IP" driver is not described
in the manual and just barely in the online documentation. Start
MPTS.EXE, click on OK, click on "Configure LAPS" and click
on "IBM OS/2 NETBIOS OVER TCP/IP" in 'Protocols'. This line
is then moved to 'Current Configuration'. Select that line,
click on "Change number" and increase it from 0 to 1. Save this
configuration.</para>
<para>If the Samba server(s) is not on your local subnet, you
can optionally add IP names and addresses of these servers
to the "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 'IBM Peer' to bring it on
the same level as Warp 4. See the webpage mentioned above.</para>
</sect2>
<sect2>
<title>How can I configure OS/2 Warp 3 (not Connect),
OS/2 1.2, 1.3 or 2.x for Samba?</title>
<para>You can use the free Microsoft LAN Manager 2.2c Client
for OS/2 from
<ulink url="ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/">
ftp://ftp.microsoft.com/BusSys/Clients/LANMAN.OS2/</ulink>.
See <ulink url="http://carol.wins.uva.nl/~leeuw/lanman.html">
http://carol.wins.uva.nl/~leeuw/lanman.html</ulink> for
more information on how to install and use this client. In
a nutshell, edit the file \OS2VER in the root directory of
the OS/2 boot partition and add the lines:</para>
<para><programlisting>
20=setup.exe
20=netwksta.sys
20=netvdd.sys
</programlisting></para>
<para>before you install the client. Also, don't use the
included NE2000 driver because it is buggy. Try the NE2000
or NS2000 driver from
<ulink url="ftp://ftp.cdrom.com/pub/os2/network/ndis/">
ftp://ftp.cdrom.com/pub/os2/network/ndis/</ulink> instead.
</para>
</sect2>
<sect2>
<title>Are there any other issues when OS/2 (any version)
is used as a client?</title>
<para>When you do a NET VIEW or use the "File and Print
Client Resource Browser", no Samba servers show up. This can
be fixed by a patch from <ulink
url="http://carol.wins.uva.nl/~leeuw/samba/fix.html">
http://carol.wins.uva.nl/~leeuw/samba/fix.html</ulink>.
The patch will be included in a later version of Samba. It also
fixes a couple of other problems, such as preserving long
filenames when objects are dragged from the Workplace Shell
to the Samba server. </para>
</sect2>
<sect2>
<title>How do I get printer driver download working
for OS/2 clients?</title>
<para>First, create a share called [PRINTDRV] that is
world-readable. Copy your OS/2 driver files there. Note
that the .EA_ 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.</para>
<para>Install the NT driver first for that printer. Then,
add to your smb.conf a parameter, os2 driver map =
<replaceable>filename</replaceable>". Then, in the file
specified by <replaceable>filename</replaceable>, map the
name of the NT driver name to the OS/2 driver name as
follows:</para>
<para><command>nt driver name = os2 "driver
name"."device name"</command>, e.g.:
HP LaserJet 5L = LASERJET.HP LaserJet 5L</para>
<para>You can have multiple drivers mapped in this file.</para>
<para>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.
</para>
</sect2>
</sect1>
<sect1>
<title>Windows for Workgroups</title>
<sect2>
<title>Use latest TCP/IP stack from Microsoft</title>
<para>Use the latest TCP/IP stack from microsoft if you use Windows
for workgroups.
</para>
<para>The early TCP/IP stacks had lots of bugs.</para>
<para>
Microsoft has released an incremental upgrade to their TCP/IP 32-Bit
VxD drivers. The latest release can be found on their ftp site at
ftp.microsoft.com, located in /peropsys/windows/public/tcpip/wfwt32.exe.
There is an update.txt file there that describes the problems that were
fixed. New files include WINSOCK.DLL, TELNET.EXE, WSOCK.386, VNBT.386,
WSTCP.386, TRACERT.EXE, NETSTAT.EXE, and NBTSTAT.EXE.
</para>
</sect2>
<sect2>
<title>Delete .pwl files after password change</title>
<para>
WfWg does a lousy job with passwords. I find that if I change my
password on either the unix box or the PC the safest thing to do is to
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.
</para>
<para>
If you don't do this you may find that WfWg remembers and uses the old
password, even if you told it a new one.
</para>
<para>
Often WfWg will totally ignore a password you give it in a dialog box.
</para>
</sect2>
<sect2>
<title>Configure WfW password handling</title>
<para>
There is a program call admincfg.exe
on the last disk (disk 8) of the WFW 3.11 disk set. To install it
type EXPAND A:\ADMINCFG.EX_ C:\WINDOWS\ADMINCFG.EXE Then add an icon
for it via the "Progam Manager" "New" Menu. This program allows you
to control how WFW handles passwords. ie disable Password Caching etc
for use with <command>security = user</command>
</para>
</sect2>
<sect2>
<title>Case handling of passwords</title>
<para>Windows for Workgroups uppercases the password before sending it to the server. Unix passwords can be case-sensitive though. Check the <ulink url="smb.conf.5.html">smb.conf(5)</ulink> information on <command>password level</command> to specify what characters samba should try to uppercase when checking.</para>
</sect2>
<sect2>
<title>Use TCP/IP as default protocol</title>
<para>To support print queue reporting you may find
that you have to use TCP/IP as the default protocol under
WfWg. For some reason if you leave Netbeui as the default
it may break the print queue reporting on some systems.
It is presumably a WfWg bug.</para>
</sect2>
<sect2>
<title>Speed improvement</title>
<para>
Note that some people have found that setting DefaultRcvWindow in
the [MSTCP] section of the SYSTEM.INI file under WfWg to 3072 gives a
big improvement. I don't know why.
</para>
<para>
My own experience wth DefaultRcvWindow is that I get much better
performance with a large value (16384 or larger). Other people have
reported that anything over 3072 slows things down enourmously. One
person even reported a speed drop of a factor of 30 when he went from
3072 to 8192. I don't know why.
</para>
</sect2>
</sect1>
<sect1>
<title>Windows '95/'98</title>
<para>
When using Windows 95 OEM SR2 the following updates are recommended where Samba
is being used. Please NOTE that the above change will affect you once these
updates have been installed.
</para>
<para>
There are more updates than the ones mentioned here. You are referred to the
Microsoft Web site for all currently available updates to your specific version
of Windows 95.
</para>
<orderedlist>
<listitem><para>Kernel Update: KRNLUPD.EXE</para></listitem>
<listitem><para>Ping Fix: PINGUPD.EXE</para></listitem>
<listitem><para>RPC Update: RPCRTUPD.EXE</para></listitem>
<listitem><para>TCP/IP Update: VIPUPD.EXE</para></listitem>
<listitem><para>Redirector Update: VRDRUPD.EXE</para></listitem>
</orderedlist>
<para>
Also, if using MS OutLook it is desirable to install the OLEUPD.EXE fix. This
fix may stop your machine from hanging for an extended period when exiting
OutLook and you may also notice a significant speedup when accessing network
neighborhood services.
</para>
<sect2>
<title>Speed improvement</title>
<para>
Configure the win95 TCPIP registry settings to give better
performance. I use a program called MTUSPEED.exe which I got off the
net. There are various other utilities of this type freely available.
</para>
</sect2>
</sect1>
<sect1>
<title>Windows 2000 Service Pack 2</title>
<para>
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
likely occur if it is not.
</para>
<para>
In order to server profiles successfully to Windows 2000 SP2
clients (when not operating as a PDC), Samba must have
<command>nt acl support = no</command>
added to the file share which 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, etc...). See the
<ulink url="smb.conf.5.html">smb.conf(5)</ulink> man page
for more details on this option. Also note that the
<command>nt acl support</command> parameter was formally a global parameter in
releases prior to Samba 2.2.2.
</para>
<para>
The following is a minimal profile share:
</para>
<para><programlisting>
[profile]
path = /export/profile
create mask = 0600
directory mask = 0700
nt acl support = no
read only = no
</programlisting></para>
<para>
The reason for this bug is that the Win2k SP2 client copies
the security descriptor for the profile which contains
the Samba server's SID, and not the domain SID. The client
compares the SID for SAMBA\user and realizes it is
different that the one assigned to DOMAIN\user. Hence the reason
for the "access denied" message.
</para>
<para>
By disabling the <command>nt acl support</command> parameter, Samba will send
the Win2k client a response to the QuerySecurityDescriptor
trans2 call which causes the client to set a default ACL
for the profile. This default ACL includes
</para>
<para><command>DOMAIN\user "Full Control"</command></para>
<note><para>This bug does not occur when using winbind to
create accounts on the Samba host for Domain users.</para></note>
</sect1>
<sect1>
<title>Windows NT 3.1</title>
<para>If you have problems communicating across routers with Windows
NT 3.1 workstations, read <ulink url="http://support.microsoft.com/default.aspx?scid=kb;[LN];Q103765">this Microsoft Knowledge Base article</ulink>.
</para>
</sect1>
</chapter>

389
docs/docbook/projdoc/PAM-Authentication-And-Samba.xml Normal file
View File

@ -0,0 +1,389 @@
<chapter id="pam">
<chapterinfo>
&author.jht;
<pubdate> (Jun 21 2001) </pubdate>
</chapterinfo>
<title>PAM Configuration for Centrally Managed Authentication</title>
<sect1>
<title>Samba and PAM</title>
<para>
A number of Unix systems (eg: 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 (<filename>/etc/passwd</filename>)
would require the provision of alternatives for all programs that provide
security services. Such a choice would involve provision of
alternatives to such programs as: <command>login</command>,
<command>passwd</command>, <command>chown</command>, etc.
</para>
<para>
PAM provides a mechanism that disconnects these security programs
from the underlying authentication/authorization infrastructure.
PAM is configured either through one file <filename>/etc/pam.conf</filename> (Solaris),
or by editing individual files that are located in <filename>/etc/pam.d</filename>.
</para>
<note>
<para>
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 <filename>/lib/security</filename>. If the module
is located outside the default then the path must be specified as:
<programlisting>
auth required /other_path/pam_strange_module.so
</programlisting>
</para>
</note>
<para>
The following is an example <filename>/etc/pam.d/login</filename> configuration file.
This example had all options been uncommented is probably not usable
as 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 <filename>pam_pwdb.so</filename>.
</para>
<para><programlisting>
#%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
</programlisting></para>
<para>
PAM allows use of replacable modules. Those available on a
sample system include:
</para>
<para><prompt>$</prompt><userinput>/bin/ls /lib/security</userinput>
<programlisting>
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
</programlisting></para>
<para>
The following example for the login program replaces the use of
the <filename>pam_pwdb.so</filename> module which uses the system
password database (<filename>/etc/passwd</filename>,
<filename>/etc/shadow</filename>, <filename>/etc/group</filename>) with
the module <filename>pam_smbpass.so</filename> which uses the Samba
database which contains the Microsoft MD4 encrypted password
hashes. This database is stored in either
<filename>/usr/local/samba/private/smbpasswd</filename>,
<filename>/etc/samba/smbpasswd</filename>, or in
<filename>/etc/samba.d/smbpasswd</filename>, depending on the
Samba implementation for your Unix/Linux system. The
<filename>pam_smbpass.so</filename> module is provided by
Samba version 2.2.1 or later. It can be compiled by specifying the
<command>--with-pam_smbpass</command> options when running Samba's
<filename>configure</filename> script. For more information
on the <filename>pam_smbpass</filename> module, see the documentation
in the <filename>source/pam_smbpass</filename> directory of the Samba
source distribution.
</para>
<para><programlisting>
#%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
</programlisting></para>
<para>
The following is the PAM configuration file for a particular
Linux system. The default condition uses <filename>pam_pwdb.so</filename>.
</para>
<para><programlisting>
#%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
</programlisting></para>
<para>
In the following example the decision has been made to use the
smbpasswd database even for basic samba authentication. Such a
decision could also be made for the passwd program and would
thus allow the smbpasswd passwords to be changed using the passwd
program.
</para>
<para><programlisting>
#%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
</programlisting></para>
<note><para>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 implmentations also
provide the <filename>pam_stack.so</filename> module that allows all
authentication to be configured in a single central file. The
<filename>pam_stack.so</filename> method has some very devoted followers
on the basis that it allows for easier administration. As with all issues in
life though, every decision makes trade-offs, so you may want examine the
PAM documentation for further helpful information.
</para></note>
<sect2>
<title>PAM Configuration in smb.conf</title>
<para>
There is an option in smb.conf called <ulink
url="smb.conf.5.html#OBEYPAMRESTRICTIONS">obey pam restrictions</ulink>.
The following is from the on-line help for this option in SWAT;
</para>
<para>
When Samba is configured to enable PAM support (i.e.
<constant>--with-pam</constant>), 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. Note that Samba always
ignores PAM for authentication in the case of
<ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords = yes</ulink>.
The reason is that PAM modules cannot support the challenge/response
authentication mechanism needed in the presence of SMB
password encryption.
</para>
<para>Default: <command>obey pam restrictions = no</command></para>
</sect2>
<sect2>
<title>Password Synchronisation using pam_smbpass.so</title>
<para>
pam_smbpass is a PAM module which can be used on conforming systems to
keep the smbpasswd (Samba password) database in sync with the unix
password file. PAM (Pluggable Authentication Modules) is an API supported
under some Unices, such as Solaris, HPUX and Linux, that provides a
generic interface to authentication mechanisms.
</para>
<para>
For more information on PAM, see http://ftp.kernel.org/pub/linux/libs/pam/
</para>
<para>
This module authenticates a local smbpasswd user database. If you require
support for authenticating against a remote SMB server, or if you're
concerned about the presence of suid root binaries on your system, it is
recommended that you use pam_winbind instead.
</para>
<para><programlisting>
Options recognized by this module are as follows:
debug - log more debugging info
audit - like debug, but also logs unknown usernames
use_first_pass - don't prompt the user for passwords;
take them from PAM_ items instead
try_first_pass - try to get the password from a previous
PAM module, fall back to prompting the user
use_authtok - like try_first_pass, but *fail* if the new
PAM_AUTHTOK has not been previously set.
(intended for stacking password modules only)
not_set_pass - don't make passwords used by this module
available to other modules.
nodelay - don't insert ~1 second delays on authentication
failure.
nullok - null passwords are allowed.
nonull - null passwords are not allowed. Used to
override the Samba configuration.
migrate - only meaningful in an "auth" context;
used to update smbpasswd file with a
password used for successful authentication.
smbconf=&lt; file &gt; - specify an alternate path to the smb.conf
file.
</programlisting></para>
<para><programlisting>
Thanks go to the following people:
* Andrew Morgan &lt; morgan@transmeta.com &gt;, for providing the Linux-PAM
framework, without which none of this would have happened
* Christian Gafton &lt; gafton@redhat.com &gt; and Andrew Morgan again, for the
pam_pwdb module upon which pam_smbpass was originally based
* Luke Leighton &lt; lkcl@switchboard.net &gt; for being receptive to the idea,
and for the occasional good-natured complaint about the project's status
that keep me working on it :)
* and of course, all the other members of the Samba team
&lt;http://www.samba.org/samba/team.html&gt;, for creating a great product
and for giving this project a purpose
---------------------
Stephen Langasek &lt; vorlon@netexpress.net &gt;
</programlisting></para>
<para>
The following are examples of the use of pam_smbpass.so in the format of Linux
<filename>/etc/pam.d/</filename> files structure. Those wishing to implement this
tool on other platforms will need to adapt this appropriately.
</para>
<sect3>
<title>Password Synchonisation Configuration</title>
<para>
A sample PAM configuration that shows the use of pam_smbpass to make
sure private/smbpasswd is kept in sync when /etc/passwd (/etc/shadow)
is changed. Useful when an expired password might be changed by an
application (such as ssh).
</para>
<para><programlisting>
#%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
</programlisting></para>
</sect3>
<sect3>
<title>Password Migration Configuration</title>
<para>
A sample PAM configuration that shows the use of pam_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 ftp in, login using ssh, pop
their mail, etc.
</para>
<para><programlisting>
#%PAM-1.0
# password-migration
#
auth requisite pam_nologin.so
# pam_smbpass is called IFF 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
</programlisting></para>
</sect3>
<sect3>
<title>Mature Password Configuration</title>
<para>
A sample PAM configuration for a 'mature' smbpasswd installation.
private/smbpasswd is fully populated, and we consider it an error if
the smbpasswd doesn't exist or doesn't match the Unix password.
</para>
<para><programlisting>
#%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
</programlisting></para>
</sect3>
<sect3>
<title>Kerberos Password Integration Configuration</title>
<para>
A sample PAM configuration that shows pam_smbpass used together with
pam_krb5. This could be useful on a Samba PDC that is also a member of
a Kerberos realm.
</para>
<para><programlisting>
#%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
</programlisting></para>
</sect3>
</sect2>
</sect1>
<sect1>
<title>Distributed Authentication</title>
<para>
The astute administrator will realize from this that the
combination of <filename>pam_smbpass.so</filename>,
<command>winbindd</command>, and a distributed
passdb backend, such as ldap, will allow the establishment of a
centrally managed, distributed
user/password database that can also be used by all
PAM (eg: Linux) aware programs and applications. This arrangement
can have particularly potent advantages compared with the
use of Microsoft Active Directory Service (ADS) in so far as
reduction of wide area network authentication traffic.
</para>
</sect1>
</chapter>

384
docs/docbook/projdoc/PolicyMgmt.xml Normal file
View File

@ -0,0 +1,384 @@
<chapter id="PolicyMgmt">
<chapterinfo>
&author.jht;
<pubdate>April 3 2003</pubdate>
</chapterinfo>
<title>System and Account Policies</title>
<sect1>
<title>Creating and Managing System Policies</title>
<para>
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.
</para>
<para>
For MS Windows 9x/Me this file must be called <filename>Config.POL</filename> and may
be generated using a tool called <filename>poledit.exe</filename>, better known as the
Policy Editor. The policy editor was provided on the Windows 98 installation CD, but
dissappeared again with the introduction of MS Windows Me (Millenium Edition). From
comments from MS Windows network administrators it would appear that this tool became
a part of the MS Windows Me Resource Kit.
</para>
<para>
MS Windows NT4 Server products include the <emphasis>System Policy Editor</emphasis>
under the <filename>Start -> Programs -> Administrative Tools</filename> menu item.
For MS Windows NT4 and later clients this file must be called <filename>NTConfig.POL</filename>.
</para>
<para>
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 obsolete the old rules and to introduce newer and more
complex tools and methods. To Microsoft's credit though, the MMC does appear to
be a step forward, but improved functionality comes at a great price.
</para>
<para>
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
<ulink url="http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp">
Implementing Profiles and Policies in Windows NT 4.0 from http://www.microsoft.com/ntserver/management/deployment/planguide/prof_policies.asp</ulink> available from Microsoft.
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".
</para>
<para>
What follows is a very brief discussion with some helpful notes. The information provided
here is incomplete - you are warned.
</para>
<sect2>
<title>Windows 9x/Me Policies</title>
<para>
You need the Win98 Group Policy Editor to set Group Profiles up under Windows 9x/Me.
It can be found on the Original full product Win98 installation CD under
<filename>tools/reskit/netadmin/poledit</filename>. Install this using the
Add/Remove Programs facility and then click on the 'Have Disk' tab.
</para>
<para>
Use the Group Policy Editor to create a policy file that specifies the location of
user profiles and/or the <filename>My Documents</filename> etc. stuff. Then
save these settings in a file called <filename>Config.POL</filename> that needs to
be placed in the root of the [NETLOGON] share. If Win98 is configured to log onto
the Samba Domain, it will automatically read this file and update the Win9x/Me registry
of the machine as it logs on.
</para>
<para>
Further details are covered in the Win98 Resource Kit documentation.
</para>
<para>
If you do not take the right steps, then every so often Win9x/Me will check the
integrity of the registry and will restore it's settings from the back-up
copy of the registry it stores on each Win9x/Me machine. Hence, you will
occasionally notice things changing back to the original settings.
</para>
<para>
Install the group policy handler for Win9x to pick up group policies. Look on the
Win98 CD in <filename>\tools\reskit\netadmin\poledit</filename>.
Install group policies on a Win9x client by double-clicking
<filename>grouppol.inf</filename>. Log off and on again a couple of times and see
if Win98 picks up group policies. Unfortunately this needs to be done on every
Win9x/Me machine that uses group policies.
</para>
</sect2>
<sect2>
<title>Windows NT4 Style Policy Files</title>
<para>
To create or edit <filename>ntconfig.pol</filename> you must use the NT Server
Policy Editor, <command>poledit.exe</command> which is included with NT4 Server
but <emphasis>not NT Workstation</emphasis>. There is a Policy Editor on a NT4
Workstation but it is not suitable for creating <emphasis>Domain Policies</emphasis>.
Further, 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.
</para>
<para>
You need <filename>poledit.exe, common.adm</filename> and <filename>winnt.adm</filename>.
It is convenient to put the two *.adm files in the <filename>c:\winnt\inf</filename>
directory which is where the binary will look for them unless told otherwise. Note also that that
directory is normally 'hidden'.
</para>
<para>
The Windows NT policy editor is also included with the Service Pack 3 (and
later) for Windows NT 4.0. Extract the files using <command>servicepackname /x</command>,
i.e. that's <command>Nt4sp6ai.exe /x</command> for service pack 6a. The policy editor,
<command>poledit.exe</command> and the associated template files (*.adm) should
be extracted as well. It is also possible to downloaded 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.
</para>
<sect3>
<title>Registry Tattoos</title>
<para>
With NT4 style registry based policy changes, a large number of settings are not
automatically reversed as the user logs off. Since the settings that were in the
NTConfig.POL file were applied to the client machine registry and that apply to the
hive key HKEY_LOCAL_MACHINE are permanent until explicitly reversed. This is known
as tattooing. It can have serious consequences down-stream and the administrator must
be extremely careful not to lock out the ability to manage the machine at a later date.
</para>
</sect3>
</sect2>
<sect2>
<title>MS Windows 200x / XP Professional Policies</title>
<para>
Windows NT4 System policies allows setting of registry parameters specific to
users, groups and computers (client workstations) that are members of the NT4
style domain. Such policy file will work with MS Windows 2000 / XP clients also.
</para>
<para>
New to MS Windows 2000 Microsoft introduced a new 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 changed.
</para>
<para>
The older NT4 style registry based policies are known as <emphasis>Administrative Templates</emphasis>
in MS Windows 2000/XP Group Policy Objects (GPOs). The later includes ability to set various security
configurations, enforce Internet Explorer browser settings, change and redirect aspects of the
users' desktop (including: the location of <emphasis>My Documents</emphasis> files (directory), 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.
</para>
<para>
Remember: NT4 policy files are named <filename>NTConfig.POL</filename> and are stored in the root
of the NETLOGON share on the domain controllers. A Windows NT4 user enters a username, a password
and selects the domain name to which the logon will attempt to take place. During the logon
process the client machine reads the NTConfig.POL file from the NETLOGON share on the authenticating
server, modifies the local registry values according to the settings in this file.
</para>
<para>
Windows 2K GPOs are very feature rich. They are NOT stored in the NETLOGON share, 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).
</para>
<para>
With NT4 clients the policy file is read and executed upon 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 concurently 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.
</para>
<sect3>
<title>Administration of Win2K / XP Policies</title>
<title>Instructions</title>
<para>
Instead of using the tool called "The System Policy Editor", commonly called Poledit (from the
executable name poledit.exe), GPOs are created and managed using a Microsoft Management Console
(MMC) snap-in as follows:</para>
<procedure>
<step>
<para>
Go to the Windows 200x / XP menu <filename>Start->Programs->Administrative Tools</filename>
and select the MMC snap-in called "Active Directory Users and Computers"
</para>
</step>
<step><para>
Select the domain or organizational unit (OU) that you wish to manage, then right click
to open the context menu for that object, select the properties item.
</para></step>
<step><para>
Now left click on the Group Policy tab, then left click on the New tab. Type a name
for the new policy you will create.
</para></step>
<step><para>
Now left click on the Edit tab to commence the steps needed to create the GPO.
</para></step>
</procedure>
<para>
All policy configuration options are controlled through the use of policy administrative
templates. These files have a .adm extension, both in NT4 as well as in Windows 200x / XP.
Beware however, since the .adm files are NOT interchangible across NT4 and Windows 200x.
The later 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
the adminsitrator is referred to the Microsoft Windows Resource Kit for your particular
version of MS Windows.
</para>
<note>
<para>
The MS Windows 2000 Resource Kit contains a tool called gpolmig.exe. This tool can be used
to migrate an NT4 NTConfig.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.
</para>
</note>
</sect3>
</sect2>
</sect1>
<sect1>
<title>Managing Account/User Policies</title>
<para>
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 not necessary.
</para>
<para>
If you create a policy that will be automatically downloaded from validating domain controllers,
you should name the file NTconfig.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 path can even be a local path such that each machine has its own policy file,
but if a change is necessary to all machines, this change must be made individually to each workstation.
</para>
<para>
When a Windows NT4/200x/XP machine logs onto the network the NETLOGON share on the authenticating domain
controller for the presence of the NTConfig.POL file. If one exists it is downloaded, parsed and then
applied to the user's part of the registry.
</para>
<para>
MS Windows 200x/XP clients that log onto an MS Windows Active Directory security domain may additionally,
acquire policy settings through Group Policy Objects (GPOs) that are defined and stored in Active Directory
itself. The key benefit of using AS GPOs is that they impose no registry <emphasis>tatooing</emphasis> effect.
This has considerable advanage compared with the use of NTConfig.POL (NT4) style policy updates.
</para>
<para>
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 includes:
</para>
<para>
<simplelist>
<member>Logon Hours</member>
<member>Password Aging</member>
<member>Permitted Logon from certain machines only</member>
<member>Account type (Local or Global)</member>
<member>User Rights</member>
</simplelist>
</para>
<sect2>
<title>With Windows NT4/200x</title>
<para>
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, the registry editor (regedt32.exe).
Under MS Windows 200x/XP this is done using the Microsoft Managment Console (MMC) with approapriate
"snap-ins", the registry editor, and potentially also the NT4 System and Group Policy Editor.
</para>
</sect2>
<sect2>
<title>With a Samba PDC</title>
<para>
With a Samba Domain Controller, the new tools for managing of user account and policy information includes:
<filename>smbpasswd, pdbedit, net, rpcclient.</filename>. The administrator should read the
man pages for these tools and become familiar with their use.
</para>
</sect2>
</sect1>
<sect1>
<title>System Startup and Logon Processing Overview</title>
<para>
The following attempts to document the order of processing of system and user policies following a system
reboot and as part of the user logon:
</para>
<orderedlist>
<listitem><para>
Network starts, then Remote Procedure Call System Service (RPCSS) and Multiple Universal Naming
Convention Provider (MUP) start
</para></listitem>
<listitem><para>
Where Active Directory is involved, an ordered list of Group Policy Objects (GPOs) is downloaded
and applied. The list may include GPOs that:
<simplelist>
<member>Apply to the location of machines in a Directory</member>
<member>Apply only when settings have changed</member>
<member>Depend on configuration of scope of applicability: local, site, domain, organizational unit, etc.</member>
</simplelist>
No desktop user interface is presented until the above have been processed.
</para></listitem>
<listitem><para>
Execution of start-up scripts (hidden and synchronous by defaut).
</para></listitem>
<listitem><para>
A keyboard action to affect start of logon (Ctrl-Alt-Del).
</para></listitem>
<listitem><para>
User credentials are validated, User profile is loaded (depends on policy settings).
</para></listitem>
<listitem><para>
An ordered list of User GPOs is obtained. The list contents depends on what is configured in respsect of:
<simplelist>
<member>Is user a domain member, thus subject to particular policies</member>
<member>Loopback enablement, and the state of the loopback policy (Merge or Replace)</member>
<member>Location of the Active Directory itself</member>
<member>Has the list of GPOs changed. No processing is needed if not changed.</member>
</simplelist>
</para></listitem>
<listitem><para>
User Policies are applied from Active Directory. Note: There are several types.
</para></listitem>
<listitem><para>
Logon scripts are run. New to Win2K and Active Directory, logon scripts may be obtained based on Group
Policy objects (hidden and executed synchronously). NT4 style logon scripts are then run in a normal
window.
</para></listitem>
<listitem><para>
The User Interface as determined from the GPOs is presented. Note: In a Samba domain (like and NT4
Domain) machine (system) policies are applied at start-up, User policies are applied at logon.
</para></listitem>
</orderedlist>
</sect1>
</chapter>

235
docs/docbook/projdoc/Portability.xml Normal file
View File

@ -0,0 +1,235 @@
<chapter id="Portability">
<chapterinfo>
&author.jelmer;
</chapterinfo>
<title>Portability</title>
<para>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.</para>
<sect1>
<title>HPUX</title>
<para>
HP's implementation of supplementary groups is, er, non-standard (for
hysterical reasons). There are two group files, /etc/group and
/etc/logingroup; the system maps UIDs to numbers using the former, but
initgroups() reads the latter. Most system admins who know the ropes
symlink /etc/group to /etc/logingroup (hard link doesn't work for reasons
too stupid to go into here). initgroups() will complain if one of the
groups you're in in /etc/logingroup has what it considers to be an invalid
ID, which means outside the range [0..UID_MAX], where UID_MAX is (I think)
60000 currently on HP-UX. This precludes -2 and 65534, the usual 'nobody'
GIDs.
</para>
<para>
If you encounter this problem, make sure that the programs that are failing
to initgroups() be run as users not in any groups with GIDs outside the
allowed range.
</para>
<para>This is documented in the HP manual pages under setgroups(2) and passwd(4).
</para>
<para>
On HPUX 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.
</para>
</sect1>
<sect1>
<title>SCO Unix</title>
<para>
If you run an old version of SCO Unix then 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.
</para>
<para>
The patch you need is UOD385 Connection Drivers SLS. It is available from
SCO (ftp.sco.com, directory SLS, files uod385a.Z and uod385a.ltr.Z).
</para>
</sect1>
<sect1>
<title>DNIX</title>
<para>
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.
</para>
<para>
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, some things still won't work right.
</para>
<para>
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.
</para>
<para>
put this in the file <filename>setegid.s</filename>:
</para>
<para><programlisting>
.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
</programlisting></para>
<para>
put this in the file <filename>seteuid.s</filename>:
</para>
<para><programlisting>
.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
</programlisting></para>
<para>
after creating the above files you then assemble them using
</para>
<para><command>as seteuid.s</command></para>
<para><command>as setegid.s</command></para>
<para>
that should produce the files <filename>seteuid.o</filename> and
<filename>setegid.o</filename>
</para>
<para>
then you need to add these to the LIBSM line in the DNIX section of
the Samba Makefile. Your LIBSM line will then look something like this:
</para>
<para><programlisting>
LIBSM = setegid.o seteuid.o -ln
</programlisting></para>
<para>
You should then remove the line:
</para>
<para><programlisting>
#define NO_EID
</programlisting></para>
<para>from the DNIX section of <filename>includes.h</filename></para>
</sect1>
<sect1>
<title>RedHat Linux Rembrandt-II</title>
<para>
By default RedHat Rembrandt-II during installation adds an
entry to /etc/hosts as follows:
<programlisting>
127.0.0.1 loopback "hostname"."domainname"
</programlisting>
</para>
<para>
This causes Samba to loop back onto the loopback interface.
The result is that Samba fails to communicate correctly with
the world and therefor may fail to correctly negotiate who
is the master browse list holder and who is the master browser.
</para>
<para>
Corrective Action: Delete the entry after the word loopback
in the line starting 127.0.0.1
</para>
</sect1>
<sect1>
<title>AIX</title>
<sect2>
<title>Sequential Read Ahead</title>
<!-- From an email by William Jojo <jojowil@hvcc.edu> -->
<para>
Disabling Sequential Read Ahead using <userinput>vmtune -r 0</userinput> improves
samba performance significally.
</para>
</sect2>
</sect1>
<sect1>
<title>Solaris</title>
<sect2>
<title>Locking improvements</title>
<para>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 woul try a lock, then fail,
then try again. The lock attempt was failing before the grant was
occurring. So the visible manifestation of this would be a handful of
processes stealing all of the CPU, and when they were trussed they would
be stuck if F_SETLKW64 loops.
</para>
<para>
Sun released patches for Solaris 2.6, 8, and 9. The patch for Solaris 7
has not been released yet.
</para>
<para>
The patch revision for 2.6 is 105181-34
for 8 is 108528-19
and for 9 is 112233-04
</para>
<para>
After the install of these patches it is recommended to reconfigure
and rebuild samba.
</para>
<para>Thanks to Joe Meslovich for reporting</para>
</sect2>
<sect2 id="winbind-solaris9">
<title>Winbind on Solaris 9</title>
<para>
Nsswitch on Solaris 9 refuses to use the winbind nss module. This behavior
is fixed by Sun in patch 113476-05 which as of March 2003 is not in any
roll-up packages.
</para>
</sect2>
</sect1>
</chapter>

276
docs/docbook/projdoc/Problems.xml Normal file
View File

@ -0,0 +1,276 @@
<chapter id="problems">
<chapterinfo>
&author.jerry;
&author.jelmer;
<author>
<firstname>David</firstname><surname>Bannon</surname>
<affiliation>
<orgname>Samba Team</orgname>
<address><email>dbannon@samba.org</email></address>
</affiliation>
</author>
<pubdate>8 Apr 2003</pubdate>
</chapterinfo>
<title>Analysing and solving samba problems</title>
<para>
There are many sources of information available in the form
of mailing lists, RFC's and documentation. The docs that come
with the samba distribution contain very good explanations of
general SMB topics such as browsing.</para>
<sect1>
<title>Diagnostics tools</title>
<para>
One of the best diagnostic tools for debugging problems is Samba itself.
You can use the -d option for both smbd and nmbd to specify what
'debug level' at which to run. See the man pages on smbd, nmbd and
smb.conf for more information on debugging options. The debug
level can range from 1 (the default) to 10 (100 for debugging passwords).
</para>
<para>
Another helpful method of debugging is to compile samba using the
<command>gcc -g </command> flag. This will include debug
information in the binaries and allow you to attach gdb to the
running smbd / nmbd process. In order to attach gdb to an 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, on the first time you join the domain) to
generate a 'LsaEnumTrustedDomains'. Thereafter, the workstation
maintains an open connection, and therefore there will be an smbd
process running (assuming that you haven't set a really short smbd
idle timeout) So, in between pressing ctrl alt delete, and actually
typing in your password, you can attach gdb and continue.
</para>
<para>
Some useful samba commands worth investigating:
</para>
<itemizedlist>
<listitem><para>testparam | more</para></listitem>
<listitem><para>smbclient -L //{netbios name of server}</para></listitem>
</itemizedlist>
<para>
An SMB enabled version of tcpdump is available from
<ulink url="http://www.tcpdump.org/">http://www.tcpdup.org/</ulink>.
Ethereal, another good packet sniffer for Unix and Win32
hosts, can be downloaded from <ulink
url="http://www.ethereal.com/">http://www.ethereal.com</ulink>.
</para>
<para>
For tracing things on the Microsoft Windows NT, Network Monitor
(aka. netmon) is available on the Microsoft Developer Network CD's,
the Windows NT Server install CD and the SMS CD's. 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.
</para>
</sect1>
<sect1>
<title>Installing 'Network Monitor' on an NT Workstation or a Windows 9x box</title>
<para>
Installing netmon on an NT workstation requires a couple
of steps. The following are 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 / Netmon. You will need both the Microsoft Windows
NT Server 4.0 Install CD and the Workstation 4.0 Install CD.
</para>
<para>
Initially you will need to install 'Network Monitor Tools and Agent'
on the NT Server. To do this
</para>
<itemizedlist>
<listitem><para>Goto Start - Settings - Control Panel -
Network - Services - Add </para></listitem>
<listitem><para>Select the 'Network Monitor Tools and Agent' and
click on 'OK'.</para></listitem>
<listitem><para>Click 'OK' on the Network Control Panel.
</para></listitem>
<listitem><para>Insert the Windows NT Server 4.0 install CD
when prompted.</para></listitem>
</itemizedlist>
<para>
At this point the Netmon files should exist in
<filename>%SYSTEMROOT%\System32\netmon\*.*</filename>.
Two subdirectories exist as well, <filename>parsers\</filename>
which contains the necessary DLL's for parsing the netmon packet
dump, and <filename>captures\</filename>.
</para>
<para>
In order to install the Netmon tools on an NT Workstation, you will
first need to install the 'Network Monitor Agent' from the Workstation
install CD.
</para>
<itemizedlist>
<listitem><para>Goto Start - Settings - Control Panel -
Network - Services - Add</para></listitem>
<listitem><para>Select the 'Network Monitor Agent' and click
on 'OK'.</para></listitem>
<listitem><para>Click 'OK' on the Network Control Panel.
</para></listitem>
<listitem><para>Insert the Windows NT Workstation 4.0 install
CD when prompted.</para></listitem>
</itemizedlist>
<para>
Now copy the files from the NT Server in %SYSTEMROOT%\System32\netmon\*.*
to %SYSTEMROOT%\System32\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.
</para>
<para>
To install Netmon on a Windows 9x box install the network monitor agent
from the Windows 9x CD (\admin\nettools\netmon). There is a readme
file located 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.
</para>
</sect1>
<sect1>
<title>Useful URL's</title>
<itemizedlist>
<listitem><para>Home of Samba site <ulink url="http://samba.org">
http://samba.org</ulink>. We have a mirror near you !</para></listitem>
<listitem><para> The <emphasis>Development</emphasis> document
on the Samba mirrors might mention your problem. If so,
it might mean that the developers are working on it.</para></listitem>
<listitem><para>See how Scott Merrill simulates a BDC behavior at
<ulink url="http://www.skippy.net/linux/smb-howto.html">
http://www.skippy.net/linux/smb-howto.html</ulink>. </para></listitem>
<listitem><para>Although 2.0.7 has almost had its day as a PDC, David Bannon will
keep the 2.0.7 PDC pages at <ulink url="http://bioserve.latrobe.edu.au/samba">
http://bioserve.latrobe.edu.au/samba</ulink> going for a while yet.</para></listitem>
<listitem><para>Misc links to CIFS information
<ulink url="http://samba.org/cifs/">http://samba.org/cifs/</ulink></para></listitem>
<listitem><para>NT Domains for Unix <ulink url="http://mailhost.cb1.com/~lkcl/ntdom/">
http://mailhost.cb1.com/~lkcl/ntdom/</ulink></para></listitem>
<listitem><para>FTP site for older SMB specs:
<ulink url="ftp://ftp.microsoft.com/developr/drg/CIFS/">
ftp://ftp.microsoft.com/developr/drg/CIFS/</ulink></para></listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Getting help from the mailing lists</title>
<para>
There are a number of Samba related mailing lists. Go to <ulink
url="http://samba.org">http://samba.org</ulink>, click on your nearest mirror
and then click on <command>Support</command> and then click on <command>
Samba related mailing lists</command>.
</para>
<para>
For questions relating to Samba TNG go to
<ulink url="http://www.samba-tng.org/">http://www.samba-tng.org/</ulink>
It has been requested that you don't post questions about Samba-TNG to the
main stream Samba lists.</para>
<para>
If you post a message to one of the lists please observe the following guide lines :
</para>
<itemizedlist>
<listitem><para> 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 time lines are 'best guess' and nothing more.
</para></listitem>
<listitem><para> Always mention what version of samba you are using and what
operating system its running under. You should probably list the
relevant sections of your &smb.conf; file, at least the options
in [global] that affect PDC support.</para></listitem>
<listitem><para>In addition to the version, if you obtained Samba via
CVS mention the date when you last checked it out.</para></listitem>
<listitem><para> Try and make your question clear and brief, lots of long,
convoluted questions get deleted before they are completely read !
Don't post html encoded messages (if you can select colour or font
size its html).</para></listitem>
<listitem><para> If you run one of those nifty 'I'm on holidays' things when
you are away, make sure its configured to not answer mailing lists.
</para></listitem>
<listitem><para> Don't cross post. Work out which is the best list to post to
and see what happens, i.e. don't 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 will see a message and thinking it would be better dealt
with on another, will forward it on for you.</para></listitem>
<listitem><para>You might include <emphasis>partial</emphasis>
log files written at a debug level set to as much as 20.
Please don't send the entire log but enough to give the context of the
error messages.</para></listitem>
<listitem><para>(Possibly) If you have a complete netmon trace ( from the opening of
the pipe to the error ) you can send the *.CAP file as well.</para></listitem>
<listitem><para>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
smb.conf in their attach directory?</para></listitem>
</itemizedlist>
</sect1>
<sect1>
<title>How to get off the mailinglists</title>
<para>To have your name removed from a samba mailing list, go to the
same place you went to to get on it. Go to <ulink
url="http://lists.samba.org/">http://lists.samba.org</ulink>,
click on your nearest mirror and then click on <command>Support</command> and
then click on <command> Samba related mailing lists</command>. Or perhaps see
<ulink url="http://lists.samba.org/mailman/roster/samba-ntdom">here</ulink>
</para>
<para>
Please don't post messages to the list asking to be removed, you will just
be referred to the above address (unless that process failed in some way...)
</para>
</sect1>
</chapter>

1126
docs/docbook/projdoc/ProfileMgmt.xml Normal file
View File

File diff suppressed because it is too large Load Diff

351
docs/docbook/projdoc/SWAT.xml Normal file
View File

@ -0,0 +1,351 @@
<chapter id="SWAT">
<chapterinfo>
&author.jht;
<pubdate>April 21, 2003</pubdate>
</chapterinfo>
<title>SWAT - The Samba Web Admininistration Tool</title>
<para>
There are many and varied opinions regarding the usefulness or otherwise 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 will allow web based configuration
of samba. It has a wizard that may help to get samba configured quickly, it has context
sensitive help on each smb.conf parameter, it provides for monitoring of current state
of connection information, and it allows network wide MS Windows network password
management.
</para>
<sect1>
<title>SWAT Features and Benefits</title>
<para>
There are network administrators who believe that it is a good idea to write systems
documentation inside configuration files, for them SWAT will aways 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 smb.conf file to disk it will write only
those parameters that are at other than the default settings. The result is that all comments
will be lost from the smb.conf file. Additionally, the parameters will be written back in
internal ordering.
</para>
<note><para>
So before using SWAT please be warned - SWAT will completely replace your smb.conf with
a fully optimised file that has been stripped of all comments you might have placed there
and only non-default settings will be written to the file.
</para></note>
<sect2>
<title>Enabling SWAT for use</title>
<para>
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 <filename>inetd</filename> or
<filename>xinetd</filename> based system.
</para>
<para>
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
<filename>/etc/inetd.conf</filename> or in the directory <filename>/etc/[x]inet.d</filename>
or similar.
</para>
<para>
The control entry for the older style file might be:
</para>
<para><programlisting>
# swat is the Samba Web Administration Tool
swat stream tcp nowait.400 root /usr/sbin/swat swat
</programlisting></para>
<para>
A control file for the newer style xinetd could be:
</para>
<para>
<programlisting>
# 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 = yes
}
</programlisting>
</para>
<para>
Both the above examples assume that the <filename>swat</filename> binary has been
located in the <filename>/usr/sbin</filename> directory. In addition to the above
SWAT will use a directory access point from which it will load it's help files
as well as other control information. The default location for this on most Linux
systems is in the directory <filename>/usr/share/samba/swat</filename>. The default
location using samba defaults will be <filename>/usr/local/samba/swat</filename>.
</para>
<para>
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: <emphasis>HOME, STATUS, VIEW, PASSWORD</emphasis>. The only page that allows
change capability in this case is <emphasis>PASSWORD</emphasis>.
</para>
<para>
So long as you log onto SWAT as the user <command>root</command> you should obtain
full change and commit ability. The buttons that will be exposed includes:
<emphasis>HOME, GLOBALS, SHARES, PRINTERS, WIZARD, STATUS, VIEW, PASSWORD</emphasis>.
</para>
</sect2>
<sect2>
<title>Securing SWAT through SSL</title>
<para>
Lots of people have asked about how to setup SWAT with SSL to allow for secure remote
administration of Samba. Here is a method that works, courtesy of Markus Krieger
</para>
<para>
Modifications to the swat setup are as following:
</para>
<itemizedlist>
<listitem><para>
install OpenSSL
</para></listitem>
<listitem><para>
generate certificate and private key
<programlisting>
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
</programlisting></para></listitem>
<listitem><para>
remove swat-entry from [x]inetd
</para></listitem>
<listitem><para>
start stunnel
<programlisting>
root# stunnel -p /etc/stunnel/stunnel.pem -d 901 \
-l /usr/local/samba/bin/swat swat
</programlisting></para></listitem>
</itemizedlist>
<para>
afterwards simply contact to swat by using the URL "https://myhost:901", accept the certificate
and the SSL connection is up.
</para>
</sect2>
<sect2>
<title>The SWAT Home Page</title>
<para>
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 Samba-HOWTO-Collection (this
document) as well as the O'Reilly book "Using Samba".
</para>
<para>
Administrators who wish to validate their samba configuration may obtain useful information
from the man pages for the diganostic 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 <command>ethereal</command>, available from <ulink url="http://www.ethereal.com">
http://www.ethereal.com</ulink>.
</para>
<note><para>
SWAT can be configured to run in <emphasis>demo</emphasis> mode. This is NOT recommended
as it runs SWAT without authentication and with full administrative ability. ie: Allows
changes to smb.conf as well as general operation with root privilidges. The option that
creates this ability is the <command>-a</command> flag to swat. DO NOT USE THIS IN ANY
PRODUCTION ENVIRONMENT - you have been warned!
</para></note>
</sect2>
<sect2>
<title>Global Settings</title>
<para>
The Globals button will expose a page that allows configuration of the global parameters
in smb.conf. There are three levels of exposure of the parameters:
</para>
<itemizedlist>
<listitem><para>
<command>Basic</command> - exposes common configuration options.
</para></listitem>
<listitem><para>
<command>Advanced</command> - exposes configuration options needed in more
complex environments.
</para></listitem>
<listitem><para>
<command>Developer</command> - exposes configuration options that only the brave
will want to tamper with.
</para></listitem>
</itemizedlist>
<para>
To switch to other than <emphasis>Basic</emphasis> editing ability click on either the
<emphasis>Advanced</emphasis> or the <emphasis>Developer</emphasis> dial, then click the
<emphasis>Commit Changes</emphasis> button.
</para>
<para>
After making any changes to configuration parameters make sure that you click on the
<emphasis>Commit Changes</emphasis> button before moving to another area otherwise
your changes will be immediately lost.
</para>
<note><para>
SWAT has context sensitive help. To find out what each parameter is for simply click the
<command>Help</command> link to the left of the configurartion parameter.
</para></note>
</sect2>
<sect2>
<title>Share Settings</title>
<para>
To affect a currenly configured share, simply click on the pull down button between the
<emphasis>Choose Share</emphasis> and the <emphasis>Delete Share</emphasis> buttons,
select the share you wish to operate on, then to edit the settings click on the
<emphasis>Choose Share</emphasis> button, to delete the share simply press the
<emphasis>Delete Share</emphasis> button.
</para>
<para>
To create a new share, next to the button labelled <emphasis>Create Share</emphasis> enter
into the text field the name of the share to be created, then click on the
<emphasis>Create Share</emphasis> button.
</para>
</sect2>
<sect2>
<title>Printers Settings</title>
<para>
To affect a currenly configured printer, simply click on the pull down button between the
<emphasis>Choose Printer</emphasis> and the <emphasis>Delete Printer</emphasis> buttons,
select the printer you wish to operate on, then to edit the settings click on the
<emphasis>Choose Printer</emphasis> button, to delete the share simply press the
<emphasis>Delete Printer</emphasis> button.
</para>
<para>
To create a new printer, next to the button labelled <emphasis>Create Printer</emphasis> enter
into the text field the name of the share to be created, then click on the
<emphasis>Create Printer</emphasis> button.
</para>
</sect2>
<sect2>
<title>The SWAT Wizard</title>
<para>
The purpose if the SWAT Wizard is to help the Microsoft knowledgable network administrator
to configure Samba with a minimum of effort.
</para>
<para>
The Wizard page provides a tool for rewiting the smb.conf file in fully optimised format.
This will also happen if you press the commit button. The two differ in the the rewrite button
ignores any changes that may have been made, while the Commit button causes all changes to be
affected.
</para>
<para>
The <emphasis>Edit</emphasis> button permits the editing (setting) of the minimal set of
options that may be necessary to create a working samba server.
</para>
<para>
Finally, there are a limited set of options that will 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 on one button you can elect to epose (or not) user
home directories.
</para>
</sect2>
<sect2>
<title>The Status Page</title>
<para>
The status page serves a limited purpose. Firstly, it allows control of the samba daemons.
The key daemons that create the samba server environment are: <command> smbd, nmbd, winbindd</command>.
</para>
<para>
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
will be continually spawned. The auto-refresh facility will allow you to track the changing
conditions with minimal effort.
</para>
<para>
Lastly, the Status page may be used to terminate specific smbd client connections in order to
free files that may be locked.
</para>
</sect2>
<sect2>
<title>The View Page</title>
<para>
This page allows the administrator to view the optimised smb.conf file and if you are
particularly massochistic will permit you also to see all possible global configuration
parameters and their settings.
</para>
</sect2>
<sect2>
<title>The Password Change Page</title>
<para>
The Password Change page is a popular tool. This tool allows the creation, deletion, deactivation
and reactivation of MS Windows networking users on the local machine. Alternatively, you can use
this tool to change a local password for a user account.
</para>
<para>
When logged in as a non-root account the user will have to provide the old password as well as
the new password (twice). When logged in as <command>root</command> only the new password is
required.
</para>
<para>
One popular use for this tool is to change user passwords across a range of remote MS Windows
servers.
</para>
</sect2>
</sect1>
</chapter>

250
docs/docbook/projdoc/Samba-BDC-HOWTO.xml Normal file
View File

@ -0,0 +1,250 @@
<chapter id="samba-bdc">
<chapterinfo>
&author.vl;
<pubdate> (26 Apr 2001) </pubdate>
</chapterinfo>
<title>
Samba Backup Domain Controller to Samba Domain Control
</title>
<sect1>
<title>Prerequisite Reading</title>
<para>
Before you continue reading in this chapter, please make sure
that you are comfortable with configuring a Samba PDC
as described in the <ulink url="Samba-PDC-HOWTO.html">Samba-PDC-HOWTO</ulink>.
</para>
</sect1>
<sect1>
<title>Background</title>
<para>
What is a Domain Controller? It is a machine that is able to answer
logon requests from workstations in a Windows NT Domain. Whenever a
user logs into a Windows NT Workstation, the workstation connects to a
Domain Controller and asks him whether the username and password the
user typed in is correct. The Domain Controller replies with a lot of
information about the user, for example the place where the users
profile is stored, the users full name of the user. All this
information is stored in the NT user database, the so-called SAM.
</para>
<para>
There are two kinds of Domain Controller in a NT 4 compatible Domain:
A Primary Domain Controller (PDC) and one or more Backup Domain
Controllers (BDC). The PDC contains the master copy of the
SAM. Whenever the SAM has to change, for example when a user changes
his password, this change has to be done on the PDC. A Backup Domain
Controller is a machine that maintains a read-only copy of the
SAM. This way it is able to reply to logon requests and authenticate
users in case the PDC is not available. During this time no changes to
the SAM are possible. Whenever changes to the SAM are done on the PDC,
all BDC receive the changes from the PDC.
</para>
<para>
Since version 2.2 Samba officially supports domain logons for all
current Windows Clients, including Windows 2000 and XP. This text
assumes the domain to be named SAMBA. To be able to act as a PDC, some
parameters in the [global]-section of the smb.conf have to be set:
</para>
<para><programlisting>
workgroup = SAMBA
domain master = yes
domain logons = yes
</programlisting></para>
<para>
Several other things like a [homes] and a [netlogon] share also may be
set along with settings for the profile path, the users home drive and
others. This will not be covered in this document.
</para>
</sect1>
<sect1>
<title>What qualifies a Domain Controller on the network?</title>
<para>
Every machine that is a Domain Controller for the domain SAMBA has to
register the NetBIOS group name SAMBA#1c with the WINS server and/or
by broadcast on the local network. The PDC also registers the unique
NetBIOS name SAMBA#1b with the WINS server. The name type #1b is
normally reserved for the domain master browser, a role that has
nothing to do with anything related to authentication, but the
Microsoft Domain implementation requires the domain master browser to
be on the same machine as the PDC.
</para>
<sect2>
<title>How does a Workstation find its domain controller?</title>
<para>
A NT workstation in the domain SAMBA that wants a local user to be
authenticated has to find the domain controller for SAMBA. It does
this by doing a NetBIOS name query for the group name SAMBA#1c. 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 (TODO: How is the DC
chosen) domain controller authenticate each other. After that the
workstation sends the user's credentials (his name and password) to
the domain controller, asking for approval.
</para>
</sect2>
<sect2>
<title>When is the PDC needed?</title>
<para>
Whenever a user wants to change his password, this has to be done on
the PDC. To find the PDC, the workstation does a NetBIOS name query
for SAMBA#1b, assuming this machine maintains the master copy of the
SAM. The workstation contacts the PDC, both mutually authenticate and
the password change is done.
</para>
</sect2>
</sect1>
<sect1>
<title>Can Samba be a Backup Domain Controller to an NT PDC?</title>
<para>
With version 2.2, no. The native NT SAM replication protocols have
not yet been fully implemented. The Samba Team is working on
understanding and implementing the protocols, but this work has not
been finished for version 2.2.
</para>
<para>
With version 3.0, the work on both the replication protocols and a
suitable storage mechanism has progressed, and some form of NT4 BDC
support is expected soon.
</para>
<para>
Can I get the benefits of a BDC with Samba? Yes. 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.
</para>
</sect1>
<sect1>
<title>How do I set up a Samba BDC?</title>
<para>
Several things have to be done:
</para>
<itemizedlist>
<listitem><para>
The domain SID has to be the same on the PDC and the BDC. This used to
be stored in the file private/MACHINE.SID. This file is not created
anymore since Samba 2.2.5 or even earlier. Nowadays the domain SID is
stored in the file private/secrets.tdb. Simply copying the secrets.tdb
from the PDC to the BDC does not work, as the BDC would
generate a new SID for itself and override the domain SID with this
new BDC SID.</para>
<para>
To retrieve the domain SID from the PDC or an existing BDC and store it in the
secrets.tdb, execute 'net rpc getsid' on the BDC.
</para></listitem>
<listitem><para>
The Unix user database has to be synchronized from the PDC to the
BDC. This means that both the /etc/passwd and /etc/group have to be
replicated from the PDC to the BDC. This can be done manually
whenever changes are made, or the PDC is set up as a NIS master
server and the BDC as a 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.
</para>
</listitem>
<listitem><para>
The Samba password database in the file private/smbpasswd has to be
replicated from the PDC to the BDC. This is a bit tricky, see the
next section.
</para></listitem>
<listitem><para>
Any 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 together with the smbpasswd
synchronization.
</para></listitem>
</itemizedlist>
<para>
Finally, the BDC has to be found by the workstations. This can be done
by setting
</para>
<para><programlisting>
workgroup = samba
domain master = no
domain logons = yes
</programlisting></para>
<para>
in the [global]-section of the smb.conf of the BDC. This makes the BDC
only register the name SAMBA#1c with the WINS server. This is no
problem as the name SAMBA#1c is a NetBIOS group name that is meant to
be registered by more than one machine. The parameter 'domain master =
no' forces the BDC not to register SAMBA#1b which as a unique NetBIOS
name is reserved for the Primary Domain Controller.
</para>
<sect2>
<title>How do I replicate the smbpasswd file?</title>
<para>
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.
</para>
<para>
As the smbpasswd file contains plain text 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. ssh itself can be set up to
accept *only* rsync transfer without requiring the user to type a
password.
</para>
</sect2>
<sect2>
<title>Can I do this all with LDAP?</title>
<para>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).
</para>
</sect2>
</sect1>
</chapter>

842
docs/docbook/projdoc/Samba-PDC-HOWTO.xml Normal file
View File

@ -0,0 +1,842 @@
<chapter id="samba-pdc">
<chapterinfo>
&author.jerry;
&author.jht;
<author>
<firstname>David</firstname><surname>Bannon</surname>
<affiliation>
<orgname>Samba Team</orgname>
<address><email>dbannon@samba.org</email></address>
</affiliation>
</author>
<pubdate> (26 Apr 2001) </pubdate>
</chapterinfo>
<title>
Samba as an NT4 or Win2k Primary Domain Controller
</title>
<sect1>
<title>Prerequisite Reading</title>
<para>
Before you continue reading in this chapter, please make sure
that you are comfortable with configuring basic files services
in smb.conf and how to enable and administer password
encryption in Samba. Theses two topics are covered in the
&smb.conf; manpage.
</para>
</sect1>
<sect1>
<title>
Background
</title>
<para>
This article outlines the steps necessary for configuring Samba as a PDC.
It is necessary to have a working Samba server prior to implementing the
PDC functionality.
</para>
<itemizedlist>
<listitem><para>
Domain logons for Windows NT 4.0 / 200x / XP Professional clients.
</para></listitem>
<listitem><para>
Placing Windows 9x / Me clients in user level security
</para></listitem>
<listitem><para>
Retrieving a list of users and groups from a Samba PDC to
Windows 9x / Me / NT / 200x / XP Professional clients
</para></listitem>
<listitem><para>
Roaming Profiles
</para></listitem>
<listitem><para>
Network/System Policies
</para></listitem>
</itemizedlist>
<note>
<para>
Roaming Profiles and System/Network policies are advanced network administration topics
that are covered separately in this document.
</para>
</note>
<para>
The following functionalities are new to the Samba 3.0 release:
</para>
<itemizedlist>
<listitem><para>
Windows NT 4 domain trusts
</para></listitem>
<listitem><para>
Adding users via the User Manager for Domains
</para></listitem>
</itemizedlist>
<para>
The following functionalities are NOT provided by Samba 3.0:
</para>
<itemizedlist>
<listitem><para>
SAM replication with Windows NT 4.0 Domain Controllers
(i.e. a Samba PDC and a Windows NT BDC or vice versa)
</para></listitem>
<listitem><para>
Acting as a Windows 2000 Domain Controller (i.e. Kerberos and
Active Directory)
</para></listitem>
</itemizedlist>
<para>
Please note that Windows 9x / Me / XP Home clients are not true members of a domain
for reasons outlined in this article. Therefore the protocol for
support of Windows 9x-style domain logons is completely different
from NT4 / Win2k type domain logons and has been officially supported for some
time.
</para>
<para><emphasis>
MS Windows XP Home edition is NOT able to join a domain and does not permit
the use of domain logons.</emphasis>
</para>
<para>
Implementing a Samba PDC can basically be divided into 3 broad
steps.
</para>
<orderedlist numeration="arabic">
<listitem><para>
Configuring the Samba PDC
</para></listitem>
<listitem><para>
Creating machine trust accounts and joining clients to the domain
</para></listitem>
<listitem><para>
Adding and managing domain user accounts
</para></listitem>
</orderedlist>
<para>
There are other minor details such as user profiles, system
policies, etc... However, these are not necessarily specific
to a Samba PDC as much as they are related to Windows NT networking
concepts.
</para>
</sect1>
<sect1>
<title>Configuring the Samba Domain Controller</title>
<para>
The first step in creating a working Samba PDC is to
understand the parameters necessary in smb.conf. Here we
attempt to explain the parameters that are covered in
the &smb.conf; man page.
</para>
<para>
Here is an example &smb.conf; for acting as a PDC:
</para>
<para><programlisting>
[global]
; Basic server settings
<ulink url="smb.conf.5.html#NETBIOSNAME">netbios name</ulink> = <replaceable>POGO</replaceable>
<ulink url="smb.conf.5.html#WORKGROUP">workgroup</ulink> = <replaceable>NARNIA</replaceable>
; User and Machine Account Backends
; Choices are: tdbsam, tdbsam_nua, smbpasswd, smbpasswd_nua, ldapsam, ldapsam_nua, ...
; mysqlsam, xmlsam, guest
<ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend</ulink> = ldapsam, guest
; we should act as the domain and local master browser
<ulink url="smb.conf.5.html#OSLEVEL">os level</ulink> = 64
<ulink url="smb.conf.5.html#PERFERREDMASTER">preferred master</ulink> = yes
<ulink url="smb.conf.5.html#DOMAINMASTER">domain master</ulink> = yes
<ulink url="smb.conf.5.html#LOCALMASTER">local master</ulink> = yes
; security settings (must user security = user)
<ulink url="smb.conf.5.html#SECURITYEQUALSUSER">security</ulink> = user
; encrypted passwords are a requirement for a PDC
<ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">encrypt passwords</ulink> = yes
; support domain logons
<ulink url="smb.conf.5.html#DOMAINLOGONS">domain logons</ulink> = yes
; where to store user profiles?
<ulink url="smb.conf.5.html#LOGONPATH">logon path</ulink> = \\%N\profiles\%u
; where is a user's home directory and where should it be mounted at?
<ulink url="smb.conf.5.html#LOGONDRIVE">logon drive</ulink> = H:
<ulink url="smb.conf.5.html#LOGONHOME">logon home</ulink> = \\homeserver\%u
; specify a generic logon script for all users
; this is a relative **DOS** path to the [netlogon] share
<ulink url="smb.conf.5.html#LOGONSCRIPT">logon script</ulink> = logon.cmd
; necessary share for domain controller
[netlogon]
<ulink url="smb.conf.5.html#PATH">path</ulink> = /usr/local/samba/lib/netlogon
<ulink url="smb.conf.5.html#READONLY">read only</ulink> = yes
<ulink url="smb.conf.5.html#WRITELIST">write list</ulink> = <replaceable>ntadmin</replaceable>
; share for storing user profiles
[profiles]
<ulink url="smb.conf.5.html#PATH">path</ulink> = /export/smb/ntprofile
<ulink url="smb.conf.5.html#READONLY">read only</ulink> = no
<ulink url="smb.conf.5.html#CREATEMASK">create mask</ulink> = 0600
<ulink url="smb.conf.5.html#DIRECTORYMASK">directory mask</ulink> = 0700
</programlisting></para>
<note><para>
The above parameters make for a full set of parameters that may define the server's mode
of operation. The following parameters are the essentials alone:
<programlisting>
workgroup = NARNIA
domain logons = Yes
security = User
</programlisting>
The additional parameters shown in the longer listing above just makes for a
more complete environment.
</para></note>
<para>
There are a couple of points to emphasize in the above configuration.
</para>
<itemizedlist>
<listitem><para>
Encrypted passwords must be enabled. For more details on how
to do this, refer to <link linkend="passdb">the User Database chapter</link>.
</para></listitem>
<listitem><para>
The server must support domain logons and a
<filename>[netlogon]</filename> share
</para></listitem>
<listitem><para>
The server must be the domain master browser in order for Windows
client to locate the server as a DC. Please refer to the various
Network Browsing documentation included with this distribution for
details.
</para></listitem>
</itemizedlist>
<para>
Samba 3.0 offers a complete implementation of group mapping
between Windows NT groups and Unix groups (this is really quite
complicated to explain in a short space).
</para>
</sect1>
<sect1>
<title>Creating Machine Trust Accounts and Joining Clients to the Domain</title>
<para>
A machine trust account is a Samba account that is used to
authenticate a client machine (rather than a user) to the Samba
server. In Windows terminology, this is known as a "Computer
Account."</para>
<para>
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 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.
</para>
<para>A Windows PDC stores each machine trust account in the Windows
Registry. A Samba-3 PDC also has to store machine trust account information
in a suitable backend data store. With Samba-3 there can be multiple back-ends
for this including:
</para>
<itemizedlist>
<listitem><para>
<emphasis>smbpasswd</emphasis> - the plain ascii file stored used by
earlier versions of Samba. This file configuration option requires
a Unix/Linux system account for EVERY entry (ie: both for user and for
machine accounts). This file will be located in the <emphasis>private</emphasis>
directory (default is /usr/local/samba/lib/private or on linux /etc/samba).
</para></listitem>
<listitem><para>
<emphasis>smbpasswd_nua</emphasis> - This file is independant of the
system wide user accounts. The use of this back-end option requires
specification of the "non unix account range" option also. It is called
smbpasswd and will be located in the <filename>private</filename> directory.
</para></listitem>
<listitem><para>
<emphasis>tdbsam</emphasis> - a binary database backend that will be
stored in the <emphasis>private</emphasis> directory in a file called
<emphasis>passwd.tdb</emphasis>. The key benefit of this binary format
file is that it can store binary objects that can not be accomodated
in the traditional plain text smbpasswd file.
</para></listitem>
<listitem><para>
<emphasis>tdbsam_nua</emphasis> like the smbpasswd_nua option above, this
file allows the creation of arbitrary user and machine accounts without
requiring that account to be added to the system (/etc/passwd) file. It
too requires the specification of the "non unix account range" option
in the [globals] section of the &smb.conf; file.
</para></listitem>
<listitem><para>
<emphasis>ldapsam</emphasis> - An LDAP based back-end. Permits the
LDAP server to be specified. eg: ldap://localhost or ldap://frodo.murphy.com
</para></listitem>
<listitem><para>
<emphasis>ldapsam_nua</emphasis> - LDAP based back-end with no unix
account requirement, like smbpasswd_nua and tdbsam_nua above.
</para></listitem>
</itemizedlist>
<para>Read the chapter about the <link linkend="passdb">User Database</link>
for details.</para>
<note><para>
The new tdbsam and ldapsam account backends store vastly more information than
smbpasswd is capable of. The new backend database includes capacity to specify
per user settings for many parameters, over-riding global settings given in the
<filename>smb.conf</filename> file. eg: logon drive, logon home, logon path, etc.
</para></note>
<para>
A Samba PDC, however, stores each machine trust account in two parts,
as follows:
<itemizedlist>
<listitem><para>A Samba account, stored in the same location as user
LanMan and NT password hashes (currently
<filename>smbpasswd</filename>). The Samba account
possesses and uses only the NT password hash.</para></listitem>
<listitem><para>A corresponding Unix account, typically stored in
<filename>/etc/passwd</filename>. (Future releases will alleviate the need to
create <filename>/etc/passwd</filename> entries.) </para></listitem>
</itemizedlist>
</para>
<para>
There are two ways to create machine trust accounts:
</para>
<itemizedlist>
<listitem><para> Manual creation. Both the Samba and corresponding
Unix account are created by hand.</para></listitem>
<listitem><para> "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. </para>
</listitem>
</itemizedlist>
<sect2>
<title>Manual Creation of Machine Trust Accounts</title>
<para>
The first step in manually creating a machine trust account is to
manually create the corresponding Unix account in
<filename>/etc/passwd</filename>. This can be done using
<command>vipw</command> or other 'add user' command that is normally
used to create new Unix accounts. The following is an example for a
Linux based Samba server:
</para>
<para>
<prompt>root# </prompt><command>/usr/sbin/useradd -g 100 -d /dev/null -c <replaceable>"machine
nickname"</replaceable> -s /bin/false <replaceable>machine_name</replaceable>$ </command>
</para>
<para>
<prompt>root# </prompt><command>passwd -l <replaceable>machine_name</replaceable>$</command>
</para>
<para>On *BSD systems, this can be done using the 'chpass' utility:</para>
<para>
<prompt>root# </prompt><command>chpass -a "<replaceable>machine_name</replaceable>$:*:101:100::0:0:Workstation <replaceable>machine_name</replaceable>:/dev/null:/sbin/nologin"</command>
</para>
<para>
The <filename>/etc/passwd</filename> entry will list the machine name
with a "$" appended, won't have a password, will have a null shell and no
home directory. For example a machine named 'doppy' would have an
<filename>/etc/passwd</filename> entry like this:
</para>
<para><programlisting>
doppy$:x:505:501:<replaceable>machine_nickname</replaceable>:/dev/null:/bin/false
</programlisting></para>
<para>
Above, <replaceable>machine_nickname</replaceable> can be any
descriptive name for the client, i.e., BasementComputer.
<replaceable>machine_name</replaceable> 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.
</para>
<para>
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 <ulink
url="smbpasswd.8.html"><command>smbpasswd(8)</command></ulink> command
as shown here:
</para>
<para>
<prompt>root# </prompt><userinput>smbpasswd -a -m <replaceable>machine_name</replaceable></userinput>
</para>
<para>
where <replaceable>machine_name</replaceable> is the machine's NetBIOS
name. The RID of the new machine account is generated from the UID of
the corresponding Unix account.
</para>
<warning>
<title>Join the client to the domain immediately</title>
<para>
Manually creating a machine trust account using this method is the
equivalent of creating a machine trust account on a Windows NT PDC using
the "Server Manager". From the time at which the account is created
to the time which 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!
</para>
</warning>
</sect2>
<sect2>
<title>"On-the-Fly" Creation of Machine Trust Accounts</title>
<para>
The second (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. </para>
<para>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
<ulink url="smb.conf.5.html#ADDMACHINESCRIPT">add machine script</ulink>
option in <filename>smb.conf</filename>. This
method is not required, however; corresponding Unix accounts may also
be created manually.
</para>
<para>Below is an example for a RedHat 6.2 Linux system.
</para>
<para><programlisting>
[global]
# &lt;...remainder of parameters...&gt;
add machine script = /usr/sbin/useradd -d /dev/null -g 100 -s /bin/false -M %u
</programlisting></para>
</sect2>
<sect2><title>Joining the Client to the Domain</title>
<para>
The procedure for joining a client to the domain varies with the
version of Windows.
</para>
<itemizedlist>
<listitem><para><emphasis>Windows 2000</emphasis></para>
<para>
When the user elects to join the client to a domain, Windows prompts for
an account and password that is privileged to join the domain. A Samba administrative
account (i.e., a Samba account that has root privileges on the Samba server) must be
entered here; the operation will fail if an ordinary user account is given.
The password for this account should be set to a different password than the associated
<filename>/etc/passwd</filename> entry, for security reasons.
</para>
<para>
The session key of the Samba administrative 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.
</para>
</listitem>
<listitem><para><emphasis>Windows NT</emphasis></para>
<para> If the machine trust account was created manually, on the
Identification Changes menu enter the domain name, but do not
check the box "Create a Computer Account in the Domain." In this case,
the existing machine trust account is used to join the machine to
the domain.</para>
<para> 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 "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 administrative account when
prompted).</para>
</listitem>
<listitem><para><emphasis>Samba</emphasis></para>
<para>Joining a samba client to a domain is documented in
the <link linkend="domain-member">Domain Member</link> chapter.
</para></listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1>
<title>Common Problems and Errors</title>
<sect2>
<title>I cannot include a '$' in a machine name</title>
<para>
A 'machine name' in (typically) <filename>/etc/passwd</filename>
of the machine name with a '$' appended. FreeBSD (and other BSD
systems?) won't create a user with a '$' in their name.
</para>
<para>
The problem is only in the program used to make the entry. Once made, it works perfectly.
Create a user without the '$' using <command>vipw</command> to edit the entry, adding
the '$'. Or create the whole entry with vipw if you like, make sure you use a unique User ID!
</para>
</sect2>
<sect2>
<title>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.</title>
<para>
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:
</para>
<para>
<prompt>C:\WINNT\></prompt> <command>net use * /d</command>
</para>
<para>
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.
</para>
</sect2>
<sect2>
<title>The system can not log you on (C000019B)....</title>
<para>I joined the domain successfully but after upgrading
to a newer version of the Samba code I get the message, "The system
can not log you on (C000019B), Please try again or consult your
system administrator" when attempting to logon.
</para>
<para>
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.
</para>
<para>
The reset or change the domain SID you can use the net command as follows:
<programlisting>
net getlocalsid 'OLDNAME'
net setlocalsid 'SID'
</programlisting>
</para>
</sect2>
<sect2>
<title>The machine trust account for this computer either does not
exist or is not accessible.</title>
<para>
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?
</para>
<para>
This problem is caused by the PDC not having a suitable machine trust account.
If you are using the <parameter>add machine script</parameter> method to create
accounts then this would indicate that it has not worked. Ensure the domain
admin user system is working.
</para>
<para>
Alternatively 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 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 /etc/passwd and the smbpasswd file. Some people have reported
that inconsistent subnet masks between the Samba server and the NT
client have caused this problem. Make sure that these are consistent
for both client and server.
</para>
</sect2>
<sect2>
<title>When I attempt to login to a Samba Domain from a NT4/W2K workstation,
I get a message about my account being disabled.</title>
<para>
At first be ensure to enable the useraccounts with <command>smbpasswd -e
%user%</command>, this is normally done, when you create an account.
</para>
</sect2>
</sect1>
<sect1>
<title>Domain Control for Windows 9x/ME</title>
<para>
A domain and a workgroup are exactly the same thing 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 that MS Windows NT/2K.
</para>
<para>
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.
</para>
<para>
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.
</para>
<para>
When an SMB client in a domain wishes to logon it broadcast 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 very stupid) to create a domain where the user
database is not shared between servers, i.e. 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.
</para>
<para>
Using these features you can make your clients verify their logon via
the Samba server; make clients run a batch file when they logon to
the network and download their preferences, desktop and start menu.
</para>
<para>
Before launching into the configuration instructions, it is
worthwhile to look at how a Windows 9x/ME client performs a logon:
</para>
<orderedlist>
<listitem>
<para>
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&lt;1c&gt; 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
\\SERVER.
</para>
</listitem>
<listitem>
<para>
The client then connects to that server, logs on (does an SMBsessetupX) and
then connects to the IPC$ share (using an SMBtconX).
</para>
</listitem>
<listitem>
<para>
The client then does a NetWkstaUserLogon request, which retrieves the name
of the user's logon script.
</para>
</listitem>
<listitem>
<para>
The client then connects to the NetLogon share and searches for this
and if it is found and can be read, is retrieved and executed by the client.
After this, the client disconnects from the NetLogon share.
</para>
</listitem>
<listitem>
<para>
The client then 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 then
the user's home share, profiles for Win9X clients MUST reside in the user
home directory.
</para>
</listitem>
<listitem>
<para>
The client then 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 sharename and path. For example, \\server\fred\.profile.
If the profiles are found, they are implemented.
</para>
</listitem>
<listitem>
<para>
The client then disconnects from the user's home share, and reconnects to
the NetLogon share and looks for CONFIG.POL, the policies file. If this is
found, it is read and implemented.
</para>
</listitem>
</orderedlist>
<sect2>
<title>Configuration Instructions: Network Logons</title>
<para>
The main difference between a PDC and a Windows 9x logon
server configuration is that
</para>
<itemizedlist>
<listitem><para>
Password encryption is not required for a Windows 9x logon server.
</para></listitem>
<listitem><para>
Windows 9x/ME clients do not possess machine trust accounts.
</para></listitem>
</itemizedlist>
<para>
Therefore, a Samba PDC will also act as a Windows 9x logon
server.
</para>
<warning>
<title>security mode and master browsers</title>
<para>
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
or not it is ok to configure Samba as a Domain Controller in security
modes other than <constant>USER</constant>. The only security mode
which will not work due to technical reasons is <constant>SHARE</constant>
mode security. <constant>DOMAIN</constant> and <constant>SERVER</constant>
mode security is really just a variation on SMB user level security.
</para>
<para>
Actually, this issue is also closely tied to the debate on whether
or not Samba must be the domain master browser for its workgroup
when operating as a DC. While it may technically be possible
to configure a server as such (after all, browsing and domain logons
are two distinctly different functions), it is not a good idea to do
so. You should remember that the DC must register the DOMAIN#1b NetBIOS
name. This is the name used by Windows clients to locate the DC.
Windows clients do not distinguish between the DC and the DMB.
For this reason, it is very wise to configure the Samba DC as the DMB.
</para>
<para>
Now back to the issue of configuring a Samba DC to use a mode other
than "security = user". If a Samba host is configured to use
another SMB server or DC in order to validate user connection
requests, then it is a fact that some other machine on the network
(the "password server") knows more about the user than the Samba host.
99% of the time, this other host is a domain controller. Now
in order to operate in domain mode security, the "workgroup" parameter
must be set to the name of the Windows NT domain (which already
has a domain controller, right?)
</para>
<para>
Therefore configuring a Samba box as a DC for a domain that
already by definition has a PDC is asking for trouble.
Therefore, you should always configure the Samba DC to be the DMB
for its domain.
</para>
</warning>
</sect2>
</sect1>
</chapter>

143
docs/docbook/projdoc/ServerType.xml Normal file
View File

@ -0,0 +1,143 @@
<chapter id="ServerType">
<chapterinfo>
&author.jht;
</chapterinfo>
<title>Nomenclature of Server Types</title>
<para>Adminstrators of Microsoft networks often refer to there being three
different type of servers:</para>
<itemizedlist>
<listitem><para>Stand Alone Server</para></listitem>
<listitem><para>Domain Member Server</para></listitem>
<listitem><para>Domain Controller</para>
<itemizedlist>
<listitem><para>Primary Domain Controller</para></listitem>
<listitem><para>Backup Domain Controller</para></listitem>
<listitem><para>ADS Domain Controller</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
<para>A network administrator who is familiar with these terms and who
wishes to migrate to or use Samba will want to know what these terms mean
within a Samba context.</para>
<sect1>
<title>Stand Alone Server</title>
<para>
The term <emphasis>stand alone server</emphasis> means that the server
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 that resources
on the machine will either be made available in either SHARE mode or in
USER mode. SHARE mode and USER mode security are documented under
discussions regarding "security mode". The smb.conf configuration parameters
that control security mode are: "security = user" and "security = share".
</para>
<para>
No special action is needed other than to create user accounts. Stand-alone
servers do NOT provide network logon services, meaning that machines that
use this server do NOT perform a domain logon but instead make use only of
the MS Windows logon which is local to the MS Windows workstation/server.
</para>
<para>
Samba tends to blur the distinction a little in respect of what is
a stand alone server. This is because the authentication database may be
local or on a remote server, even if from the samba protocol perspective
the samba server is NOT a member of a domain security context.
</para>
<para>
Through the use of PAM (Pluggable Authentication Modules) and nsswitch
(the name service switcher) 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 (/etc/passwd or /etc/shadow), may use a local smbpasswd
file (/etc/samba/smbpasswd or /usr/local/samba/lib/private/smbpasswd), or
may use an LDAP back end, or even via PAM and Winbind another CIFS/SMB
server for authentication.
</para>
</sect1>
<sect1>
<title>Domain Member Server</title>
<para>
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.
</para>
<para><emphasis>
Of course it should be clear that the authentication back end itself could be from any
distributed directory architecture server that is supported by Samba. This can be
LDAP (from OpenLDAP), or Sun's iPlanet, of NetWare Directory Server, etc.
</emphasis></para>
<para>
Please refer to the section on Howto configure Samba as a Primary Domain Controller
and for more information regarding how to create a domain machine account for a
domain member server as well as for information regarding how to enable the samba
domain member machine to join the domain and to be fully trusted by it.
</para>
</sect1>
<sect1>
<title>Domain Controller</title>
<para>
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 what Domain Control
is the following types of controller are known:
</para>
<sect2>
<title>Domain Controller Types</title>
<simplelist>
<member>Primary Domain Controller</member>
<member>Backup Domain Controller</member>
<member>ADS Domain Controller</member>
</simplelist>
<para>
The <emphasis>Primary Domain Controller</emphasis> or PDC plays an important role in the MS
Windows NT3 and NT4 Domain Control architecture, but not in the manner that so many
expect. The PDC seeds the Domain Control database (a part of the Windows registry) and
it plays a key part in synchronisation of the domain authentication database.
</para>
<para>
New to Samba-3.0.0 is the ability to use a back-end file that holds the same type of data as
the NT4 style SAM (Security Account Manager) database (one of the registry files).
The samba-3.0.0 SAM can be specified via the smb.conf file parameter "passwd backend" and
valid options include <emphasis> smbpasswd tdbsam ldapsam nisplussam plugin unixsam</emphasis>.
The smbpasswd, tdbsam and ldapsam options can have a "_nua" suffix to indicate that No Unix
Accounts need to be created. In other words, the Samba SAM will be independant of Unix/Linux
system accounts, provided a uid range is defined from which SAM accounts can be created.
</para>
<para>
The <emphasis>Backup Domain Controller</emphasis> or BDC plays a key role in servicing network
authentication requests. The BDC is biased to answer logon requests so that on a network segment
that has a BDC and a PDC the BDC will be most likely to service network logon requests. The PDC will
answer network logon requests when the BDC is too busy (high load). A BDC can be promoted to
a PDC. If the PDC is on line at the time that the BDC is promoted to PDC the previous PDC is
automatically demoted to a BDC.
</para>
<para>
At this time Samba is NOT capable of acting as an <emphasis>ADS Domain Controller</emphasis>.
</para>
</sect2>
</sect1>
</chapter>

211
docs/docbook/projdoc/Speed.xml Normal file
View File

@ -0,0 +1,211 @@
<chapter id="speed">
<chapterinfo>
<author>
<firstname>Paul</firstname><surname>Cochrane</surname>
<affiliation>
<orgname>Dundee Limb Fitting Centre</orgname>
<address><email>paulc@dth.scot.nhs.uk</email></address>
</affiliation>
</author>
&author.jelmer;
</chapterinfo>
<title>Samba performance issues</title>
<sect1>
<title>Comparisons</title>
<para>
The Samba server uses TCP to talk to the client. Thus 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.
</para>
<para>
If you want to test against something like a NT or WfWg 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.
</para>
<para>
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 very much depends on your system.
</para>
<para>
Several people have done comparisons between Samba and Novell, NFS or
WinNT. In some cases Samba performed the best, in others the worst. I
suspect the biggest factor is not Samba vs 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.
</para>
</sect1>
<sect1>
<title>Socket options</title>
<para>
There are a number of socket options that can greatly affect the
performance of a TCP based server like Samba.
</para>
<para>
The socket options that Samba uses are settable both on the command
line with the -O option, or in the smb.conf file.
</para>
<para>
The <command>socket options</command> section of the &smb.conf; manual page describes how
to set these and gives recommendations.
</para>
<para>
Getting the socket options right 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.
</para>
<para>
The socket option TCP_NODELAY is the one that seems to make the
biggest single difference for most networks. Many people report that
adding <command>socket options = TCP_NODELAY</command> 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.
</para>
</sect1>
<sect1>
<title>Read size</title>
<para>
The option <command>read size</command> 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.
</para>
<para>
This overlapping works best when the speeds of disk and network access
are similar, having very little effect when the speed of one is much
greater than the other.
</para>
<para>
The default value is 16384, but very little experimentation has been
done 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.
</para>
</sect1>
<sect1>
<title>Max xmit</title>
<para>
At startup the client and server negotiate a <command>maximum transmit</command> size,
which limits the size of nearly all SMB commands. You can set the
maximum size that Samba will negotiate using the <command>max xmit = </command> option
in &smb.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
honours this limit.
</para>
<para>
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.
</para>
<para>
In most cases the default is the best option.
</para>
</sect1>
<sect1>
<title>Log level</title>
<para>
If you set the log level (also known as <command>debug level</command>) 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 very
expensive.
</para>
</sect1>
<sect1>
<title>Read raw</title>
<para>
The <command>read raw</command> operation is designed to be an optimised, low-latency
file read operation. A server may choose to not support it,
however. and Samba makes support for <command>read raw</command> optional, with it
being enabled by default.
</para>
<para>
In some cases clients don't handle <command>read raw</command> very well and actually
get lower performance using it than they get using the conventional
read operations.
</para>
<para>
So you might like to try <command>read raw = no</command> and see what happens on your
network. It might lower, raise or not affect your performance. Only
testing can really tell.
</para>
</sect1>
<sect1>
<title>Write raw</title>
<para>
The <command>write raw</command> operation is designed to be an optimised, low-latency
file write operation. A server may choose to not support it,
however. and Samba makes support for <command>write raw</command> optional, with it
being enabled by default.
</para>
<para>
Some machines may find <command>write raw</command> slower than normal write, in which
case you may wish to change this option.
</para>
</sect1>
<sect1>
<title>Slow Logins</title>
<para>
Slow logins are almost always due to the password checking time. Using
the lowest practical <command>password level</command> will improve things.
</para>
</sect1>
<sect1>
<title>Client tuning</title>
<para>
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
<link linkend="Other-Clients">Samba and Other Clients</link>.
</para>
</sect1>
</chapter>

176
docs/docbook/projdoc/UNIX_INSTALL.xml Normal file
View File

@ -0,0 +1,176 @@
<chapter id="install">
<chapterinfo>
&author.tridge;
&author.jelmer;
<author><firstname>Karl</firstname><surname>Auer</surname></author>
<!-- Isn't some of this written by others as well? -->
</chapterinfo>
<title>How to Install and Test SAMBA</title>
<sect1>
<title>Obtaining and installing samba</title>
<para>Binary packages of samba are included in almost any Linux or
Unix distribution. There are also some packages available at
<ulink url="http://samba.org/">the samba homepage</ulink>.
</para>
<para>If you need to compile samba from source, check the
<link linkend="compiling">appropriate appendix chapter</link>.</para>
</sect1>
<sect1>
<title>Configuring samba</title>
<para>Samba's configuration is stored in the smb.conf file,
that usually resides in <filename>/etc/samba/smb.conf</filename>
or <filename>/usr/local/samba/lib/smb.conf</filename>. 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.</para>
<sect2>
<title>Editing the <filename>smb.conf</filename> file</title>
<para>There are sample configuration files in the examples
subdirectory in the distribution. I suggest you read them
carefully so you can see how the options go together in
practice. See the man page for all the options.</para>
<para>The simplest useful configuration file would be
something like this:</para>
<para><programlisting>
[global]
workgroup = MYGROUP
[homes]
guest ok = no
read only = no
</programlisting></para>
<para>which would allow connections by anyone with an
account on the server, using either their login name or
"<command>homes</command>" as the service name. (Note that I also set the
workgroup that Samba is part of. See BROWSING.txt for details)</para>
<para>Make sure you put the <filename>smb.conf</filename> file in the same place
you specified in the<filename>Makefile</filename> (the default is to
look for it in <filename>/usr/local/samba/lib/</filename>).</para>
<para>For more information about security settings for the
<command>[homes]</command> share please refer to the chapter
<link linkend="securing-samba">Securing Samba</link>.</para>
<sect3>
<title>Test your config file with
<command>testparm</command></title>
<para>It's important that you test the validity of your
<filename>smb.conf</filename> file using the <application>testparm</application> program.
If testparm runs OK then it will list the loaded services. If
not it will give an error message.</para>
<para>Make sure it runs OK and that the services look
reasonable before proceeding. </para>
<para>Always run testparm again when you change
<filename>smb.conf</filename>!</para>
</sect3>
</sect2>
<sect2>
<title>SWAT</title>
<para>
SWAT is a web-based interface that helps you configure samba.
SWAT might not be available in the samba package on your platform,
but in a separate package. Please read the swat manpage
on compiling, installing and configuring swat from source.
</para>
<para>To launch SWAT just run your favorite web browser and
point it at "http://localhost:901/". Replace <replaceable>localhost</replaceable> with the name of the computer you are running samba on if you
are running samba on a different computer than your browser.</para>
<para>Note that you can attach to SWAT from any IP connected
machine but connecting from a remote machine leaves your
connection open to password sniffing as passwords will be sent
in the clear over the wire. </para>
</sect2>
</sect1>
<sect1>
<title>Try listing the shares available on your
server</title>
<para><prompt>$ </prompt><userinput>smbclient -L
<replaceable>yourhostname</replaceable></userinput></para>
<para>You should get back a list of shares available on
your server. If you don't then something is incorrectly setup.
Note that this method can also be used to see what shares
are available on other LanManager clients (such as WfWg).</para>
<para>If you choose user level security then you may find
that Samba requests a password before it will list the shares.
See the <command>smbclient</command> man page for details. (you
can force it to list the shares without a password by
adding the option -U% to the command line. This will not work
with non-Samba servers)</para>
</sect1>
<sect1>
<title>Try connecting with the unix client</title>
<para><prompt>$ </prompt><userinput>smbclient <replaceable>
//yourhostname/aservice</replaceable></userinput></para>
<para>Typically the <replaceable>yourhostname</replaceable>
would be the name of the host where you installed &smbd;.
The <replaceable>aservice</replaceable> is
any service you have defined in the &smb.conf;
file. Try your user name if you just have a <command>[homes]</command>
section
in &smb.conf;.</para>
<para>For example if your unix host is <replaceable>bambi</replaceable>
and your login name is <replaceable>fred</replaceable> you would type:</para>
<para><prompt>$ </prompt><userinput>smbclient //<replaceable>bambi</replaceable>/<replaceable>fred</replaceable>
</userinput></para>
</sect1>
<sect1>
<title>Try connecting from a DOS, WfWg, Win9x, WinNT,
Win2k, OS/2, etc... client</title>
<para>Try mounting disks. eg:</para>
<para><prompt>C:\WINDOWS\> </prompt><userinput>net use d: \\servername\service
</userinput></para>
<para>Try printing. eg:</para>
<para><prompt>C:\WINDOWS\> </prompt><userinput>net use lpt1:
\\servername\spoolservice</userinput></para>
<para><prompt>C:\WINDOWS\> </prompt><userinput>print filename
</userinput></para>
</sect1>
<sect1>
<title>What If Things Don't Work?</title>
<para>Then you might read the file chapter
<link linkend="diagnosis">Diagnosis</link> and the
FAQ. If you are still stuck then try to follow
the <link linkend="problems">Analysing and Solving Problems chapter</link>
Samba has been successfully installed at thousands of sites worldwide,
so maybe someone else has hit your problem and has overcome it. </para>
</sect1>
</chapter>

230
docs/docbook/projdoc/VFS.xml Normal file
View File

@ -0,0 +1,230 @@
<chapter id="VFS">
<chapterinfo>
&author.jelmer;
&author.jht;
<author><firstname>Alexander</firstname><surname>Bokovoy</surname></author>
<author><firstname>Tim</firstname><surname>Potter</surname></author>
<author><firstname>Simo</firstname><surname>Sorce</surname></author>
</chapterinfo>
<title>Stackable VFS modules</title>
<sect1>
<title>Introduction and configuration</title>
<para>
Since samba 3.0, samba supports stackable VFS(Virtual File System) modules.
Samba passes each request to access the unix file system thru the loaded VFS modules.
This chapter covers all the modules that come with the samba source and references to
some external modules.
</para>
<para>
You may have problems to compile 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.
</para>
<para>
To use the VFS modules, create a share similar to the one below. The
important parameter is the <command>vfs object</command> parameter which must point to
the exact pathname of the shared library objects. For example, to log all access
to files and use a recycle bin:
<programlisting>
[audit]
comment = Audited /data directory
path = /data
vfs object = /path/to/audit.so /path/to/recycle.so
writeable = yes
browseable = yes
</programlisting>
</para>
<para>
The modules are used in the order they are specified.
</para>
<para>
Further documentation on writing VFS modules for Samba can be found in
the Samba Developers Guide.
</para>
</sect1>
<sect1>
<title>Included modules</title>
<sect2>
<title>audit</title>
<para>A simple module to audit file access to the syslog
facility. The following operations are logged:
<simplelist>
<member>share</member>
<member>connect/disconnect</member>
<member>directory opens/create/remove</member>
<member>file open/close/rename/unlink/chmod</member>
</simplelist>
</para>
</sect2>
<sect2>
<title>extd_audit</title>
<para>
This module is identical with the <emphasis>audit</emphasis> module above except
that it sends audit logs to both syslog as well as the smbd log file/s. The
loglevel for this module is set in the smb.conf file.
</para>
<para>
The logging information that will be written to the smbd log file is controlled by
the <emphasis>log level</emphasis> parameter in <filename>smb.conf</filename>. The
following information will be recorded:
</para>
<table frame="all"><title>Extended Auditing Log Information</title>
<tgroup cols="2" align="center">
<thead>
<row><entry align="center">Log Level</entry><entry>Log Details - File and Directory Operations</entry></row>
</thead>
<tbody>
<row><entry align="center">0</entry><entry align="left">Creation / Deletion</entry></row>
<row><entry align="center">1</entry><entry align="left">Create / Delete / Rename / Permission Changes</entry></row>
<row><entry align="center">2</entry><entry align="left">Create / Delete / Rename / Perm Change / Open / Close</entry></row>
</tbody>
</tgroup>
</table>
</sect2>
<sect2>
<title>recycle</title>
<para>
A recycle-bin like module. When used any unlink call
will be intercepted and files moved to the recycle
directory instead of being deleted.
</para>
<para>Supported options:
<variablelist>
<varlistentry>
<term>vfs_recycle_bin:repository</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:keeptree</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:versions</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:touch</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:maxsize</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:exclude</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:exclude_dir</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
<varlistentry>
<term>vfs_recycle_bin:noversions</term>
<listitem><para>FIXME</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
<sect2>
<title>netatalk</title>
<para>
A netatalk module, that will ease co-existence of samba and
netatalk file sharing services.
</para>
<para>Advantages compared to the old netatalk module:
<simplelist>
<member>it doesn't care about creating of .AppleDouble forks, just keeps them in sync</member>
<member>if share in smb.conf doesn't contain .AppleDouble item in hide or veto list, it will be added automatically</member>
</simplelist>
</para>
</sect2>
</sect1>
<sect1>
<title>VFS modules available elsewhere</title>
<para>
This section contains a listing of various other VFS modules that
have been posted but don't 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).
</para>
<para>
No statemets about the stability or functionality of any module
should be implied due to its presence here.
</para>
<sect2>
<title>DatabaseFS</title>
<para>
URL: <ulink url="http://www.css.tayloru.edu/~elorimer/databasefs/index.php">http://www.css.tayloru.edu/~elorimer/databasefs/index.php</ulink>
</para>
<para>By <ulink url="mailto:elorimer@css.tayloru.edu">Eric Lorimer</ulink>.</para>
<para>
I have created a VFS module which 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," etc... I have since applied it to a student
roster database very easily). 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.
</para>
<para>
Any feedback would be appreciated: comments, suggestions, patches,
etc... If nothing else, hopefully it might prove useful for someone
else who wishes to create a virtual filesystem.
</para>
</sect2>
<sect2>
<title>vscan</title>
<para>URL: <ulink url="http://www.openantivirus.org/">http://www.openantivirus.org/</ulink></para>
<para>
samba-vscan is a proof-of-concept module for Samba, which
uses the VFS (virtual file system) features of Samba 2.2.x/3.0
alphaX. Of couse, Samba has to be compiled with VFS support.
samba-vscan supports various virus scanners and is maintained
by Rainer Link.
</para>
</sect2>
</sect1>
</chapter>

396
docs/docbook/projdoc/locking.xml Normal file
View File

@ -0,0 +1,396 @@
<chapter id="locking">
<chapterinfo>
&author.jeremy;
&author.jelmer;
&author.jht;
</chapterinfo>
<title>File and Record Locking</title>
<sect1>
<title>Discussion</title>
<para>
One area which sometimes causes trouble is locking.
</para>
<para>
There are two types of locking which need to be performed by a SMB server.
The first is <emphasis>record locking</emphasis> which allows a client to lock
a range of bytes in a open file. The second is the <emphasis>deny modes</emphasis>
that are specified when a file is open.
</para>
<para>
Record locking semantics under Unix is 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 can not be fully correct due to several reasons. The simplest is the fact
that a Windows client is allowed to lock a byte range up to 2^32 or 2^64,
depending on the client OS. The unix locking only supports byte ranges up to 2^31.
So it is not possible to correctly satisfy a lock request above 2^31. There are
many more differences, too many to be listed here.
</para>
<para>
Samba 2.2 and above implements record locking completely independent of the
underlying unix system. If a byte range lock that the client requests happens
to fall into the range 0-2^31, Samba hands this request down to the Unix system.
All other locks can not be seen by unix anyway.
</para>
<para>
Strictly a 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 rpc.lockd. It is also almost always unnecessary as clients are supposed to
independently make locking calls before reads and writes anyway if locking is
important to them. By default Samba only makes locking calls when explicitly asked
to by a client, but if you set <emphasis>strict locking = yes</emphasis> then it
will make lock checking calls on every read and write.
</para>
<para>
You can also disable by range locking completely using <emphasis>locking = no</emphasis>.
This is useful for those shares that don't support locking or don't need it
(such as cdroms). In this case Samba fakes the return codes of locking calls to
tell clients that everything is OK.
</para>
<para>
The second class of locking is the <emphasis>deny modes</emphasis>. 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
DENY_NONE, DENY_READ, DENY_WRITE or DENY_ALL. There are also special compatibility
modes called DENY_FCB and DENY_DOS.
</para>
</sect1>
<sect1>
<title>Samba Opportunistic Locking Control</title>
<para>
Opportunistic locking essentially means that the client is allowed to download and cache
a file on their hard drive while making changes; if a second client wants to access the
file, the first client receives a break and must synchronise the file back to the server.
This can give significant performance gains in some cases; some programs insist on
synchronising the contents of the entire file back to the server for a single change.
</para>
<para>
Level1 Oplocks (aka just plain "oplocks") is another term for opportunistic locking.
</para>
<para>
Level2 Oplocks provids opportunistic locking for a file that will be treated as
<emphasis>read only</emphasis>. 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.
</para>
<para>
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 under lying OS, SGI IRIX and Linux are the only two OS's that are
oplock aware at this time.
</para>
<para>
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, as any break the first client receives will affect synchronisation of
the entire file (not just the single record), which will result in a noticable performance
impairment and, more likely, problems accessing the database in the first place. Notably,
Microsoft Outlook's personal folders (*.pst) react very badly to oplocks. If in doubt,
disable oplocks and tune your system from that point.
</para>
<para>
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.
</para>
<para>
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.
</para>
<para>
You can disable oplocks on a per-share basis with the following:
<programlisting>
oplocks = False
level2 oplocks = False
</programlisting>
Alternately, you could disable oplocks on a per-file basis within the share:
<programlisting>
veto oplock files = /*.mdb/*.MDB/*.dbf/*.DBF/
</programlisting>
</para>
<para>
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.
</para>
</sect1>
<sect1>
<title>MS Windows Opportunistic Locking and Caching Controls</title>
<para>
There is a known issue when running applications (like Norton Anti-Virus) 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 known as <emphasis>Opportunistic Locking</emphasis>. 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 <emphasis>Access Denied</emphasis>
error message being displayed during network operations.
</para>
<para>
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 opportunistic locking disabled in order to minimize the risk of data file corruption.
This includes Windows 9x/Me, Windows NT, Windows 200x and Windows XP.
</para>
<para>
If you are using a Windows NT family workstation in place of a server, you must also
disable opportunistic locking (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.
</para>
<para>
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.
</para>
<para>
You can verify (or 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.
</para>
<para>
The location of the client registry entry for opportunistic locking has changed in
Windows 2000 from the earlier location in Microsoft Windows NT.
</para>
<note><para>
Windows 2000 will still respect the EnableOplocks registry value used to disable oplocks
in earlier versions of Windows.
</para></note>
<para>
You can also deny the granting of opportunistic locks by changing the following registry entries:
</para>
<para>
<programlisting>
HKEY_LOCAL_MACHINE\System\CurrentControlSet\Services\MRXSmb\Parameters\
OplocksDisabled REG_DWORD 0 or 1
Default: 0 (not disabled)
</programlisting>
</para>
<note><para>
The OplocksDisabled registry value configures Windows clients to either request or not
request opportunistic locks on a remote file. To disable oplocks, the value of
OplocksDisabled must be set to 1.
</para></note>
<para>
<programlisting>
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)
</programlisting>
</para>
<note><para>
The EnableOplocks value configures Windows-based servers (including Workstations sharing
files) to allow or deny opportunistic locks on local files.
</para></note>
<para>
To force closure of open oplocks on close or program exit EnableOpLockForceClose must be set to 1.
</para>
<para>
An illustration of how level II oplocks work:
</para>
<itemizedlist>
<listitem><para>
Station 1 opens the file, requesting oplock.
</para></listitem>
<listitem><para>
Since no other station has the file open, the server grants station 1 exclusive oplock.
</para></listitem>
<listitem><para>
Station 2 opens the file, requesting oplock.
</para></listitem>
<listitem><para>
Since station 1 has not yet written to the file, the server asks station 1 to Break
to Level II Oplock.
</para></listitem>
<listitem><para>
Station 1 complies by flushing locally buffered lock information to the server.
</para></listitem>
<listitem><para>
Station 1 informs the server that it has Broken to Level II Oplock (alternatively,
station 1 could have closed the file).
</para></listitem>
<listitem><para>
The server responds to station 2's open request, granting it level II oplock.
Other stations can likewise open the file and obtain level II oplock.
</para></listitem>
<listitem><para>
Station 2 (or any station that has the file open) sends a write request SMB.
The server returns the write response.
</para></listitem>
<listitem><para>
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.
</para></listitem>
</itemizedlist>
<sect2>
<title>Workstation Service Entries</title>
<para><programlisting>
\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanWorkstation\Parameters
UseOpportunisticLocking REG_DWORD 0 or 1
Default: 1 (true)
</programlisting></para>
<para>
Indicates whether the redirector should use opportunistic-locking (oplock) performance
enhancement. This parameter should be disabled only to isolate problems.
</para>
</sect2>
<sect2>
<title>Server Service Entries</title>
<para><programlisting>
\HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\LanmanServer\Parameters
EnableOplocks REG_DWORD 0 or 1
Default: 1 (true)
</programlisting></para>
<para>
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 wide-area networks.
</para>
<para><programlisting>
MinLinkThroughput REG_DWORD 0 to infinite bytes per second
Default: 0
</programlisting></para>
<para>
Specifies the minimum link throughput allowed by the server before it disables
raw and opportunistic locks for this connection.
</para>
<para><programlisting>
MaxLinkDelay REG_DWORD 0 to 100,000 seconds
Default: 60
</programlisting></para>
<para>
Specifies the maximum time allowed for a link delay. If delays exceed this number,
the server disables raw I/O and opportunistic locking for this connection.
</para>
<para><programlisting>
OplockBreakWait REG_DWORD 10 to 180 seconds
Default: 35
</programlisting></para>
<para>
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.
</para>
</sect2>
</sect1>
<sect1>
<title>Persistent Data Corruption</title>
<para>
If you have applied all of the settings discussed in this paper but data corruption problems
and other symptoms persist, here are some additional things to check out:
</para>
<para>
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 reindexing, 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.
</para>
</sect1>
<sect1>
<title>Additional Reading</title>
<para>
You may want to check for an updated version of this white paper on our Web site from
time to time. Many of our white papers are updated as information changes. For those papers,
the Last Edited date is always at the top of the paper.
</para>
<para>
Section of the Microsoft MSDN Library on opportunistic locking:
</para>
<para>
Opportunistic Locks, Microsoft Developer Network (MSDN), Windows Development &gt;
Windows Base Services &gt; Files and I/O &gt; SDK Documentation &gt; File Storage &gt; File Systems
&gt; About File Systems &gt; Opportunistic Locks, Microsoft Corporation.
<ulink url="http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp">http://msdn.microsoft.com/library/en-us/fileio/storage_5yk3.asp</ulink>
</para>
<para>
Microsoft Knowledge Base Article Q224992 "Maintaining Transactional Integrity with OPLOCKS",
Microsoft Corporation, April 1999, <ulink url="=http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q224992</ulink>.
</para>
<para>
Microsoft Knowledge Base Article Q296264 "Configuring Opportunistic Locking in Windows 2000",
Microsoft Corporation, April 2001, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q296264</ulink>.
</para>
<para>
Microsoft Knowledge Base Article Q129202 "PC Ext: Explanation of Opportunistic Locking on Windows NT",
Microsoft Corporation, April 1995, <ulink url="http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202">http://support.microsoft.com/default.aspx?scid=kb;en-us;Q129202</ulink>.
</para>
</sect1>
</chapter>

116
docs/docbook/projdoc/msdfs_setup.xml Normal file
View File

@ -0,0 +1,116 @@
<chapter id="msdfs">
<chapterinfo>
<author>
<firstname>Shirish</firstname><surname>Kalele</surname>
<affiliation>
<orgname>Samba Team &amp; Veritas Software</orgname>
<address>
<email>samba@samba.org</email>
</address>
</affiliation>
</author>
<pubdate>12 Jul 2000</pubdate>
</chapterinfo>
<title>Hosting a Microsoft Distributed File System tree on Samba</title>
<sect1>
<title>Instructions</title>
<para>The Distributed File System (or 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 etc. For more information about Dfs, refer to <ulink
url="http://www.microsoft.com/NTServer/nts/downloads/winfeatures/NTSDistrFile/AdminGuide.asp">
Microsoft documentation</ulink>. </para>
<para>This document explains how to host a Dfs tree on a Unix
machine (for Dfs-aware clients to browse) using Samba.</para>
<para>To enable SMB-based DFS for Samba, configure it with the
<parameter>--with-msdfs</parameter> option. Once built, a
Samba server can be made a Dfs server by setting the global
boolean <ulink url="smb.conf.5.html#HOSTMSDFS"><parameter>
host msdfs</parameter></ulink> parameter in the <filename>smb.conf
</filename> file. You designate a share as a Dfs root using the share
level boolean <ulink url="smb.conf.5.html#MSDFSROOT"><parameter>
msdfs root</parameter></ulink> 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
<filename>junction-&gt;msdfs:storage1\share1</filename> 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, \\storage1\share1).</para>
<para>Dfs trees on Samba work with all Dfs-aware clients ranging
from Windows 95 to 2000.</para>
<para>Here's an example of setting up a Dfs tree on a Samba
server.</para>
<para><programlisting>
# The smb.conf file:
[global]
netbios name = SAMBA
host msdfs = yes
[dfs]
path = /export/dfsroot
msdfs root = yes
</programlisting></para>
<para>In the /export/dfsroot directory we set up our dfs links to
other servers on the network.</para>
<para><prompt>root# </prompt><userinput>cd /export/dfsroot</userinput></para>
<para><prompt>root# </prompt><userinput>chown root /export/dfsroot</userinput></para>
<para><prompt>root# </prompt><userinput>chmod 755 /export/dfsroot</userinput></para>
<para><prompt>root# </prompt><userinput>ln -s msdfs:storageA\\shareA linka</userinput></para>
<para><prompt>root# </prompt><userinput>ln -s msdfs:serverB\\share,serverC\\share linkb</userinput></para>
<para>You should set up the permissions and ownership of
the directory acting as the Dfs root such 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.</para>
<para>Users on Dfs-aware clients can now browse the Dfs tree
on the Samba server at \\samba\dfs. Accessing
links linka or linkb (which appear as directories to the client)
takes users directly to the appropriate shares on the network.</para>
<sect2>
<title>Notes</title>
<itemizedlist>
<listitem><para>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.</para>
</listitem>
<listitem><para>Currently there's a restriction that msdfs
symlink names should all be lowercase.</para>
</listitem>
<listitem><para>For security purposes, the directory
acting as the root of the Dfs tree should have ownership
and permissions set so that only designated users can
modify the symbolic links in the directory.</para>
</listitem>
</itemizedlist>
</sect2>
</sect1>
</chapter>

970
docs/docbook/projdoc/passdb.xml Normal file
View File

@ -0,0 +1,970 @@
<chapter id="passdb">
<chapterinfo>
&author.jelmer;
&author.jerry;
&author.jeremy;
&author.jht;
<author>
<firstname>Olivier (lem)</firstname><surname>Lemaire</surname>
<affiliation>
<orgname>IDEALX</orgname>
<address><email>olem@IDEALX.org</email></address>
</affiliation>
</author>
<pubdate>February 2003</pubdate>
</chapterinfo>
<title>User information database</title>
<sect1>
<title>Introduction</title>
<para>Old windows clients send plain text passwords over the wire.
Samba can check these passwords by crypting them and comparing them
to the hash stored in the unix user database.
</para>
<para>
Newer windows clients send encrypted passwords (so-called
Lanman and NT hashes) over
the wire, instead of plain text passwords. The newest clients
will only send encrypted passwords and refuse to send plain text
passwords, unless their registry is tweaked.
</para>
<para>These 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. </para>
<para>Next to a differently encrypted passwords,
windows also stores certain data for each user
that is not stored in a unix user database, e.g.
workstations the user may logon from, the location where his/her
profile is stored, etc.
Samba retrieves and stores this information using a "passdb backend".
Commonly
available backends are LDAP, plain text file, MySQL and nisplus.
For more information, see the documentation about the
<command>passdb backend = </command> parameter.
</para>
</sect1>
<sect1>
<title>Important Notes About Security</title>
<para>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
cleartext 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 thus treat the data stored in whatever
passdb backend you use (smbpasswd file, ldap, mysql) as though it contained the
cleartext passwords of all your users. Its contents must be kept
secret, and the file should be protected accordingly.</para>
<para>Ideally we would like a password scheme which neither requires
plain text passwords on the net or on disk. Unfortunately this
is not available as Samba is stuck with being compatible with
other SMB systems (WinNT, WfWg, Win95 etc). </para>
<warning>
<para>Note that Windows NT 4.0 Service pack 3 changed the
default for permissible authentication so that plaintext
passwords are <emphasis>never</emphasis> sent over the wire.
The solution to this is either to switch to encrypted passwords
with Samba or edit the Windows NT registry to re-enable plaintext
passwords. See the document WinNT.txt for details on how to do
this.</para>
<para>Other Microsoft operating systems which also exhibit
this behavior includes</para>
<para> These versions of MS Windows do not support full domain
security protocols, although they may log onto a domain environment.
Of these Only MS Windows XP Home does NOT support domain logons.</para>
<simplelist>
<member>MS DOS Network client 3.0 with
the basic network redirector installed</member>
<member>Windows 95 with the network redirector
update installed</member>
<member>Windows 98 [se]</member>
<member>Windows Me</member>
<member>Windows XP Home</member>
</simplelist>
<para> The following versions of MS Windows fully support domain
security protocols.</para>
<simplelist>
<member>Windows NT 3.5x</member>
<member>Windows NT 4.0</member>
<member>Windows 2000 Professional</member>
<member>Windows 200x Server/Advanced Server</member>
<member>Windows XP Professional</member>
</simplelist>
</warning>
<note><para>All current release 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.</para></note>
<para>MS Windows clients will cache the encrypted password alone.
Even when plain text passwords are re-enabled, through the appropriate
registry change, the plain text 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 affect a auto-reconnect. If the resource server does not support encrypted
passwords the auto-reconnect will fail. <emphasis>USE OF ENCRYPTED PASSWORDS
IS STRONGLY ADVISED.</emphasis></para>
<sect2>
<title>Advantages of SMB Encryption</title>
<simplelist>
<member>Plain text passwords are not passed across
the network. Someone using a network sniffer cannot just
record passwords going to the SMB server.</member>
<member>WinNT doesn't 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 things you can do to stop this is to use SMB encryption.
</member>
<member>Encrypted password support allows automatic share
(resource) reconnects.</member>
</simplelist>
</sect2>
<sect2>
<title>Advantages of non-encrypted passwords</title>
<simplelist>
<member>Plain text passwords are not kept
on disk, and are NOT cached in memory. </member>
<member>Uses same password file as other unix
services such as login and ftp</member>
<member>Use of other services (such as telnet and ftp) which
send plain text passwords over the net, so sending them for SMB
isn't such a big deal.</member>
</simplelist>
</sect2>
</sect1>
<sect1>
<title>The smbpasswd Command</title>
<para>The smbpasswd utility is a utility similar to the
<command>passwd</command> or <command>yppasswd</command> programs.
It maintains the two 32 byte password fields in the passdb backend. </para>
<para><command>smbpasswd</command> 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 - as follows.</para>
<para><command>smbpasswd</command> has the capability
to change passwords on Windows NT servers (this only works when
the request is sent to the NT Primary Domain Controller if you
are changing an NT Domain user's password).</para>
<para>To run smbpasswd as a normal user just type :</para>
<para><prompt>$ </prompt><userinput>smbpasswd</userinput></para>
<para><prompt>Old SMB password: </prompt><userinput>&lt;type old value here -
or hit return if there was no old password&gt;</userinput></para>
<para><prompt>New SMB Password: </prompt><userinput>&lt;type new value&gt;
</userinput></para>
<para><prompt>Repeat New SMB Password: </prompt><userinput>&lt;re-type new value
</userinput></para>
<para>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.</para>
<para>If invoked by an ordinary user it will only allow the user
to change his or her own Samba password.</para>
<para>If run by the root user smbpasswd may take an optional
argument, specifying the user name whose SMB password you wish to
change. Note that when run as root smbpasswd does not prompt for
or check the old password value, thus allowing root to set passwords
for users who have forgotten their passwords.</para>
<para><command>smbpasswd</command> is designed to work in the same way
and be familiar to UNIX users who use the <command>passwd</command> or
<command>yppasswd</command> commands.</para>
<para>For more details on using <command>smbpasswd</command> refer
to the man page which will always be the definitive reference.</para>
</sect1>
<!--
<sect1>
<title>The <command>pdbedit</command> command</title>
FIXME
</sect1>
-->
<sect1>
<title>Plain text</title>
<para>
Older versions of samba retrieved user information from the unix user database
and eventually some other fields from the file <filename>/etc/samba/smbpasswd</filename>
or <filename>/etc/smbpasswd</filename>. When password encryption is disabled, no
data is stored at all.
</para>
</sect1>
<sect1>
<title>TDB</title>
<para>Samba can also store the user data in a "TDB" (Trivial Database). Using this backend
doesn't require any additional configuration. This backend is recommended for new installations that
don not require LDAP.
</para>
</sect1>
<sect1>
<title>LDAP</title>
<sect2>
<title>Introduction</title>
<para>
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.
</para>
<itemizedlist>
<listitem><para>OpenLDAP - <ulink url="http://www.openldap.org/">http://www.openldap.org/</ulink></para></listitem>
<listitem><para>iPlanet Directory Server - <ulink url="http://iplanet.netscape.com/directory">http://iplanet.netscape.com/directory</ulink></para></listitem>
</itemizedlist>
<para>
Note that <ulink url="http://www.ora.com/">O'Reilly Publishing</ulink> is working on
a guide to LDAP for System Administrators which has a planned release date of
early summer, 2002.
</para>
<para>
Two additional Samba resources which may prove to be helpful are
</para>
<itemizedlist>
<listitem><para>The <ulink url="http://www.unav.es/cti/ldap-smb/ldap-smb-3-howto.html">Samba-PDC-LDAP-HOWTO</ulink>
maintained by Ignacio Coupeau.</para></listitem>
<listitem><para>The NT migration scripts from <ulink url="http://samba.idealx.org/">IDEALX</ulink> that are
geared to manage users and group in such a Samba-LDAP Domain Controller configuration.
</para></listitem>
</itemizedlist>
</sect2>
<sect2>
<title>Encrypted Password Database</title>
<para>
Traditionally, when configuring <ulink url="smb.conf.5.html#ENCRYPTPASSWORDS">"encrypt
passwords = yes"</ulink> in Samba's <filename>smb.conf</filename> file, user account
information such as username, LM/NT password hashes, password change times, and account
flags have been stored in the <filename>smbpasswd(5)</filename> file. There are several
disadvantages to this approach for sites with very large numbers of users (counted
in the thousands).
</para>
<itemizedlist>
<listitem><para>
The first is that all lookups must be performed sequentially. Given that
there are approximately two lookups per domain logon (one for a normal
session connection 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 is used in databases.
</para></listitem>
<listitem><para>
The second problem is that administrators who desired to replicate a
smbpasswd file to more than one Samba server were left to use external
tools such as <command>rsync(1)</command> and <command>ssh(1)</command>
and wrote custom, in-house scripts.
</para></listitem>
<listitem><para>
And finally, the amount of information which is stored in an
smbpasswd entry leaves no room for additional attributes such as
a home directory, password expiration time, or even a Relative
Identified (RID).
</para></listitem>
</itemizedlist>
<para>
As a result of these defeciencies, a more robust means of storing user attributes
used by smbd was developed. The API which 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 CVS trees).
</para>
<para>
There are a few points to stress about that the ldapsam
does not provide. The LDAP support referred to in the this documentation does not
include:
</para>
<itemizedlist>
<listitem><para>A means of retrieving user account information from
an Windows 2000 Active Directory server.</para></listitem>
<listitem><para>A means of replacing /etc/passwd.</para></listitem>
</itemizedlist>
<para>
The second item can be accomplished by using LDAP NSS and PAM modules. LGPL
versions of these libraries can be obtained from PADL Software
(<ulink url="http://www.padl.com/">http://www.padl.com/</ulink>). More
information about the configuration of these packages may be found at "LDAP,
System Administration; Gerald Carter, O'Reilly; Chapter 6: Replacing NIS".
</para>
</sect2>
<sect2>
<title>Supported LDAP Servers</title>
<!-- FIXME: This is outdated for 3.0 -->
<para>
The LDAP samdb code in 2.2.3 (and later) has been developed and tested
using the OpenLDAP 2.0 server and client libraries.
The same code should be able to work with Netscape's Directory Server
and client SDK. However, due to lack of testing so far, there are bound
to be compile errors and bugs. These should not be hard to fix.
If you are so inclined, please be sure to forward all patches to
<ulink url="mailto:samba-patches@samba.org">samba-patches@samba.org</ulink> and
<ulink url="mailto:jerry@samba.org">jerry@samba.org</ulink>.
</para>
</sect2>
<sect2>
<title>Schema and Relationship to the RFC 2307 posixAccount</title>
<para>
Samba 3.0 includes the necessary schema file for OpenLDAP 2.0 in
<filename>examples/LDAP/samba.schema</filename>. The sambaAccount objectclass is given here:
</para>
<para><programlisting>
objectclass ( 1.3.1.5.1.4.1.7165.2.2.2 NAME 'sambaAccount' SUP top AUXILIARY
DESC 'Samba Account'
MUST ( uid $ rid )
MAY ( cn $ lmPassword $ ntPassword $ pwdLastSet $ logonTime $
logoffTime $ kickoffTime $ pwdCanChange $ pwdMustChange $ acctFlags $
displayName $ smbHome $ homeDrive $ scriptPath $ profilePath $
description $ userWorkstations $ primaryGroupID $ domain ))
</programlisting></para>
<para>
The samba.schema file has been formatted for OpenLDAP 2.0. The OID's are
owned by the Samba Team and as such is legal to be openly published.
If you translate the schema to be used with Netscape DS, please
submit the modified schema file as a patch to <ulink
url="mailto:jerry@samba.org">jerry@samba.org</ulink>
</para>
<para>
Just as the smbpasswd file is meant to store information which supplements a
user's <filename>/etc/passwd</filename> entry, so is the sambaAccount object
meant to supplement the UNIX user account information. A sambaAccount is a
<constant>STRUCTURAL</constant> objectclass so it can be stored individually
in the directory. However, there are several fields (e.g. uid) which overlap
with the posixAccount objectclass outlined in RFC2307. This is by design.
</para>
<!--olem: we should perhaps have a note about shadowAccounts too as many
systems use them, isn'it ? -->
<para>
In order to store all user account information (UNIX and Samba) in the directory,
it is necessary to use the sambaAccount and posixAccount objectclasses in
combination. However, smbd will still obtain the user's UNIX account
information via the standard C library calls (e.g. getpwnam(), et. al.).
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.
</para>
</sect2>
<sect2>
<title>Configuring Samba with LDAP</title>
<sect3>
<title>OpenLDAP configuration</title>
<para>
To include support for the sambaAccount object in an OpenLDAP directory
server, first copy the samba.schema file to slapd's configuration directory.
</para>
<para>
<prompt>root# </prompt><userinput>cp samba.schema /etc/openldap/schema/</userinput>
</para>
<para>
Next, include the <filename>samba.schema</filename> file in <filename>slapd.conf</filename>.
The sambaAccount object contains two attributes which depend upon other schema
files. The 'uid' attribute is defined in <filename>cosine.schema</filename> and
the 'displayName' attribute is defined in the <filename>inetorgperson.schema</filename>
file. Both of these must be included before the <filename>samba.schema</filename> file.
</para>
<para><programlisting>
## /etc/openldap/slapd.conf
## schema files (core.schema is required by default)
include /etc/openldap/schema/core.schema
## needed for sambaAccount
include /etc/openldap/schema/cosine.schema
include /etc/openldap/schema/inetorgperson.schema
include /etc/openldap/schema/samba.schema
include /etc/openldap/schema/nis.schema
....
</programlisting></para>
<para>
It is recommended that you maintain some indices on some of the most usefull attributes,
like in the following example, to speed up searches made on sambaAccount objectclasses
(and possibly posixAccount and posixGroup as well).
</para>
<para><programlisting>
# Indices to maintain
## required by OpenLDAP 2.0
index objectclass eq
## support pb_getsampwnam()
index uid pres,eq
## support pdb_getsambapwrid()
index rid eq
## uncomment these if you are storing posixAccount and
## posixGroup entries in the directory as well
##index uidNumber eq
##index gidNumber eq
##index cn eq
##index memberUid eq
# (both fetched via ldapsearch):
index primaryGroupID eq
index displayName pres,eq
</programlisting></para>
</sect3>
<sect3>
<title>Configuring Samba</title>
<para>
The following parameters are available in smb.conf only with <parameter>--with-ldapsam</parameter>
was included when compiling Samba.
</para>
<itemizedlist>
<listitem><para><ulink url="smb.conf.5.html#PASSDBBACKEND">passdb backend [ldapsam|ldapsam_nua]:url</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPSSL">ldap ssl</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPADMINDN">ldap admin dn</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPSUFFIX">ldap suffix</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPFILTER">ldap filter</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPPORT">ldap port</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPMACHINSUFFIX">ldap machine suffix</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPUSERSUFFIX">ldap user suffix</ulink></para></listitem>
<listitem><para><ulink url="smb.conf.5.html#LDAPDELETEDN">ldap delete dn</ulink></para></listitem>
</itemizedlist>
<para>
These are described in the <ulink url="smb.conf.5.html">smb.conf(5)</ulink> man
page and so will not be repeated here. However, a sample smb.conf file for
use with an LDAP directory could appear as
</para>
<para><programlisting>
## /usr/local/samba/lib/smb.conf
[global]
security = user
encrypt passwords = yes
netbios name = TASHTEGO
workgroup = NARNIA
# ldap related parameters
# define the DN to use when binding to the directory servers
# The password for this DN is not stored in smb.conf. Rather it
# must be set by using 'smbpasswd -w <replaceable>secretpw</replaceable>' to store the
# passphrase in the secrets.tdb file. If the "ldap admin dn" values
# change, this password will need to be reset.
ldap admin dn = "cn=Samba Manager,ou=people,dc=samba,dc=org"
# Define the SSL option when connecting to the directory
# ('off', 'start tls', or 'on' (default))
ldap ssl = start tls
passdb backend ldapsam:ldap://ahab.samba.org
# smbpasswd -x delete the entire dn-entry
ldap delete dn = no
# the machine and user suffix added to the base suffix
# wrote WITHOUT quotes. NULL siffixes by default
ldap user suffix = ou=People
ldap machine suffix = ou=Systems
# define the port to use in the LDAP session (defaults to 636 when
# "ldap ssl = on")
ldap port = 389
# specify the base DN to use when searching the directory
ldap suffix = "ou=people,dc=samba,dc=org"
# generally the default ldap search filter is ok
# ldap filter = "(&amp;(uid=%u)(objectclass=sambaAccount))"
</programlisting></para>
</sect3>
</sect2>
<sect2>
<title>Accounts and Groups management</title>
<para>
As users accounts are managed thru the sambaAccount objectclass, you should
modify your existing administration tools to deal with sambaAccount attributes.
</para>
<para>
Machines accounts are managed with the sambaAccount objectclass, just
like users accounts. However, it's up to you to store thoses accounts
in a different tree of you LDAP namespace: you should use
"ou=Groups,dc=plainjoe,dc=org" to store groups and
"ou=People,dc=plainjoe,dc=org" to store users. Just configure your
NSS and PAM accordingly (usually, in the /etc/ldap.conf configuration
file).
</para>
<para>
In Samba release 3.0, the group management system is based on posix
groups. This means that Samba makes usage of the posixGroup objectclass.
For now, there is no NT-like group system management (global and local
groups).
</para>
</sect2>
<sect2>
<title>Security and sambaAccount</title>
<para>
There are two important points to remember when discussing the security
of sambaAccount entries in the directory.
</para>
<itemizedlist>
<listitem><para><emphasis>Never</emphasis> retrieve the lmPassword or
ntPassword attribute values over an unencrypted LDAP session.</para></listitem>
<listitem><para><emphasis>Never</emphasis> allow non-admin users to
view the lmPassword or ntPassword attribute values.</para></listitem>
</itemizedlist>
<para>
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 the <link
linkend="passdb">User Database</link> of the Samba-HOWTO-Collection.
</para>
<para>
To remedy the first security issue, the "ldap ssl" smb.conf parameter defaults
to require an encrypted session (<command>ldap ssl = on</command>) using
the default port of 636
when contacting the directory server. When using an OpenLDAP 2.0 server, it
is possible to use the use the StartTLS LDAP extended operation in the place of
LDAPS. In either case, you are strongly discouraged to disable this security
(<command>ldap ssl = off</command>).
</para>
<para>
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.
</para>
<para>
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 <filename>slapd.conf</filename>:
</para>
<para><programlisting>
## allow the "ldap admin dn" access, but deny everyone else
access to attrs=lmPassword,ntPassword
by dn="cn=Samba Admin,ou=people,dc=plainjoe,dc=org" write
by * none
</programlisting></para>
</sect2>
<sect2>
<title>LDAP specials attributes for sambaAccounts</title>
<para>
The sambaAccount objectclass is composed of the following attributes:
</para>
<itemizedlist>
<listitem><para><constant>lmPassword</constant>: the LANMAN password 16-byte hash stored as a character
representation of a hexidecimal string.</para></listitem>
<listitem><para><constant>ntPassword</constant>: the NT password hash 16-byte stored as a character
representation of a hexidecimal string.</para></listitem>
<listitem><para><constant>pwdLastSet</constant>: The integer time in seconds since 1970 when the
<constant>lmPassword</constant> and <constant>ntPassword</constant> attributes were last set.
</para></listitem>
<listitem><para><constant>acctFlags</constant>: string of 11 characters surrounded by square brackets []
representing account flags such as U (user), W(workstation), X(no password expiration), and
D(disabled).</para></listitem>
<listitem><para><constant>logonTime</constant>: Integer value currently unused</para></listitem>
<listitem><para><constant>logoffTime</constant>: Integer value currently unused</para></listitem>
<listitem><para><constant>kickoffTime</constant>: Integer value currently unused</para></listitem>
<listitem><para><constant>pwdCanChange</constant>: Integer value currently unused</para></listitem>
<listitem><para><constant>pwdMustChange</constant>: Integer value currently unused</para></listitem>
<listitem><para><constant>homeDrive</constant>: specifies the drive letter to which to map the
UNC path specified by homeDirectory. 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.</para></listitem>
<listitem><para><constant>scriptPath</constant>: The scriptPath 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 "logon script" parameter in the
smb.conf(5) man page for more information.</para></listitem>
<listitem><para><constant>profilePath</constant>: 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
"logon path" parameter in the smb.conf(5) man page for more information.</para></listitem>
<listitem><para><constant>smbHome</constant>: The homeDirectory property specifies the path of
the home directory for the user. The string can be null. If homeDrive is set and specifies
a drive letter, homeDirectory should be a UNC path. The path must be a network
UNC path of the form \\server\share\directory. This value can be a null string.
Refer to the "logon home" parameter in the smb.conf(5) man page for more information.
</para></listitem>
<listitem><para><constant>userWorkstation</constant>: character string value currently unused.
</para></listitem>
<listitem><para><constant>rid</constant>: the integer representation of the user's relative identifier
(RID).</para></listitem>
<listitem><para><constant>primaryGroupID</constant>: the relative identifier (RID) of the primary group
of the user.</para></listitem>
</itemizedlist>
<para>
The majority of these parameters are only used when Samba is acting as a PDC of
a domain (refer to the <ulink url="Samba-PDC-HOWTO.html">Samba-PDC-HOWTO</ulink> for details on
how to configure Samba as a Primary Domain Controller). The following four attributes
are only stored with the sambaAccount entry if the values are non-default values:
</para>
<itemizedlist>
<listitem><para>smbHome</para></listitem>
<listitem><para>scriptPath</para></listitem>
<listitem><para>logonPath</para></listitem>
<listitem><para>homeDrive</para></listitem>
</itemizedlist>
<para>
These attributes are only stored with the sambaAccount entry if
the values are non-default values. For example, assume TASHTEGO has now been
configured as a PDC and that <command>logon home = \\%L\%u</command> was defined in
its <filename>smb.conf</filename> file. When a user named "becky" logons to the domain,
the <parameter>logon home</parameter> string is expanded to \\TASHTEGO\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 <parameter>logon home</parameter> 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. \\MOBY\becky).
</para>
</sect2>
<sect2>
<title>Example LDIF Entries for a sambaAccount</title>
<para>
The following is a working LDIF with the inclusion of the posixAccount objectclass:
</para>
<para><programlisting>
dn: uid=guest2, ou=people,dc=plainjoe,dc=org
ntPassword: 878D8014606CDA29677A44EFA1353FC7
pwdMustChange: 2147483647
primaryGroupID: 1201
lmPassword: 552902031BEDE9EFAAD3B435B51404EE
pwdLastSet: 1010179124
logonTime: 0
objectClass: sambaAccount
uid: guest2
kickoffTime: 2147483647
acctFlags: [UX ]
logoffTime: 2147483647
rid: 19006
pwdCanChange: 0
</programlisting></para>
<para>
The following is an LDIF entry for using both the sambaAccount and
posixAccount objectclasses:
</para>
<para><programlisting>
dn: uid=gcarter, ou=people,dc=plainjoe,dc=org
logonTime: 0
displayName: Gerald Carter
lmPassword: 552902031BEDE9EFAAD3B435B51404EE
primaryGroupID: 1201
objectClass: posixAccount
objectClass: sambaAccount
acctFlags: [UX ]
userPassword: {crypt}BpM2ej8Rkzogo
uid: gcarter
uidNumber: 9000
cn: Gerald Carter
loginShell: /bin/bash
logoffTime: 2147483647
gidNumber: 100
kickoffTime: 2147483647
pwdLastSet: 1010179230
rid: 19000
homeDirectory: /home/tashtego/gcarter
pwdCanChange: 0
pwdMustChange: 2147483647
ntPassword: 878D8014606CDA29677A44EFA1353FC7
</programlisting></para>
</sect2>
</sect1>
<sect1>
<title>MySQL</title>
<sect2>
<title>Creating the database</title>
<para>
You either can set up your own table and specify the field names to pdb_mysql (see below
for the column names) or use the default table. The file <filename>examples/pdb/mysql/mysql.dump</filename>
contains the correct queries to create the required tables. Use the command :
<command>mysql -u<replaceable>username</replaceable> -h<replaceable>hostname</replaceable> -p<replaceable>password</replaceable> <replaceable>databasename</replaceable> &gt; <filename>/path/to/samba/examples/pdb/mysql/mysql.dump</filename></command>
</para>
</sect2>
<sect2>
<title>Configuring</title>
<para>This plugin lacks some good documentation, but here is some short info:</para>
<para>Add a the following to the <command>passdb backend</command> variable in your <filename>smb.conf</filename>:
<programlisting>
passdb backend = [other-plugins] mysql:identifier [other-plugins]
</programlisting>
</para>
<para>The identifier can be any string you like, as long as it doesn't collide with
the identifiers of other plugins or other instances of pdb_mysql. If you
specify multiple pdb_mysql.so entries in 'passdb backend', you also need to
use different identifiers!
</para>
<para>
Additional options can be given thru the smb.conf file in the [global] section.
</para>
<para><programlisting>
identifier:mysql host - host name, defaults to 'localhost'
identifier:mysql password
identifier:mysql user - defaults to 'samba'
identifier:mysql database - defaults to 'samba'
identifier:mysql port - defaults to 3306
identifier:table - Name of the table containing users
</programlisting></para>
<warning>
<para>
Since the password for the mysql user is stored in the
smb.conf file, you should make the the smb.conf file
readable only to the user that runs samba. This is considered a security
bug and will be fixed soon.
</para>
</warning>
<para>Names of the columns in this table(I've added column types those columns should have first):</para>
<para><programlisting>
identifier:logon time column - int(9)
identifier:logoff time column - int(9)
identifier:kickoff time column - int(9)
identifier:pass last set time column - int(9)
identifier:pass can change time column - int(9)
identifier:pass must change time column - int(9)
identifier:username column - varchar(255) - unix username
identifier:domain column - varchar(255) - NT domain user is part of
identifier:nt username column - varchar(255) - NT username
identifier:fullname column - varchar(255) - Full name of user
identifier:home dir column - varchar(255) - Unix homedir path
identifier:dir drive column - varchar(2) - Directory drive path (eg: 'H:')
identifier:logon script column - varchar(255)
- Batch file to run on client side when logging on
identifier:profile path column - varchar(255) - Path of profile
identifier:acct desc column - varchar(255) - Some ASCII NT user data
identifier:workstations column - varchar(255)
- Workstations user can logon to (or NULL for all)
identifier:unknown string column - varchar(255) - unknown string
identifier:munged dial column - varchar(255) - ?
identifier:user sid column - varchar(255) - NT user SID
identifier:group sid column - varchar(255) - NT group ID
identifier:lanman pass column - varchar(255) - encrypted lanman password
identifier:nt pass column - varchar(255) - encrypted nt passwd
identifier:plain pass column - varchar(255) - plaintext password
identifier:acct control column - int(9) - nt user data
identifier:unknown 3 column - int(9) - unknown
identifier:logon divs column - int(9) - ?
identifier:hours len column - int(9) - ?
identifier:unknown 5 column - int(9) - unknown
identifier:unknown 6 column - int(9) - unknown
</programlisting></para>
<para>
Eventually, you can put a colon (:) after the name of each column, which
should specify the column to update when updating the table. You can also
specify nothing behind the colon - then the data from the field will not be
updated.
</para>
</sect2>
<sect2>
<title>Using plaintext passwords or encrypted password</title>
<para>
I strongly discourage the use of plaintext passwords, however, you can use them:
</para>
<para>
If you would like to use plaintext passwords, set
'identifier:lanman pass column' and 'identifier:nt pass column' to
'NULL' (without the quotes) and 'identifier:plain pass column' to the
name of the column containing the plaintext passwords.
</para>
<para>
If you use encrypted passwords, set the 'identifier:plain pass
column' to 'NULL' (without the quotes). This is the default.
</para>
</sect2>
<sect2>
<title>Getting non-column data from the table</title>
<para>
It is possible to have not all data in the database and making some 'constant'.
</para>
<para>
For example, you can set 'identifier:fullname column' to :
<command>CONCAT(First_name,' ',Sur_name)</command>
</para>
<para>
Or, set 'identifier:workstations column' to :
<command>NULL</command></para>
<para>See the MySQL documentation for more language constructs.</para>
</sect2>
</sect1>
<sect1>
<title>XML</title>
<para>This module requires libxml2 to be installed.</para>
<para>The usage of pdb_xml is pretty straightforward. To export data, use:
</para>
<para>
<userinput>pdbedit -e xml:filename</userinput>
</para>
<para>
(where filename is the name of the file to put the data in)
</para>
<para>
To import data, use:
<userinput>pdbedit -i xml:filename -e current-pdb</userinput>
</para>
<para>
Where filename is the name to read the data from and current-pdb to put it in.
</para>
</sect1>
</chapter>

1038
docs/docbook/projdoc/printer_driver2.xml Normal file
View File

File diff suppressed because it is too large Load Diff

133
docs/docbook/projdoc/samba-doc.xml Normal file
View File

@ -0,0 +1,133 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE book SYSTEM "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % globalentities SYSTEM '../global.ent'> %globalentities;
]>
<book id="Samba-HOWTO-Collection">
<title>SAMBA Project Documentation</title>
<bookinfo>
<author>
<othername>SAMBA Team</othername>
<affiliation><address><email>samba@samba.org</email></address></affiliation>
</author>
<editor>&person.jelmer;</editor>
<editor>&person.jht;</editor>
<editor>&person.jerry;</editor>
<pubdate>Monday April 21, 2003</pubdate>
<abstract>
<para>
This book is a collection of HOWTOs added to Samba documentation over the years.
Samba is always under development, and so is its' documentation. This release of the
documentation represents a major revision or layout as well as contents.
The most recent version of this document can be found at
<ulink url="http://www.samba.org/">http://www.samba.org/</ulink>
on the "Documentation" page. Please send updates to
<ulink url="mailto:jelmer@samba.org">Jelmer Venrooij</ulink>,
<ulink url="mailto:jht@samba.org">John Terpstra</ulink> or
<ulink url="mailto:jerry@samba.org">Gerald (Jerry) Carter</ulink>.
</para>
<para>
The Samba-Team would like to express sincere thanks to the many people who have with
or without their knowledge contributed to this update. The size and scope of this
project would not have been possible without significant community contribution. A not
insignificant number of ideas for inclusion (if not content itself) has been obtained
from a number of Unofficial HOWTOs - to each such author a big "Thank-you" is also offered.
Please keep publishing your Unofficial HOWTO's - they are a source of inspiration and
application knowledge that is most to be desired by many Samba users and administrators.
</para>
</abstract>
<legalnotice>
<para>
This documentation is distributed under the GNU General Public License (GPL)
version 2. A copy of the license is included with the Samba source
distribution. A copy can be found on-line at <ulink
url="http://www.fsf.org/licenses/gpl.txt">http://www.fsf.org/licenses/gpl.txt</ulink>
</para>
</legalnotice>
</bookinfo>
<!-- Contents -->
<toc/>
<!-- Chapters -->
<part id="introduction">
<title>General Installation</title>
<partintro>
<title>Preparing Samba for Configuration</title>
<para>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.</para>
</partintro>
&IntroSMB;
&UNIX-INSTALL;
</part>
<part id="type">
<title>Server Configuration Basics</title>
<partintro>
<title>First Steps in Server Configuration</title>
<para>
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.
</para>
</partintro>
&ServerType;
&SECURITY-LEVEL;
&Samba-PDC-HOWTO;
&Samba-BDC-HOWTO;
&ADS-HOWTO;
&DOMAIN-MEMBER;
</part>
<part id="optional">
<title>Advanced Configuration</title>
<partintro>
<title>Valuable Nuts and Bolts Information</title>
<para>
Samba has several features that you might want or might not want to use. The chapters in this part each cover specific Samba features.
</para>
</partintro>
&NetworkBrowsing;
&Passdb;
&NT-Security;
&GROUP-MAPPING-HOWTO;
&PRINTER-DRIVER2;
&CUPS;
&WINBIND;
&AdvancedNetworkAdmin;
&PolicyMgmt;
&ProfileMgmt;
&Trusts;
&Samba-PAM;
&VFS;
&MS-Dfs-Setup;
&IntegratingWithWindows;
&SecuringSamba;
&unicode;
&locking;
</part>
<part id="troubleshooting">
<title>Troubleshooting</title>
&Diagnosis;
&problems;
&BUGS;
</part>
<part id="Appendixes">
<title>Appendixes</title>
&Compiling;
&NT4Migration;
&Portability;
&Other-Clients;
&SWAT;
&SPEED;
</part>
</book>

205
docs/docbook/projdoc/securing-samba.xml Normal file
View File

@ -0,0 +1,205 @@
<chapter id="securing-samba">
<chapterinfo>
&author.tridge;
&author.jht;
<pubdate>17 March 2003</pubdate>
</chapterinfo>
<title>Securing Samba</title>
<sect1>
<title>Introduction</title>
<para>
This note was attached to the Samba 2.2.8 release notes as it contained an
important security fix. The information contained here applies to Samba
installations in general.
</para>
</sect1>
<sect1>
<title>Using host based protection</title>
<para>
In many installations of Samba the greatest threat comes for outside
your immediate network. By default Samba will accept 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.
</para>
<para>
One of the simplest fixes in this case is to use the <command>hosts allow</command> and
<command>hosts deny</command> options in the Samba &smb.conf; configuration file to only
allow access to your server from a specific range of hosts. An example
might be:
</para>
<para><programlisting>
hosts allow = 127.0.0.1 192.168.2.0/24 192.168.3.0/24
hosts deny = 0.0.0.0/0
</programlisting></para>
<para>
The above will only allow SMB connections from '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 a
'not listening on called name' error.
</para>
</sect1>
<sect1>
<title>Using interface protection</title>
<para>
By default Samba will accept connections on any network interface that
it finds on your system. That means if you have a ISDN line or a PPP
connection to the Internet then Samba will accept connections on those
links. This may not be what you want.
</para>
<para>
You can change this behaviour using options like the following:
</para>
<para><programlisting>
interfaces = eth* lo
bind interfaces only = yes
</programlisting></para>
<para>
This tells Samba to only listen for connections on interfaces with a
name starting with 'eth' such as eth0, eth1, plus on the loopback
interface called '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.
</para>
<para>
If you use the above and someone tries to make a SMB connection to
your host over a PPP interface called 'ppp0' then they will get a TCP
connection refused reply. In that case no Samba code is run at all as
the operating system has been told not to pass connections from that
interface to any samba process.
</para>
</sect1>
<sect1>
<title>Using a firewall</title>
<para>
Many people use a firewall to deny access to services that they don't
want exposed outside their network. This can be a very good idea,
although I would recommend using it in conjunction with the above
methods so that you are protected even if your firewall is not active
for some reason.
</para>
<para>
If you are setting up a firewall then you need to know what TCP and
UDP ports to allow and block. Samba uses the following:
</para>
<para><programlisting>
UDP/137 - used by nmbd
UDP/138 - used by nmbd
TCP/139 - used by smbd
TCP/445 - used by smbd
</programlisting></para>
<para>
The last one is important as many older firewall setups may not be
aware of it, given that this port was only added to the protocol in
recent years.
</para>
</sect1>
<sect1>
<title>Using a IPC$ share deny</title>
<para>
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.
</para>
<para>
To do that you could use:
</para>
<para><programlisting>
[ipc$]
hosts allow = 192.168.115.0/24 127.0.0.1
hosts deny = 0.0.0.0/0
</programlisting></para>
<para>
this would tell Samba that IPC$ connections are not allowed from
anywhere but the two listed places (localhost and a local
subnet). Connections to other shares would still be allowed. As the
IPC$ share is the only share that is always accessible anonymously
this provides some level of protection against attackers that do not
know a username/password for your host.
</para>
<para>
If you use this method then clients will be given a 'access denied'
reply when they try to access the IPC$ share. That means that those
clients will not be able to browse shares, and may also be unable to
access some other resources.
</para>
<para>
This is not recommended unless you cannot use one of the other
methods listed above for some reason.
</para>
</sect1>
<sect1>
<title>NTLMv2 Security</title>
<para>
To configure NTLMv2 authentication the following registry keys are worth knowing about:
</para>
<para>
<programlisting>
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa]
"lmcompatibilitylevel"=dword:00000003
0x3 - 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.
[HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Lsa\MSV1_0]
"NtlmMinClientSec"=dword:00080000
0x80000 - NTLMv2 session security. If either NtlmMinClientSec or
NtlmMinServerSec is set to 0x80000, the connection will fail if NTLMv2
session security is not negotiated.
</programlisting>
</para>
</sect1>
<sect1>
<title>Upgrading Samba</title>
<para>
Please check regularly on <ulink url="http://www.samba.org/">http://www.samba.org/</ulink> for updates and
important announcements. Occasionally security releases are made and
it is highly recommended to upgrade Samba when a security vulnerability
is discovered.
</para>
</sect1>
</chapter>

340
docs/docbook/projdoc/security_level.xml Normal file
View File

@ -0,0 +1,340 @@
<chapter id="securitylevels">
<chapterinfo>
&author.tridge;
&author.jelmer;
</chapterinfo>
<title>Samba as Stand-Alone Server</title>
<para>
In this section the function and purpose of Samba's <emphasis>security</emphasis>
modes are described.
</para>
<sect1>
<title>User and Share security level</title>
<para>
A SMB server tells the client at startup what "security level" it 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. I know this is
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.
</para>
<sect2>
<title>User Level Security</title>
<para>
I'll describe user level security first, as its simpler. In user level
security the client will send a "session setup" command directly after
the protocol negotiation. This contains a username and password. The
server can either accept or reject that username/password
combination. Note that at this stage the server has no idea what
share the client will eventually try to connect to, so it can't base
the "accept/reject" on anything other than:
</para>
<orderedlist>
<listitem><para>the username/password</para></listitem>
<listitem><para>the machine that the client is coming from</para></listitem>
</orderedlist>
<para>
If the server accepts the username/password then the client expects to
be able to mount any share (using a "tree connection") without
specifying a password. It expects that all access rights will be as
the username/password specified in the "session setup".
</para>
<para>
It is also possible for a client to send multiple "session setup"
requests. When the server responds it gives the client a "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)
</para>
</sect2>
<sect2>
<title>Share Level Security</title>
<para>
Ok, now for share level security. In share level security the client
authenticates itself separately for each share. It will send a
password along with each "tree connection" (share mount). It does not
explicitly send a username with this operation. The client is
expecting 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. It is never explicitly sent the
username. 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 that is authenticated, not a "share/password".
</para>
<para>
Many clients send a "session setup" 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 does a "tree connection" 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 <command>user =</command> &smb.conf;
line. The password is then checked in turn against these "possible
usernames". If a match is found then the client is authenticated as
that user.
</para>
</sect2>
<sect2>
<title>Server Level Security</title>
<para>
Finally "server level" security. In server level security 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 login to the "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
clients connection. This allows the samba server to use another SMB
server as the "password server".
</para>
<para>
You should also note that at the very start of all this, where the
server tells the client what security level it is in, it also tells
the client if it supports encryption. If it does then it supplies the
client with a random "cryptkey". The client will then send all
passwords in encrypted form. You have to compile samba with encryption
enabled to support this feature, and you have to maintain a separate
smbpasswd file with SMB style encrypted passwords. It is
cryptographically impossible to translate from unix style encryption
to SMB style encryption, although there are some fairly simple management
schemes by which the two could be kept in sync.
</para>
<para>
"security = server" means that Samba reports to clients that
it is running in "user mode" but actually passes off all authentication
requests to another "user mode" server. This requires an additional
parameter "password server =" that points to the real authentication server.
That real authentication server can be another Samba server or can be a
Windows NT server, the later natively capable of encrypted password support.
</para>
<note><para>
<emphasis>Server</emphasis> level security is incompatible with what is known
as <emphasis>schannel</emphasis> or "sign and seal" protocols. This means that
if you want to use <emphasis>server</emphasis> level security you must disable
the use of "sign and seal" on all machines on your network.
</para></note>
<sect3>
<title>Configuring Samba for Seemless Windows Network Integration</title>
<para>
MS Windows clients may use encrypted passwords as part of a challenege/response
authentication model (a.k.a. NTLMv1) 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 plain text or encrypted, but
not both in the same authentication request.
</para>
<para>
When encrypted passwords are used a password that has been entered by the user
is encrypted in two ways:
</para>
<itemizedlist>
<listitem><para>An MD4 hash of the UNICODE of the password
string. This is known as the NT hash.
</para></listitem>
<listitem><para>The password is converted to upper case,
and then padded or trucated 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 for the LanMan hash.
</para></listitem>
</itemizedlist>
<para>
MS Windows 95 pre-service pack 1, 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.
</para>
<para>
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.
</para>
<para>
When Microsoft changed the default password mode, support was dropped for caching
of the plain text password. This means that when the registry parameter is changed
to re-enable use of plain text passwords it appears to work, but when a dropped
service connection mapping attempts to revalidate it will fail if the remote
authentication server does not support encrypted passwords. This means that it
is definitely not a good idea to re-enable plain text password support in such clients.
</para>
<para>
The following parameters can be used to work around the issue of Windows 9x client
upper casing usernames and password before transmitting them to the SMB server
when using clear text authentication.
</para>
<para><programlisting>
<ulink url="smb.conf.5.html#PASSWORDLEVEL">passsword level</ulink> = <replaceable>integer</replaceable>
<ulink url="smb.conf.5.html#USERNAMELEVEL">username level</ulink> = <replaceable>integer</replaceable>
</programlisting></para>
<para>
By default Samba will lower case the username before attempting to lookup the user
in the database of local system accounts. Because UNIX usernames conventionally
only contain lower case character, the <parameter>username level</parameter> parameter
is rarely needed.
</para>
<para>
However, passwords on UNIX systems often make use of mixed case characters.
This means that in order for a user on a Windows 9x client to connect to a Samba
server using clear text authentication, the <parameter>password level</parameter>
must be set to the maximum number of upper case letter which <emphasis>could</emphasis>
appear is a password. Note that the server OS uses the traditional DES version
of crypt(), a <parameter>password level</parameter> of 8 will result in case
insensitive passwords as seen from Windows users. This will also result in longer
login times as 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).
</para>
<para>
The best option to adopt is to enable support for encrypted passwords
where ever Samba is used. There are three configuration possibilities
for support of encrypted passwords:
</para>
</sect3>
<sect3>
<title>Use MS Windows NT as an authentication server</title>
<para>
This method involves the additions of the following parameters in the &smb.conf; file:
</para>
<para><programlisting>
encrypt passwords = Yes
security = server
password server = "NetBIOS_name_of_PDC"
</programlisting></para>
<para>
There are two ways of identifying whether or not a username and
password pair was valid or not. One uses the reply information provided
as part of the authentication messaging process, the other uses
just an error code.
</para>
<para>
The down-side of this mode of configuration is the fact 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 username and password pair then an alternative mode
of identification of validation is used. Where a site uses password
lock out after a certain number of failed authentication attempts
this will result in user lockouts.
</para>
<para>
Use of this mode of authentication does require there to be
a standard Unix account for the user, this account can be blocked
to prevent logons by other than MS Windows clients.
</para>
</sect3>
</sect2>
<sect2>
<title>Domain Level Security</title>
<para>
When samba is operating in <emphasis>security = domain</emphasis> mode this means that
the Samba server has a domain security trust account (a machine account) and will cause
all authentication requests to be passed through to the domain controllers.
</para>
<sect3>
<title>Samba as a member of an MS Windows NT security domain</title>
<para>
This method involves addition of the following parameters in the &smb.conf; file:
</para>
<para><programlisting>
encrypt passwords = Yes
security = domain
workgroup = "name of NT domain"
password server = *
</programlisting></para>
<para>
The use of the "*" argument to <command>password server</command> will cause samba to locate the
domain controller in a way analogous to the way this is done within MS Windows NT.
This is the default behaviour.
</para>
<para>
In order for this method to work the Samba server needs to join the
MS Windows NT security domain. This is done as follows:
</para>
<itemizedlist>
<listitem><para>On the MS Windows NT domain controller using
the Server Manager add a machine account for the Samba server.
</para></listitem>
<listitem><para>Next, on the Linux system execute:
<command>smbpasswd -r PDC_NAME -j DOMAIN_NAME</command> (samba 2.x)
<command>net join -U administrator%password</command> (samba-3)
</para></listitem>
</itemizedlist>
<para>
Use of this mode of authentication does require there to be a standard Unix account
for the user in order to assign a uid once the account has been authenticated by
the remote Windows DC. This account can be blocked to prevent logons by clients other than
MS Windows through things such as setting an invalid shell in the
<filename>/etc/passwd</filename> entry.
</para>
<para>
An alternative to assigning UIDs to Windows users on a Samba member server is
presented in the <link linkend="winbind">Winbind Overview</link> chapter
in this HOWTO collection.
</para>
</sect3>
</sect2>
<sect2>
<title>ADS Level Security</title>
<para>
For information about the configuration option please refer to the entire section entitled
<emphasis>Samba as an ADS Domain Member.</emphasis>
</para>
</sect2>
</sect1>
</chapter>

142
docs/docbook/projdoc/unicode.xml Normal file
View File

@ -0,0 +1,142 @@
<chapter id="unicode">
<chapterinfo>
&author.jelmer;
<author>
<firstname>TAKAHASHI</firstname><surname>Motonobu</surname>
<affiliation>
<address><email>monyo@home.monyo.com</email></address>
</affiliation>
</author>
<pubdate>25 March 2003</pubdate>
</chapterinfo>
<title>Unicode/Charsets</title>
<sect1>
<title>What are charsets and unicode?</title>
<para>
Computers communicate in numbers. In texts, each number will be
translated to a corresponding letter. The meaning that will be assigned
to a certain number depends on the <emphasis>character set(charset)
</emphasis> that is used.
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, etc). Usually a charset contains
256 characters, which means that storing a character with it takes
exactly one byte. </para>
<para>
There are also charsets that support even more characters,
but those need twice(or even more) as much storage space. These
charsets can contain <command>256 * 256 = 65536</command> characters, which
is more then all possible characters one could think of. They are called
multibyte charsets (because they use more then one byte to
store one character).
</para>
<para>
A standardised multibyte charset is unicode, info is available at
<ulink url="http://www.unicode.org/">www.unicode.org</ulink>.
A big advantage of using a multibyte charset is that you only need one; no
need to make sure two computers use the same charset when they are
communicating.
</para>
<para>Old windows clients used to use single-byte charsets, named
'codepages' by microsoft. However, there is no support for
negotiating the charset to be used in the smb protocol. Thus, you
have to make sure you are using the same charset when talking to an old client.
Newer clients (Windows NT, 2K, XP) talk unicode over the wire.
</para>
</sect1>
<sect1>
<title>Samba and charsets</title>
<para>
As of samba 3.0, samba can (and will) talk unicode over the wire. Internally,
samba knows of three kinds of character sets:
</para>
<variablelist>
<varlistentry>
<term>unix charset</term>
<listitem><para>
This is the charset used internally by your operating system.
The default is <constant>ASCII</constant>, which is fine for most
systems.
</para></listitem>
</varlistentry>
<varlistentry>
<term>display charset</term>
<listitem><para>This is the charset samba will use to print messages
on your screen. It should generally be the same as the <command>unix charset</command>.
</para></listitem>
</varlistentry>
<varlistentry>
<term>dos charset</term>
<listitem><para>This is the charset samba uses when communicating with
DOS and Windows 9x clients. It will talk unicode to all newer clients.
The default depends on the charsets you have installed on your system.
Run <command>testparm -v | grep "dos charset"</command> to see
what the default is on your system.
</para></listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1>
<title>Conversion from old names</title>
<para>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.</para>
<para>The following script from Steve Langasek converts all
filenames from CP850 to the iso8859-15 charset.</para>
<para>
<prompt>#</prompt><userinput>find <replaceable>/path/to/share</replaceable> -type f -exec bash -c 'CP="{}"; ISO=`echo -n "$CP" | iconv -f cp850 \
-t iso8859-15`; if [ "$CP" != "$ISO" ]; then mv "$CP" "$ISO"; fi' \;
</userinput>
</para>
</sect1>
<sect1>
<title>Japanese charsets</title>
<para>Samba doesn't work correctly with Japanese charsets yet. Here are
points of attention when setting it up:</para>
<itemizedlist>
<listitem><para>You should set <command>mangling method =
hash</command></para></listitem>
<listitem><para>There are various iconv() implementations around and not
all of them work equally well. glibc2's iconv() has a critical problem
in CP932. libiconv-1.8 works with CP932 but still has some problems and
does not work with EUC-JP.</para></listitem>
<listitem><para>You should set <command>dos charset = CP932</command>, not
Shift_JIS, SJIS...</para></listitem>
<listitem><para>Currently only <command>unix charset = CP932</command>
will work (but still has some problems...) because of iconv() issues.
<command>unix charset = EUC-JP</command> doesn't work well because of
iconv() issues.</para></listitem>
<listitem><para>Currently Samba 3.0 does not support <command>unix charset
= UTF8-MAC/CAP/HEX/JIS*</command></para></listitem>
</itemizedlist>
<para>More information (in Japanese) is available at: <ulink url="http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html">http://www.atmarkit.co.jp/flinux/special/samba3/samba3a.html</ulink>.</para>
</sect1>
</chapter>

36
docs/docbook/projdoc/upgrading-to-3.0.xml Normal file
View File

@ -0,0 +1,36 @@
<chapter id="upgrading-to-3.0">
<chapterinfo>
&author.jelmer;
<pubdate>25 October 2002</pubdate>
</chapterinfo>
<title>Issues when upgrading from 2.2 to 3.0</title>
<sect1>
<title>Charsets</title>
<para>You might experience problems with special characters
when communicating with old DOS clients. Codepage
support has changed in samba 3.0. Read the chapter
<link linkend="unicode">Unicode support</link> for details.
</para>
</sect1>
<sect1>
<title>Obsolete configuration options</title>
<para>
In 3.0, the following configuration options have been removed.
</para>
<simplelist>
<member>printer driver (replaced by new driver procedures) </member>
<member>printer driver file (replaced by new driver procedures)</member>
<member>printer driver location (replaced by new driver procedures)</member>
<member>use rhosts</member>
<member>postscript</member>
<member>client code page (replaced by dos charset)</member>
</simplelist>
</sect1>
</chapter>

1169
docs/docbook/projdoc/winbind.xml Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/docbook/smbdotconf/.cvsignore Normal file
View File

@ -0,0 +1,3 @@
parameters.all.xml
parameters.global.xml
parameters.service.xml

87
docs/docbook/smbdotconf/expand-smb.conf.xsl Normal file
View File

@ -0,0 +1,87 @@
<?xml version='1.0'?>
<!-- vim:set sts=2 shiftwidth=2 syntax=xml: -->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:exsl="http://exslt.org/common"
xmlns:samba="http://samba.org/common"
version="1.1"
extension-element-prefixes="exsl">
<xsl:output method="xml"/>
<!-- Generates one big XML file for smb.conf -->
<xsl:param name="xmlSambaNsUri" select="'http://samba.org/common'"/>
<xsl:template match="refentry">
<xsl:text disable-output-escaping="yes">
&lt;!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
&lt;!ENTITY % globalentities SYSTEM './../global.ent'> %globalentities;
]>
</xsl:text>
<xsl:element name="refentry">
<xsl:attribute name="id"><xsl:value-of select="@id"/></xsl:attribute>
<xsl:apply-templates/>
</xsl:element>
</xsl:template>
<!-- This is needed to copy content unchanged -->
<xsl:template match="@*|node()">
<xsl:copy>
<xsl:apply-templates select="@*|node()"/>
</xsl:copy>
</xsl:template>
<xsl:template match="//samba:parameter">
<!-- reconstruct varlistentry - not all of them will go into separate files
and also we must repair the main varlistentry itself.
-->
<xsl:message>
<xsl:text>Processing samba:parameter (</xsl:text>
<xsl:value-of select="@name"/>
<xsl:text>)</xsl:text>
</xsl:message>
<xsl:variable name="name"><xsl:value-of select="translate(translate(string(@name),' ',''),
'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"/>
</xsl:variable>
<xsl:variable name="anchor">
<xsl:element name="anchor">
<xsl:attribute name="id">
<xsl:value-of select="$name"/>
</xsl:attribute>
</xsl:element>
</xsl:variable>
<xsl:variable name="context">
<xsl:text> (</xsl:text>
<xsl:value-of select="@context"/>
<xsl:text>)</xsl:text>
</xsl:variable>
<xsl:variable name="term">
<xsl:element name="term">
<xsl:copy-of select="$anchor"/>
<xsl:value-of select="@name"/>
<xsl:value-of select="$context"/>
</xsl:element>
</xsl:variable>
<xsl:variable name="content">
<xsl:apply-templates/>
</xsl:variable>
<xsl:element name="varlistentry">
<xsl:text>&#10;</xsl:text>
<xsl:copy-of select="$term"/>
<xsl:copy-of select="$content"/>
<xsl:text>
</xsl:text>
</xsl:element>
</xsl:template>
</xsl:stylesheet>

22
docs/docbook/smbdotconf/printing/maxreportedprintjobs.xml Normal file
View File

@ -0,0 +1,22 @@
<samba:parameter name="max reported print jobs"
context="S"
print="1"
xmlns:samba="http://samba.org/common">
<listitem>
<para>This parameter limits the maximum number of
jobs displayed in a port monitor for Samba printer queue at any given
moment. If this number is exceeded, the excess jobs will not be shown.
A value of zero means there is no limit on the number of print
jobs reported.
See all <link linkend="TOTALPRINTJOBS"><parameter moreinfo="none">total
print jobs</parameter></link> and <link
linkend="MAXPRINTJOBS"><parameter moreinfo="none">max print
jobs</parameter></link> parameters.
</para>
<para>Default: <command moreinfo="none">max reported print jobs = 0</command></para>
<para>Example: <command moreinfo="none">max reported print jobs = 1000</command></para>
</listitem>
</samba:parameter>

Some files were not shown because too many files have changed in this diff Show More