This commit was manufactured by cvs2svn to create branch 'SAMBA_3_0'.(This used to...
authorcvs2svn Import User <samba-bugs@samba.org>
Wed, 25 Sep 2002 12:59:48 +0000 (12:59 +0000)
committercvs2svn Import User <samba-bugs@samba.org>
Wed, 25 Sep 2002 12:59:48 +0000 (12:59 +0000)
80 files changed:
docs/docbook/devdoc/CodingSuggestions.sgml [new file with mode: 0644]
docs/docbook/devdoc/NetBIOS.sgml [new file with mode: 0644]
docs/docbook/devdoc/Tracing.sgml [new file with mode: 0644]
docs/docbook/devdoc/architecture.sgml [new file with mode: 0644]
docs/docbook/devdoc/cifsntdomain.sgml [new file with mode: 0644]
docs/docbook/devdoc/debug.sgml [new file with mode: 0644]
docs/docbook/devdoc/dev-doc.sgml [new file with mode: 0644]
docs/docbook/devdoc/internals.sgml [new file with mode: 0644]
docs/docbook/devdoc/parsing.sgml [new file with mode: 0644]
docs/docbook/devdoc/unix-smb.sgml [new file with mode: 0644]
docs/docbook/manpages/vfstest.1.sgml [new file with mode: 0644]
docs/docbook/projdoc/GROUP-MAPPING-HOWTO.sgml [new file with mode: 0644]
docs/docbook/projdoc/Other-Clients.sgml [new file with mode: 0644]
docs/docbook/projdoc/Portability.sgml [new file with mode: 0644]
docs/docbook/samba.dsl [new file with mode: 0644]
docs/manpages/vfstest.1 [new file with mode: 0644]
examples/VFS/README.netatalk [new file with mode: 0644]
examples/VFS/netatalk.c [new file with mode: 0644]
examples/sam/Makefile.in [new file with mode: 0644]
examples/sam/README [new file with mode: 0644]
examples/sam/sam_skel.c [new file with mode: 0644]
source3/include/nt_status.h [new file with mode: 0644]
source3/include/sam.h [new file with mode: 0644]
source3/lib/gencache.c [new file with mode: 0644]
source3/lib/sendfile.c [new file with mode: 0644]
source3/libads/ads_utils.c [new file with mode: 0644]
source3/nsswitch/winbind_client.h [new file with mode: 0644]
source3/python/.cvsignore [new file with mode: 0644]
source3/python/README [new file with mode: 0644]
source3/python/examples/spoolss/changeid.py [new file with mode: 0755]
source3/python/examples/spoolss/enumprinters.py [new file with mode: 0755]
source3/python/examples/spoolss/psec.py [new file with mode: 0755]
source3/python/examples/tdbpack/tdbtimetrial.py [new file with mode: 0755]
source3/python/examples/tdbpack/test_tdbpack.py [new file with mode: 0755]
source3/python/gprinterdata [new file with mode: 0755]
source3/python/gtdbtool [new file with mode: 0755]
source3/python/gtkdictbrowser.py [new file with mode: 0755]
source3/python/py_common.c [new file with mode: 0644]
source3/python/py_conv.c [new file with mode: 0644]
source3/python/py_conv.h [new file with mode: 0644]
source3/python/py_samba.c [new file with mode: 0644]
source3/python/py_samr.c [new file with mode: 0644]
source3/python/py_samr_conv.c [new file with mode: 0644]
source3/python/py_spoolss.c [new file with mode: 0644]
source3/python/py_spoolss_drivers.c [new file with mode: 0644]
source3/python/py_spoolss_drivers_conv.c [new file with mode: 0644]
source3/python/py_spoolss_forms.c [new file with mode: 0644]
source3/python/py_spoolss_jobs.c [new file with mode: 0644]
source3/python/py_spoolss_printerdata.c [new file with mode: 0644]
source3/python/py_spoolss_printers.c [new file with mode: 0644]
source3/python/py_spoolss_printers_conv.c [new file with mode: 0644]
source3/python/py_spoolss_proto.h [new file with mode: 0644]
source3/python/py_tdbpack.c [new file with mode: 0644]
source3/python/py_winbind.c [new file with mode: 0644]
source3/python/py_winbind_conv.c [new file with mode: 0644]
source3/python/samba/.cvsignore [new file with mode: 0644]
source3/python/samba/__init__.py [new file with mode: 0644]
source3/python/samba/printerdata.py [new file with mode: 0644]
source3/python/setup.py [new file with mode: 0755]
source3/registry/reg_objects.c [new file with mode: 0644]
source3/sam/account.c [new file with mode: 0644]
source3/sam/api.c [new file with mode: 0644]
source3/sam/get_set_account.c [new file with mode: 0644]
source3/sam/get_set_domain.c [new file with mode: 0644]
source3/sam/get_set_group.c [new file with mode: 0644]
source3/sam/group.c [new file with mode: 0644]
source3/sam/interface.c [new file with mode: 0644]
source3/sam/sam_plugin.c [new file with mode: 0644]
source3/script/find_missing_doc.pl [new file with mode: 0755]
source3/torture/cmd_sam.c [new file with mode: 0644]
source3/torture/cmd_vfs.c [new file with mode: 0644]
source3/torture/samtest.c [new file with mode: 0644]
source3/torture/samtest.h [new file with mode: 0644]
source3/torture/vfstest.c [new file with mode: 0644]
source3/torture/vfstest.h [new file with mode: 0644]
source3/utils/net_ads_cldap.c [new file with mode: 0644]
source3/utils/net_cache.c [new file with mode: 0644]
source3/utils/net_rpc_samsync.c [new file with mode: 0644]
swat/images/wizard.gif [new file with mode: 0644]
testsuite/build_farm/backtrace [new file with mode: 0755]

diff --git a/docs/docbook/devdoc/CodingSuggestions.sgml b/docs/docbook/devdoc/CodingSuggestions.sgml
new file mode 100644 (file)
index 0000000..bdf6d3d
--- /dev/null
@@ -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>
diff --git a/docs/docbook/devdoc/NetBIOS.sgml b/docs/docbook/devdoc/NetBIOS.sgml
new file mode 100644 (file)
index 0000000..ec9d3af
--- /dev/null
@@ -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 <1c> <1d> <1e> 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>
diff --git a/docs/docbook/devdoc/Tracing.sgml b/docs/docbook/devdoc/Tracing.sgml
new file mode 100644 (file)
index 0000000..3a0e4ba
--- /dev/null
@@ -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 >& strace.out</command></para>
+
+<para>or with a sh style shell:</para>
+
+<para><command>strace -f -p 3872 > strace.out 2>&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>
diff --git a/docs/docbook/devdoc/architecture.sgml b/docs/docbook/devdoc/architecture.sgml
new file mode 100644 (file)
index 0000000..312a63a
--- /dev/null
@@ -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>
diff --git a/docs/docbook/devdoc/cifsntdomain.sgml b/docs/docbook/devdoc/cifsntdomain.sgml
new file mode 100644 (file)
index 0000000..f64e1b3
--- /dev/null
@@ -0,0 +1,2923 @@
+<chapter id="ntdomain">
+<chapterinfo>
+       <author>
+               <firstname>Luke</firstname><surname>Leighton</surname>
+               <affiliation><address><email>lkcl@switchboard.net</email></address></affiliation>
+       </author>
+       <author>
+               <firstname>Paul</firstname><surname>Ashton</surname>
+               <affiliation><address><email>paul@argo.demon.co.uk</email></address></affiliation>
+       </author>
+       <author>
+               <firstname>Duncan</firstname><surname>Stansfield</surname>
+               <affiliation><address><email>duncans@sco.com</email></address></affiliation>
+       </author>
+
+       <pubdate>01 November 97(version 0.0.24)</pubdate>
+</chapterinfo>
+
+<title>NT Domain RPC's</title>
+
+<sect1>
+<title>Introduction</title>
+
+
+<para>
+This document contains information to provide an NT workstation with login
+services, without the need for an NT server. It is the sgml version of <ulink url="http://mailhost.cb1.com/~lkcl/cifsntdomain.txt">http://mailhost.cb1.com/~lkcl/cifsntdomain.txt</ulink>, controlled by Luke.
+</para>
+
+<para>
+It should be possible to select a domain instead of a workgroup (in the NT
+workstation's TCP/IP settings) and after the obligatory reboot, type in a
+username, password, select a domain and successfully log in.  I would
+appreciate any feedback on your experiences with this process, and any
+comments, corrections and additions to this document.
+</para>
+
+<para>
+The packets described here can be easily derived from (and are probably
+better understood using) Netmon.exe.  You will need to use the version
+of Netmon that matches your system, in order to correctly decode the
+NETLOGON, lsarpc and srvsvc Transact pipes.  This document is derived from
+NT Service Pack 1 and its corresponding version of Netmon.  It is intended
+that an annotated packet trace be produced, which will likely be more
+instructive than this document.
+</para>
+
+<para>
+Also needed, to fully implement NT Domain Login Services, is the 
+document describing the cryptographic part of the NT authentication.
+This document is available from comp.protocols.smb; from the ntsecurity.net
+digest and from the samba digest, amongst other sources.
+</para>
+
+<para>
+A copy is available from:
+</para>
+
+<para><ulink url="http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935">http://ntbugtraq.rc.on.ca/SCRIPTS/WA.EXE?A2=ind9708;L=ntbugtraq;O=A;P=2935</ulink></para>
+
+<para><ulink url="http://mailhost.cb1.com/~lkcl/crypt.html">http://mailhost.cb1.com/~lkcl/crypt.html</ulink></para>
+
+<para>
+A c-code implementation, provided by <ulink url="mailto:linus@incolumitas.se">Linus Nordberg</ulink>
+of this protocol is available from:
+</para>
+
+<para><ulink url="http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html">http://samba.org/cgi-bin/mfs/01/digest/1997/97aug/0391.html</ulink></para>
+<para><ulink url="http://mailhost.cb1.com/~lkcl/crypt.txt">http://mailhost.cb1.com/~lkcl/crypt.txt</ulink></para>
+
+<para>
+Also used to provide debugging information is the Check Build version of
+NT workstation, and enabling full debugging in NETLOGON.  This is
+achieved by setting the following REG_SZ registry key to 0x1ffffff:
+</para>
+
+<para><filename>HKLM\SYSTEM\CurrentControlSet\Services\Netlogon\Parameters</filename></para>
+
+<para><emphasis>Incorrect direct editing of the registry can cause your
+machine to fail. Then again, so can incorrect implementation of this 
+protocol. See "Liability:" above.</emphasis></para>
+
+<para>
+Bear in mind that each packet over-the-wire will have its origin in an
+API call.  Therefore, there are likely to be structures, enumerations
+and defines that are usefully documented elsewhere.
+</para>
+
+<para>
+This document is by no means complete or authoritative.  Missing sections
+include, but are not limited to:
+</para>
+
+
+<orderedlist>
+
+<listitem><para>Mappings of RIDs to usernames (and vice-versa).</para></listitem>
+
+<listitem><para>What a User ID is and what a Group ID is.</para></listitem>
+
+<listitem><para>The exact meaning/definition of various magic constants or enumerations.</para></listitem>
+
+<listitem><para>The reply error code and use of that error code when a
+workstation becomes a member of a domain (to be described later).  
+Failure to return this error code will make the workstation report 
+that it is already a member of the domain.</para></listitem>
+
+<listitem><para>the cryptographic side of the NetrServerPasswordSet command, 
+which would allow the workstation to change its password.  This password is
+used to generate the long-term session key.  [It is possible to reject this
+command, and keep the default workstation password].</para></listitem>
+
+</orderedlist>
+
+<sect2>
+<title>Sources</title>
+
+<simplelist>
+<member>cket Traces from Netmonitor (Service Pack 1 and above)</member>
+<member>ul Ashton and Luke Leighton's other "NT Domain" doc.</member>
+<member>FS documentation - cifs6.txt</member>
+<member>FS documentation - cifsrap2.txt</member>
+</simplelist>
+
+</sect2>
+
+<sect2>
+<title>Credits</title>
+
+<simplelist> 
+<member>Paul Ashton: loads of work with Net Monitor; understanding the NT authentication system; reference implementation of the NT domain support on which this document is originally based.</member>
+<member>Duncan Stansfield: low-level analysis of MSRPC Pipes.</member>
+<member>Linus Nordberg: producing c-code from Paul's crypto spec.</member>
+<member>Windows Sourcer development team</member>
+</simplelist>
+
+</sect2>
+
+</sect1>
+
+<sect1>
+<title>Notes and Structures</title>
+
+<sect2>
+<title>Notes</title>
+
+<orderedlist>
+<listitem><para>
+In the SMB Transact pipes, some "Structures", described here, appear to be
+4-byte aligned with the SMB header, at their start.  Exactly which
+"Structures" need aligning is not precisely known or documented.
+</para></listitem>
+
+<listitem><para>
+In the UDP NTLOGON Mailslots, some "Structures", described here, appear to be
+2-byte aligned with the start of the mailslot, at their start.
+</para></listitem>
+
+<listitem><para>
+Domain SID is of the format S-revision-version-auth1-auth2...authN.
+e.g S-1-5-123-456-789-123-456.  the 5 could be a sub-revision.
+</para></listitem>
+
+<listitem><para>
+any undocumented buffer pointers must be non-zero if the string buffer it
+refers to contains characters.  exactly what value they should be is unknown.
+0x0000 0002 seems to do the trick to indicate that the buffer exists.  a
+NULL buffer pointer indicates that the string buffer is of zero length.
+If the buffer pointer is NULL, then it is suspected that the structure it
+refers to is NOT put into (or taken out of) the SMB data stream.  This is
+empirically derived from, for example, the LSA SAM Logon response packet,
+where if the buffer pointer is NULL, the user information is not inserted
+into the data stream.  Exactly what happens with an array of buffer pointers
+is not known, although an educated guess can be made.
+</para></listitem>
+
+<listitem><para>
+an array of structures (a container) appears to have a count and a pointer.
+if the count is zero, the pointer is also zero.  no further data is put
+into or taken out of the SMB data stream.  if the count is non-zero, then
+the pointer is also non-zero.  immediately following the pointer is the
+count again, followed by an array of container sub-structures.  the count
+appears a third time after the last sub-structure.
+</para></listitem>
+</orderedlist>
+
+</sect2>
+
+<sect2>
+<title>Enumerations</title>
+
+<sect3>
+<title>MSRPC Header type</title>
+<para>command number in the msrpc packet header</para>
+
+<variablelist>
+<varlistentry>
+       <term>MSRPC_Request:</term>
+       <listitem><para>0x00</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>MSRPC_Response:</term>
+       <listitem><para>0x02</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>MSRPC_Bind:</term>
+       <listitem><para>0x0B</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>MSRPC_BindAck:</term>
+       <listitem><para>0x0C</para></listitem>
+</varlistentry>
+</variablelist>
+</sect3>
+
+<sect3>
+<title>MSRPC Packet info</title>
+
+<para>The meaning of these flags is undocumented</para>
+
+<variablelist>
+<varlistentry>
+       <term>FirstFrag:</term>
+       <listitem><para>0x01 </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LastFrag:</term>
+       <listitem><para>0x02 </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NotaFrag:</term>
+       <listitem><para>0x04  </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>RecRespond:</term>
+       <listitem><para>0x08  </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NoMultiplex:</term>
+       <listitem><para>0x10  </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NotForIdemp:</term>
+       <listitem><para>0x20  </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NotforBcast:</term>
+       <listitem><para>0x40  </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NoUuid:</term>
+       <listitem><para>0x80 </para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>Structures</title>
+
+<sect3><title>VOID *</title>
+<para>sizeof VOID* is 32 bits.</para>
+</sect3>
+
+<sect3><title>char</title>
+<para>sizeof char is 8 bits.</para>
+</sect3>
+
+<sect3><title>UTIME</title>
+<para>UTIME is 32 bits, indicating time in seconds since 01jan1970.  documented in cifs6.txt (section 3.5 page, page 30).</para>
+</sect3>
+
+<sect3><title>NTTIME</title>
+<para>NTTIME is 64 bits.  documented in cifs6.txt (section 3.5 page, page 30).</para>
+</sect3>
+
+<sect3>
+<title>DOM_SID (domain SID structure)</title>
+
+<variablelist>
+
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num of sub-authorities in domain SID</para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>UINT8</term>
+       <listitem><para>SID revision number</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8</term>
+       <listitem><para>num of sub-authorities in domain SID</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[6]</term>
+       <listitem><para>6 bytes for domain SID - Identifier Authority.</para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>UINT16[n_subauths]</term>
+       <listitem><para>domain SID sub-authorities</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+<para><emphasis>Note: the domain SID is documented elsewhere.</emphasis>
+</para>
+
+</sect3>
+
+<sect3>
+<title>STR (string)</title>
+
+<para>STR (string) is a char[] : a null-terminated string of ascii characters.</para>
+
+</sect3>
+
+<sect3>
+<title>UNIHDR (unicode string header) </title>
+
+<variablelist>
+
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>length of unicode string</para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>max length of unicode string</para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>4 - undocumented.</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>UNIHDR2 (unicode string header plus buffer pointer)</title>
+
+<variablelist>
+
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>unicode string header</para></listitem>
+</varlistentry>
+
+
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>UNISTR (unicode string)</title>
+
+<variablelist>
+
+<varlistentry>
+       <term>UINT16[]</term>
+       <listitem><para>null-terminated string of unicode characters.</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>NAME (length-indicated unicode string)</title>
+
+<variablelist>
+
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>length of unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16[]</term>
+       <listitem><para>null-terminated string of unicode characters.</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>UNISTR2 (aligned unicode string)</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>padding to get unicode string 4-byte aligned with the start of the SMB header.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>max length of unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>length of unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16[]</term>
+       <listitem><para>string of uncode characters</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>OBJ_ATTR (object attributes)</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>0x18 - length (in bytes) including the length field.</para></listitem></varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>0 - root directory (pointer)</para></listitem></varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>0 - object name (pointer)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>0 - attributes (undocumented)</para></listitem></varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>0 - security descriptior (pointer)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - security quality of service</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>POL_HND (LSA policy handle)</title>
+
+<variablelist>
+<varlistentry>
+       <term>char[20]</term>
+       <listitem><para>policy handle</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>DOM_SID2 (domain SID structure, SIDS stored in unicode)</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>5 - SID type</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR2</term>
+       <listitem><para>domain SID unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>domain SID unicode string</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para><emphasis>Note:  there is a conflict between the unicode string header and the unicode string itself as to which to use to indicate string length.  this will need to be resolved.</emphasis></para>
+
+<para><emphasis>Note:  the SID type indicates, for example, an alias; a well-known group etc. this is documented somewhere.</emphasis></para>
+
+</sect3>
+
+<sect3>
+<title>DOM_RID (domain RID structure)</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>5 - well-known SID.  1 - user SID (see ShowACLs)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>5 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>domain RID </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - domain index out of above reference domains</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>LOG_INFO (server, account, client structure)</title>
+
+<para><emphasis>Note:  logon server name starts with two '\' characters and is upper case.</emphasis></para>
+
+<para><emphasis>Note:  account name is the logon client name from the LSA Request Challenge, with a $ on the end of it, in upper case.</emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon server unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>account name unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>sec_chan - security channel type</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon client machine unicode string</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>CLNT_SRV (server, client names structure)</title>
+
+<para><emphasis>Note:  logon server name starts with two '\' characters and is upper case.</emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon server unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon client machine unicode string</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>CREDS (credentials + time stamp)</title>
+
+<variablelist>
+<varlistentry>
+       <term>char[8]</term>
+       <listitem><para>credentials</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UTIME</term>
+       <listitem><para>time stamp</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>CLNT_INFO2 (server, client structure, client credentials)</title>
+
+<para><emphasis>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will beused in subsequent credential checks.  the presumed intention is to
+       maintain an authenticated request/response trail.</emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>CLNT_SRV</term>
+       <listitem><para>client and server names</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>???? padding, for 4-byte alignment with SMB header.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>pointer to client credentials.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>CREDS</term>
+       <listitem><para>client-calculated credentials + client time</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>CLNT_INFO (server, account, client structure, client credentials)</title>
+<para><emphasis>Note: whenever this structure appears in a request, you must take a copy of the client-calculated credentials received, because they will be used in subsequent credential checks.  the presumed intention is to maintain an authenticated request/response trail.</emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>LOG_INFO</term>
+       <listitem><para>logon account info</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>CREDS</term>
+       <listitem><para>client-calculated credentials + client time</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>ID_INFO_1 (id info structure, auth level 1)</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>ptr_id_info_1</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>domain name unicode header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>param control</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT64</term>
+       <listitem><para>logon ID</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>user name unicode header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>workgroup name unicode header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[16]</term>
+       <listitem><para>arc4 LM OWF Password</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[16]</term>
+       <listitem><para>arc4 NT OWF Password</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>domain name unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>user name unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>workstation name unicode string</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>SAM_INFO (sam logon/logoff id info structure)</title>
+
+<para><emphasis>Note: presumably, the return credentials is supposedly for the server to verify that the credential chain hasn't been compromised.</emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>CLNT_INFO2</term>
+       <listitem><para>client identification/authentication info</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>pointer to return credentials.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>CRED</term>
+       <listitem><para>return credentials - ignored.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>logon level</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>switch value</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+<para><programlisting>
+        switch (switch_value)
+        case 1:
+        {
+            ID_INFO_1     id_info_1;
+        }
+</programlisting></para>
+
+</sect3>
+
+<sect3>
+<title>GID (group id info)</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>group id</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>user attributes (only used by NT 3.1 and 3.51)</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>DOM_REF (domain reference info)</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num referenced domains?</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented domain name buffer pointer.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>32 - max number of entries</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>4 - num referenced domains?</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR2</term>
+       <listitem><para>domain name unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR2[num_ref_doms-1]</term>
+       <listitem><para>referenced domain unicode string headers</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>domain name unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>DOM_SID[num_ref_doms]</term>
+       <listitem><para>referenced domain SIDs</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>DOM_INFO (domain info, levels 3 and 5 are the same))</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>??? padding to get 4-byte alignment with start of SMB header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>domain name string length * 2</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>domain name string length * 2</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented domain name string buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>undocumented domain SID string buffer pointer</para></listitem></varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+<listitem><para>domain name (unicode string)</para></listitem></varlistentry>
+<varlistentry>
+       <term>DOM_SID</term>
+       <listitem><para>domain SID</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>USER_INFO (user logon info)</title>
+
+<para><emphasis>Note: it would be nice to know what the 16 byte user session key is for.</emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>NTTIME</term>
+       <listitem><para>logon time</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NTTIME</term>
+       <listitem><para>logoff time</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NTTIME</term>
+       <listitem><para>kickoff time</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NTTIME</term>
+       <listitem><para>password last set time</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NTTIME</term>
+       <listitem><para>password can change time</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NTTIME</term>
+       <listitem><para>password must change time</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>username unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>user's full name unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>logon script unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>profile path unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>home directory unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>home directory drive unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>logon count</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>bad password count</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>User ID</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>Group ID</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num groups</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer to groups.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>user flags</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[16]</term>
+       <listitem><para>user session key</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>logon server unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNIHDR</term>
+       <listitem><para>logon domain unicode string header</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented logon domain id pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[40]</term>
+       <listitem><para>40 undocumented padding bytes.  future expansion?</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - num_other_sids?</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>NULL - undocumented pointer to other domain SIDs.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>username unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>user's full name unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon script unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>profile path unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>home directory unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>home directory drive unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num groups</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>GID[num_groups]</term>
+       <listitem><para>group info</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon server unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon domain unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>DOM_SID</term>
+       <listitem><para>domain SID</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>DOM_SID[num_sids]</term>
+       <listitem><para>other domain SIDs?</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>SH_INFO_1_PTR (pointers to level 1 share info strings)</title>
+
+<para><emphasis>Note:  see cifsrap2.txt section5, page 10.</emphasis></para>
+
+<simplelist>
+<member>0 for shi1_type indicates a  Disk.</member>
+<member>1 for shi1_type indicates a  Print Queue.</member>
+<member>2 for shi1_type indicates a  Device.</member>
+<member>3 for shi1_type indicates an IPC pipe.</member>
+<member>0x8000 0000 (top bit set in shi1_type) indicates a hidden share.</member>
+</simplelist>
+
+<variablelist>
+
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>shi1_netname - pointer to net name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>shi1_type    - type of share.  0 - undocumented.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>shi1_remark  - pointer to comment.</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>SH_INFO_1_STR (level 1 share info strings)</title>
+
+<variablelist>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>shi1_netname - unicode string of net name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>shi1_remark  - unicode string of comment.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>SHARE_INFO_1_CTR</title>
+
+<para>share container with 0 entries:</para>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - EntriesRead</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - Buffer</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>share container with > 0 entries:</para>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>EntriesRead</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>non-zero - Buffer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>EntriesRead</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SH_INFO_1_PTR[EntriesRead]</term>
+       <listitem><para>share entry pointers</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SH_INFO_1_STR[EntriesRead]</term>
+       <listitem><para>share entry strings</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>padding to get unicode string 4-byte aligned with start of the SMB header.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>EntriesRead</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - padding</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>SERVER_INFO_101</title>
+
+<para><emphasis>Note:  see cifs6.txt section 6.4 - the fields described therein will be of assistance here.  for example, the type listed below is the         same as fServerType, which is described in 6.4.1. </emphasis></para>
+
+<variablelist>
+<varlistentry>
+       <term>SV_TYPE_WORKSTATION</term>
+       <listitem><para>0x00000001  All workstations</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_SERVER</term>
+       <listitem><para>0x00000002  All servers</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_SQLSERVER</term>
+       <listitem><para>0x00000004  Any server running with SQL server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_DOMAIN_CTRL</term>
+       <listitem><para>0x00000008  Primary domain controller</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_DOMAIN_BAKCTRL</term>
+       <listitem><para>0x00000010  Backup domain controller</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_TIME_SOURCE</term>
+       <listitem><para>0x00000020  Server running the timesource service</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_AFP</term>
+       <listitem><para>0x00000040  Apple File Protocol servers</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_NOVELL</term>
+       <listitem><para>0x00000080  Novell servers</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_DOMAIN_MEMBER</term>
+       <listitem><para>0x00000100  Domain Member</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_PRINTQ_SERVER</term>
+       <listitem><para>0x00000200  Server sharing print queue</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_DIALIN_SERVER</term>
+       <listitem><para>0x00000400  Server running dialin service.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_XENIX_SERVER</term>
+       <listitem><para>0x00000800  Xenix server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_NT</term>
+       <listitem><para>0x00001000  NT server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_WFW</term>
+       <listitem><para>0x00002000  Server running Windows for </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_SERVER_NT</term>
+       <listitem><para>0x00008000  Windows NT non DC server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_POTENTIAL_BROWSER</term>
+       <listitem><para>0x00010000  Server that can run the browser service</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_BACKUP_BROWSER</term>
+       <listitem><para>0x00020000  Backup browser server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_MASTER_BROWSER</term>
+       <listitem><para>0x00040000  Master browser server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_DOMAIN_MASTER</term>
+       <listitem><para>0x00080000  Domain Master Browser server</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_LOCAL_LIST_ONLY</term>
+       <listitem><para>0x40000000  Enumerate only entries marked "local"</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SV_TYPE_DOMAIN_ENUM</term>
+       <listitem><para>0x80000000  Enumerate Domains. The pszServer and pszDomain parameters must be NULL.</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>500 - platform_id</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>pointer to name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>5 - major version</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>4 - minor version</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>type (SV_TYPE_... bit field)</para></listitem></varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>pointer to comment</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>sv101_name - unicode string of server name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>sv_101_comment  - unicode string of server comment.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>padding to get unicode string 4-byte aligned with start of the SMB header.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+</sect2>
+</sect1>
+
+<sect1>
+<title>MSRPC over Transact Named Pipe</title>
+
+<para>For details on the SMB Transact Named Pipe, see cifs6.txt</para>
+
+<sect2>
+<title>MSRPC Pipes</title>
+
+<para>
+The MSRPC is conducted over an SMB Transact Pipe with a name of 
+<filename>\PIPE\</filename>.  You must first obtain a 16 bit file handle, by
+sending a SMBopenX with the pipe name <filename>\PIPE\srvsvc</filename> for
+example.  You can then perform an SMB Trans,
+and must carry out an SMBclose on the file handle once you are finished.
+</para>
+
+<para>
+Trans Requests must be sent with two setup UINT16s, no UINT16 params (none
+known about), and UINT8 data parameters sufficient to contain the MSRPC
+header, and MSRPC data.  The first UINT16 setup parameter must be either
+0x0026 to indicate an RPC, or 0x0001 to indicate Set Named Pipe Handle
+state.  The second UINT16 parameter must be the file handle for the pipe,
+obtained above.
+</para>
+
+<para>
+The Data section for an API Command of 0x0026 (RPC pipe) in the Trans
+Request is the RPC Header, followed by the RPC Data.  The Data section for
+an API Command of 0x0001 (Set Named Pipe Handle state) is two bytes.  The
+only value seen for these two bytes is 0x00 0x43.
+</para>
+
+<para>
+MSRPC Responses are sent as response data inside standard SMB Trans
+responses, with the MSRPC Header, MSRPC Data and MSRPC tail.
+</para>
+
+<para>
+It is suspected that the Trans Requests will need to be at least 2-byte
+aligned (probably 4-byte).  This is standard practice for SMBs.  It is also
+independent of the observed 4-byte alignments with the start of the MSRPC
+header, including the 4-byte alignment between the MSRPC header and the
+MSRPC data.
+</para>
+
+<para>
+First, an SMBtconX connection is made to the IPC$ share.  The connection
+must be made using encrypted passwords, not clear-text.  Then, an SMBopenX
+is made on the pipe.  Then, a Set Named Pipe Handle State must be sent,
+after which the pipe is ready to accept API commands.  Lastly, and SMBclose
+is sent.
+</para>
+
+<para>
+To be resolved:
+</para>
+
+<para>
+lkcl/01nov97 there appear to be two additional bytes after the null-terminated \PIPE\ name for the RPC pipe.  Values seen so far are
+listed below:</para>
+
+<para><programlisting>
+        initial SMBopenX request:         RPC API command 0x26 params:
+        "\\PIPE\\lsarpc"                  0x65 0x63; 0x72 0x70; 0x44 0x65;
+        "\\PIPE\\srvsvc"                  0x73 0x76; 0x4E 0x00; 0x5C 0x43;
+</programlisting></para>
+
+</sect2>
+
+<sect2>
+<title>Header</title>
+
+<para>[section to be rewritten, following receipt of work by Duncan Stansfield]</para>
+
+<para>Interesting note: if you set packed data representation to 0x0100 0000
+then all 4-byte and 2-byte word ordering is turned around!</para>
+
+<para>The start of each of the NTLSA and NETLOGON named pipes begins with:</para>
+
+<segmentedlist>
+<segtitle>offset</segtitle><segtitle>Variable type</segtitle><segtitle>Variable data</segtitle>
+<seglistitem><seg>00</seg><seg>UINT8</seg><seg>5 - RPC major version</seg></seglistitem>
+<seglistitem><seg>01</seg><seg>UINT8</seg><seg>0 - RPC minor version</seg></seglistitem>
+<seglistitem><seg>02</seg><seg>UINT8</seg><seg>2 - RPC response packet</seg></seglistitem>
+<seglistitem><seg>03</seg><seg>UINT8</seg><seg>3 - (FirstFrag bit-wise or with LastFrag)</seg></seglistitem>
+<seglistitem><seg>04</seg><seg>UINT32</seg><seg>0x1000 0000 - packed data representation</seg></seglistitem>
+<seglistitem><seg>08</seg><seg>UINT16</seg><seg>fragment length - data size (bytes) inc header and tail.</seg></seglistitem>
+<seglistitem><seg>0A</seg><seg>UINT16</seg><seg>0 - authentication length </seg></seglistitem>
+<seglistitem><seg>0C</seg><seg>UINT32</seg><seg>call identifier. matches 12th UINT32 of incoming RPC data.</seg></seglistitem>
+<seglistitem><seg>10</seg><seg>UINT32</seg><seg>allocation hint - data size (bytes) minus header and tail.</seg></seglistitem>
+<seglistitem><seg>14</seg><seg>UINT16</seg><seg>0 - presentation context identifier</seg></seglistitem>
+<seglistitem><seg>16</seg><seg>UINT8</seg><seg>0 - cancel count</seg></seglistitem>
+<seglistitem><seg>17</seg><seg>UINT8</seg><seg>in replies: 0 - reserved; in requests: opnum - see #defines.</seg></seglistitem>
+<seglistitem><seg>18</seg><seg>......</seg><seg>start of data (goes on for allocation_hint bytes)</seg></seglistitem>
+</segmentedlist>
+
+<sect3>
+<title>RPC_Packet for request, response, bind and bind acknowledgement</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT8 versionmaj</term>
+<listitem><para>reply same as request (0x05)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 versionmin</term>
+<listitem><para>reply same as request (0x00)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 type</term>
+<listitem><para>one of the MSRPC_Type enums</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 flags</term>
+<listitem><para>reply same as request (0x00 for Bind, 0x03 for Request)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32 representation</term>
+<listitem><para>reply same as request (0x00000010)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 fraglength</term>
+<listitem><para>the length of the data section of the SMB trans packet</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 authlength</term>
+       <listitem><para></para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32 callid</term>
+<listitem><para>call identifier. (e.g. 0x00149594)</para></listitem></varlistentry>
+<varlistentry>
+       <term>* stub USE TvPacket</term>
+<listitem><para>the remainder of the packet depending on the "type"</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Interface identification</title>
+
+<para>the interfaces are numbered. as yet I haven't seen more than one interface used on the same pipe name srvsvc</para>
+
+<para><programlisting>
+abstract (0x4B324FC8, 0x01D31670, 0x475A7812, 0x88E16EBF, 0x00000003)
+transfer (0x8A885D04, 0x11C91CEB, 0x0008E89F, 0x6048102B, 0x00000002)
+</programlisting></para>
+
+</sect3>
+
+<sect3>
+<title>RPC_Iface RW</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT8 byte[16]</term>
+<listitem><para>16 bytes of number</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32 version</term>
+<listitem><para>the interface number</para></listitem></varlistentry>
+</variablelist>
+
+
+</sect3>
+
+<sect3>
+<title>RPC_ReqBind RW</title>
+
+<para>the remainder of the packet after the header if "type" was Bind in the response header, "type" should be BindAck</para>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16 maxtsize</term>
+<listitem><para>maximum transmission fragment size (0x1630)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 maxrsize</term>
+<listitem><para>max receive fragment size (0x1630)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32 assocgid</term>
+<listitem><para>associated group id (0x0)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32 numelements</term>
+<listitem><para>the number of elements (0x1)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 contextid</term>
+<listitem><para>presentation context identifier (0x0)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 numsyntaxes</term>
+<listitem><para>the number of syntaxes (has always been 1?)(0x1)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry>
+<varlistentry>
+       <term>* abstractint USE RPC_Iface</term>
+<listitem><para>num and vers. of interface client is using</para></listitem></varlistentry>
+<varlistentry>
+       <term>* transferint USE RPC_Iface</term>
+       <listitem><para>num and vers. of interface to use for replies</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>RPC_Address RW</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16 length</term>
+<listitem><para>length of the string including null terminator</para></listitem></varlistentry>
+<varlistentry>
+       <term>* port USE string</term>
+<listitem><para>the string above in single byte, null terminated form</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>RPC_ResBind RW</title>
+
+<para>the response to place after the header in the reply packet</para>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16 maxtsize</term>
+<listitem><para>same as request</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 maxrsize</term>
+<listitem><para>same as request</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32 assocgid</term>
+<listitem><para>zero</para></listitem></varlistentry>
+<varlistentry>
+       <term>* secondaddr USE RPC_Address</term>
+<listitem><para>the address string, as described earlier</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 numresults</term>
+<listitem><para>the number of results (0x01)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+<listitem><para>4-byte alignment padding, against SMB header</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 result</term>
+<listitem><para>result (0x00 = accept)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 reason</term>
+<listitem><para>reason (0x00 = no reason specified)</para></listitem></varlistentry>
+<varlistentry>
+       <term>* transfersyntax USE RPC_Iface</term>
+<listitem><para>the transfer syntax from the request</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>RPC_ReqNorm RW</title>
+
+<para>the remainder of the packet after the header for every other other request</para>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32 allochint</term>
+<listitem><para>the size of the stub data in bytes</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 prescontext</term>
+<listitem><para>presentation context identifier (0x0)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 opnum</term>
+<listitem><para>operation number (0x15)</para></listitem></varlistentry>
+<varlistentry>
+       <term>* stub USE TvPacket</term>
+<listitem><para>a packet dependent on the pipe name (probably the interface) and the op number)</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>RPC_ResNorm RW</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32 allochint</term>
+<listitem><para># size of the stub data in bytes</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16 prescontext</term>
+<listitem><para># presentation context identifier (same as request)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 cancelcount</term>
+<listitem><para># cancel count? (0x0)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8 reserved</term>
+<listitem><para># 0 - one byte padding</para></listitem></varlistentry>
+<varlistentry>
+       <term>* stub USE TvPacket</term>
+<listitem><para># the remainder of the reply</para></listitem></varlistentry>
+</variablelist>
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>Tail</title>
+
+<para>The end of each of the NTLSA and NETLOGON named pipes ends with:</para>
+
+<variablelist>
+<varlistentry>
+       <term>......</term>
+       <listitem><para>end of data</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>return code</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect2>
+
+<sect2>
+<title>RPC Bind / Bind Ack</title>
+
+<para>
+RPC Binds are the process of associating an RPC pipe (e.g \PIPE\lsarpc)
+with a "transfer syntax" (see RPC_Iface structure).  The purpose for doing
+this is unknown.
+</para>
+
+<para><emphasis>Note: The RPC_ResBind SMB Transact request is sent with two uint16 setup parameters.  The first is 0x0026; the second is the file handle
+       returned by the SMBopenX Transact response.</emphasis></para>
+
+<para><emphasis>Note:  The RPC_ResBind members maxtsize, maxrsize and assocgid are the same in the response as the same members in the RPC_ReqBind.  The
+       RPC_ResBind member transfersyntax is the same in the response as
+       the</emphasis></para>
+
+<para><emphasis>Note:  The RPC_ResBind response member secondaddr contains the name of what is presumed to be the service behind the RPC pipe.  The
+       mapping identified so far is:</emphasis></para>
+
+<variablelist>
+
+<varlistentry>
+       <term>initial SMBopenX request:</term>
+       <listitem><para>RPC_ResBind response:</para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>"\\PIPE\\srvsvc"</term>
+       <listitem><para>"\\PIPE\\ntsvcs"</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>"\\PIPE\\samr"</term>
+       <listitem><para>"\\PIPE\\lsass"</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>"\\PIPE\\lsarpc"</term>
+       <listitem><para>"\\PIPE\\lsass"</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>"\\PIPE\\wkssvc"</term>
+       <listitem><para>"\\PIPE\\wksvcs"</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>"\\PIPE\\NETLOGON"</term>
+       <listitem><para>"\\PIPE\\NETLOGON"</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para><emphasis>Note:  The RPC_Packet fraglength member in both the Bind Request and Bind Acknowledgment must contain the length of the entire RPC data, including the RPC_Packet header.</emphasis></para>
+
+<para>Request:</para>
+
+<simplelist>
+<member>RPC_Packet</member>
+<member>RPC_ReqBind</member>
+</simplelist>
+
+<para>Response:</para>
+<simplelist>
+<member>RPC_Packet</member>
+<member>RPC_ResBind</member>
+</simplelist>
+
+</sect2>
+
+<sect2>
+<title>NTLSA Transact Named Pipe</title>
+
+<para>The sequence of actions taken on this pipe are:</para>
+
+<simplelist>
+<member>Establish a connection to the IPC$ share (SMBtconX).  use encrypted passwords.</member>
+<member>Open an RPC Pipe with the name "\\PIPE\\lsarpc".  Store the file handle.</member>
+<member>Using the file handle, send a Set Named Pipe Handle state to 0x4300.</member>
+<member>Send an LSA Open Policy request.  Store the Policy Handle.</member>
+<member>Using the Policy Handle, send LSA Query Info Policy requests, etc.</member>
+<member>Using the Policy Handle, send an LSA Close.</member>
+<member>Close the IPC$ share.</member>
+</simplelist>
+
+<para>Defines for this pipe, identifying the query are:</para>
+<variablelist>
+<varlistentry>
+       <term>LSA Open Policy:</term>
+       <listitem><para>0x2c</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Query Info Policy:</term>
+       <listitem><para>0x07</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Enumerate Trusted Domains:</term>
+       <listitem><para>0x0d</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Open Secret:</term>
+       <listitem><para>0xff</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Lookup SIDs:</term>
+       <listitem><para>0xfe</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Lookup Names:</term>
+       <listitem><para>0xfd</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Close:</term>
+       <listitem><para>0x00</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect2>
+
+<sect2>
+<title>LSA Open Policy</title>
+
+<para><emphasis>Note:  The policy handle can be anything you like.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>server name - unicode string starting with two '\'s</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>OBJ_ATTR</term>
+       <listitem><para>object attributes</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>1 - desired access</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+
+<varlistentry>
+       <term>POL_HND</term>
+       <listitem><para>LSA policy handle</para></listitem>
+</varlistentry>
+
+<varlistentry>
+       <term>return</term>
+       <listitem><para>0 - indicates success</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA Query Info Policy</title>
+
+<para><emphasis>Note:  The info class in response must be the same as that in the request.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>POL_HND</term>
+<listitem><para>LSA policy handle</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+<listitem><para>info class (also a policy handle?)</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>info class (same as info class in request).</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+<para><programlisting>
+switch (info class)
+case 3:
+case 5:
+{
+DOM_INFO domain info, levels 3 and 5 (are the same).
+}
+
+return    0 - indicates success
+</programlisting></para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA Enumerate Trusted Domains</title>
+
+<sect3>
+<title>Request</title>
+
+<para>no extra data</para>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - enumeration context</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - entries read</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - trust information</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>return</term>
+       <listitem><para>0x8000 001a - "no trusted domains" success code</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+</sect2>
+
+<sect2>
+<title>LSA Open Secret</title>
+
+<sect3>
+<title>Request</title>
+
+<para>no extra data</para>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>0 - undocumented</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>return    0x0C00 0034 - "no such secret" success code</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA Close</title>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>POL_HND</term>
+       <listitem><para>policy handle to be closed</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>POL_HND</term>
+<listitem><para>0s - closed policy handle (all zeros)</para></listitem></varlistentry>
+</variablelist>
+
+<para>return    0 - indicates success</para>
+
+</sect3>
+</sect2>
+
+<sect2>
+<title>LSA Lookup SIDS</title>
+
+<para><emphasis>Note:  num_entries in response must be same as num_entries in request.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>POL_HND</term>
+       <listitem><para>LSA policy handle</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num_entries</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented domain SID buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented domain name buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*[num_entries] undocumented domain SID pointers to be looked up.
+</term>
+<listitem><para>DOM_SID[num_entries] domain SIDs to be looked up.</para></listitem></varlistentry>
+<varlistentry>
+       <term>char[16]</term>
+       <listitem><para>completely undocumented 16 bytes.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>DOM_REF</term>
+<listitem><para>domain reference response</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>num_entries (listed above)</para></listitem></varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>undocumented buffer pointer</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>num_entries (listed above)</para></listitem></varlistentry>
+<varlistentry>
+       <term>DOM_SID2[num_entries]</term>
+<listitem><para>domain SIDs (from Request, listed above).</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>num_entries (listed above)</para></listitem></varlistentry>
+</variablelist>
+
+<para>return                0 - indicates success</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA Lookup Names</title>
+
+<para><emphasis>Note:  num_entries in response must be same as num_entries in request.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>POL_HND</term>
+       <listitem><para>LSA policy handle</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num_entries</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>num_entries</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented domain SID buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented domain name buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>NAME[num_entries]</term>
+       <listitem><para>names to be looked up.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[]</term>
+       <listitem><para>undocumented bytes - falsely translated SID structure?</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>DOM_REF</term>
+<listitem><para>domain reference response</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>num_entries (listed above)</para></listitem></varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>undocumented buffer pointer</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>num_entries (listed above)</para></listitem></varlistentry>
+<varlistentry>
+       <term>DOM_RID[num_entries]</term>
+<listitem><para>domain SIDs (from Request, listed above).</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>num_entries (listed above)</para></listitem></varlistentry>
+</variablelist>
+
+<para>return                0 - indicates success</para>
+
+</sect3>
+</sect2>
+</sect1>
+
+<sect1>
+<title>NETLOGON rpc Transact Named Pipe</title>
+
+<para>The sequence of actions taken on this pipe are:</para>
+
+<simplelist>
+<member>tablish a connection to the IPC$ share (SMBtconX).  use encrypted passwords.</member>
+<member>en an RPC Pipe with the name "\\PIPE\\NETLOGON".  Store the file handle.</member>
+<member>ing the file handle, send a Set Named Pipe Handle state to 0x4300.</member>
+<member>eate Client Challenge. Send LSA Request Challenge.  Store Server Challenge.</member>
+<member>lculate Session Key.  Send an LSA Auth 2 Challenge.  Store Auth2 Challenge.</member>
+<member>lc/Verify Client Creds.  Send LSA Srv PW Set.  Calc/Verify Server Creds.</member>
+<member>lc/Verify Client Creds.  Send LSA SAM Logon .  Calc/Verify Server Creds.</member>
+<member>lc/Verify Client Creds.  Send LSA SAM Logoff.  Calc/Verify Server Creds.</member>
+<member>ose the IPC$ share.</member>
+</simplelist>
+
+<para>Defines for this pipe, identifying the query are</para>
+
+<variablelist>
+<varlistentry>
+       <term>LSA Request Challenge:</term>
+       <listitem><para>0x04</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Server Password Set:</term>
+       <listitem><para>0x06</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA SAM Logon:</term>
+       <listitem><para>0x02</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA SAM Logoff:</term>
+       <listitem><para>0x03</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Auth 2:</term>
+       <listitem><para>0x0f</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>LSA Logon Control:</term>
+       <listitem><para>0x0e</para></listitem>
+</varlistentry>
+</variablelist>
+
+<sect2>
+<title>LSA Request Challenge</title>
+
+<para><emphasis>Note:  logon server name starts with two '\' characters and is upper case.</emphasis></para>
+
+<para><emphasis>Note:  logon client is the machine, not the user.</emphasis></para>
+
+<para><emphasis>Note:  the initial LanManager password hash, against which the challenge is issued, is the machine name itself (lower case).  there will becalls issued (LSA Server Password Set) which will change this, later. refusing these calls allows you to always deal with the same password (i.e the LM# of the machine name in lower case).</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon server unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>logon client unicode string</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[8]</term>
+       <listitem><para>client challenge</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>char[8]</term>
+       <listitem><para>server challenge</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>return    0 - indicates success</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA Authenticate 2</title>
+
+<para><emphasis>Note:  in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</emphasis></para>
+
+<para><emphasis>Note:  neg_flags in the response is the same as that in the request.</emphasis></para>
+
+<para><emphasis>Note:  you must take a copy of the client-calculated credentials received      here, because they will be used in subsequent authentication packets.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>LOG_INFO</term>
+       <listitem><para>client identification info</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[8]</term>
+       <listitem><para>client-calculated credentials</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+<listitem><para>padding to 4-byte align with start of SMB header.</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>neg_flags - negotiated flags (usual value is 0x0000 01ff)</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>char[8]</term>
+       <listitem><para>server credentials.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>neg_flags - same as neg_flags in request.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>return    0 - indicates success.  failure value unknown.</para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA Server Password Set</title>
+
+<para><emphasis>Note: the new password is suspected to be a DES encryption using the old password to generate the key.</emphasis></para>
+
+<para><emphasis>Note: in between request and response, calculate the client credentials, and check them against the client-calculated credentials (this process uses the previously received client credentials).</emphasis></para>
+
+<para><emphasis>Note: the server credentials are constructed from the client-calculated credentials and the client time + 1 second.</emphasis></para>
+
+<para><emphasis>Note: you must take a copy of the client-calculated credentials received here, because they will be used in subsequent authentication packets.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>CLNT_INFO</term>
+       <listitem><para>client identification/authentication info</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[]</term>
+       <listitem><para>new password - undocumented.</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>CREDS</term>
+       <listitem><para>server credentials.  server time stamp appears to be ignored.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>return    0 - indicates success; 0xC000 006a indicates failure</para>
+
+</sect3>
+</sect2>
+
+<sect2
+<title>LSA SAM Logon</title>
+
+<para><emphasis>
+Note:  valid_user is True iff the username and password hash are valid for
+       the requested domain.
+</emphasis></para>
+
+<sect3>
+<title>Request</title>
+<variablelist>
+<varlistentry>
+       <term>SAM_INFO</term>
+       <listitem><para>sam_id structure</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>CREDS</term>
+       <listitem><para>server credentials.  server time stamp appears to be ignored.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para><programlisting>
+if (valid_user)
+{
+       UINT16      3 - switch value indicating USER_INFO structure.
+    VOID*     non-zero - pointer to USER_INFO structure
+    USER_INFO user logon information
+
+    UINT32    1 - Authoritative response; 0 - Non-Auth?
+
+    return    0 - indicates success
+}
+else
+{
+       UINT16    0 - switch value.  value to indicate no user presumed.
+    VOID*     0x0000 0000 - indicates no USER_INFO structure.
+
+    UINT32    1 - Authoritative response; 0 - Non-Auth?
+
+    return    0xC000 0064 - NT_STATUS_NO_SUCH_USER.
+}
+</programlisting></para>
+
+</sect3>
+
+</sect2>
+
+<sect2>
+<title>LSA SAM Logoff</title>
+
+<para><emphasis>
+Note:  presumably, the SAM_INFO structure is validated, and a (currently
+       undocumented) error code returned if the Logoff is invalid.
+</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>SAM_INFO</term>
+       <listitem><para>sam_id structure</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>undocumented buffer pointer</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>CREDS</term>
+       <listitem><para>server credentials.  server time stamp appears to be ignored.</para></listitem>
+</varlistentry>
+</variablelist>
+
+<para>return      0 - indicates success.  undocumented failure indication.</para>
+
+</sect3>
+</sect2>
+</sect1>
+
+<sect1>
+<title>\\MAILSLOT\NET\NTLOGON</title>
+
+<para><emphasis>
+Note:  mailslots will contain a response mailslot, to which the response
+       should be sent.  the target NetBIOS name is REQUEST_NAME<20>, where
+       REQUEST_NAME is the name of the machine that sent the request.
+</emphasis></para>
+
+<sect2>
+<title>Query for PDC</title>
+
+<para><emphasis>Note:  NTversion, LMNTtoken, LM20token in response are the same as those       given in the request.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>0x0007 - Query for PDC</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>STR</term>
+       <listitem><para>machine name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>STR</term>
+       <listitem><para>response mailslot</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>padding to 2-byte align with start of mailslot.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>machine name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>NTversion</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>LMNTtoken</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>LM20token</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16</term>
+<listitem><para>0x000A - Respose to Query for PDC</para></listitem></varlistentry>
+<varlistentry>
+       <term>STR</term>
+<listitem><para>machine name (in uppercase)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>padding to 2-byte align with start of mailslot.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>machine name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+<listitem><para>domain name</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>NTversion (same as received in request)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+<listitem><para>LMNTtoken (same as received in request)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+<listitem><para>LM20token (same as received in request)</para></listitem></varlistentry>
+</variablelist>
+
+</sect3>
+</sect2
+
+<sect2>
+<title>SAM Logon</title>
+
+<para><emphasis>Note: machine name in response is preceded by two '\' characters.</emphasis></para>
+
+<para><emphasis>Note:  NTversion, LMNTtoken, LM20token in response are the same as those given in the request.</emphasis></para>
+
+<para><emphasis>Note:  user name in the response is presumably the same as that in the request.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>0x0012 - SAM Logon</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>request count</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>machine name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>user name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>STR</term>
+       <listitem><para>response mailslot</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>alloweable account</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>domain SID size</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>char[sid_size]</term>
+       <listitem><para>domain SID, of sid_size bytes.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>???? padding to 4? 2? -byte align with start of mailslot.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>NTversion</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>LMNTtoken</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>LM20token</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>0x0013 - Response to SAM Logon</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>machine name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>user name - workstation trust account</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UNISTR</term>
+       <listitem><para>domain name </para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>NTversion</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>LMNTtoken</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT16</term>
+       <listitem><para>LM20token</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+</sect2>
+</sect1>
+
+<sect1>
+<title>SRVSVC Transact Named Pipe</title>
+
+<para>Defines for this pipe, identifying the query are:</para>
+
+<variablelist>
+<varlistentry>
+       <term>Net Share Enum</term>
+       <listitem><para>0x0f</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Net Server Get Info</term>
+       <listitem><para>0x15</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+<sect2>
+<title>Net Share Enum</title>
+
+<para><emphasis>Note:  share level and switch value in the response are presumably the same as those in the request.</emphasis></para>
+
+<para><emphasis>Note:  cifsrap2.txt (section 5) may be of limited assistance here.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>pointer (to server name?)</para></listitem></varlistentry>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>server name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT8[]</term>
+       <listitem><para>padding to get unicode string 4-byte aligned with the start of the SMB header.</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>share level</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>switch value</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>pointer to SHARE_INFO_1_CTR</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SHARE_INFO_1_CTR</term>
+       <listitem><para>share info with 0 entries</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+<listitem><para>preferred maximum length (0xffff ffff)</para></listitem></varlistentry>
+</variablelist>
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>share level</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>switch value</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+<listitem><para>pointer to SHARE_INFO_1_CTR</para></listitem></varlistentry>
+<varlistentry>
+       <term>SHARE_INFO_1_CTR</term>
+<listitem><para>share info (only added if share info ptr is non-zero)</para></listitem></varlistentry>
+</variablelist>
+
+<para>return            0 - indicates success</para>
+
+</sect3>
+</sect2>
+
+<sect2>
+<title>Net Server Get Info</title>
+
+<para><emphasis>Note:  level is the same value as in the request.</emphasis></para>
+
+<sect3>
+<title>Request</title>
+
+<variablelist>
+<varlistentry>
+       <term>UNISTR2</term>
+       <listitem><para>server name</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>switch level</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>Response</title>
+
+<variablelist>
+<varlistentry>
+       <term>UINT32</term>
+       <listitem><para>switch level</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>VOID*</term>
+       <listitem><para>pointer to SERVER_INFO_101</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>SERVER_INFO_101</term>
+<listitem><para>server info (only added if server info ptr is non-zero)</para></listitem></varlistentry>
+</variablelist>
+
+<para>return            0 - indicates success</para>
+
+</sect3>
+</sect2>
+</sect1>
+
+<sect1>
+<title>Cryptographic side of NT Domain Authentication</title>
+
+<sect2>
+<title>Definitions</title>
+
+<variablelist>
+<varlistentry>
+<term>Add(A1,A2)</term>
+<listitem><para>Intel byte ordered addition of corresponding 4 byte words in arrays A1 and A2</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>E(K,D)</term>
+<listitem><para>DES ECB encryption of 8 byte data D using 7 byte key K</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>lmowf()</term>
+<listitem><para>Lan man hash</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>ntowf()</term>
+<listitem><para>NT hash</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>PW</term>
+<listitem><para>md4(machine_password) == md4(lsadump $machine.acc) ==
+pwdump(machine$) (initially) == md4(lmowf(unicode(machine)))
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>ARC4(K,Lk,D,Ld)</term>
+<listitem><para>ARC4 encryption of data D of length Ld with key K of length Lk</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>v[m..n(,l)]</term>
+<listitem><para>subset of v from bytes m to n, optionally padded with zeroes to length l</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Cred(K,D)</term>
+<listitem><para>E(K[7..7,7],E(K[0..6],D)) computes a credential</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Time()</term>
+<listitem><para>4 byte current time</para></listitem>
+</varlistentry>
+
+<varlistentry>
+<term>Cc,Cs</term>
+<listitem><para>8 byte client and server challenges Rc,Rs: 8 byte client and server credentials</para></listitem>
+</varlistentry>
+
+</variablelist>
+
+</sect2>
+
+<sect2>
+<title>Protocol</title>
+
+<para>
+C->S ReqChal,Cc S->C Cs
+</para>
+
+<para>
+C & S compute session key Ks = E(PW[9..15],E(PW[0..6],Add(Cc,Cs)))
+</para>
+
+<para>
+C: Rc = Cred(Ks,Cc) C->S Authenticate,Rc S: Rs = Cred(Ks,Cs),
+assert(Rc == Cred(Ks,Cc)) S->C Rs C: assert(Rs == Cred(Ks,Cs))
+</para>
+
+<para>
+On joining the domain the client will optionally attempt to change its
+password and the domain controller may refuse to update it depending
+on registry settings. This will also occur weekly afterwards.
+</para>
+
+<para>
+C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) C->S ServerPasswordSet,Rc',Tc,
+arc4(Ks[0..7,16],lmowf(randompassword()) C: Rc = Cred(Ks,Rc+Tc+1) S:
+assert(Rc' == Cred(Ks,Rc+Tc)), Ts = Time() S: Rs' = Cred(Ks,Rs+Tc+1)
+S->C Rs',Ts C: assert(Rs' == Cred(Ks,Rs+Tc+1)) S: Rs = Rs'
+</para>
+
+<para>
+User: U with password P wishes to login to the domain (incidental data
+such as workstation and domain omitted)
+</para>
+
+<para>
+C: Tc = Time(), Rc' = Cred(Ks,Rc+Tc) C->S NetLogonSamLogon,Rc',Tc,U,
+arc4(Ks[0..7,16],16,ntowf(P),16), arc4(Ks[0..7,16],16,lmowf(P),16) S:
+assert(Rc' == Cred(Ks,Rc+Tc)) assert(passwords match those in SAM) S:
+Ts = Time()
+</para>
+
+<para>
+S->C Cred(Ks,Cred(Ks,Rc+Tc+1)),userinfo(logon script,UID,SIDs,etc) C:
+assert(Rs == Cred(Ks,Cred(Rc+Tc+1)) C: Rc = Cred(Ks,Rc+Tc+1)
+</para>
+
+</sect2>
+
+<sect2>
+<title>Comments</title>
+
+<para>
+On first joining the domain the session key could be computed by
+anyone listening in on the network as the machine password has a well
+known value. Until the machine is rebooted it will use this session
+key to encrypt NT and LM one way functions of passwords which are
+password equivalents. Any user who logs in before the machine has been
+rebooted a second time will have their password equivalent exposed. Of
+course the new machine password is exposed at this time anyway.
+</para>
+
+<para>
+None of the returned user info such as logon script, profile path and
+SIDs *appear* to be protected by anything other than the TCP checksum.
+</para>
+
+<para>
+The server time stamps appear to be ignored.
+</para>
+
+<para>
+The client sends a ReturnAuthenticator in the SamLogon request which I
+can't find a use for.  However its time is used as the timestamp
+returned by the server.
+</para>
+
+<para>
+The password OWFs should NOT be sent over the network reversibly
+encrypted. They should be sent using ARC4(Ks,md4(owf)) with the server
+computing the same function using the owf values in the SAM.
+</para>
+
+</sect2>
+</sect1>
+
+<sect1>
+<title>SIDs and RIDs</title>
+
+<para>
+SIDs and RIDs are well documented elsewhere.
+</para>
+
+<para>
+A SID is an NT Security ID (see DOM_SID structure).  They are of the form:
+</para>
+
+<simplelist>
+<member>revision-NN-SubAuth1-SubAuth2-SubAuth3... </member>
+<member>revision-0xNNNNNNNNNNNN-SubAuth1-SubAuth2-SubAuth3...</member>
+</simplelist>
+
+<para>
+currently, the SID revision is 1.
+The Sub-Authorities are known as Relative IDs (RIDs).
+</para>
+
+<sect2>
+<title>Well-known SIDs</title>
+
+<sect3>
+<title>Universal well-known SIDs</title>
+
+<variablelist>
+<varlistentry>
+       <term>Null SID</term>
+       <listitem><para>S-1-0-0</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>World</term>
+       <listitem><para>S-1-1-0</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Local</term>
+       <listitem><para>S-1-2-0</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Creator Owner ID</term>
+       <listitem><para>S-1-3-0</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Creator Group ID</term>
+       <listitem><para>S-1-3-1</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Creator Owner Server ID</term>
+       <listitem><para>S-1-3-2</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Creator Group Server ID</term>
+       <listitem><para>S-1-3-3</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>(Non-unique IDs)</term>
+       <listitem><para>S-1-4</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+
+<sect3>
+<title>NT well-known SIDs</title>
+
+<variablelist>
+<varlistentry>
+       <term>NT Authority</term>
+       <listitem><para>S-1-5</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Dialup</term>
+       <listitem><para>S-1-5-1</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Network</term>
+       <listitem><para>S-1-5-2</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Batch</term>
+       <listitem><para>S-1-5-3</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Interactive</term>
+       <listitem><para>S-1-5-4</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Service</term>
+<listitem><para>S-1-5-6</para></listitem></varlistentry>
+<varlistentry>
+       <term>AnonymousLogon(aka null logon session)</term>
+       <listitem><para>S-1-5-7</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>Proxy</term>
+<listitem><para>S-1-5-8</para></listitem></varlistentry>
+<varlistentry>
+       <term>ServerLogon(aka domain controller account)</term>
+       <listitem><para>S-1-5-8</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>(Logon IDs)</term>
+       <listitem><para>S-1-5-5-X-Y</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>(NT non-unique IDs)</term>
+       <listitem><para>S-1-5-0x15-...</para></listitem>
+</varlistentry>
+<varlistentry>
+       <term>(Built-in domain)</term>
+       <listitem><para>s-1-5-0x20</para></listitem>
+</varlistentry>
+</variablelist>
+
+</sect3>
+</sect2>
+
+<sect2>
+<title>Well-known RIDS</title>
+
+<para>
+A RID is a sub-authority value, as part of either a SID, or in the case
+of Group RIDs, part of the DOM_GID structure, in the USER_INFO_1
+structure, in the LSA SAM Logon response.
+</para>
+
+<sect3>
+<title>Well-known RID users</title>
+
+<segmentedlist>
+<segtitle>Groupname</segtitle>
+<segtitle>????</segtitle>
+<segtitle>RID</segtitle>
+<seglistitem><seg>DOMAIN_USER_RID_ADMIN</seg><seg>0x0000</seg><seg>01F4</seg></seglistitem>
+<seglistitem><seg>DOMAIN_USER_RID_GUEST</seg><seg>0x0000</seg><seg>01F5</seg></seglistitem>
+</segmentedlist>
+
+</sect3>
+
+<sect3>
+<title>Well-known RID groups</title>
+
+<segmentedlist>
+<segtitle>Groupname</segtitle>
+<segtitle>????</segtitle>
+<segtitle>RID</segtitle>
+<seglistitem><seg>     DOMAIN_GROUP_RID_ADMINS</seg><seg>0x0000</seg><seg>0200</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_GROUP_RID_USERS</seg><seg>0x0000</seg><seg>0201</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_GROUP_RID_GUESTS</seg><seg>0x0000</seg><seg>0202</seg></seglistitem>
+</segmentedlist>
+
+</sect3>
+
+<sect3>
+<title>Well-known RID aliases</title>
+
+<segmentedlist>
+<segtitle>Groupname</segtitle>
+<segtitle>????</segtitle>
+<segtitle>RID</segtitle>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_ADMINS</seg><seg>0x0000</seg><seg>0220</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_USERS</seg><seg>0x0000</seg><seg>0221</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_GUESTS</seg><seg>0x0000</seg><seg>0222</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_POWER_USERS</seg><seg>0x0000</seg><seg>0223</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_ACCOUNT_OPS</seg><seg>0x0000</seg><seg>0224</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_SYSTEM_OPS</seg><seg>0x0000</seg><seg>0225</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_PRINT_OPS</seg><seg>0x0000</seg><seg>0226</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_BACKUP_OPS</seg><seg>0x0000</seg><seg>0227</seg></seglistitem>
+<seglistitem><seg>     DOMAIN_ALIAS_RID_REPLICATOR</seg><seg>0x0000</seg><seg>0228</seg></seglistitem>
+</segmentedlist>
+
+</sect3>
+</sect2>
+</sect1>
+</chapter>
diff --git a/docs/docbook/devdoc/debug.sgml b/docs/docbook/devdoc/debug.sgml
new file mode 100644 (file)
index 0000000..7e81cc8
--- /dev/null
@@ -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>
diff --git a/docs/docbook/devdoc/dev-doc.sgml b/docs/docbook/devdoc/dev-doc.sgml
new file mode 100644 (file)
index 0000000..c1ffb73
--- /dev/null
@@ -0,0 +1,62 @@
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY NetBIOS SYSTEM "NetBIOS.sgml">
+<!ENTITY Architecture SYSTEM "architecture.sgml">
+<!ENTITY debug SYSTEM "debug.sgml">
+<!ENTITY internals SYSTEM "internals.sgml">
+<!ENTITY parsing SYSTEM "parsing.sgml">
+<!ENTITY unix-smb SYSTEM "unix-smb.sgml">
+<!ENTITY CodingSuggestions SYSTEM "CodingSuggestions.sgml">
+<!ENTITY Tracing SYSTEM "Tracing.sgml">
+<!ENTITY cifsntdomain SYSTEM "cifsntdomain.sgml">
+]>
+
+<book id="Samba-Developer-Documentation">
+
+<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 aug 26 12:41:19 CEST 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@samba.org</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>
+
+<!-- Chapters -->
+&NetBIOS;
+&Architecture;
+&debug;
+&CodingSuggestions;
+&internals;
+&parsing;
+&unix-smb;
+&Tracing;
+&cifsntdomain;
+
+</book>
diff --git a/docs/docbook/devdoc/internals.sgml b/docs/docbook/devdoc/internals.sgml
new file mode 100644 (file)
index 0000000..7952434
--- /dev/null
@@ -0,0 +1,439 @@
+<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>
+<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>
diff --git a/docs/docbook/devdoc/parsing.sgml b/docs/docbook/devdoc/parsing.sgml
new file mode 100644 (file)
index 0000000..0121935
--- /dev/null
@@ -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>
diff --git a/docs/docbook/devdoc/unix-smb.sgml b/docs/docbook/devdoc/unix-smb.sgml
new file mode 100644 (file)
index 0000000..be79698
--- /dev/null
@@ -0,0 +1,311 @@
+<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<->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>
+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>
+
diff --git a/docs/docbook/manpages/vfstest.1.sgml b/docs/docbook/manpages/vfstest.1.sgml
new file mode 100644 (file)
index 0000000..11878c1
--- /dev/null
@@ -0,0 +1,159 @@
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<refentry id="vfstest">
+
+<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 &quot;command&quot;</arg>
+               <arg choice="opt">-l &quot;logfile&quot;</arg>
+               <arg choice="opt">-h</arg>
+       </cmdsynopsis>
+</refsynopsisdiv>
+
+<refsect1>
+       <title>DESCRIPTION</title>
+
+       <para>This tool is part of the <ulink url="samba.7.html">
+       Samba</ulink> 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-seperated) commands. 
+               See below for the commands that are available.
+               </para> </listitem> 
+               </varlistentry>
+
+               <varlistentry>
+               <term>-d|--debug=debuglevel</term>
+               <listitem><para>set the debuglevel. Debug level 0 is the lowest 
+               and 100 being the highest. This should be set to 100 if you are
+               planning on submitting a bug report to the Samba team (see 
+               <filename>BUGS.txt</filename>). 
+               </para></listitem>
+               </varlistentry>
+               
+               <varlistentry>
+               <term>-h|--help</term>
+               <listitem><para>Print a summary of command line options.
+               </para></listitem>
+               </varlistentry>
+
+               <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>
+
+       </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>
diff --git a/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.sgml b/docs/docbook/projdoc/GROUP-MAPPING-HOWTO.sgml
new file mode 100644 (file)
index 0000000..6d5a019
--- /dev/null
@@ -0,0 +1,78 @@
+<chapter id="groupmapping">
+<chapterinfo>
+       <author>
+               <firstname>Jean Fran├žois</firstname><surname>Micouleau</surname>
+       </author>
+</chapterinfo>
+
+<title>Group mapping HOWTO</title>
+
+<para> 
+Starting with Samba 3.0 alpha 2, a new group mapping function is available. The
+current method (likely to change) to manage the groups is a new command called
+<command>smbgroupedit</command>.
+</para>
+
+<para>
+The first immediate reason to use the group mapping on a PDC, is that
+the <command>domain admin group</command> of <filename>smb.conf</filename> is 
+now gone. This parameter was used to give the listed users local admin rights 
+on their workstations. It was some magic stuff that simply worked but didn't
+scale very well for complex setups.
+</para>
+
+<para>
+Let me explain how it works on NT/W2K, to have this magic fade away.
+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, during that phase, the "Domain
+Administrators' group of the PDC is added to the 'Administrators' group of the
+workstation. Every members of the 'Domain Administrators' group 'inherit' the
+rights of the 'Administrators' group when logging on the workstation.
+</para>
+
+<para>
+You are now wondering how to make some of your samba PDC users members of the
+'Domain Administrators' ? That's really easy.
+</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 <command>domain admins</command> group by running the command:</para>
+
+<para><command>smbgroupedit -c "Domain Admins" -u domadm</command></para></listitem>
+
+</orderedlist>
+
+<para>You're set, joe, john and mary are domain administrators !</para>
+
+<para>
+Like the Domain Admins group, you can map any arbitrary Unix group to any NT
+group. You can also make any Unix group a domain group. For example, on a domain
+member machine (an NT/W2K or a samba server running winbind), you would like to
+give access to a certain directory to some users who are member of a group on
+your samba PDC. Flag that group as a domain group by running:
+</para>
+
+<para><command>smbgroupedit -a unixgroup -td</command></para>
+
+<para>You can list the various groups in the mapping database like this</para>
+<para><command>smbgroupedit -v</command></para>
+
+</chapter>
diff --git a/docs/docbook/projdoc/Other-Clients.sgml b/docs/docbook/projdoc/Other-Clients.sgml
new file mode 100644 (file)
index 0000000..f790024
--- /dev/null
@@ -0,0 +1,332 @@
+<chapter id="Other-Clients">
+<chapterinfo>
+       <author>
+               <firstname>Jim</firstname><surname>McDonough</surname>
+               <affiliation>
+                       <orgname>IBM</orgname>
+               </affiliation>
+               <firstname>Jelmer</firstname><surname>Vernooij</surname>
+               <affiliation>
+                       <orgname>Samba Team</orgname>
+                       <address>jelmer@samba.org</address>
+               </affiliation>
+       </author>
+       
+       <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 DAVE - see
+</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>
+
+</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>
+
+</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>
+
+<para><emphasis>NOTE : This bug does not occur when using winbind to
+create accounts on the Samba host for Domain users.</emphasis></para>
+
+</sect1>
+
+</chapter>
diff --git a/docs/docbook/projdoc/Portability.sgml b/docs/docbook/projdoc/Portability.sgml
new file mode 100644 (file)
index 0000000..f2fe66b
--- /dev/null
@@ -0,0 +1,148 @@
+<chapter id="Portability">
+<chapterinfo>
+       <author>
+               <firstname>Jelmer</firstname><surname>Vernooij</surname>
+       </author>
+</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>
+
+</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>
+</chapter>
diff --git a/docs/docbook/samba.dsl b/docs/docbook/samba.dsl
new file mode 100644 (file)
index 0000000..80197df
--- /dev/null
@@ -0,0 +1,82 @@
+<!-- This file defines the DocBook-utils Style Sheet for DocBook
+     Eric Bischoff <eric@caldera.de>
+-->
+
+<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
+  <!ENTITY % html "IGNORE">
+  <![%html; [
+       <!ENTITY % print "IGNORE">
+       <!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" CDATA dsssl>
+  ]]>
+  <!ENTITY % print "INCLUDE">
+  <![%print; [
+       <!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA dsssl>
+  ]]>
+]>
+
+<STYLE-SHEET>
+
+  <STYLE-SPECIFICATION ID="UTILS" USE="DOCBOOK">
+    <STYLE-SPECIFICATION-BODY>
+;; ===================================================================
+;; Generic Parameters
+;; (Generic currently means: both print and html)
+(define (chunk-element-list)
+  (list (normalize "preface")
+       (normalize "chapter")
+       (normalize "appendix") 
+       (normalize "article")
+       (normalize "glossary")
+       (normalize "bibliography")
+       (normalize "index")
+       (normalize "colophon")
+       (normalize "setindex")
+       (normalize "reference")
+       (normalize "refentry")
+       (normalize "part")
+;      (normalize "sect1") 
+       (normalize "section") 
+       (normalize "book") ;; just in case nothing else matches...
+       (normalize "set")  ;; sets are definitely chunks...
+       ))
+
+(define %chapter-autolabel% #t)
+(define %section-autolabel% #t)
+(define (toc-depth nd) 3)
+
+(define %root-filename% "Samba-HOWTO") ;; name for the root html file
+(define %html-ext% ".html")            ;; default extension for html output files
+(define %html-prefix% "")               ;; prefix for all filenames generated (except root)
+(define %use-id-as-filename% #t)
+
+; === HTML settings ===
+(define %html-pubid% "-//W3C//DTD HTML 4.01 Transitional//EN") ;; Nearly true :-(
+(define %html40% #t)
+
+; === Media objects ===
+(define preferred-mediaobject-extensions  ;; this magic allows to use different graphical
+  (list "png" "jpg" "jpeg"))           ;;   formats for printing and putting online
+(define acceptable-mediaobject-extensions
+  (list "bmp" "gif" "eps" "epsf" "avi" "mpg" "mpeg" "qt"))
+(define preferred-mediaobject-notations
+  (list "PNG" "JPG" "JPEG"))
+(define acceptable-mediaobject-notations
+  (list "EPS" "BMP" "GIF" "linespecific"))                                                                                                    
+; === Rendering ===
+(define %admon-graphics% #t)           ;; use symbols for Caution|Important|Note|Tip|Warning
+
+; === Books only ===
+(define %generate-book-titlepage% #t)
+(define %generate-book-toc% #t)
+(define ($generate-chapter-toc$) #f)   ;; never generate a chapter TOC in books
+
+; === Articles only ===
+(define %generate-article-titlepage% #t)
+(define %generate-article-toc% #t)      ;; make TOC
+
+    </STYLE-SPECIFICATION-BODY>
+  </STYLE-SPECIFICATION>
+
+  <EXTERNAL-SPECIFICATION ID="DOCBOOK" DOCUMENT="docbook.dsl">
+
+</STYLE-SHEET>
diff --git a/docs/manpages/vfstest.1 b/docs/manpages/vfstest.1
new file mode 100644 (file)
index 0000000..78e6e6c
--- /dev/null
@@ -0,0 +1,178 @@
+.\" This manpage has been automatically generated by docbook2man 
+.\" from a DocBook document.  This tool can be found at:
+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/> 
+.\" Please send any bug reports, improvements, comments, patches, 
+.\" etc. to Steve Cheng <steve@ggi-project.org>.
+.TH "VFSTEST" "1" "20 August 2002" "" ""
+.SH NAME
+vfstest \- tool for testing samba VFS modules
+.SH SYNOPSIS
+
+\fBvfstest\fR [ \fB-d debuglevel\fR ] [ \fB-c command\fR ] [ \fB-l logfile\fR ] [ \fB-h\fR ]
+
+.SH "DESCRIPTION"
+.PP
+This tool is part of the  Sambasuite.
+.PP
+\fBvfstest\fR 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.
+.SH "OPTIONS"
+.TP
+\fB-c|--command=command\fR
+Execute the specified (colon-seperated) commands. 
+See below for the commands that are available.
+.TP
+\fB-d|--debug=debuglevel\fR
+set the debuglevel. Debug level 0 is the lowest 
+and 100 being the highest. This should be set to 100 if you are
+planning on submitting a bug report to the Samba team (see \fIBUGS.txt\fR). 
+.TP
+\fB-h|--help\fR
+Print a summary of command line options.
+.TP
+\fB-l|--logfile=logbasename\fR
+File name for log/debug files. The extension 
+\&'.client' will be appended. The log file is never removed  
+by the client.
+.SH "COMMANDS"
+.PP
+\fBVFS COMMANDS\fR
+.TP 0.2i
+\(bu
+\fBload <module.so>\fR - Load specified VFS module 
+.TP 0.2i
+\(bu
+\fBpopulate <char> <size>\fR - Populate a data buffer with the specified data
+.TP 0.2i
+\(bu
+\fBshowdata [<offset> <len>]\fR - Show data currently in data buffer
+.TP 0.2i
+\(bu
+\fBconnect\fR - VFS connect()
+.TP 0.2i
+\(bu
+\fBdisconnect\fR - VFS disconnect()
+.TP 0.2i
+\(bu
+\fBdisk_free\fR - VFS disk_free()
+.TP 0.2i
+\(bu
+\fBopendir\fR - VFS opendir()
+.TP 0.2i
+\(bu
+\fBreaddir\fR - VFS readdir()
+.TP 0.2i
+\(bu
+\fBmkdir\fR - VFS mkdir()
+.TP 0.2i
+\(bu
+\fBrmdir\fR - VFS rmdir()
+.TP 0.2i
+\(bu
+\fBclosedir\fR - VFS closedir()
+.TP 0.2i
+\(bu
+\fBopen\fR - VFS open()
+.TP 0.2i
+\(bu
+\fBclose\fR - VFS close()
+.TP 0.2i
+\(bu
+\fBread\fR - VFS read()
+.TP 0.2i
+\(bu
+\fBwrite\fR - VFS write()
+.TP 0.2i
+\(bu
+\fBlseek\fR - VFS lseek()
+.TP 0.2i
+\(bu
+\fBrename\fR - VFS rename()
+.TP 0.2i
+\(bu
+\fBfsync\fR - VFS fsync()
+.TP 0.2i
+\(bu
+\fBstat\fR - VFS stat()
+.TP 0.2i
+\(bu
+\fBfstat\fR - VFS fstat()
+.TP 0.2i
+\(bu
+\fBlstat\fR - VFS lstat()
+.TP 0.2i
+\(bu
+\fBunlink\fR - VFS unlink()
+.TP 0.2i
+\(bu
+\fBchmod\fR - VFS chmod()
+.TP 0.2i
+\(bu
+\fBfchmod\fR - VFS fchmod()
+.TP 0.2i
+\(bu
+\fBchown\fR - VFS chown()
+.TP 0.2i
+\(bu
+\fBfchown\fR - VFS fchown()
+.TP 0.2i
+\(bu
+\fBchdir\fR - VFS chdir()
+.TP 0.2i
+\(bu
+\fBgetwd\fR - VFS getwd()
+.TP 0.2i
+\(bu
+\fButime\fR - VFS utime()
+.TP 0.2i
+\(bu
+\fBftruncate\fR - VFS ftruncate()
+.TP 0.2i
+\(bu
+\fBlock\fR - VFS lock()
+.TP 0.2i
+\(bu
+\fBsymlink\fR - VFS symlink()
+.TP 0.2i
+\(bu
+\fBreadlink\fR - VFS readlink()
+.TP 0.2i
+\(bu
+\fBlink\fR - VFS link()
+.TP 0.2i
+\(bu
+\fBmknod\fR - VFS mknod()
+.TP 0.2i
+\(bu
+\fBrealpath\fR - VFS realpath()
+.PP
+\fBGENERAL COMMANDS\fR
+.TP 0.2i
+\(bu
+\fBconf <smb.conf>\fR - Load a different configuration file
+.TP 0.2i
+\(bu
+\fBhelp [<command>]\fR - Get list of commands or info about specified command
+.TP 0.2i
+\(bu
+\fBdebuglevel <level>\fR - Set debug level
+.TP 0.2i
+\(bu
+\fBfreemem\fR - Free memory currently in use
+.TP 0.2i
+\(bu
+\fBexit\fR - Exit vfstest
+.SH "VERSION"
+.PP
+This man page is correct for version 3.0 of the Samba 
+suite.
+.SH "AUTHOR"
+.PP
+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.
+.PP
+The vfstest man page was written by Jelmer Vernooij.
diff --git a/examples/VFS/README.netatalk b/examples/VFS/README.netatalk
new file mode 100644 (file)
index 0000000..70f6eea
--- /dev/null
@@ -0,0 +1,18 @@
+There is the new netatalk module both for HEAD.
+This one has some difference from previous module:
+
+-- it doesn't care about creating of .AppleDouble forks, just keeps ones in
+sync;
+
+-- if share in smb.conf doesn't contain .AppleDouble item in hide or veto 
+list, it will be added automatically.
+
+To my way of thinking, module became more lightweight and speedy.
+
+How to compile: 
+
+you should place proper netatalk.c into examples/VFS/ then run 'configure'
+from source/ and then run 'make' from examples/VFS/.
+
+add string 'vfs object = <path_to_netatalk_so>/netatlk.so' to smb.conf. It may
+be defined either as global or as share-specific parameter.
diff --git a/examples/VFS/netatalk.c b/examples/VFS/netatalk.c
new file mode 100644 (file)
index 0000000..353be36
--- /dev/null
@@ -0,0 +1,430 @@
+/* 
+ * AppleTalk VFS module for Samba-3.x
+ *
+ * Copyright (C) Alexei Kotovich, 2002
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *  
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *  
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+ */
+
+#include "config.h"
+#include <stdio.h>
+#include <sys/stat.h>
+#ifdef HAVE_UTIME_H
+#include <utime.h>
+#endif
+#ifdef HAVE_DIRENT_H
+#include <dirent.h>
+#endif
+#ifdef HAVE_FCNTL_H
+#include <fcntl.h>
+#endif
+#include <errno.h>
+#include <string.h>
+#include <includes.h>
+#include <vfs.h>
+
+#define APPLEDOUBLE    ".AppleDouble"
+#define ADOUBLEMODE    0777
+
+/* atalk functions */
+
+static int atalk_build_paths(TALLOC_CTX *ctx, const char *path,
+  const char *fname, char **adbl_path, char **orig_path, 
+  SMB_STRUCT_STAT *adbl_info, SMB_STRUCT_STAT *orig_info);
+
+static int atalk_unlink_file(const char *path);
+
+static struct vfs_ops default_vfs_ops; /* For passthrough operation */
+static struct smb_vfs_handle_struct *atalk_handle;
+
+static int atalk_get_path_ptr(char *path)
+{
+       int i   = 0;
+       int ptr = 0;
+       
+       for (i = 0; path[i]; i ++) {
+               if (path[i] == '/')
+                       ptr = i;
+               /* get out some 'spam';) from win32's file name */
+               else if (path[i] == ':') {
+                       path[i] = '\0';
+                       break;
+               }
+       }
+       
+       return ptr;
+}
+
+static int atalk_build_paths(TALLOC_CTX *ctx, const char *path, const char *fname,
+                              char **adbl_path, char **orig_path,
+                              SMB_STRUCT_STAT *adbl_info, SMB_STRUCT_STAT *orig_info)
+{
+       int ptr0 = 0;
+       int ptr1 = 0;
+       char *dname = 0;
+       char *name  = 0;
+
+       if (!ctx || !path || !fname || !adbl_path || !orig_path ||
+               !adbl_info || !orig_info)
+               return -1;
+#if 0
+       DEBUG(3, ("ATALK: PATH: %s[%s]\n", path, fname));
+#endif
+       if (strstr(path, APPLEDOUBLE) || strstr(fname, APPLEDOUBLE)) {
+               DEBUG(3, ("ATALK: path %s[%s] already contains %s\n", path, fname, APPLEDOUBLE));
+               return -1;
+       }
+
+       if (fname[0] == '.') ptr0 ++;
+       if (fname[1] == '/') ptr0 ++;
+
+       *orig_path = talloc_asprintf(ctx, "%s/%s", path, &fname[ptr0]);
+
+       /* get pointer to last '/' */
+       ptr1 = atalk_get_path_ptr(*orig_path);
+
+       sys_lstat(*orig_path, orig_info);
+
+       if (S_ISDIR(orig_info->st_mode)) {
+               *adbl_path = talloc_asprintf(ctx, "%s/%s/%s/", 
+                 path, &fname[ptr0], APPLEDOUBLE);
+       } else {
+               dname = talloc_strdup(ctx, *orig_path);
+               dname[ptr1] = '\0';
+               name = *orig_path;
+               *adbl_path = talloc_asprintf(ctx, "%s/%s/%s", 
+                 dname, APPLEDOUBLE, &name[ptr1 + 1]);
+       }
+#if 0
+       DEBUG(3, ("ATALK: DEBUG:\n%s\n%s\n", *orig_path, *adbl_path)); 
+#endif
+       sys_lstat(*adbl_path, adbl_info);
+       return 0;
+}
+
+static int atalk_unlink_file(const char *path)
+{
+       int ret = 0;
+
+       become_root();
+       ret = unlink(path);
+       unbecome_root();
+       
+       return ret;
+}
+
+static void atalk_add_to_list(name_compare_entry **list)
+{
+       int i, count = 0;
+       name_compare_entry *new_list = 0;
+       name_compare_entry *cur_list = 0;
+
+       cur_list = *list;
+
+       if (cur_list) {
+               for (i = 0, count = 0; cur_list[i].name; i ++, count ++) {
+                       if (strstr(cur_list[i].name, APPLEDOUBLE))
+                               return;
+               }
+       }
+
+       if (!(new_list = calloc(1, 
+         (count == 0 ? 1 : count + 1) * sizeof(name_compare_entry))))
+               return;
+
+       for (i = 0; i < count; i ++) {
+               new_list[i].name    = strdup(cur_list[i].name);
+               new_list[i].is_wild = cur_list[i].is_wild;
+       }
+
+       new_list[i].name    = strdup(APPLEDOUBLE);
+       new_list[i].is_wild = False;
+
+       free_namearray(*list);
+
+       *list = new_list;
+       new_list = 0;
+       cur_list = 0;
+}
+
+static void atalk_rrmdir(TALLOC_CTX *ctx, char *path)
+{
+       int n;
+       char *dpath;
+       struct dirent **namelist;
+
+       if (!path) return;
+
+       n = scandir(path, &namelist, 0, alphasort);
+       if (n < 0) {
+               return;
+       } else {
+               while (n --) {
+                       if (strcmp(namelist[n]->d_name, ".") == 0 ||
+                         strcmp(namelist[n]->d_name, "..") == 0)
+                               continue;
+                       if (!(dpath = talloc_asprintf(ctx, "%s/%s", 
+                         path, namelist[n]->d_name)))
+                               continue;
+                       atalk_unlink_file(dpath);
+                       free(namelist[n]);
+               }
+       }
+}
+
+/* Disk operations */
+
+/* Directory operations */
+
+DIR *atalk_opendir(struct connection_struct *conn, const char *fname)
+{
+       DIR *ret = 0;
+       
+       ret = default_vfs_ops.opendir(conn, fname);
+
+       /*
+        * when we try to perform delete operation upon file which has fork
+        * in ./.AppleDouble and this directory wasn't hidden by Samba,
+        * MS Windows explorer causes the error: "Cannot find the specified file"
+        * There is some workaround to avoid this situation, i.e. if
+        * connection has not .AppleDouble entry in either veto or hide 
+        * list then it would be nice to add one.
+        */
+
+       atalk_add_to_list(&conn->hide_list);
+       atalk_add_to_list(&conn->veto_list);
+
+       return ret;
+}
+
+static int atalk_rmdir(struct connection_struct *conn, const char *path)
+{
+       BOOL add = False;
+       TALLOC_CTX *ctx = 0;
+       char *dpath;
+
+       if (!conn || !conn->origpath || !path) goto exit_rmdir;
+
+       /* due to there is no way to change bDeleteVetoFiles variable
+        * from this module, gotta use talloc stuff..
+        */
+
+       strstr(path, APPLEDOUBLE) ? (add = False) : (add = True);
+
+       if (!(ctx = talloc_init_named("remove_directory")))
+               goto exit_rmdir;
+
+       if (!(dpath = talloc_asprintf(ctx, "%s/%s%s", 
+         conn->origpath, path, add ? "/"APPLEDOUBLE : "")))
+               goto exit_rmdir;
+
+       atalk_rrmdir(ctx, dpath);
+
+exit_rmdir:
+       talloc_destroy(ctx);
+       return default_vfs_ops.rmdir(conn, path);
+}
+
+/* File operations */
+
+static int atalk_rename(struct connection_struct *conn, const char *old, const char *new)
+{
+       int ret = 0;
+       char *adbl_path = 0;
+       char *orig_path = 0;
+       SMB_STRUCT_STAT adbl_info;
+       SMB_STRUCT_STAT orig_info;
+       TALLOC_CTX *ctx;
+
+       ret = default_vfs_ops.rename(conn, old, new);
+
+       if (!conn || !old) return ret;
+
+       if (!(ctx = talloc_init_named("rename_file")))
+               return ret;
+
+       if (atalk_build_paths(ctx, conn->origpath, old, &adbl_path, &orig_path, 
+         &adbl_info, &orig_info) != 0)
+               return ret;
+
+       if (S_ISDIR(orig_info.st_mode) || S_ISREG(orig_info.st_mode)) {
+               DEBUG(3, ("ATALK: %s has passed..\n", adbl_path));              
+               goto exit_rename;
+       }
+
+       atalk_unlink_file(adbl_path);
+
+exit_rename:
+       talloc_destroy(ctx);
+       return ret;
+}
+
+static int atalk_unlink(struct connection_struct *conn, const char *path)
+{
+       int ret = 0, i;
+       char *adbl_path = 0;
+       char *orig_path = 0;
+       SMB_STRUCT_STAT adbl_info;
+       SMB_STRUCT_STAT orig_info;
+       TALLOC_CTX *ctx;
+
+       ret = default_vfs_ops.unlink(conn, path);
+
+       if (!conn || !path) return ret;
+
+       /* no .AppleDouble sync if veto or hide list is empty,
+        * otherwise "Cannot find the specified file" error will be caused
+        */
+
+       if (!conn->veto_list) return ret;
+       if (!conn->hide_list) return ret;
+
+       for (i = 0; conn->veto_list[i].name; i ++) {
+               if (strstr(conn->veto_list[i].name, APPLEDOUBLE))
+                       break;
+       }
+
+       if (!conn->veto_list[i].name) {
+               for (i = 0; conn->hide_list[i].name; i ++) {
+                       if (strstr(conn->hide_list[i].name, APPLEDOUBLE))
+                               break;
+                       else {
+                               DEBUG(3, ("ATALK: %s is not hidden, skipped..\n",
+                                 APPLEDOUBLE));                
+                               return ret;
+                       }
+               }
+       }
+
+       if (!(ctx = talloc_init_named("unlink_file")))
+               return ret;
+
+       if (atalk_build_paths(ctx, conn->origpath, path, &adbl_path, &orig_path, 
+         &adbl_info, &orig_info) != 0)
+               return ret;
+
+       if (S_ISDIR(orig_info.st_mode) || S_ISREG(orig_info.st_mode)) {
+               DEBUG(3, ("ATALK: %s has passed..\n", adbl_path));
+               goto exit_unlink;
+       }
+
+       atalk_unlink_file(adbl_path);
+
+exit_unlink:   
+       talloc_destroy(ctx);
+       return ret;
+}
+
+static int atalk_chmod(struct connection_struct *conn, const char *path, mode_t mode)
+{
+       int ret = 0;
+       char *adbl_path = 0;
+       char *orig_path = 0;
+       SMB_STRUCT_STAT adbl_info;
+       SMB_STRUCT_STAT orig_info;
+       TALLOC_CTX *ctx;
+
+       ret = default_vfs_ops.chmod(conn, path, mode);
+
+       if (!conn || !path) return ret;
+
+       if (!(ctx = talloc_init_named("chmod_file")))
+               return ret;
+
+       if (atalk_build_paths(ctx, conn->origpath, path, &adbl_path, &orig_path,
+         &adbl_info, &orig_info) != 0)
+               return ret;
+
+       if (!S_ISDIR(orig_info.st_mode) && !S_ISREG(orig_info.st_mode)) {
+               DEBUG(3, ("ATALK: %s has passed..\n", orig_path));              
+               goto exit_chmod;
+       }
+
+       chmod(adbl_path, ADOUBLEMODE);
+
+exit_chmod:    
+       talloc_destroy(ctx);
+       return ret;
+}
+
+static int atalk_chown(struct connection_struct *conn, const char *path, uid_t uid, gid_t gid)
+{
+       int ret = 0;
+       char *adbl_path = 0;
+       char *orig_path = 0;
+       SMB_STRUCT_STAT adbl_info;
+       SMB_STRUCT_STAT orig_info;
+       TALLOC_CTX *ctx;
+
+       ret = default_vfs_ops.chown(conn, path, uid, gid);
+
+       if (!conn || !path) return ret;
+
+       if (!(ctx = talloc_init_named("chown_file")))
+               return ret;
+
+       if (atalk_build_paths(ctx, conn->origpath, path, &adbl_path, &orig_path,
+         &adbl_info, &orig_info) != 0)
+               return ret;
+
+       if (!S_ISDIR(orig_info.st_mode) && !S_ISREG(orig_info.st_mode)) {
+               DEBUG(3, ("ATALK: %s has passed..\n", orig_path));              
+               goto exit_chown;
+       }
+
+       chown(adbl_path, uid, gid);
+
+exit_chown:    
+       talloc_destroy(ctx);
+       return ret;
+}
+
+static vfs_op_tuple atalk_ops[] = {
+    
+       /* Directory operations */
+
+       {atalk_opendir,         SMB_VFS_OP_OPENDIR,     SMB_VFS_LAYER_TRANSPARENT},
+       {atalk_rmdir,           SMB_VFS_OP_RMDIR,       SMB_VFS_LAYER_TRANSPARENT},
+
+       /* File operations */
+
+       {atalk_rename,          SMB_VFS_OP_RENAME,      SMB_VFS_LAYER_TRANSPARENT},
+       {atalk_unlink,          SMB_VFS_OP_UNLINK,      SMB_VFS_LAYER_TRANSPARENT},
+       {atalk_chmod,           SMB_VFS_OP_CHMOD,       SMB_VFS_LAYER_TRANSPARENT},
+       {atalk_chown,           SMB_VFS_OP_CHOWN,       SMB_VFS_LAYER_TRANSPARENT},
+       
+       /* Finish VFS operations definition */
+       
+       {NULL,                  SMB_VFS_OP_NOOP,        SMB_VFS_LAYER_NOOP}
+};
+
+/* VFS initialisation function.  Return vfs_op_tuple array back to SAMBA. */
+vfs_op_tuple *vfs_init(int *vfs_version, struct vfs_ops *def_vfs_ops,
+  struct smb_vfs_handle_struct *vfs_handle)
+{
+       *vfs_version = SMB_VFS_INTERFACE_VERSION;
+       memcpy(&default_vfs_ops, def_vfs_ops, sizeof(struct vfs_ops));
+       
+       atalk_handle = vfs_handle;
+
+       DEBUG(3, ("ATALK: vfs module loaded\n"));
+       return atalk_ops;
+}
+
+/* VFS finalization function. */
+void vfs_done(connection_struct *conn)
+{
+       DEBUG(3, ("ATALK: vfs module unloaded\n"));
+}
diff --git a/examples/sam/Makefile.in b/examples/sam/Makefile.in
new file mode 100644 (file)
index 0000000..d5df346
--- /dev/null
@@ -0,0 +1,28 @@
+CC             = @CC@
+CFLAGS         = @CFLAGS@
+CPPFLAGS       = @CPPFLAGS@
+LDFLAGS                = @LDFLAGS@
+LDSHFLAGS      = -shared
+srcdir         = @builddir@
+FLAGS          =  $(CFLAGS) -Iinclude -I$(srcdir)/include -I$(srcdir)/ubiqx -I$(srcdir)/smbwrapper  -I. $(CPPFLAGS) -I$(srcdir)
+
+SAM_OBJS       = sam_skel.so
+
+# Default target
+
+default: $(SAM_OBJS)
+
+# Pattern rules
+
+%.so: %.o
+       $(CC) $(LDSHFLAGS) $(LDFLAGS) -o $@ $<
+
+%.o: %.c
+       $(CC) $(FLAGS) -c $<
+
+# Misc targets
+
+clean:
+       rm -rf .libs
+       rm -f core *~ *% *.bak \
+       $(SAM_OBJ) $(SAM_OBJS)
diff --git a/examples/sam/README b/examples/sam/README
new file mode 100644 (file)
index 0000000..9e9fbb2
--- /dev/null
@@ -0,0 +1,29 @@
+README for Samba SAM Database examples
+====================================================
+26-08-2002 Stefan (metze) Metzmacher <metze@metzemix.de>
+
+Every module MUST have a sam_version() function.
+
+this is defined in include/sam.h:
+#define SAM_MODULE_VERSIONING_MAGIC \
+int sam_version(void)\
+{\
+       return SAM_INTERFACE_VERSION;\
+}
+
+You MUST add this line inside a module:
+SAM_MODULE_VERSIONING_MAGIC
+
+
+The sam_skel.c file in this directory contains a very basic example of 
+a SAM plugin. It just prints the name of the function that is executed using
+DEBUG. Maybe it's nice to include some of the arguments to the function in the 
+future too..
+
+New SAM plugins should go into the samba lib directory, (/usr/lib/samba/ 
+for most distributions) and should be prefixed with 'sam_' and should go into the 
+subdir sam/. The SAM subsystem will search in /usr/lib/samba/sam and fall back to 
+/usr/lib/samba/ . 
+An example path would be: 
+/usr/lib/samba/sam/sam_skel.so
+
diff --git a/examples/sam/sam_skel.c b/examples/sam/sam_skel.c
new file mode 100644 (file)
index 0000000..da3a375
--- /dev/null
@@ -0,0 +1,250 @@
+/*
+   Unix SMB/CIFS implementation.
+   this is a skeleton for SAM backend modules.
+       
+   Copyright (C) Stefan (metze) Metzmacher             2002
+   Copyright (C) Jelmer Vernooij                               2002
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "includes.h"
+
+static int sam_skel_debug_level = DBGC_SAM;
+
+#undef DBGC_CLASS
+#define DBGC_CLASS sam_skel_debug_level
+
+/* define the version of the SAM interface */ 
+SAM_MODULE_VERSIONING_MAGIC
+
+/* General API */
+
+NTSTATUS sam_skel_get_sec_desc(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, const DOM_SID *sid, SEC_DESC **sd)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_set_sec_desc(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, const DOM_SID *sid, const SEC_DESC *sd)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+       
+NTSTATUS sam_skel_lookup_sid(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, const DOM_SID *sid, char **name, uint32 *type)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_lookup_name(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, const char *name, DOM_SID **sid, uint32 *type)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+       
+/* Domain API */
+
+NTSTATUS sam_skel_update_domain(const SAM_METHODS *sam_methods, const SAM_DOMAIN_HANDLE *domain)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_get_domain_handle(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, SAM_DOMAIN_HANDLE **domain)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+
+/* Account API */
+
+NTSTATUS sam_skel_create_account(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *group_name, uint16 acct_ctrl, SAM_ACCOUNT_HANDLE **account)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_add_account(const SAM_METHODS *sam_methods, const SAM_ACCOUNT_HANDLE *account)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_update_account(const SAM_METHODS *sam_methods, const SAM_ACCOUNT_HANDLE *account)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_delete_account(const SAM_METHODS *sam_methods, const SAM_ACCOUNT_HANDLE *account)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_enum_accounts(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint16 acct_ctrl, uint32 *account_count, SAM_ACCOUNT_ENUM **accounts)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+
+NTSTATUS sam_skel_get_account_by_sid(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *accountsid, SAM_ACCOUNT_HANDLE **account)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_get_account_by_name(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *name, SAM_ACCOUNT_HANDLE **account)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+
+/* Group API */
+
+NTSTATUS sam_skel_create_group(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *account_name, uint16 group_ctrl, SAM_GROUP_HANDLE **group)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_add_group(const SAM_METHODS *sam_methods, const SAM_GROUP_HANDLE *group)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_update_group(const SAM_METHODS *sam_methods, const SAM_GROUP_HANDLE *group)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_delete_group(const SAM_METHODS *sam_methods, const SAM_GROUP_HANDLE *group)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_enum_groups(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint16 group_ctrl, uint32 *groups_count, SAM_GROUP_ENUM **groups)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_get_group_by_sid(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *groupsid, SAM_GROUP_HANDLE **group)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_get_group_by_name(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *name, SAM_GROUP_HANDLE **group)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+
+NTSTATUS sam_skel_add_member_to_group(const SAM_METHODS *sam_methods, const SAM_GROUP_HANDLE *group, const SAM_GROUP_MEMBER *member)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_delete_member_from_group(const SAM_METHODS *sam_methods, const SAM_GROUP_HANDLE *group, const SAM_GROUP_MEMBER *member)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_skel_enum_groupmembers(const SAM_METHODS *sam_methods, const SAM_GROUP_HANDLE *group, uint32 *members_count, SAM_GROUP_MEMBER **members)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+
+NTSTATUS sam_skel_get_groups_of_sid(const SAM_METHODS *sam_methods, const NT_USER_TOKEN *access_token, const DOM_SID **sids, uint16 group_ctrl, uint32 *group_count, SAM_GROUP_ENUM **groups)
+{
+       DEBUG(0,("sam_skel: %s was called!\n",__FUNCTION__));
+       return NT_STATUS_NOT_IMPLEMENTED;
+}
+
+NTSTATUS sam_init(SAM_METHODS *sam_methods, const char *module_params)
+{
+       /* Functions your SAM module doesn't provide should be set 
+        * to NULL */
+
+       sam_methods->sam_get_sec_desc = sam_skel_get_sec_desc;
+       sam_methods->sam_set_sec_desc = sam_skel_set_sec_desc;
+       
+       sam_methods->sam_lookup_sid = sam_skel_lookup_sid;
+       sam_methods->sam_lookup_name = sam_skel_lookup_name;
+       
+       /* Domain API */
+
+       sam_methods->sam_update_domain = sam_skel_update_domain;
+       sam_methods->sam_get_domain_handle = sam_skel_get_domain_handle;
+
+       /* Account API */
+
+       sam_methods->sam_create_account = sam_skel_create_account;
+       sam_methods->sam_add_account = sam_skel_add_account;
+       sam_methods->sam_update_account = sam_skel_update_account;
+       sam_methods->sam_delete_account = sam_skel_delete_account;
+       sam_methods->sam_enum_accounts = sam_skel_enum_accounts;
+
+       sam_methods->sam_get_account_by_sid = sam_skel_get_account_by_sid;
+       sam_methods->sam_get_account_by_name = sam_skel_get_account_by_name;
+
+       /* Group API */
+
+       sam_methods->sam_create_group = sam_skel_create_group;
+       sam_methods->sam_add_group = sam_skel_add_group;
+       sam_methods->sam_update_group = sam_skel_update_group;
+       sam_methods->sam_delete_group = sam_skel_delete_group;
+       sam_methods->sam_enum_groups = sam_skel_enum_groups;
+       sam_methods->sam_get_group_by_sid = sam_skel_get_group_by_sid;
+       sam_methods->sam_get_group_by_name = sam_skel_get_group_by_name;
+
+       sam_methods->sam_add_member_to_group = sam_skel_add_member_to_group;
+       sam_methods->sam_delete_member_from_group = sam_skel_delete_member_from_group;
+       sam_methods->sam_enum_groupmembers = sam_skel_enum_groupmembers;
+
+       sam_methods->sam_get_groups_of_sid = sam_skel_get_groups_of_sid;
+
+       sam_methods->free_private_data = NULL;
+
+
+       sam_skel_debug_level = debug_add_class("sam_skel");
+       if (sam_skel_debug_level == -1) {
+               sam_skel_debug_level = DBGC_SAM;
+               DEBUG(0, ("sam_skel: Couldn't register custom debugging class!\n"));
+       } else DEBUG(2, ("sam_skel: Debug class number of 'sam_skel': %d\n", sam_skel_debug_level));
+    
+       if(module_params)
+               DEBUG(0, ("Starting 'sam_skel' with parameters '%s' for domain %s\n", module_params, sam_methods->domain_name));
+       else
+               DEBUG(0, ("Starting 'sam_skel' for domain %s without paramters\n", sam_methods->domain_name));
+
+       return NT_STATUS_OK;
+}
diff --git a/source3/include/nt_status.h b/source3/include/nt_status.h
new file mode 100644 (file)
index 0000000..1c80c5e
--- /dev/null
@@ -0,0 +1,62 @@
+/* 
+   Unix SMB/CIFS implementation.
+   SMB parameters and setup, plus a whole lot more.
+   
+   Copyright (C) Andrew Tridgell              2001
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef _NT_STATUS_H
+#define _NT_STATUS_H
+
+/* The Splint code analysis tool doesn't like immediate structures. */
+
+#ifdef _SPLINT_                      /* http://www.splint.org */
+#undef HAVE_IMMEDIATE_STRUCTURES
+#endif
+
+/* the following rather strange looking definitions of NTSTATUS and WERROR
+   and there in order to catch common coding errors where different error types
+   are mixed up. This is especially important as we slowly convert Samba
+   from using BOOL for internal functions 
+*/
+
+#if defined(HAVE_IMMEDIATE_STRUCTURES)
+typedef struct {uint32 v;} NTSTATUS;
+#define NT_STATUS(x) ((NTSTATUS) { x })
+#define NT_STATUS_V(x) ((x).v)
+#else
+typedef uint32 NTSTATUS;
+#define NT_STATUS(x) (x)
+#define NT_STATUS_V(x) (x)
+#endif
+
+#if defined(HAVE_IMMEDIATE_STRUCTURES)
+typedef struct {uint32 v;} WERROR;
+#define W_ERROR(x) ((WERROR) { x })
+#define W_ERROR_V(x) ((x).v)
+#else
+typedef uint32 WERROR;
+#define W_ERROR(x) (x)
+#define W_ERROR_V(x) (x)
+#endif
+
+#define NT_STATUS_IS_OK(x) (NT_STATUS_V(x) == 0)
+#define NT_STATUS_IS_ERR(x) ((NT_STATUS_V(x) & 0xc0000000) == 0xc0000000)
+#define NT_STATUS_EQUAL(x,y) (NT_STATUS_V(x) == NT_STATUS_V(y))
+#define W_ERROR_IS_OK(x) (W_ERROR_V(x) == 0)
+
+#endif
diff --git a/source3/include/sam.h b/source3/include/sam.h
new file mode 100644 (file)
index 0000000..2157a37
--- /dev/null
@@ -0,0 +1,282 @@
+/* 
+   Unix SMB/CIFS implementation.
+   SAM structures
+   Copyright (C) Kai Krueger 2002
+   Copyright (C) Stefan (metze) Metzmacher 2002
+   Copyright (C) Simo Sorce 2002
+   Copyright (C) Andrew Bartlett 2002
+   Copyright (C) Jelmer Vernooij 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef _SAM_H
+#define _SAM_H
+
+/* We want to track down bugs early */
+#if 1
+#define SAM_ASSERT(x) SMB_ASSERT(x)
+#else
+#define SAM_ASSERT(x) while (0) { \
+       if (!(x)) {
+               DEBUG(0, ("SAM_ASSERT failed!\n"))
+               return NT_STATUS_FAIL_CHECK;\
+       } \
+    }
+#endif
+
+
+/* let it be 0 until we have a stable interface --metze */
+#define SAM_INTERFACE_VERSION 0
+
+/* use this inside a passdb module */
+#define SAM_MODULE_VERSIONING_MAGIC \
+int sam_version(void)\
+{\
+       return SAM_INTERFACE_VERSION;\
+}
+
+/* Backend to use by default when no backend was specified */
+#define SAM_DEFAULT_BACKEND "plugin"
+
+typedef struct sam_domain_handle {
+       TALLOC_CTX *mem_ctx;
+       uint32 access_granted;
+       const struct sam_methods *current_sam_methods; /* sam_methods creating this handle */
+       void (*free_fn)(struct sam_domain_handle **);
+       struct domain_data {
+               DOM_SID sid; /*SID of the domain. Should not be changed */
+               char *name; /* Name of the domain */
+               char *servername; /* */
+               NTTIME max_passwordage; /* time till next password expiration */
+               NTTIME min_passwordage; /* time till password can be changed again */
+               NTTIME lockout_duration; /* time till login is allowed again after lockout*/
+               NTTIME reset_count; /* time till bad login counter is reset */
+               uint16 min_passwordlength; /* minimum number of characters for a password */
+               uint16 password_history; /* number of passwords stored in history */
+               uint16 lockout_count; /* number of bad login attempts before lockout */
+               BOOL force_logoff; /* force logoff after logon hours have expired */
+               BOOL login_pwdchange; /* Users need to logon to change their password */
+               uint32 num_accounts; /* number of accounts in the domain */
+               uint32 num_groups; /* number of global groups */
+               uint32 num_aliases; /* number of local groups */
+       } private;
+} SAM_DOMAIN_HANDLE;
+
+typedef struct sam_account_handle {
+       TALLOC_CTX *mem_ctx;
+       uint32 access_granted;
+       const struct sam_methods *current_sam_methods; /* sam_methods creating this handle */
+       void (*free_fn)(struct sam_account_handle **);
+       struct sam_account_data {
+               uint32 init_flag;
+               NTTIME logon_time; /* logon time */
+               NTTIME logoff_time; /* logoff time */
+               NTTIME kickoff_time; /* kickoff time */
+               NTTIME pass_last_set_time; /* password last set time */
+               NTTIME pass_can_change_time; /* password can change time */
+               NTTIME pass_must_change_time; /* password must change time */
+               char * account_name; /* account_name string */
+               SAM_DOMAIN_HANDLE * domain; /* domain of account */
+               char *full_name; /* account's full name string */
+               char *unix_home_dir; /* UNIX home directory string */
+               char *home_dir; /* home directory string */
+               char *dir_drive; /* home directory drive string */
+               char *logon_script; /* logon script string */
+               char *profile_path; /* profile path string */
+               char *acct_desc; /* account description string */
+               char *workstations; /* login from workstations string */
+               char *unknown_str; /* don't know what this is, yet. */
+               char *munged_dial; /* munged path name and dial-back tel number */
+               DOM_SID account_sid; /* Primary Account SID */
+               DOM_SID group_sid; /* Primary Group SID */
+               DATA_BLOB lm_pw; /* .data is Null if no password */
+               DATA_BLOB nt_pw; /* .data is Null if no password */
+               char *plaintext_pw; /* if Null not available */
+               uint16 acct_ctrl; /* account info (ACB_xxxx bit-mask) */
+               uint32 unknown_1; /* 0x00ff ffff */
+               uint16 logon_divs; /* 168 - number of hours in a week */
+               uint32 hours_len; /* normally 21 bytes */
+               uint8 hours[MAX_HOURS_LEN];
+               uint32 unknown_2; /* 0x0002 0000 */
+               uint32 unknown_3; /* 0x0000 04ec */
+       } private;
+} SAM_ACCOUNT_HANDLE;
+
+typedef struct sam_group_handle {
+       TALLOC_CTX *mem_ctx;
+       uint32 access_granted;
+       const struct sam_methods *current_sam_methods; /* sam_methods creating this handle */
+       void (*free_fn)(struct sam_group_handle **);
+       struct sam_group_data {
+               char *group_name;
+               char *group_desc;
+               DOM_SID sid;
+               uint16 group_ctrl; /* specifies if the group is a local group or a global group */
+               uint32 num_members;
+       } private;
+} SAM_GROUP_HANDLE;
+
+
+typedef struct sam_group_member {
+       DOM_SID sid; 
+       BOOL group; /* specifies if it is a group or a account */ 
+} SAM_GROUP_MEMBER;
+
+typedef struct sam_account_enum {
+       DOM_SID sid; 
+       char *account_name; 
+       char *full_name; 
+       char *account_desc; 
+       uint16 acct_ctrl; 
+} SAM_ACCOUNT_ENUM;
+
+typedef struct sam_group_enum {
+       DOM_SID sid;
+       char *group_name;
+       char *group_desc;
+       uint16 group_ctrl;
+} SAM_GROUP_ENUM;
+
+
+/* bits for group_ctrl: to spezify if the group is global group or alias */
+#define GCB_LOCAL_GROUP                0x0001
+#define GCB_ALIAS_GROUP                (GCB_LOCAL_GROUP |GCB_BUILTIN)
+#define GCB_GLOBAL_GROUP       0x0002
+#define GCB_BUILTIN            0x1000
+
+typedef struct sam_context 
+{
+       struct sam_methods *methods;
+       TALLOC_CTX *mem_ctx;
+       
+       /* General API */
+       
+       NTSTATUS (*sam_get_sec_desc) (const struct sam_context *, const NT_USER_TOKEN *access_token, const DOM_SID *sid, SEC_DESC **sd);
+       NTSTATUS (*sam_set_sec_desc) (const struct sam_context *, const NT_USER_TOKEN *access_token, const DOM_SID *sid, const SEC_DESC *sd);
+       
+       NTSTATUS (*sam_lookup_sid) (const struct sam_context *, const NT_USER_TOKEN *access_token, const DOM_SID *sid, char **name, uint32 *type);
+       NTSTATUS (*sam_lookup_name) (const struct sam_context *, const NT_USER_TOKEN *access_token, const char *domain, const char *name, DOM_SID **sid, uint32 *type);
+
+
+       /* Domain API */
+
+       NTSTATUS (*sam_update_domain) (const struct sam_context *, const SAM_DOMAIN_HANDLE *domain);
+
+       NTSTATUS (*sam_enum_domains) (const struct sam_context *, const NT_USER_TOKEN *access_token, int32 *domain_count, DOM_SID **domains, char **domain_names);
+       NTSTATUS (*sam_lookup_domain) (const struct sam_context *, const NT_USER_TOKEN * access_token, const char *domain, DOM_SID **domainsid);
+
+       NTSTATUS (*sam_get_domain_by_sid) (const struct sam_context *, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *domainsid, SAM_DOMAIN_HANDLE **domain);
+
+
+       /* Account API */
+
+       NTSTATUS (*sam_create_account) (const struct sam_context *context, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *domainsid, const char *account_name, uint16 acct_ctrl, SAM_ACCOUNT_HANDLE **account);
+       NTSTATUS (*sam_add_account) (const struct sam_context *, const DOM_SID *domainsid, const SAM_ACCOUNT_HANDLE *account);
+       NTSTATUS (*sam_update_account) (const struct sam_context *, const SAM_ACCOUNT_HANDLE *account);
+       NTSTATUS (*sam_delete_account) (const struct sam_context *, const SAM_ACCOUNT_HANDLE *account);
+       NTSTATUS (*sam_enum_accounts) (const struct sam_context *, const NT_USER_TOKEN *access_token, const DOM_SID *domain, uint16 acct_ctrl, uint32 *account_count, SAM_ACCOUNT_ENUM **accounts);
+
+       NTSTATUS (*sam_get_account_by_sid) (const struct sam_context *, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *accountsid, SAM_ACCOUNT_HANDLE **account);
+       NTSTATUS (*sam_get_account_by_name) (const struct sam_context *, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *domain, const char *name, SAM_ACCOUNT_HANDLE **account);
+
+       /* Group API */
+
+       NTSTATUS (*sam_create_group) (const struct sam_context *, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *domainsid, const char *group_name, uint16 group_ctrl, SAM_GROUP_HANDLE **group);
+       NTSTATUS (*sam_add_group) (const struct sam_context *, const DOM_SID *domainsid, const SAM_GROUP_HANDLE *group);
+       NTSTATUS (*sam_update_group) (const struct sam_context *, const SAM_GROUP_HANDLE *group);
+       NTSTATUS (*sam_delete_group) (const struct sam_context *, const SAM_GROUP_HANDLE *group);
+       NTSTATUS (*sam_enum_groups) (const struct sam_context *, const NT_USER_TOKEN *access_token, const DOM_SID *domainsid, const uint16 group_ctrl, uint32 *groups_count, SAM_GROUP_ENUM **groups);
+       NTSTATUS (*sam_get_group_by_sid) (const struct sam_context *, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *groupsid, SAM_GROUP_HANDLE **group);
+       NTSTATUS (*sam_get_group_by_name) (const struct sam_context *, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *domain, const char *name, SAM_GROUP_HANDLE **group);
+
+       NTSTATUS (*sam_add_member_to_group) (const struct sam_context *, const SAM_GROUP_HANDLE *group, const SAM_GROUP_MEMBER *member);
+       NTSTATUS (*sam_delete_member_from_group) (const struct sam_context *, const SAM_GROUP_HANDLE *group, const SAM_GROUP_MEMBER *member);
+       NTSTATUS (*sam_enum_groupmembers) (const struct sam_context *, const SAM_GROUP_HANDLE *group, uint32 *members_count, SAM_GROUP_MEMBER **members);
+
+       NTSTATUS (*sam_get_groups_of_sid) (const struct sam_context *, const NT_USER_TOKEN *access_token, const DOM_SID **sids, uint16 group_ctrl, uint32 *group_count, SAM_GROUP_ENUM **groups);
+       void (*free_fn)(struct sam_context **);
+} SAM_CONTEXT;
+
+typedef struct sam_methods 
+{
+       struct sam_context              *parent;
+       struct sam_methods              *next;
+       struct sam_methods              *prev;
+       const char                      *backendname;
+       const char                      *domain_name;
+       DOM_SID                         domain_sid;
+       void                            *private_data;
+       
+       /* General API */
+       
+       NTSTATUS (*sam_get_sec_desc) (const struct sam_methods *, const NT_USER_TOKEN *access_token, const DOM_SID *sid, SEC_DESC **sd);
+       NTSTATUS (*sam_set_sec_desc) (const struct sam_methods *, const NT_USER_TOKEN *access_token, const DOM_SID *sid, const SEC_DESC *sd);
+       
+       NTSTATUS (*sam_lookup_sid) (const struct sam_methods *, const NT_USER_TOKEN *access_token, const DOM_SID *sid, char **name, uint32 *type);
+       NTSTATUS (*sam_lookup_name) (const struct sam_methods *, const NT_USER_TOKEN *access_token, const char *name, DOM_SID **sid, uint32 *type);
+       
+       /* Domain API */
+
+       NTSTATUS (*sam_update_domain) (const struct sam_methods *, const SAM_DOMAIN_HANDLE *domain);
+       NTSTATUS (*sam_get_domain_handle) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, SAM_DOMAIN_HANDLE **domain);
+
+       /* Account API */
+
+       NTSTATUS (*sam_create_account) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *account_name, uint16 acct_ctrl, SAM_ACCOUNT_HANDLE **account);
+       NTSTATUS (*sam_add_account) (const struct sam_methods *, const SAM_ACCOUNT_HANDLE *account);
+       NTSTATUS (*sam_update_account) (const struct sam_methods *, const SAM_ACCOUNT_HANDLE *account);
+       NTSTATUS (*sam_delete_account) (const struct sam_methods *, const SAM_ACCOUNT_HANDLE *account);
+       NTSTATUS (*sam_enum_accounts) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint16 acct_ctrl, uint32 *account_count, SAM_ACCOUNT_ENUM **accounts);
+
+       NTSTATUS (*sam_get_account_by_sid) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *accountsid, SAM_ACCOUNT_HANDLE **account);
+       NTSTATUS (*sam_get_account_by_name) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *name, SAM_ACCOUNT_HANDLE **account);
+
+       /* Group API */
+
+       NTSTATUS (*sam_create_group) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *group_name, uint16 group_ctrl, SAM_GROUP_HANDLE **group);
+       NTSTATUS (*sam_add_group) (const struct sam_methods *, const SAM_GROUP_HANDLE *group);
+       NTSTATUS (*sam_update_group) (const struct sam_methods *, const SAM_GROUP_HANDLE *group);
+       NTSTATUS (*sam_delete_group) (const struct sam_methods *, const SAM_GROUP_HANDLE *group);
+       NTSTATUS (*sam_enum_groups) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint16 group_ctrl, uint32 *groups_count, SAM_GROUP_ENUM **groups);
+       NTSTATUS (*sam_get_group_by_sid) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, const DOM_SID *groupsid, SAM_GROUP_HANDLE **group);
+       NTSTATUS (*sam_get_group_by_name) (const struct sam_methods *, const NT_USER_TOKEN *access_token, uint32 access_desired, const char *name, SAM_GROUP_HANDLE **group);
+
+       NTSTATUS (*sam_add_member_to_group) (const struct sam_methods *, const SAM_GROUP_HANDLE *group, const SAM_GROUP_MEMBER *member);
+       NTSTATUS (*sam_delete_member_from_group) (const struct sam_methods *, const SAM_GROUP_HANDLE *group, const SAM_GROUP_MEMBER *member);
+       NTSTATUS (*sam_enum_groupmembers) (const struct sam_methods *, const SAM_GROUP_HANDLE *group, uint32 *members_count, SAM_GROUP_MEMBER **members);
+
+       NTSTATUS (*sam_get_groups_of_sid) (const struct sam_methods *, const NT_USER_TOKEN *access_token, const DOM_SID **sids, uint16 group_ctrl, uint32 *group_count, SAM_GROUP_ENUM **groups);
+
+       void (*free_private_data)(void **);
+} SAM_METHODS;
+
+typedef NTSTATUS (*sam_init_function)(SAM_METHODS *, const char *);
+
+struct sam_init_function_entry {
+       char *module_name;
+       /* Function to create a member of the sam_methods list */
+       sam_init_function init;
+};
+
+typedef struct sam_backend_entry {
+       char    *module_name;
+       char    *module_params;
+       char    *domain_name;
+       DOM_SID *domain_sid;
+} SAM_BACKEND_ENTRY;
+
+
+#endif /* _SAM_H */
diff --git a/source3/lib/gencache.c b/source3/lib/gencache.c
new file mode 100644 (file)
index 0000000..9e2009a
--- /dev/null
@@ -0,0 +1,319 @@
+/* 
+   Unix SMB/CIFS implementation.
+
+   Generic, persistent and shared between processes cache mechanism for use
+   by various parts of the Samba code
+
+   Copyright (C) Rafal Szczesniak    2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "includes.h"
+
+#undef  DBGC_CLASS
+#define DBGC_CLASS DBGC_TDB
+
+#define TIMEOUT_LEN 12
+#define CACHE_DATA_FMT "%12u/%s"
+
+static TDB_CONTEXT *cache;
+
+/**
+ * @file gencache.c
+ * @brief Generic, persistent and shared between processes cache mechanism
+ *        for use by various parts of the Samba code
+ *
+ **/
+
+
+/**
+ * Cache initialisation function. Opens cache tdb file or creates
+ * it if does not exist.
+ *
+ * @return true on successful initialisation of the cache or
+ *         false on failure
+ **/
+
+BOOL gencache_init(void)
+{
+       char* cache_fname = NULL;
+       
+       /* skip file open if it's already opened */
+       if (cache) return True;
+
+       asprintf(&cache_fname, "%s/%s", lp_lockdir(), "gencache.tdb");
+       if (cache_fname)
+               DEBUG(5, ("Opening cache file at %s\n", cache_fname));
+       else {
+               DEBUG(0, ("Filename allocation failed.\n"));
+               return False;
+       }
+
+       cache = tdb_open_log(cache_fname, 0, TDB_DEFAULT,
+                            O_RDWR|O_CREAT, 0644);
+
+       SAFE_FREE(cache_fname);
+       if (!cache) {
+               DEBUG(0, ("Attempt to open the cache file has failed.\n"));
+               return False;
+       }
+       return True;
+}
+
+
+/**
+ * Cache shutdown function. Closes opened cache tdb file.
+ *
+ * @return true on successful closing the cache or
+ *         false on failure during cache shutdown
+ **/
+BOOL gencache_shutdown(void)
+{
+       /* tdb_close routine returns 0 on successful close */
+       if (!cache) return False;
+       DEBUG(5, ("Closing cache file\n"));
+       return tdb_close(cache) ? False : True;
+}
+
+
+/**
+ * Add one entry to the cache file.
+ * (it part of tridge's proposed API)
+ *
+ * @param key string that represents a key of this entry
+ * @param value text representation value being cached
+ * @param timeout time when the value is expired
+ *
+ * @return true when entry is successfuly stored or
+ *         false on the attempt's failure
+ **/
+BOOL gencache_add(const char *keystr, const char *value, time_t timeout)
+{
+       int ret;
+       TDB_DATA keybuf, databuf;
+       char* valstr = NULL;
+       
+       /* fail completely if get null pointers passed */
+       SMB_ASSERT(keystr && value);
+
+       if (!gencache_init()) return False;
+       
+       asprintf(&valstr, CACHE_DATA_FMT, (int)timeout, value);
+       keybuf.dptr = strdup(keystr);
+       keybuf.dsize = strlen(keystr);
+       databuf.dptr = strdup(valstr);
+       databuf.dsize = strlen(valstr);
+       DEBUG(10, ("Adding cache entry with key = %s; value = %s and timeout \
+                  = %s (%d seconds %s)\n", keybuf.dptr, value, ctime(&timeout),
+                  (int)(timeout - time(NULL)), timeout > time(NULL) ? "ahead" : "in the past"));
+               
+       ret = tdb_store(cache, keybuf, databuf, TDB_INSERT);
+       SAFE_FREE(valstr);
+       SAFE_FREE(keybuf.dptr);
+       SAFE_FREE(databuf.dptr);
+       
+       return ret == 0 ? True : False;
+}
+
+
+/**
+ * Set existing entry to the cache file.
+ * (it part of tridge's proposed API)
+ *
+ * @param key string that represents a key of this entry
+ * @param value text representation value being cached
+ * @param timeout time when the value is expired
+ *
+ * @return true when entry is successfuly set or
+ *         false on the attempt's failure
+ **/
+
+BOOL gencache_set(const char *keystr, const char *valstr, time_t timeout)
+{
+       int ret = -1;
+       TDB_DATA keybuf, databuf;
+       char *old_valstr, *datastr;
+       time_t old_timeout;
+       
+       /* fail completely if get null pointers passed */
+       SMB_ASSERT(keystr && valstr);
+
+       if (!gencache_init()) return False;
+                       
+       /* 
+        * Check whether entry exists in the cache
+        * Don't verify gencache_get exit code, since the entry may be expired
+        */     
+       gencache_get(keystr, &old_valstr, &old_timeout);
+       
+       if (!(old_valstr && old_timeout)) return False;
+               
+       DEBUG(10, ("Setting cache entry with key = %s; old value = %s and old timeout \
+                  = %s\n", keystr, old_valstr, ctime(&old_timeout)));
+
+       asprintf(&datastr, CACHE_DATA_FMT, (int)timeout, valstr);
+       keybuf.dptr = strdup(keystr);
+       keybuf.dsize = strlen(keystr);
+       databuf.dptr = strdup(datastr);
+       databuf.dsize = strlen(datastr);
+       DEBUGADD(10, ("New value = %s, new timeout = %s (%d seconds %s)", valstr,
+                     ctime(&timeout), (int)(timeout - time(NULL)),
+                     timeout > time(NULL) ? "ahead" : "in the past"));
+
+               
+       ret = tdb_store(cache, keybuf, databuf, TDB_REPLACE);
+
+       SAFE_FREE(datastr);
+       SAFE_FREE(old_valstr);
+       SAFE_FREE(keybuf.dptr);
+       SAFE_FREE(databuf.dptr);
+       
+       return ret == 0 ? True : False;
+}
+
+/**
+ * Delete one entry from the cache file.
+ * (it part of tridge's proposed API)
+ *
+ * @param key string that represents a key of this entry
+ *
+ * @return true upon successful deletion or
+ *         false in case of failure
+ **/
+
+BOOL gencache_del(const char *keystr)
+{
+       int ret;
+       TDB_DATA keybuf;
+       
+       /* fail completely if get null pointers passed */
+       SMB_ASSERT(keystr);
+
+       if (!gencache_init()) return False;     
+       
+       keybuf.dptr = strdup(keystr);
+       keybuf.dsize = strlen(keystr);
+       DEBUG(10, ("Deleting cache entry (key = %s)\n", keystr));
+       ret = tdb_delete(cache, keybuf);
+       
+       SAFE_FREE(keybuf.dptr);
+       return ret == 0 ? True : False;
+}
+
+
+/**
+ * Get existing entry from the cache file.
+ * (it part of tridge's proposed API)
+ *
+ * @param key string that represents a key of this entry
+ * @param value buffer that is allocated and filled with the entry value
+ *        buffer's disposing is done outside
+ * @param timeout pointer to a time_t that is filled with entry's
+ *        timeout
+ *
+ * @return true when entry is successfuly fetched or
+ *         false on the failure
+ **/
+
+BOOL gencache_get(const char *keystr, char **valstr, time_t *timeout)
+{
+       TDB_DATA keybuf, databuf;
+
+       /* fail completely if get null pointers passed */
+       SMB_ASSERT(keystr && valstr && timeout);
+
+       if (!gencache_init()) return False;
+       
+       keybuf.dptr = strdup(keystr);
+       keybuf.dsize = strlen(keystr);
+       databuf = tdb_fetch(cache, keybuf);
+       
+       if (databuf.dptr) {
+               char* entry_buf = strndup(databuf.dptr, databuf.dsize);
+               *valstr = (char*)malloc(sizeof(char) * (databuf.dsize - TIMEOUT_LEN));
+                               
+               sscanf(entry_buf, CACHE_DATA_FMT, (int*)timeout, *valstr);
+               SAFE_FREE(entry_buf);
+
+               DEBUG(10, ("Returning %s cache entry: key = %s, value = %s, timeout = %s\n",
+                          *timeout > time(NULL) ? "valid" : "expired", keystr, *valstr,
+                          ctime(timeout)));
+               return *timeout > time(NULL);
+       } else {
+               *valstr = NULL;
+               timeout = NULL;
+               DEBUG(10, ("Cache entry with key = %s couldn't be found\n", keystr));
+               return False;
+       }
+}
+
+
+/**
+ * Iterate through all entries which key matches to specified pattern
+ *
+ * @param fn pointer to the function that will be supplied with each single
+ *        matching cache entry (key, value and timeout) as an arguments
+ * @param keystr_pattern pattern the existing entries' keys are matched to
+ *
+ **/
+
+void gencache_iterate(void (*fn)(const char* key, const char *value, time_t timeout),
+                      const char* keystr_pattern)
+{
+       TDB_LIST_NODE *node, *first_node;
+       TDB_DATA databuf;
+       char *keystr = NULL, *valstr = NULL, *entry = NULL;
+       time_t timeout = 0;
+
+       /* fail completely if get null pointers passed */
+       SMB_ASSERT(fn && keystr_pattern);
+
+       if (!gencache_init()) return;
+
+       DEBUG(5, ("Searching cache keys with pattern %s", keystr_pattern));
+       node = tdb_search_keys(cache, keystr_pattern);
+       first_node = node;
+       
+       while (node) {
+               /* ensure null termination of the key string */
+               node->node_key.dptr[node->node_key.dsize] = '\0';
+               keystr = node->node_key.dptr;
+
+               /* 
+                * We don't use gencache_get function, because we need to iterate through
+                * all of the entries. Validity verification is up to fn routine.
+                */
+               databuf = tdb_fetch(cache, node->node_key);
+               entry = strndup(databuf.dptr, databuf.dsize);
+               valstr = (char*)malloc(sizeof(char) * (databuf.dsize - TIMEOUT_LEN));
+               sscanf(entry, CACHE_DATA_FMT, (int*)(&timeout), valstr);
+               
+               DEBUG(10, ("Calling function with arguments (key = %s, value = %s, timeout = %s)\n",
+                          keystr, valstr, ctime(&timeout)));
+               fn(keystr, valstr, timeout);
+               
+               SAFE_FREE(valstr);
+               SAFE_FREE(entry);
+               node = node->next;
+       }
+       
+       tdb_search_list_free(first_node);
+}
+
+
diff --git a/source3/lib/sendfile.c b/source3/lib/sendfile.c
new file mode 100644 (file)
index 0000000..98a5260
--- /dev/null
@@ -0,0 +1,302 @@
+/*
+ Unix SMB/Netbios implementation.
+ Version 2.2.x / 3.0.x
+ sendfile implementations.
+ Copyright (C) Jeremy Allison 2002.
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+/*
+ * This file handles the OS dependent sendfile implementations.
+ * The API is such that it returns -1 on error, else returns the
+ * number of bytes written.
+ */
+
+#include "includes.h"
+
+#if defined(LINUX_SENDFILE_API)
+
+#include <sys/sendfile.h>
+
+#ifndef MSG_MORE
+#define MSG_MORE 0x8000
+#endif
+
+ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count)
+{
+       size_t total=0;
+       ssize_t ret;
+       ssize_t hdr_len = 0;
+
+       /*
+        * Send the header first.
+        * Use MSG_MORE to cork the TCP output until sendfile is called.
+        */
+
+       if (header) {
+               hdr_len = header->length;
+               while (total < hdr_len) {
+                       ret = sys_send(tofd, header->data + total,hdr_len - total, MSG_MORE);
+                       if (ret == -1)
+                               return -1;
+                       total += ret;
+               }
+       }
+
+       total = count;
+       while (total) {
+               ssize_t nwritten;
+               do {
+#if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T) && defined(HAVE_SENDFILE64)
+                       nwritten = sendfile64(tofd, fromfd, &offset, total);
+#else
+                       nwritten = sendfile(tofd, fromfd, &offset, total);
+#endif
+               } while (nwritten == -1 && errno == EINTR);
+               if (nwritten == -1)
+                       return -1;
+               if (nwritten == 0)
+                       return -1; /* I think we're at EOF here... */
+               total -= nwritten;
+       }
+       return count + hdr_len;
+}
+
+#elif defined(LINUX_BROKEN_SENDFILE_API)
+
+/*
+ * We must use explicit 32 bit types here. This code path means Linux
+ * won't do proper 64-bit sendfile. JRA.
+ */
+
+extern int32 sendfile (int out_fd, int in_fd, int32 *offset, uint32 count);
+
+
+#ifndef MSG_MORE
+#define MSG_MORE 0x8000
+#endif
+
+ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count)
+{
+       size_t total=0;
+       ssize_t ret;
+       ssize_t hdr_len = 0;
+       uint32 small_total = 0;
+       int32 small_offset;
+
+       /* 
+        * Fix for broken Linux 2.4 systems with no working sendfile64().
+        * If the offset+count > 2 GB then pretend we don't have the
+        * system call sendfile at all. The upper layer catches this
+        * and uses a normal read. JRA.
+        */
+
+       if ((sizeof(SMB_OFF_T) >= 8) && (offset + count > (SMB_OFF_T)0x7FFFFFFF)) {
+               errno = ENOSYS;
+               return -1;
+       }
+
+       /*
+        * Send the header first.
+        * Use MSG_MORE to cork the TCP output until sendfile is called.
+        */
+
+       if (header) {
+               hdr_len = header->length;
+               while (total < hdr_len) {
+                       ret = sys_send(tofd, header->data + total,hdr_len - total, MSG_MORE);
+                       if (ret == -1)
+                               return -1;
+                       total += ret;
+               }
+       }
+
+       small_total = (uint32)count;
+       small_offset = (int32)offset;
+
+       while (small_total) {
+               int32 nwritten;
+               do {
+                       nwritten = sendfile(tofd, fromfd, &small_offset, small_total);
+               } while (nwritten == -1 && errno == EINTR);
+               if (nwritten == -1)
+                       return -1;
+               if (nwritten == 0)
+                       return -1; /* I think we're at EOF here... */
+               small_total -= nwritten;
+       }
+       return count + hdr_len;
+}
+
+
+#elif defined(SOLARIS_SENDFILE_API)
+
+/* Hmmm. Can't find Solaris sendfile API docs.... Where is it ? */
+ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count)
+{
+       errno = ENOSYS;
+       return -1;
+}
+
+#elif defined(HPUX_SENDFILE_API)
+
+#include <sys/socket.h>
+#include <sys/uio.h>
+
+ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count)
+{
+       size_t total=0;
+       struct iovec hdtrl[2];
+       size_t hdr_len = 0;
+
+       if (header) {
+               /* Set up the header/trailer iovec. */
+               hdtrl[0].iov_base = header->data;
+               hdtrl[0].iov_len = hdr_len = header->length;
+       } else {
+               hdtrl[0].iov_base = NULL;
+               hdtrl[0].iov_len = hdr_len = 0;
+       }
+       hdtrl[1].iov_base = NULL;
+       hdtrl[1].iov_base = 0;
+
+       total = count;
+       while (total + hdtrl[0].iov_len) {
+               ssize_t nwritten;
+
+               /*
+                * HPUX guarantees that if any data was written before
+                * a signal interrupt then sendfile returns the number of
+                * bytes written (which may be less than requested) not -1.
+                * nwritten includes the header data sent.
+                */
+
+               do {
+#if defined(HAVE_EXPLICIT_LARGEFILE_SUPPORT) && defined(HAVE_OFF64_T) && defined(HAVE_SENDFILE64)
+                       nwritten = sendfile64(tofd, fromfd, offset, total, &hdtrl[0], 0);
+#else
+                       nwritten = sendfile(tofd, fromfd, offset, total, &hdtrl[0], 0);
+#endif
+               } while (nwritten == -1 && errno == EINTR);
+               if (nwritten == -1)
+                       return -1;
+               if (nwritten == 0)
+                       return -1; /* I think we're at EOF here... */
+
+               /*
+                * If this was a short (signal interrupted) write we may need
+                * to subtract it from the header data, or null out the header
+                * data altogether if we wrote more than hdtrl[0].iov_len bytes.
+                * We change nwritten to be the number of file bytes written.
+                */
+
+               if (hdtrl[0].iov_base && hdtrl[0].iov_len) {
+                       if (nwritten >= hdtrl[0].iov_len) {
+                               nwritten -= hdtrl[0].iov_len;
+                               hdtrl[0].iov_base = NULL;
+                               hdtrl[0].iov_len = 0;
+                       } else {
+                               nwritten = 0;
+                               /* iov_base is defined as a void *... */
+                               hdtrl[0].iov_base = ((char *)hdtrl[0].iov_base) + nwritten;
+                               hdtrl[0].iov_len -= nwritten;
+                       }
+               }
+               total -= nwritten;
+               offset += nwritten;
+       }
+       return count + hdr_len;
+}
+
+#elif defined(FREEBSD_SENDFILE_API)
+
+#include <sys/types.h>
+#include <sys/socket.h>
+#include <sys/uio.h>
+
+ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count)
+{
+       size_t total=0;
+       struct sf_hdtr hdr;
+       struct iovec hdtrl;
+       size_t hdr_len = 0;
+
+       hdr.headers = &hdtrl;
+       hdr.hdr_cnt = 1;
+       hdr.trailers = NULL;
+       hdr.trl_cnt = 0;
+
+       /* Set up the header iovec. */
+       if (header) {
+               hdtrl.iov_base = header->data;
+               hdtrl.iov_len = hdr_len = header->length;
+       } else {
+               hdtrl.iov_base = NULL;
+               hdtrl.iov_len = 0;
+       }
+
+       total = count;
+       while (total + hdtrl.iov_len) {
+               SMB_OFF_T nwritten;
+               int ret;
+
+               /*
+                * FreeBSD sendfile returns 0 on success, -1 on error.
+                * Remember, the tofd and fromfd are reversed..... :-).
+                * nwritten includes the header data sent.
+                */
+
+               do {
+                       ret = sendfile(fromfd, tofd, offset, total, &hdr, &nwritten, 0);
+               } while (ret == -1 && errno == EINTR);
+               if (ret == -1)
+                       return -1;
+
+               if (nwritten == 0)
+                       return -1; /* I think we're at EOF here... */
+
+               /*
+                * If this was a short (signal interrupted) write we may need
+                * to subtract it from the header data, or null out the header
+                * data altogether if we wrote more than hdtrl.iov_len bytes.
+                * We change nwritten to be the number of file bytes written.
+                */
+
+               if (hdtrl.iov_base && hdtrl.iov_len) {
+                       if (nwritten >= hdtrl.iov_len) {
+                               nwritten -= hdtrl.iov_len;
+                               hdtrl.iov_base = NULL;
+                               hdtrl.iov_len = 0;
+                       } else {
+                               nwritten = 0;
+                               hdtrl.iov_base += nwritten;
+                               hdtrl.iov_len -= nwritten;
+                       }
+               }
+               total -= nwritten;
+               offset += nwritten;
+       }
+       return count + hdr_len;
+}
+
+#else /* No sendfile implementation. Return error. */
+
+ssize_t sys_sendfile(int tofd, int fromfd, const DATA_BLOB *header, SMB_OFF_T offset, size_t count)
+{
+       /* No sendfile syscall. */
+       errno = ENOSYS;
+       return -1;
+}
+#endif
diff --git a/source3/libads/ads_utils.c b/source3/libads/ads_utils.c
new file mode 100644 (file)
index 0000000..fc8a270
--- /dev/null
@@ -0,0 +1,171 @@
+/* 
+   Unix SMB/CIFS implementation.
+   ads (active directory) utility library
+   
+   Copyright (C) Stefan (metze) Metzmacher 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "includes.h"
+
+#ifdef HAVE_ADS
+
+
+/* 
+translated the ACB_CTRL Flags to UserFlags (userAccountControl) 
+*/ 
+uint32 ads_acb2uf(uint16 acb)
+{
+       uint32 uf = 0x00000000;
+       
+       if (acb & ACB_DISABLED)         uf |= UF_ACCOUNTDISABLE;
+       if (acb & ACB_HOMDIRREQ)        uf |= UF_HOMEDIR_REQUIRED;
+       if (acb & ACB_PWNOTREQ)         uf |= UF_PASSWD_NOTREQD;        
+       if (acb & ACB_TEMPDUP)          uf |= UF_TEMP_DUPLICATE_ACCOUNT;        
+       if (acb & ACB_NORMAL)           uf |= UF_NORMAL_ACCOUNT;
+       if (acb & ACB_MNS)              uf |= UF_MNS_LOGON_ACCOUNT;
+       if (acb & ACB_DOMTRUST)         uf |= UF_INTERDOMAIN_TRUST_ACCOUNT;
+       if (acb & ACB_WSTRUST)          uf |= UF_WORKSTATION_TRUST_ACCOUNT;
+       if (acb & ACB_SVRTRUST)         uf |= UF_SERVER_TRUST_ACCOUNT;
+       if (acb & ACB_PWNOEXP)          uf |= UF_DONT_EXPIRE_PASSWD;
+       if (acb & ACB_AUTOLOCK)         uf |= UF_LOCKOUT;
+
+       return uf;
+}
+
+/*
+translated the UserFlags (userAccountControl) to ACB_CTRL Flags
+*/
+uint16 ads_uf2acb(uint32 uf)
+{
+       uint16 acb = 0x0000;
+       
+       if (uf & UF_ACCOUNTDISABLE)             acb |= ACB_DISABLED;
+       if (uf & UF_HOMEDIR_REQUIRED)           acb |= ACB_HOMDIRREQ;
+       if (uf & UF_PASSWD_NOTREQD)             acb |= ACB_PWNOTREQ;    
+       if (uf & UF_MNS_LOGON_ACCOUNT)          acb |= ACB_MNS;
+       if (uf & UF_DONT_EXPIRE_PASSWD)         acb |= ACB_PWNOEXP;
+       if (uf & UF_LOCKOUT)                    acb |= ACB_AUTOLOCK;
+       
+       switch (uf & UF_ACCOUNT_TYPE_MASK)
+       {
+               case UF_TEMP_DUPLICATE_ACCOUNT:         acb |= ACB_TEMPDUP;break;       
+               case UF_NORMAL_ACCOUNT:                 acb |= ACB_NORMAL;break;
+               case UF_INTERDOMAIN_TRUST_ACCOUNT:      acb |= ACB_DOMTRUST;break;
+               case UF_WORKSTATION_TRUST_ACCOUNT:      acb |= ACB_WSTRUST;break;
+               case UF_SERVER_TRUST_ACCOUNT:           acb |= ACB_SVRTRUST;break;
+               /*Fix Me: what should we do here? */
+               default:                                acb |= ACB_NORMAL;break;
+       }
+
+       return acb;
+}
+
+/* 
+get the accountType from the UserFlags
+*/
+uint32 ads_uf2atype(uint32 uf)
+{
+       uint32 atype = 0x00000000;
+               
+       if (uf & UF_NORMAL_ACCOUNT)                     atype = ATYPE_NORMAL_ACCOUNT;
+       else if (uf & UF_TEMP_DUPLICATE_ACCOUNT)        atype = ATYPE_NORMAL_ACCOUNT;
+       else if (uf & UF_SERVER_TRUST_ACCOUNT)          atype = ATYPE_WORKSTATION_TRUST;
+       else if (uf & UF_WORKSTATION_TRUST_ACCOUNT)     atype = ATYPE_WORKSTATION_TRUST;
+       else if (uf & UF_INTERDOMAIN_TRUST_ACCOUNT)     atype = ATYPE_INTERDOMAIN_TRUST;
+
+       return atype;
+} 
+
+/* 
+translated the GROUP_CTRL Flags to GroupType (groupType) 
+*/ 
+uint32 ads_gcb2gtype(uint16 gcb)
+{
+       uint32 gtype = 0x00000000;
+
+       if (gcb & GCB_ALIAS_GROUP)      gtype |= GTYPE_SECURITY_BUILTIN_LOCAL_GROUP;
+       else if(gcb & GCB_LOCAL_GROUP)  gtype |= GTYPE_SECURITY_DOMAIN_LOCAL_GROUP;
+       if (gcb & GCB_GLOBAL_GROUP)     gtype |= GTYPE_SECURITY_GLOBAL_GROUP;
+               
+       return gtype;
+}
+
+/*
+translated the GroupType (groupType) to GROUP_CTRL Flags
+*/
+uint16 ads_gtype2gcb(uint32 gtype)
+{
+       uint16 gcb = 0x0000;
+
+       switch(gtype) {
+               case GTYPE_SECURITY_BUILTIN_LOCAL_GROUP:
+                       gcb = GCB_ALIAS_GROUP;
+                       break;
+               case GTYPE_SECURITY_DOMAIN_LOCAL_GROUP:
+                       gcb = GCB_LOCAL_GROUP;
+                       break;
+               case GTYPE_SECURITY_GLOBAL_GROUP:
+                       gcb = GCB_GLOBAL_GROUP;
+                       break;
+
+               case GTYPE_DISTRIBUTION_GLOBAL_GROUP:
+                       gcb = GCB_GLOBAL_GROUP;
+                       break;
+               case GTYPE_DISTRIBUTION_DOMAIN_LOCAL_GROUP:
+                       gcb = GCB_LOCAL_GROUP;
+                       break;
+               case GTYPE_DISTRIBUTION_UNIVERSAL_GROUP:
+                       gcb = GCB_GLOBAL_GROUP;
+                       break;
+       }
+       
+       return gcb;
+}
+
+/* 
+get the accountType from the groupType
+*/
+uint32 ads_gtype2atype(uint32 gtype)
+{
+       uint32 atype = 0x00000000;
+       
+       switch(gtype) {
+               case GTYPE_SECURITY_BUILTIN_LOCAL_GROUP:
+                       atype = ATYPE_SECURITY_LOCAL_GROUP;
+                       break;
+               case GTYPE_SECURITY_DOMAIN_LOCAL_GROUP:
+                       atype = ATYPE_SECURITY_LOCAL_GROUP;
+                       break;
+               case GTYPE_SECURITY_GLOBAL_GROUP:
+                       atype = ATYPE_SECURITY_GLOBAL_GROUP;
+                       break;
+       
+               case GTYPE_DISTRIBUTION_GLOBAL_GROUP:
+                       atype = ATYPE_DISTRIBUTION_GLOBAL_GROUP;
+                       break;
+               case GTYPE_DISTRIBUTION_DOMAIN_LOCAL_GROUP:
+                       atype = ATYPE_DISTRIBUTION_UNIVERSAL_GROUP;
+                       break;
+               case GTYPE_DISTRIBUTION_UNIVERSAL_GROUP:
+                       atype = ATYPE_DISTRIBUTION_LOCAL_GROUP;
+                       break;
+       }
+
+       return atype;
+}
+
+#endif
diff --git a/source3/nsswitch/winbind_client.h b/source3/nsswitch/winbind_client.h
new file mode 100644 (file)
index 0000000..4de2d57
--- /dev/null
@@ -0,0 +1,16 @@
+#include "winbind_nss_config.h"
+#include "winbindd_nss.h"
+
+void init_request(struct winbindd_request *req,int rq_type);
+NSS_STATUS winbindd_send_request(int req_type,
+                                struct winbindd_request *request);
+NSS_STATUS winbindd_get_response(struct winbindd_response *response);
+NSS_STATUS winbindd_request(int req_type, 
+                           struct winbindd_request *request,
+                           struct winbindd_response *response);
+int winbind_open_pipe_sock(void);
+int write_sock(void *buffer, int count);
+int read_reply(struct winbindd_response *response);
+void close_sock(void);
+void free_response(struct winbindd_response *response);
+
diff --git a/source3/python/.cvsignore b/source3/python/.cvsignore
new file mode 100644 (file)
index 0000000..7e99e36
--- /dev/null
@@ -0,0 +1 @@
+*.pyc
\ No newline at end of file
diff --git a/source3/python/README b/source3/python/README
new file mode 100644 (file)
index 0000000..04f7942
--- /dev/null
@@ -0,0 +1,28 @@
+This directory contains Python bindings to allow you to access various
+aspects of Samba.  At the moment their status is "experimental" and
+they are not built by default.
+
+In order to be able to compile samba-python you need to have python
+and the python-dev packages installed.
+
+Python libraries are always built for a particular version of Python
+(2.2, 2.1, etc), and libraries built for one version will not be seen
+by another.  By default Samba's libraries are built for whatever is
+installed as "python" on your $PATH, but you can override this using
+the --with-python option.  For example
+
+  $ ./configure --with-python=python2.2
+
+To build:
+
+$ autoconf
+$ ./configure 
+$ make python_ext
+
+Now, you can install the modules:
+
+$ cp build/lib.*/*.so /usr/lib/python2.1/lib-dynload/
+
+(the directory /usr/lib/python2.1 may vary, depending on your installation)
+
+Samba-python should work now!
diff --git a/source3/python/examples/spoolss/changeid.py b/source3/python/examples/spoolss/changeid.py
new file mode 100755 (executable)
index 0000000..85fe0ef
--- /dev/null
@@ -0,0 +1,34 @@
+#!/usr/bin/python
+#
+# Display the changeid for a list of printers given on the command line
+#
+# Sample usage:
+#
+#     changeid.py '\\win2kdc1\magpie'
+#
+
+import sys
+from samba import spoolss
+
+if len(sys.argv) == 1:
+    print "Usage: changeid.py <printername>"
+    sys.exit(1)
+
+for printer in sys.argv[1:]:
+
+    # Open printer handle
+
+    try:
+        hnd = spoolss.openprinter(printer)
+    except:
+        print "error opening printer %s" % printer
+        sys.exit(1)
+
+    # Fetch and display changeid
+
+    info = hnd.getprinter(level = 0)
+    print info["change_id"]
+
+    # Clean up
+
+    spoolss.closeprinter(hnd)
diff --git a/source3/python/examples/spoolss/enumprinters.py b/source3/python/examples/spoolss/enumprinters.py
new file mode 100755 (executable)
index 0000000..478c46b
--- /dev/null
@@ -0,0 +1,36 @@
+#!/usr/bin/env python
+#
+# Display information on all printers on a print server.  Defaults to
+# printer info level 1.
+#
+# Example: enumprinters.py win2kdc1
+#
+
+import sys
+from samba import spoolss
+
+if len(sys.argv) < 2 or len(sys.argv) > 3:
+    print "Usage: enumprinters.py <servername> [infolevel]"
+    sys.exit(1)
+
+printserver = sys.argv[1]
+
+level = 1
+if len(sys.argv) == 3:
+    level = int(sys.argv[2])
+        
+# Get list of printers
+
+try:
+    printer_list = spoolss.enumprinters("\\\\%s" % printserver)
+except:
+    print "error enumerating printers on %s" % printserver
+    sys.exit(1)
+
+# Display basic info
+
+for printer in printer_list:
+    h = spoolss.openprinter("\\\\%s\\%s" % (printserver, printer))
+    info = h.getprinter(level = level)
+    print "Printer info %d for %s: %s" % (level, printer, info)
+    print
diff --git a/source3/python/examples/spoolss/psec.py b/source3/python/examples/spoolss/psec.py
new file mode 100755 (executable)
index 0000000..498a0ef
--- /dev/null
@@ -0,0 +1,88 @@
+#!/usr/bin/env python
+#
+# Get or set the security descriptor on a printer
+#
+
+import sys, re, string
+from samba import spoolss
+
+if len(sys.argv) != 3:
+    print "Usage: psec.py getsec|setsec printername"
+    sys.exit(1)
+
+op = sys.argv[1]
+printername = sys.argv[2]
+
+# Display security descriptor
+
+if op == "getsec":
+
+    try:
+        hnd = spoolss.openprinter(printername)
+    except:
+        print "error opening printer %s" % printername
+        sys.exit(1)
+
+    secdesc = hnd.getprinter(level = 3)["security_descriptor"]
+
+    print secdesc["owner_sid"]
+    print secdesc["group_sid"]
+
+    for acl in secdesc["dacl"]["ace_list"]:
+        print "%d %d 0x%08x %s" % (acl["type"], acl["flags"],
+                                   acl["mask"], acl["trustee"])
+
+    spoolss.closeprinter(hnd)
+
+    sys.exit(0)
+
+# Set security descriptor
+
+if op == "setsec":
+
+    # Open printer
+
+    try:
+        hnd = spoolss.openprinter(printername,
+                                  creds = {"domain": "NPSD-TEST2",
+                                           "username": "Administrator",
+                                           "password": "penguin"})
+    except:
+        print "error opening printer %s" % printername
+        sys.exit(1)
+
+    # Read lines from standard input and build security descriptor
+
+    lines = sys.stdin.readlines()
+
+    secdesc = {}
+
+    secdesc["owner_sid"] = lines[0]
+    secdesc["group_sid"] = lines[1]
+
+    secdesc["revision"] = 1
+    secdesc["dacl"] = {}
+    secdesc["dacl"]["revision"] = 2
+    secdesc["dacl"]["ace_list"] = []
+
+    for acl in lines[2:]:
+        match = re.match("(\d+) (\d+) (0[xX][\dA-Fa-f]+) (\S+)", acl)
+        secdesc["dacl"]["ace_list"].append(
+            {"type": int(match.group(1)), "flags": int(match.group(2)),
+             "mask": string.atoi(match.group(3), 0), "trustee": match.group(4)})
+
+    # Build info3 structure
+
+    info3 = {}
+
+    info3["flags"] = 0x8004             # self-relative, dacl present
+    info3["level"] = 3
+    info3["security_descriptor"] = secdesc
+
+    hnd.setprinter(info3)
+
+    spoolss.closeprinter(hnd)
+    sys.exit(0)
+
+print "invalid operation %s" % op
+sys.exit(1)
diff --git a/source3/python/examples/tdbpack/tdbtimetrial.py b/source3/python/examples/tdbpack/tdbtimetrial.py
new file mode 100755 (executable)
index 0000000..be64048
--- /dev/null
@@ -0,0 +1,12 @@
+#! /usr/bin/python2.2
+
+def run_trial():
+    # import tdbutil
+    from samba.tdbpack import pack
+    
+    for i in xrange(500000):
+        pack("ddffd", (10, 2, "mbp", "martin", 0))
+        #s = "\n\0\0\0" + "\x02\0\0\0" + "mbp\0" + "martin\0" + "\0\0\0\0"
+
+if __name__ == '__main__':
+    run_trial()
diff --git a/source3/python/examples/tdbpack/test_tdbpack.py b/source3/python/examples/tdbpack/test_tdbpack.py
new file mode 100755 (executable)
index 0000000..36fed88
--- /dev/null
@@ -0,0 +1,195 @@
+#! /usr/bin/env python2.2
+
+__doc__ = """test case for samba.tdbkpack functions
+
+tdbpack provides a means of pickling values into binary formats
+compatible with that used by the samba tdbpack()/tdbunpack()
+functions.
+
+Numbers are always stored in little-endian format; strings are stored
+in either DOS or Unix codepage as appropriate.
+
+The format for any particular element is encoded as a short ASCII
+string, with one character per field."""
+
+# Copyright (C) 2002 Hewlett-Packard.
+
+__author__ = 'Martin Pool <mbp@sourcefrog.net>'
+
+import unittest
+# import tdbutil
+import samba.tdbpack
+
+packer = samba.tdbpack.pack
+unpacker = samba.tdbpack.unpack
+
+
+class PackTests(unittest.TestCase):
+    symm_cases = [('B', ['hello' * 51], '\xff\0\0\0' + 'hello' * 51),
+             ('w', [42], '\x2a\0'),
+             ('www', [42, 2, 69], '\x2a\0\x02\0\x45\0'),
+             ('wd', [42, 256], '\x2a\0\0\x01\0\0'),
+             ('w', [0], '\0\0'),
+             ('w', [255], '\xff\0'),
+             ('w', [256], '\0\x01'),
+             ('w', [0xdead], '\xad\xde'),
+             ('w', [0xffff], '\xff\xff'),
+             ('p', [0], '\0\0\0\0'),
+             ('p', [1], '\x01\0\0\0'),
+             ('d', [0x01020304], '\x04\x03\x02\x01'),
+             ('d', [0x7fffffff], '\xff\xff\xff\x7f'),
+             ('d', [0x80000000], '\x00\x00\x00\x80'),
+             ('d', [-1], '\xff\xff\xff\xff'),
+             ('d', [-255], '\x01\xff\xff\xff'),
+             ('d', [-256], '\x00\xff\xff\xff'),
+             ('ddd', [1, 10, 50], '\x01\0\0\0\x0a\0\0\0\x32\0\0\0'),
+             ('ff', ['hello', 'world'], 'hello\0world\0'),
+             ('fP', ['hello', 'world'], 'hello\0world\0'),
+             ('PP', ['hello', 'world'], 'hello\0world\0'),
+             ('B', [''], '\0\0\0\0'),
+             ('B', ['hello'], '\x05\0\0\0hello'),
+             ('BB', ['hello\0world', 'now'],
+              '\x0b\0\0\0hello\0world\x03\0\0\0now'),
+             ('pd', [1, 10], '\x01\0\0\0\x0a\0\0\0'),
+             ('BBB', ['hello', '', 'world'],
+              '\x05\0\0\0hello\0\0\0\0\x05\0\0\0world'),
+
+             # strings are sequences in Python, there's no getting away
+             # from it
+             ('ffff', 'evil', 'e\0v\0i\0l\0'),
+             ('BBBB', 'evil',                   
+              '\x01\0\0\0e'
+              '\x01\0\0\0v'
+              '\x01\0\0\0i'
+              '\x01\0\0\0l'),
+
+             ('', [], ''),
+
+             # exercise some long strings
+             ('PP', ['hello' * 255, 'world' * 255],
+              'hello' * 255 + '\0' + 'world' * 255 + '\0'),
+             ('PP', ['hello' * 40000, 'world' * 50000],
+              'hello' * 40000 + '\0' + 'world' * 50000 + '\0'),
+             ('B', ['hello' * 51], '\xff\0\0\0' + 'hello' * 51),
+             ('BB', ['hello' * 40000, 'world' * 50000],
+              '\x40\x0d\x03\0' + 'hello' * 40000 + '\x90\xd0\x03\x00' + 'world' * 50000),
+             ]
+
+    def test_symmetric(self):
+        """Cookbook of symmetric pack/unpack tests
+        """
+        for format, values, expected in self.symm_cases:
+            self.assertEquals(packer(format, values), expected)
+            out, rest = unpacker(format, expected)
+            self.assertEquals(rest, '')
+            self.assertEquals(list(values), list(out))
+        
+    
+    def test_pack(self):
+        """Cookbook of expected pack values
+
+        These can't be used for the symmetric test because the unpacked value is
+        not "canonical".
+        """
+        cases = [('w', (42,), '\x2a\0'),
+                 ('p', [None], '\0\0\0\0'),
+                 ('p', ['true'], '\x01\0\0\0'),
+
+                 ('w', {1: 'fruit'}, '\x01\0'),
+                 # passing a dictionary is dodgy, but it gets coerced to keys
+                 # as if you called list()
+                 ]
+
+        for format, values, expected in cases:
+            self.assertEquals(packer(format, values), expected)
+
+    def test_unpack_extra(self):
+        # Test leftover data
+        for format, values, packed in self.symm_cases:
+            out, rest = unpacker(format, packed + 'hello sailor!')
+            self.assertEquals(rest, 'hello sailor!')
+            self.assertEquals(list(values), list(out))
+        
+
+    def test_unpack(self):
+        """Cookbook of tricky unpack tests"""
+        cases = [
+                 ]
+        for format, values, expected in cases:
+            out, rest = unpacker(format, expected)
+            self.assertEquals(rest, '')
+            self.assertEquals(list(values), list(out))
+
+
+    def test_pack_failures(self):
+        """Expected errors for incorrect packing"""
+        cases = [('w', [], IndexError),
+                 ('w', (), IndexError),
+                 ('w', {}, IndexError),
+                 ('ww', [2], IndexError),
+                 ('w', 2, TypeError),
+                 ('', [1, 2, 3], IndexError),
+                 ('w', None, TypeError),
+                 ('wwwwwwwwwwww', [], IndexError),
+                 ('w', [2, 3], IndexError),
+                 ('w', [0x60A15EC5L], TypeError),
+                 ('w', [None], TypeError),
+                 ('w', xrange(10000), IndexError),
+                 ('d', [], IndexError),
+                 ('d', [0L], TypeError),
+                 ('p', [], IndexError),
+                 ('f', [2], TypeError),
+                 ('P', [None], TypeError),
+                 ('P', (), IndexError),
+                 ('f', [packer], TypeError),
+                 ('fw', ['hello'], IndexError),
+                 ('f', [u'hello'], TypeError),
+                 ('B', [2], TypeError),
+                 (None, [2, 3, 4], TypeError),
+                 (ord('f'), [20], TypeError),
+                 (['w', 'w'], [2, 2], TypeError),
+                 ('Q', [2], ValueError),
+                 ('fQ', ['2', 3], ValueError),
+                 ('fQ', ['2'], IndexError),
+                 (2, [2], TypeError),
+                 ({}, {}, TypeError)]
+        for format, values, throwable_class in cases:
+            def do_pack():
+                packer(format, values)
+            self.assertRaises(throwable_class, do_pack)
+
+
+    def test_unpack_failures(self):
+        """Expected errors for incorrect unpacking"""
+        cases = [('$', '', ValueError),
+                 ('Q', '', ValueError),
+                 ('Q$', '', ValueError),
+                 ('f', '', IndexError),
+                 ('d', '', IndexError),
+                 ('d', '2', IndexError),
+                 ('d', '22', IndexError),
+                 ('d', '222', IndexError),
+                 ('w', '', IndexError),
+                 ('w', '2', IndexError),
+                 ('f', 'hello', IndexError),
+                 ('f', '', IndexError),
+                 ('p', '\x01\0', IndexError),
+                 ('B', '\xff\0\0\0hello', IndexError),
+                 ('B', '\xff\0', IndexError),
+                 ('B', '\x01\0\0\0', IndexError),
+                 ('B', '\x05\0\0\0hell', IndexError),
+                 ('B', '\xff\xff\xff\xff', ValueError),
+                 ('B', 'foobar', IndexError),
+                 ('BB', '\x01\0\0\0a\x01', IndexError),
+                 ]
+        
+        for format, values, throwable_class in cases:
+            def do_unpack():
+                unpacker(format, values)
+            self.assertRaises(throwable_class, do_unpack)
+
+        
+
+if __name__ == '__main__':
+    unittest.main()
+    
diff --git a/source3/python/gprinterdata b/source3/python/gprinterdata
new file mode 100755 (executable)
index 0000000..cd06207
--- /dev/null
@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+import sys
+from gtkdictbrowser import GtkDictBrowser, hex_string
+import gtk
+from samba import spoolss
+import string
+import printerdata
+
+# Initialise printerdata dictionary
+
+if len(sys.argv) < 2 or len(sys.argv) > 3:
+    print "Usage: gprinterdata [--ex] <printer>"
+    print "where <printer> is a UNC printer name."
+    sys.exit(1)
+
+try:
+    host = string.replace(sys.argv[len(sys.argv) - 1], "/", "\\")
+    if sys.argv[1] == "--ex":
+        t = printerdata.printerdata_ex(host)
+    else:
+        t = printerdata.printerdata(host)
+except:
+    print "gprinterdata: error opening %s" % sys.argv[len(sys.argv) - 1]
+    sys.exit(1)
+
+# Create interface
+
+db = GtkDictBrowser(t)
+db.register_get_value_text_fn("", hex_string)
+db.build_ui('gprinterdata')
+
+# Override Python's handling of ctrl-c so we can break out of the
+# gui from the command line.
+
+import signal
+signal.signal(signal.SIGINT, signal.SIG_DFL)
+
+gtk.mainloop()
diff --git a/source3/python/gtdbtool b/source3/python/gtdbtool
new file mode 100755 (executable)
index 0000000..129f4fe
--- /dev/null
@@ -0,0 +1,39 @@
+#!/usr/bin/env python
+
+import sys
+from gtkdictbrowser import GtkDictBrowser
+import gtk
+from samba import tdb
+import string
+
+# Open handle on tdb
+
+if len(sys.argv) != 2:
+    print "Usage: gdbtool <tdbfile>"
+    sys.exit(1)
+
+try:
+    t = tdb.open(sys.argv[1])
+except tdb.error, t:
+    print "gtdbtool: error opening %s: %s" % (sys.argv[1], t)
+    sys.exit(1)
+
+# Create interface
+
+db = GtkDictBrowser(t)
+
+def display_key_x00(key):
+    """Remove \x00 from all keys as they mucks up GTK."""
+    return string.replace(key, "\x00", "")
+
+db.register_get_key_text_fn(display_key_x00)
+
+db.build_ui('gtdbtool')
+
+# Override Python's handling of ctrl-c so we can break out of the
+# gui from the command line.
+
+import signal
+signal.signal(signal.SIGINT, signal.SIG_DFL)
+
+gtk.mainloop()
diff --git a/source3/python/gtkdictbrowser.py b/source3/python/gtkdictbrowser.py
new file mode 100755 (executable)
index 0000000..dd8bed8
--- /dev/null
@@ -0,0 +1,272 @@
+#!/usr/bin/python
+#
+# Browse a Python dictionary in a two pane graphical interface written
+# in GTK.
+#
+# The GtkDictBrowser class is supposed to be generic enough to allow
+# applications to override enough methods and produce a
+# domain-specific browser provided the information is presented as a
+# Python dictionary.
+#
+# Possible applications:
+#
+#   - Windows registry browser
+#   - SPOOLSS printerdata browser
+#   - tdb file browser
+#
+
+from gtk import *
+import string, re
+
+class GtkDictBrowser:
+
+    def __init__(self, dict):
+        self.dict = dict
+        
+        # This variable stores a list of (regexp, function) used to
+        # convert the raw value data to a displayable string.
+
+        self.get_value_text_fns = []
+        self.get_key_text = lambda x: x
+
+        # We can filter the list of keys displayed using a regex
+
+        self.filter_regex = ""
+
+    # Create and configure user interface widgets.  A string argument is
+    # used to set the window title.
+
+    def build_ui(self, title):
+        win = GtkWindow()
+        win.set_title(title)
+
+        win.connect("destroy", mainquit)
+
+        hpaned = GtkHPaned()
+        win.add(hpaned)
+        hpaned.set_border_width(5)
+        hpaned.show()
+
+        vbox = GtkVBox()
+        hpaned.add1(vbox)
+        vbox.show()
+
+        scrolled_win = GtkScrolledWindow()
+        scrolled_win.set_policy(POLICY_AUTOMATIC, POLICY_AUTOMATIC)
+        vbox.pack_start(scrolled_win)
+        scrolled_win.show()
+
+        hbox = GtkHBox()
+        vbox.pack_end(hbox, expand = 0, padding = 5)
+        hbox.show()
+
+        label = GtkLabel("Filter:")
+        hbox.pack_start(label, expand = 0, padding = 5)
+        label.show()
+
+        self.entry = GtkEntry()
+        hbox.pack_end(self.entry, padding = 5)
+        self.entry.show()
+
+        self.entry.connect("activate", self.filter_activated)
+        
+        self.list = GtkList()
+        self.list.set_selection_mode(SELECTION_MULTIPLE)
+        self.list.set_selection_mode(SELECTION_BROWSE)
+        scrolled_win.add_with_viewport(self.list)
+        self.list.show()
+
+        self.list.connect("select_child", self.key_selected)
+
+        scrolled_win = GtkScrolledWindow()
+        scrolled_win.set_policy(POLICY_AUTOMATIC, POLICY_AUTOMATIC)
+        hpaned.add2(scrolled_win)
+        scrolled_win.set_usize(500,400)
+        scrolled_win.show()
+        
+        self.text = GtkText()
+        self.text.set_editable(FALSE)
+        scrolled_win.add_with_viewport(self.text)
+        self.text.show()
+
+        self.text.connect("event", self.event_handler)
+
+        self.menu = GtkMenu()
+        self.menu.show()
+
+        self.font = load_font("fixed")
+
+        self.update_keylist()
+
+        win.show()
+
+    # Add a key to the left hand side of the user interface
+
+    def add_key(self, key):
+        display_key = self.get_key_text(key)
+        list_item = GtkListItem(display_key)
+        list_item.set_data("raw_key", key) # Store raw key in item data
+        self.list.add(list_item)
+        list_item.show()
+
+    # Event handler registered by build_ui()
+
+    def event_handler(self, event, menu):
+        return FALSE
+
+    # Set the text to appear in the right hand side of the user interface 
+
+    def set_value_text(self, item):
+
+        # Clear old old value in text window
+
+        self.text.delete_text(0, self.text.get_length())
+        
+        if type(item) == str:
+
+            # The text widget has trouble inserting text containing NULL
+            # characters.
+            
+            item = string.replace(item, "\x00", ".")
+            
+            self.text.insert(self.font, None, None, item)
+
+        else:
+
+            # A non-text item
+            
+            self.text.insert(self.font, None, None, repr(item))
+            
+    # This function is called when a key is selected in the left hand side
+    # of the user interface.
+
+    def key_selected(self, list, list_item):
+        key = list_item.children()[0].get()
+
+        # Look for a match in the value display function list
+
+        text = self.dict[list_item.get_data("raw_key")]
+
+        for entry in self.get_value_text_fns:
+            if re.match(entry[0], key):
+                text = entry[1](text)
+                break
+
+        self.set_value_text(text)
+
+    # Refresh the key list by removing all items and re-inserting them.
+    # Items are only inserted if they pass through the filter regexp.
+
+    def update_keylist(self):
+        self.list.remove_items(self.list.children())
+        self.set_value_text("")
+        for k in self.dict.keys():
+            if re.match(self.filter_regex, k):
+                self.add_key(k)
+
+    # Invoked when the user hits return in the filter text entry widget.
+
+    def filter_activated(self, entry):
+        self.filter_regex = entry.get_text()
+        self.update_keylist()
+
+    # Register a key display function
+
+    def register_get_key_text_fn(self, fn):
+        self.get_key_text = fn
+
+    # Register a value display function
+
+    def register_get_value_text_fn(self, regexp, fn):
+        self.get_value_text_fns.append((regexp, fn))
+
+#
+# A utility function to convert a string to the standard hex + ascii format.
+# To display all values in hex do:
+#   register_get_value_text_fn("", gtkdictbrowser.hex_string)
+#
+
+def hex_string(data):
+    """Return a hex dump of a string as a string.
+
+    The output produced is in the standard 16 characters per line hex +
+    ascii format:
+
+    00000000: 40 00 00 00 00 00 00 00  40 00 00 00 01 00 04 80  @....... @.......
+    00000010: 01 01 00 00 00 00 00 01  00 00 00 00              ........ ....
+    """
+    
+    pos = 0                             # Position in data
+    line = 0                            # Line of data
+    
+    hex = ""                            # Hex display
+    ascii = ""                          # ASCII display
+
+    result = ""
+    
+    while pos < len(data):
+        
+       # Start with header
+        
+       if pos % 16 == 0:
+            hex = "%08x: " % (line * 16)
+            ascii = ""
+            
+        # Add character
+            
+       hex = hex + "%02x " % (ord(data[pos]))
+        
+        if ord(data[pos]) < 32 or ord(data[pos]) > 176:
+            ascii = ascii + '.'
+        else:
+            ascii = ascii + data[pos]
+                
+        pos = pos + 1
+            
+        # Add separator if half way
+            
+       if pos % 16 == 8:
+            hex = hex + " "
+            ascii = ascii + " "
+
+        # End of line
+
+       if pos % 16 == 0:
+            result = result + "%s %s\n" % (hex, ascii)
+            line = line + 1
+            
+    # Leftover bits
+
+    if pos % 16 != 0:
+
+        # Pad hex string
+
+        for i in range(0, (16 - (pos % 16))):
+            hex = hex + "   "
+
+        # Half way separator
+
+        if (pos % 16) < 8:
+            hex = hex + " "
+
+        result = result + "%s %s\n" % (hex, ascii)
+
+    return result
+
+# For testing purposes, create a fixed dictionary to browse with
+
+if __name__ == "__main__":
+
+    dict = {"chicken": "ham", "spam": "fun", "subdict": {"a": "b", "c": "d"}}
+
+    db = GtkDictBrowser(dict)
+
+    db.build_ui("GtkDictBrowser")
+
+    # Override Python's handling of ctrl-c so we can break out of the
+    # gui from the command line.
+
+    import signal
+    signal.signal(signal.SIGINT, signal.SIG_DFL)
+
+    mainloop()
diff --git a/source3/python/py_common.c b/source3/python/py_common.c
new file mode 100644 (file)
index 0000000..e21858e
--- /dev/null
@@ -0,0 +1,270 @@
+/* 
+   Python wrappers for DCERPC/SMB client routines.
+
+   Copyright (C) Tim Potter, 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "includes.h"
+#include "Python.h"
+
+#include "python/py_common_proto.h"
+
+/* Return a tuple of (error code, error string) from a WERROR */
+
+PyObject *py_werror_tuple(WERROR werror)
+{
+       return Py_BuildValue("[is]", W_ERROR_V(werror), 
+                            dos_errstr(werror));
+}
+
+/* Return a tuple of (error code, error string) from a WERROR */
+
+PyObject *py_ntstatus_tuple(NTSTATUS ntstatus)
+{
+       return Py_BuildValue("[is]", NT_STATUS_V(ntstatus), 
+                            nt_errstr(ntstatus));
+}
+
+/* Initialise samba client routines */
+
+static BOOL initialised;
+
+void py_samba_init(void)
+{
+       extern pstring global_myname;
+       char *p;
+
+       if (initialised)
+               return;
+
+       /* Load configuration file */
+
+       if (!lp_load(dyn_CONFIGFILE, True, False, False))
+               fprintf(stderr, "Can't load %s\n", dyn_CONFIGFILE);
+
+       /* Misc other stuff */
+
+       load_interfaces();
+       
+       fstrcpy(global_myname, myhostname());
+       p = strchr(global_myname, '.');
+       if (p)
+               *p = 0;
+
+       initialised = True;
+}
+
+/* Debuglevel routines */
+
+PyObject *get_debuglevel(PyObject *self, PyObject *args)
+{
+       PyObject *debuglevel;
+
+       if (!PyArg_ParseTuple(args, ""))
+               return NULL;
+
+       debuglevel = PyInt_FromLong(DEBUGLEVEL);
+
+       return debuglevel;
+}
+
+PyObject *set_debuglevel(PyObject *self, PyObject *args)
+{
+       int debuglevel;
+
+       if (!PyArg_ParseTuple(args, "i", &debuglevel))
+               return NULL;
+
+       DEBUGLEVEL = debuglevel;
+
+       Py_INCREF(Py_None);
+       return Py_None;
+}
+
+/* Initialise logging */
+
+PyObject *py_setup_logging(PyObject *self, PyObject *args, PyObject *kw)
+{
+       BOOL interactive = False;
+       char *logfilename = NULL;
+       static char *kwlist[] = {"interactive", "logfilename", NULL};
+
+       if (!PyArg_ParseTupleAndKeywords(
+                   args, kw, "|is", kwlist, &interactive, &logfilename))
+               return NULL;
+       
+       if (interactive && logfilename) {
+               PyErr_SetString(PyExc_RuntimeError,
+                               "can't be interactive and set log file name");
+               return NULL;
+       }
+
+       if (interactive)
+               setup_logging("spoolss", True);
+
+       if (logfilename) {
+               lp_set_logfile(logfilename);
+               setup_logging(logfilename, False);
+               reopen_logs();
+       }
+
+       Py_INCREF(Py_None);
+       return Py_None;
+}
+
+/* Parse credentials from a python dictionary.  The dictionary can
+   only have the keys "username", "domain" and "password".  Return
+   True for valid credentials in which case the username, domain and
+   password are set to pointers to their values from the dicationary.
+   If returns False, the errstr is set to point at some mallocated
+   memory describing the error. */
+
+BOOL py_parse_creds(PyObject *creds, char **username, char **domain, 
+                   char **password, char **errstr)
+{
+       /* Initialise anonymous credentials */
+
+       *username = "";
+       *domain = "";
+       *password = "";
+
+       if (creds && PyDict_Size(creds) > 0) {
+               PyObject *username_obj, *password_obj, *domain_obj;
+               PyObject *key, *value;
+               int i;
+
+               /* Check for presence of required fields */
+
+               username_obj = PyDict_GetItemString(creds, "username");
+               domain_obj = PyDict_GetItemString(creds, "domain");
+               password_obj = PyDict_GetItemString(creds, "password");
+
+               if (!username_obj) {
+                       *errstr = strdup("no username field in credential");
+                       return False;
+               }
+
+               if (!domain_obj) {
+                       *errstr = strdup("no domain field in credential");
+                       return False;
+               }
+
+               if (!password_obj) {
+                       *errstr = strdup("no password field in credential");
+                       return False;
+               }
+
+               /* Check type of required fields */
+
+               if (!PyString_Check(username_obj)) {
+                       *errstr = strdup("username field is not string type");
+                       return False;
+               }
+
+               if (!PyString_Check(domain_obj)) {
+                       *errstr = strdup("domain field is not string type");
+                       return False;
+               }
+
+               if (!PyString_Check(password_obj)) {
+                       *errstr = strdup("password field is not string type");
+                       return False;
+               }
+
+               /* Look for any extra fields */
+
+               i = 0;
+
+               while (PyDict_Next(creds, &i, &key, &value)) {
+                       if (strcmp(PyString_AsString(key), "domain") != 0 &&
+                           strcmp(PyString_AsString(key), "username") != 0 &&
+                           strcmp(PyString_AsString(key), "password") != 0) {
+                               asprintf(errstr,
+                                        "creds contain extra field '%s'",
+                                        PyString_AsString(key));
+                               return False;
+                       }
+               }
+
+               /* Assign values */
+
+               *username = PyString_AsString(username_obj);
+               *domain = PyString_AsString(domain_obj);
+               *password = PyString_AsString(password_obj);
+       }
+
+       *errstr = NULL;
+
+       return True;
+}
+
+/* Return a cli_state to a RPC pipe on the given server.  Use the
+   credentials passed if not NULL.  If an error occurs errstr is set to a
+   string describing the error and NULL is returned.  If set, errstr must
+   be freed by calling free(). */
+
+struct cli_state *open_pipe_creds(char *server, PyObject *creds, 
+                                 char *pipe_name, char **errstr)
+{
+       char *username, *password, *domain;
+       struct cli_state *cli;
+       NTSTATUS result;
+       
+       /* Extract credentials from the python dictionary */
+
+       if (!py_parse_creds(creds, &username, &domain, &password, errstr))
+               return NULL;
+
+       /* Now try to connect */
+
+       result = cli_full_connection(
+               &cli, NULL, server, NULL, 0, "IPC$", "IPC",
+               username, domain, password, 0);
+       
+       if (!NT_STATUS_IS_OK(result)) {
+               *errstr = strdup("error connecting to IPC$ pipe");
+               return NULL;
+       }
+
+       if (!cli_nt_session_open(cli, pipe_name)) {
+               cli_shutdown(cli);
+               free(cli);
+               asprintf(errstr, "error opening %s", pipe_name);
+               return NULL;
+       }
+
+       *errstr = NULL;
+
+       return cli;
+}
+
+/* Return true if a dictionary contains a "level" key with an integer
+   value.  Set the value if so. */
+
+BOOL get_level_value(PyObject *dict, uint32 *level)
+{
+       PyObject *obj;
+
+       if (!(obj = PyDict_GetItemString(dict, "level")) ||
+           !PyInt_Check(obj))
+               return False;
+
+       if (level)
+               *level = PyInt_AsLong(obj);
+
+       return True;
+}
diff --git a/source3/python/py_conv.c b/source3/python/py_conv.c
new file mode 100644 (file)
index 0000000..20302c8
--- /dev/null
@@ -0,0 +1,184 @@
+/* 
+   Python wrappers for DCERPC/SMB client routines.
+
+   Copyright (C) Tim Potter, 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "includes.h"
+#include "Python.h"
+#include "py_conv.h"
+
+/* Helper for rpcstr_pull() function */
+
+static void fstr_pull(fstring str, UNISTR *uni)
+{
+       rpcstr_pull(str, uni->buffer, sizeof(fstring), -1, STR_TERMINATE);
+}
+
+/* Convert a structure to a Python dict */
+
+PyObject *from_struct(void *s, struct pyconv *conv)
+{
+       PyObject *obj, *item;
+       int i;
+
+       obj = PyDict_New();
+
+       for (i = 0; conv[i].name; i++) {
+               switch (conv[i].type) {
+               case PY_UNISTR: {
+                       UNISTR *u = (UNISTR *)((char *)s + conv[i].offset);
+                       fstring s = "";
+
+                       if (u->buffer)
+                               fstr_pull(s, u);
+
+                       item = PyString_FromString(s);
+                       PyDict_SetItemString(obj, conv[i].name, item);
+
+                       break;
+               }
+               case PY_UINT32: {
+                       uint32 *u = (uint32 *)((char *)s + conv[i].offset);
+
+                       item = PyInt_FromLong(*u);
+                       PyDict_SetItemString(obj, conv[i].name, item);
+                       
+                       break;
+               }
+               case PY_UINT16: {
+                       uint16 *u = (uint16 *)((char *)s + conv[i].offset);
+
+                       item = PyInt_FromLong(*u);
+                       PyDict_SetItemString(obj, conv[i].name, item);
+
+                       break;
+               }
+               case PY_STRING: {
+                       char *str = (char *)s + conv[i].offset;
+
+                       item = PyString_FromString(str);
+                       PyDict_SetItemString(obj, conv[i].name, item);
+
+                       break;
+               }
+               case PY_UID: {
+                       uid_t *uid = (uid_t *)((char *)s + conv[i].offset);
+
+                       item = PyInt_FromLong(*uid);
+                       PyDict_SetItemString(obj, conv[i].name, item);
+
+                       break;
+               }
+               case PY_GID: {
+                       gid_t *gid = (gid_t *)((char *)s + conv[i].offset);
+
+                       item = PyInt_FromLong(*gid);
+                       PyDict_SetItemString(obj, conv[i].name, item);
+
+                       break;
+               }
+               default:
+                       
+                       break;
+               }
+       }
+
+       return obj;
+}
+
+/* Convert a Python dict to a structure */
+
+BOOL to_struct(void *s, PyObject *dict, struct pyconv *conv)
+{
+       PyObject *visited, *key, *value;
+       BOOL result = False;
+       int i;
+
+       visited = PyDict_New();
+
+       for (i = 0; conv[i].name; i++) {
+               PyObject *obj;
+               
+               obj = PyDict_GetItemString(dict, conv[i].name);
+
+               if (!obj)
+                       goto done;
+               
+               switch (conv[i].type) {
+               case PY_UNISTR: {
+                       UNISTR *u = (UNISTR *)((char *)s + conv[i].offset);
+                       char *s = "";
+
+                       if (!PyString_Check(obj))
+                               goto done;
+
+                       s = PyString_AsString(obj);
+                       init_unistr(u, s);
+                       
+                       break;
+               }
+               case PY_UINT32: {
+                       uint32 *u = (uint32 *)((char *)s + conv[i].offset);
+
+                       if (!PyInt_Check(obj))
+                               goto done;
+
+                       *u = PyInt_AsLong(obj);
+
+                       break;
+               }
+               case PY_UINT16: {
+                       uint16 *u = (uint16 *)((char *)s + conv[i].offset);
+
+                       if (!PyInt_Check(obj)) 
+                               goto done;
+
+                       *u = PyInt_AsLong(obj);
+                       break;
+               }
+               default:
+                       break;
+               }
+
+               /* Mark as visited */
+
+               PyDict_SetItemString(visited, conv[i].name, 
+                                    PyInt_FromLong(1));
+       }
+
+       /* Iterate over each item in the input dictionary and see if it was
+          visited.  If it wasn't then the user has added some extra crap
+          to the dictionary. */
+
+       i = 0;
+
+       while (PyDict_Next(dict, &i, &key, &value)) {
+               if (!PyDict_GetItem(visited, key))
+                       goto done;
+       }
+
+       result = True;
+
+done:
+       /* We must decrement the reference count here or the visited
+          dictionary will not be freed. */
+              
+       Py_DECREF(visited);
+
+       return result;
+}
diff --git a/source3/python/py_conv.h b/source3/python/py_conv.h
new file mode 100644 (file)
index 0000000..24f5a66
--- /dev/null
@@ -0,0 +1,40 @@
+/* 
+   Python wrappers for DCERPC/SMB client routines.
+
+   Copyright (C) Tim Potter, 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#ifndef _PY_CONV_H
+#define _PY_CONV_H
+
+enum pyconv_types { PY_UNISTR, PY_UINT32, PY_UINT16, PY_STRING, PY_UID, PY_GID };
+
+struct pyconv {
+       char *name;             /* Name of member */
+       enum pyconv_types type; /* Type */
+       size_t offset;          /* Offset into structure */
+};
+
+PyObject *from_struct(void *s, struct pyconv *conv);
+BOOL to_struct(void *s, PyObject *dict, struct pyconv *conv);
+
+/* Another version of offsetof (-: */
+
+#undef offsetof
+#define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
+
+#endif /* _PY_CONV_H */
diff --git a/source3/python/py_samba.c b/source3/python/py_samba.c
new file mode 100644 (file)
index 0000000..c0ade12
--- /dev/null
@@ -0,0 +1,56 @@
+/* 
+   Python wrappers for DCERPC/SMB client routines.
+
+   Copyright (C) Tim Potter, 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "Python.h"
+#include "python/py_common.h"
+
+/*
+ * Module initialisation 
+ */
+
+static PyObject *lsa_open_policy(PyObject *self, PyObject *args, 
+                               PyObject *kw) 
+{
+       return NULL;
+}
+
+static PyMethodDef samba_methods[] = {
+       { NULL }
+};
+
+static PyMethodDef cheepy_methods[] = {
+       { "open_policy", (PyCFunction)lsa_open_policy, METH_VARARGS|METH_KEYWORDS,
+         "Foo"},
+       { NULL }
+};
+
+void initsamba(void)
+{
+       PyObject *module, *new_module, *dict;
+
+       /* Initialise module */
+
+       module = Py_InitModule("samba", samba_methods);
+       dict = PyModule_GetDict(module);
+
+       /* Do samba initialisation */
+
+       py_samba_init();
+}
diff --git a/source3/python/py_samr.c b/source3/python/py_samr.c
new file mode 100644 (file)
index 0000000..917a90a
--- /dev/null
@@ -0,0 +1,498 @@
+/* 
+   Python wrappers for DCERPC/SMB client routines.
+
+   Copyright (C) Tim Potter, 2002
+   
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 2 of the License, or
+   (at your option) any later version.
+   
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+   
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+*/
+
+#include "python/py_samr.h"
+
+/* 
+ * Exceptions raised by this module 
+ */
+
+PyObject *samr_error;          /* This indicates a non-RPC related error
+                                  such as name lookup failure */
+
+PyObject *samr_ntstatus;       /* This exception is raised when a RPC call
+                                  returns a status code other than
+                                  NT_STATUS_OK */
+
+/* SAMR connect handle object */
+
+static void py_samr_connect_hnd_dealloc(PyObject* self)
+{
+       PyObject_Del(self);
+}
+
+PyObject *new_samr_domain_hnd_object(struct cli_state *cli, TALLOC_CTX *mem_ctx,
+                                    POLICY_HND *pol)
+{
+       samr_domain_hnd_object *o;
+
+       o = PyObject_New(samr_domain_hnd_object, &samr_domain_hnd_type);
+
+       o->cli = cli;
+       o->mem_ctx = mem_ctx;
+       memcpy(&o->domain_pol, pol, sizeof(POLICY_HND));
+
+       return (PyObject*)o;
+}
+
+static PyObject *samr_open_domain(PyObject *self, PyObject *args, PyObject *kw)
+{
+       samr_connect_hnd_object *connect_hnd = (samr_connect_hnd_object *)self;
+       static char *kwlist[] = { "sid", "access", NULL };
+       uint32 desired_access = MAXIMUM_ALLOWED_ACCESS;
+       char *sid_str;
+       DOM_SID sid;
+       TALLOC_CTX *mem_ctx = NULL;
+       POLICY_HND domain_pol;
+       NTSTATUS ntstatus;
+       PyObject *result = NULL;
+
+       if (!PyArg_ParseTupleAndKeywords(
+                   args, kw, "s|i", kwlist, &sid_str, &desired_access))
+               return NULL;
+
+       if (!string_to_sid(&sid, sid_str)) {
+               PyErr_SetString(PyExc_TypeError, "string is not a sid");
+               return NULL;
+       }
+
+       if (!(mem_ctx = talloc_init())) {
+               PyErr_SetString(samr_error, "unable to init talloc context");
+               return NULL;
+       }
+
+       ntstatus = cli_samr_open_domain(
+               connect_hnd->cli, mem_ctx, &connect_hnd->connect_pol,
+               desired_access, &sid, &domain_pol);
+                                       
+       if (!NT_STATUS_IS_OK(ntstatus)) {
+               PyErr_SetObject(samr_ntstatus, py_ntstatus_tuple(ntstatus));
+               goto done;
+       }
+
+       result = new_samr_domain_hnd_object(
+               connect_hnd->cli, mem_ctx, &domain_pol);
+
+done:
+       if (!result) {
+               if (mem_ctx)
+                       talloc_destroy(mem_ctx);
+       }
+
+       return result;
+}
+
+static PyMethodDef samr_connect_methods[] = {
+       { "open_domain", (PyCFunction)samr_open_domain,
+         METH_VARARGS | METH_KEYWORDS,
+         "Open a handle on a domain" },
+
+       { NULL }
+};
+
+static PyObject *py_samr_connect_hnd_getattr(PyObject *self, char *attrname)
+{
+       return Py_FindMethod(samr_connect_methods, self, attrname);
+}
+
+PyTypeObject samr_connect_hnd_type = {
+       PyObject_HEAD_INIT(NULL)
+       0,
+       "SAMR Connect Handle",
+       sizeof(samr_connect_hnd_object),
+       0,
+       py_samr_connect_hnd_dealloc, /*tp_dealloc*/
+       0,          /*tp_print*/
+       py_samr_connect_hnd_getattr,          /*tp_getattr*/
+       0,          /*tp_setattr*/
+       0,          /*tp_compare*/
+       0,          /*tp_repr*/
+       0,          /*tp_as_number*/
+       0,          /*tp_as_sequence*/
+       0,          /*tp_as_mapping*/
+       0,          /*tp_hash */
+};
+
+PyObject *new_samr_connect_hnd_object(struct cli_state *cli, TALLOC_CTX *mem_ctx,
+                                     POLICY_HND *pol)
+{
+       samr_connect_hnd_object *o;
+
+       o = PyObject_New(samr_connect_hnd_object, &samr_connect_hnd_type);
+
+       o->cli = cli;
+       o->mem_ctx = mem_ctx;
+       memcpy(&o->connect_pol, pol, sizeof(POLICY_HND));
+
+       return (PyObject*)o;
+}
+
+/* SAMR domain handle object */
+
+static void py_samr_domain_hnd_dealloc(PyObject* self)
+{
+       PyObject_Del(self);
+}
+
+static PyObject *samr_enum_dom_groups(PyObject *self, PyObject *args, 
+                                     PyObject *kw)
+{
+       samr_domain_hnd_object *domain_hnd = (samr_domain_hnd_object *)self;
+       static char *kwlist[] = { NULL };
+       TALLOC_CTX *mem_ctx;
+       uint32 desired_access = MAXIMUM_ALLOWED_ACCESS;
+       uint32 start_idx, size, num_dom_groups;
+       struct acct_info *dom_groups;
+       NTSTATUS result;
+       PyObject *py_result = NULL;
+       
+       if (!PyArg_ParseTupleAndKeywords(
+                   args, kw, "", kwlist))
+               return NULL;
+
+       if (!(mem_ctx = talloc_init())) {
+               PyErr_SetString(samr_error, "unable to init talloc context");
+               return NULL;
+       }
+
+       start_idx = 0;
+       size = 0xffff;
+
+       do {
+               result = cli_samr_enum_dom_groups(
+                       domain_hnd->cli, mem_ctx, &domain_hnd->domain_pol,
+                       &start_idx, size, &dom_groups, &num_dom_groups);
+
+               if (NT_STATUS_IS_OK(result) ||
+                   NT_STATUS_V(result) == NT_STATUS_V(STATUS_MORE_ENTRIES)) {
+                       py_from_acct_info(&py_result, dom_groups,
+                                         num_dom_groups);
+               }
+
+       } while (NT_STATUS_V(result) == NT_STATUS_V(STATUS_MORE_ENTRIES));
+
+       return py_result;
+}      
+
+static PyMethodDef samr_domain_methods[] = {
+       { "enum_domain_groups", (PyCFunction)samr_enum_dom_groups,
+         METH_VARARGS | METH_KEYWORDS, "Enumerate domain groups" },
+       { NULL }
+};
+
+static PyObject *py_samr_domain_hnd_getattr(PyObject *self, char *attrname)
+{
+       return Py_FindMethod(samr_domain_methods, self, attrname);
+}
+
+PyTypeObject samr_domain_hnd_type = {
+       PyObject_HEAD_INIT(NULL)
+       0,
+       "SAMR Domain Handle",
+       sizeof(samr_domain_hnd_object),
+       0,
+       py_samr_domain_hnd_dealloc, /*tp_dealloc*/
+       0,          /*tp_print*/
+       py_samr_domain_hnd_getattr,          /*tp_getattr*/
+       0,          /*tp_setattr*/
+       0,          /*tp_compare*/
+       0,          /*tp_repr*/
+       0,          /*tp_as_number*/
+       0,          /*tp_as_sequence*/
+       0,          /*tp_as_mapping*/
+       0,          /*tp_hash */
+};
+
+/* SAMR user handle object */
+
+static void py_samr_user_hnd_dealloc(PyObject* self)
+{
+       PyObject_Del(self);
+}
+
+static PyMethodDef samr_user_methods[] = {
+       { NULL }
+};
+
+static PyObject *py_samr_user_hnd_getattr(PyObject *self, char *attrname)
+{
+       return Py_FindMethod(samr_user_methods, self, attrname);
+}
+
+PyTypeObject samr_user_hnd_type = {
+       PyObject_HEAD_INIT(NULL)
+       0,
+       "SAMR User Handle",
+       sizeof(samr_user_hnd_object),
+       0,
+       py_samr_user_hnd_dealloc, /*tp_dealloc*/
+       0,          /*tp_print*/
+       py_samr_user_hnd_getattr,          /*tp_getattr*/
+       0,          /*tp_setattr*/
+       0,          /*tp_compare*/
+       0,          /*tp_repr*/
+       0,          /*tp_as_number*/
+       0,          /*tp_as_sequence*/
+       0,          /*tp_as_mapping*/
+       0,          /*tp_hash */
+};
+
+PyObject *new_samr_user_hnd_object(struct cli_state *cli, TALLOC_CTX *mem_ctx,
+                                     POLICY_HND *pol)
+{
+       samr_user_hnd_object *o;
+
+       o = PyObject_New(samr_user_hnd_object, &samr_user_hnd_type);
+
+       o->cli = cli;
+       o->mem_ctx = mem_ctx;
+       memcpy(&o->user_pol, pol, sizeof(POLICY_HND));
+
+       return (PyObject*)o;
+}
+
+/* SAMR group handle object */
+
+static void py_samr_group_hnd_dealloc(PyObject* self)
+{
+       PyObject_Del(self);
+}
+
+static PyMethodDef samr_group_methods[] = {
+       { NULL }
+};
+
+static PyObject *py_samr_group_hnd_getattr(PyObject *self, char *attrname)
+{
+       return Py_FindMethod(samr_group_methods, self, attrname);
+}
+
+PyTypeObject samr_group_hnd_type = {
+       PyObject_HEAD_INIT(NULL)
+       0,
+       "SAMR Group Handle",
+       sizeof(samr_group_hnd_object),
+       0,
+       py_samr_group_hnd_dealloc, /*tp_dealloc*/
+       0,          /*tp_print*/
+       py_samr_group_hnd_getattr,          /*tp_getattr*/
+       0,          /*tp_setattr*/
+       0,          /*tp_compare*/
+       0,          /*tp_repr*/
+       0,          /*tp_as_number*/
+       0,          /*tp_as_sequence*/
+       0,          /*tp_as_mapping*/
+       0,          /*tp_hash */
+};
+
+PyObject *new_samr_group_hnd_object(struct cli_state *cli, TALLOC_CTX *mem_ctx,
+                                     POLICY_HND *pol)
+{
+       samr_group_hnd_object *o;
+
+       o = PyObject_New(samr_group_hnd_object, &samr_group_hnd_type);
+
+       o->cli = cli;
+       o->mem_ctx = mem_ctx;
+       memcpy(&o->group_pol, pol, sizeof(POLICY_HND));
+
+       return (PyObject*)o;
+}
+
+/* Alias handle object */
+
+static void py_samr_alias_hnd_dealloc(PyObject* self)
+{
+       PyObject_Del(self);
+}
+
+static PyMethodDef samr_alias_methods[] = {
+       { NULL }
+};
+
+static PyObject *py_samr_alias_hnd_getattr(PyObject *self, char *attrname)
+{
+       return Py_FindMethod(samr_alias_methods, self, attrname);
+}
+
+PyTypeObject samr_alias_hnd_type = {
+       PyObject_HEAD_INIT(NULL)
+       0,
+       "SAMR Alias Handle",
+       sizeof(samr_alias_hnd_object),
+       0,
+       py_samr_alias_hnd_dealloc, /*tp_dealloc*/
+       0,          /*tp_print*/
+       py_samr_alias_hnd_getattr,          /*tp_getattr*/
+       0,          /*tp_setattr*/
+       0,          /*tp_compare*/
+       0,          /*tp_repr*/
+       0,          /*tp_as_number*/
+       0,          /*tp_as_sequence*/
+       0,          /*tp_as_mapping*/
+       0,          /*tp_hash */
+};
+
+PyObject *new_samr_alias_hnd_object(struct cli_state *cli, TALLOC_CTX *mem_ctx,
+                                     POLICY_HND *pol)
+{
+       samr_alias_hnd_object *o;
+
+       o = PyObject_New(samr_alias_hnd_object, &samr_alias_hnd_type);
+
+       o->cli = cli;
+       o->mem_ctx = mem_ctx;
+       memcpy(&o->alias_pol, pol, sizeof(POLICY_HND));
+
+       return (PyObject*)o;
+}
+
+static PyObject *samr_connect(PyObject *self, PyObject *args, PyObject *kw)
+{
+       static char *kwlist[] = { "server", "creds", "access", NULL };
+       uint32 desired_access = MAXIMUM_ALLOWED_ACCESS;
+       char *server, *errstr;
+       struct cli_state *cli = NULL;
+       POLICY_HND hnd;
+       TALLOC_CTX *mem_ctx = NULL;
+       PyObject *result = NULL, *creds = NULL;
+       NTSTATUS ntstatus;
+
+       if (!PyArg_ParseTupleAndKeywords(
+                   args, kw, "s|Oi", kwlist, &server, &creds,
+                   &desired_access)) 
+               return NULL;
+
+       if (server[0] != '\\' || server[1] != '\\') {
+               PyErr_SetString(PyExc_ValueError, "UNC name required");
+               return NULL;
+       }
+
+       server += 2;
+
+       if (creds && creds != Py_None && !PyDict_Check(creds)) {
+               PyErr_SetString(PyExc_TypeError, 
+                               "credentials must be dictionary or None");
+               return NULL;
+       }
+
+       if (!(cli = open_pipe_creds(server, creds, PIPE_SAMR, &errstr))) {
+               PyErr_SetString(samr_error, errstr);
+               free(errstr);
+               return NULL;
+       }
+
+       if (!(mem_ctx = talloc_init())) {
+               PyErr_SetString(samr_ntstatus,
+                               "unable to init talloc context\n");
+               goto done;
+       }
+
+       ntstatus = cli_samr_connect(cli, mem_ctx, desired_access, &hnd);
+
+       if (!NT_STATUS_IS_OK(ntstatus)) {
+               cli_shutdown(cli);
+               SAFE_FREE(cli);
+               PyErr_SetObject(samr_ntstatus, py_ntstatus_tuple(ntstatus));
+               goto done;
+       }
+
+       result = new_samr_connect_hnd_object(cli, mem_ctx, &hnd);
+
+done:
+       if (!result) {
+               if (cli)
+                       cli_shutdown(cli);
+
+               if (mem_ctx)
+                       talloc_destroy(mem_ctx);
+       }
+
+       return result;
+}
+
+/*
+ * Module initialisation 
+ */
+
+static PyMethodDef samr_methods[] = {
+
+       /* Open/close samr connect handles */
+       
+       { "connect", (PyCFunction)samr_connect, 
+         METH_VARARGS | METH_KEYWORDS, 
+         "Open a connect handle" },
+       
+       { NULL }
+};
+
+static struct const_vals {
+       char *name;
+       uint32 value;